fix: drivers imports alignment (#5448)

buntarb · web-flow · commit ab1242650ba0 · 2022-10-08T13:40:58.000+03:00
diff --git a/packages/cubejs-athena-driver/src/AthenaDriver.ts b/packages/cubejs-athena-driver/src/AthenaDriver.ts
@@ -1,3 +1,16 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `AthenaDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+  checkNonNullable,
+  pausePromise,
+  Required,
+} from '@cubejs-backend/shared';
 import { Athena, GetQueryResultsCommandOutput } from '@aws-sdk/client-athena';
 import { S3, GetObjectCommand } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
@@ -9,13 +22,6 @@ import {
   QueryOptions, StreamOptions,
   StreamTableData, TableName
 } from '@cubejs-backend/base-driver';
-import {
-  getEnv,
-  assertDataSource,
-  checkNonNullable,
-  pausePromise,
-  Required,
-} from '@cubejs-backend/shared';
 import * as SqlString from 'sqlstring';
 import { AthenaClientConfig } from '@aws-sdk/client-athena/dist-types/AthenaClient';
 import { URL } from 'url';
@@ -125,6 +131,7 @@ export class AthenaDriver extends BaseDriver implements DriverInterface {
     });
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public async query<R = unknown>(query: string, values: unknown[], options?: QueryOptions): Promise<R[]> {
     const qid = await this.startQuery(query, values);
     await this.waitForSuccess(qid);
diff --git a/packages/cubejs-base-driver/src/BaseDriver.ts b/packages/cubejs-base-driver/src/BaseDriver.ts
@@ -1,7 +1,18 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `BaseDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  keyByDataSource,
+  isFilePath,
+  isSslKey,
+  isSslCert,
+} from '@cubejs-backend/shared';
 import { reduce } from 'ramda';
 import fs from 'fs';
-import { getEnv, keyByDataSource, isFilePath, isSslKey, isSslCert } from '@cubejs-backend/shared';
-
 import { cancelCombinator } from './utils';
 import {
   CreateTableIndex,
diff --git a/packages/cubejs-bigquery-driver/src/BigQueryDriver.ts b/packages/cubejs-bigquery-driver/src/BigQueryDriver.ts
@@ -1,4 +1,15 @@
-/* eslint-disable no-underscore-dangle */
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `BigQueryDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+  pausePromise,
+  Required,
+} from '@cubejs-backend/shared';
 import R from 'ramda';
 import {
   BigQuery,
@@ -12,12 +23,6 @@ import {
   BaseDriver, DownloadTableCSVData,
   DriverInterface, QueryOptions, StreamTableData,
 } from '@cubejs-backend/base-driver';
-import {
-  getEnv,
-  assertDataSource,
-  pausePromise,
-  Required,
-} from '@cubejs-backend/shared';
 import { Query } from '@google-cloud/bigquery/build/src/bigquery';
 import { HydrationStream } from './HydrationStream';
 
diff --git a/packages/cubejs-clickhouse-driver/src/ClickHouseDriver.ts b/packages/cubejs-clickhouse-driver/src/ClickHouseDriver.ts
@@ -1,4 +1,13 @@
-/* eslint-disable no-restricted-syntax */
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `ClickHouseDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+} from '@cubejs-backend/shared';
 import {
   BaseDriver,
   DownloadQueryResultsOptions,
@@ -7,7 +16,6 @@ import {
   StreamOptions,
   StreamTableDataWithTypes,
 } from '@cubejs-backend/base-driver';
-import { getEnv, assertDataSource } from '@cubejs-backend/shared';
 import genericPool, { Pool } from 'generic-pool';
 import { v4 as uuidv4 } from 'uuid';
 import sqlstring from 'sqlstring';
diff --git a/packages/cubejs-crate-driver/src/CrateDriver.ts b/packages/cubejs-crate-driver/src/CrateDriver.ts
@@ -1,3 +1,9 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `CrateDriver` and related types declaration.
+ */
+
 import { PostgresDriver } from '@cubejs-backend/postgres-driver';
 import { PoolClient } from 'pg';
 
diff --git a/packages/cubejs-databricks-jdbc-driver/src/DatabricksDriver.ts b/packages/cubejs-databricks-jdbc-driver/src/DatabricksDriver.ts
@@ -1,4 +1,13 @@
-/* eslint-disable no-restricted-syntax */
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `DatabricksDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+} from '@cubejs-backend/shared';
 import fs from 'fs';
 import path from 'path';
 import { S3, GetObjectCommand } from '@aws-sdk/client-s3';
@@ -15,7 +24,6 @@ import {
   JDBCDriver,
   JDBCDriverConfiguration,
 } from '@cubejs-backend/jdbc-driver';
-import { getEnv, assertDataSource } from '@cubejs-backend/shared';
 import { DatabricksQuery } from './DatabricksQuery';
 import { downloadJDBCDriver } from './installer';
 
diff --git a/packages/cubejs-databricks-jdbc-driver/src/index.ts b/packages/cubejs-databricks-jdbc-driver/src/index.ts
@@ -1,3 +1,4 @@
 import { DatabricksDriver } from './DatabricksDriver';
 
 export default DatabricksDriver;
+export { DatabricksDriver };
diff --git a/packages/cubejs-dremio-driver/driver/DremioDriver.js b/packages/cubejs-dremio-driver/driver/DremioDriver.js
@@ -1,8 +1,17 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `DremioDriver` and related types declaration.
+ */
+
+const {
+  getEnv,
+  assertDataSource,
+  pausePromise,
+} = require('@cubejs-backend/shared');
 const axios = require('axios');
 const SqlString = require('sqlstring');
 const { BaseDriver } = require('@cubejs-backend/base-driver');
-const { getEnv, assertDataSource, pausePromise } = require('@cubejs-backend/shared');
-
 const DremioQuery = require('./DremioQuery');
 
 // limit - Determines how many rows are returned (maximum of 500). Default: 100
diff --git a/packages/cubejs-druid-driver/src/DruidDriver.ts b/packages/cubejs-druid-driver/src/DruidDriver.ts
@@ -1,5 +1,14 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `DruidDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+} from '@cubejs-backend/shared';
 import { BaseDriver, TableQueryResult } from '@cubejs-backend/base-driver';
-import { getEnv, assertDataSource } from '@cubejs-backend/shared';
 import { DruidClient, DruidClientBaseConfiguration, DruidClientConfiguration } from './DruidClient';
 import { DruidQuery } from './DruidQuery';
 
diff --git a/packages/cubejs-elasticsearch-driver/driver/ElasticSearchDriver.js b/packages/cubejs-elasticsearch-driver/driver/ElasticSearchDriver.js
@@ -1,6 +1,15 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `ElasticSearchDriver` and related types declaration.
+ */
+
+const {
+  getEnv,
+  assertDataSource,
+} = require('@cubejs-backend/shared');
 const { Client } = require('@elastic/elasticsearch');
 const SqlString = require('sqlstring');
-const { getEnv, assertDataSource } = require('@cubejs-backend/shared');
 const { BaseDriver } = require('@cubejs-backend/base-driver');
 
 /**
diff --git a/packages/cubejs-firebolt-driver/src/FireboltDriver.ts b/packages/cubejs-firebolt-driver/src/FireboltDriver.ts
@@ -1,4 +1,13 @@
-import { getEnv, assertDataSource } from '@cubejs-backend/shared';
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `FireboltDriver` and related types declaration.
+ */
+
+import {
+  getEnv,
+  assertDataSource,
+} from '@cubejs-backend/shared';
 import {
   BaseDriver,
   DriverInterface,
diff --git a/packages/cubejs-hive-driver/driver/HiveDriver.js b/packages/cubejs-hive-driver/driver/HiveDriver.js
@@ -1,15 +1,25 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `HiveDriver` and related types declaration.
+ */
+
+const {
+  getEnv,
+  assertDataSource,
+} = require('@cubejs-backend/shared');
 const jshs2 = require('jshs2');
 const SqlString = require('sqlstring');
 const genericPool = require('generic-pool');
 const { BaseDriver } = require('@cubejs-backend/base-driver');
-const { getEnv, assertDataSource } = require('@cubejs-backend/shared');
-
-const {
-  HS2Util, IDLContainer, HiveConnection, Configuration
-} = jshs2;
 const Connection = require('jshs2/lib/Connection');
-
 const IDLFactory = require('jshs2/lib/common/IDLFactory');
+const {
+  HS2Util,
+  IDLContainer,
+  HiveConnection,
+  Configuration,
+} = jshs2;
 
 const newIDL = [
   "2.1.1",
diff --git a/packages/cubejs-jdbc-driver/src/JDBCDriver.ts b/packages/cubejs-jdbc-driver/src/JDBCDriver.ts
@@ -1,3 +1,9 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `JDBCDriver` and related types declaration.
+ */
+
 /* eslint-disable no-restricted-syntax,import/no-extraneous-dependencies */
 import {
   getEnv,
diff --git a/packages/cubejs-ksql-driver/src/KsqlDriver.ts b/packages/cubejs-ksql-driver/src/KsqlDriver.ts
@@ -1,4 +1,9 @@
-/* eslint-disable no-restricted-syntax */
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `KsqlDriver` and related types declaration.
+ */
+
 import {
   getEnv,
   assertDataSource,
@@ -202,14 +207,17 @@ export class KsqlDriver extends BaseDriver implements DriverInterface {
     return fields.map(c => ({ name: c.name, type: this.toGenericType(c.schema.type) }));
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public loadPreAggregationIntoTable(preAggregationTableName: string, loadSql: string, params: any[], options: any): Promise<any> {
     return this.query(loadSql.replace(preAggregationTableName, this.tableDashName(preAggregationTableName)), params);
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public async downloadTable(table: string, options: any): Promise<any> {
     return this.getStreamingTableData(this.tableDashName(table));
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public async downloadQueryResults(query: string, params: any, options: any) {
     const table = KsqlQuery.extractTableFromSimpleSelectAsteriskQuery(query);
     if (!table) {
diff --git a/packages/cubejs-materialize-driver/src/MaterializeDriver.ts b/packages/cubejs-materialize-driver/src/MaterializeDriver.ts
@@ -1,3 +1,9 @@
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `MaterializeDriver` and related types declaration.
+ */
+
 import { PostgresDriver, PostgresDriverConfiguration } from '@cubejs-backend/postgres-driver';
 import { BaseDriver, DownloadTableMemoryData, IndexesSQL, StreamOptions, StreamTableDataWithTypes, TableStructure } from '@cubejs-backend/base-driver';
 import { PoolClient, QueryResult } from 'pg';
diff --git a/packages/cubejs-mongobi-driver/src/MongoBIDriver.ts b/packages/cubejs-mongobi-driver/src/MongoBIDriver.ts
@@ -1,10 +1,16 @@
-import { createConnection, Connection, ConnectionOptions, RowDataPacket, Field } from 'mysql2';
-import genericPool, { Pool } from 'generic-pool';
-import { Readable } from 'stream';
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `MongoBIDriver` and related types declaration.
+ */
+
 import {
   getEnv,
   assertDataSource,
 } from '@cubejs-backend/shared';
+import { createConnection, Connection, ConnectionOptions, RowDataPacket, Field } from 'mysql2';
+import genericPool, { Pool } from 'generic-pool';
+import { Readable } from 'stream';
 import {
   BaseDriver,
   DownloadQueryResultsOptions,
diff --git a/packages/cubejs-mssql-driver/driver/MSSqlDriver.js b/packages/cubejs-mssql-driver/driver/MSSqlDriver.js
@@ -1,9 +1,16 @@
-const sql = require('mssql');
-const { BaseDriver } = require('@cubejs-backend/base-driver');
-import {
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `MSSqlDriver` and related types declaration.
+ */
+
+const {
   getEnv,
   assertDataSource,
-} from '@cubejs-backend/shared';
+} = require('@cubejs-backend/shared');
+const sql = require('mssql');
+const { BaseDriver } = require('@cubejs-backend/base-driver');
+
 
 const GenericTypeToMSSql = {
   boolean: 'bit',
diff --git a/packages/cubejs-mysql-aurora-serverless-driver/driver/AuroraServerlessMySqlDriver.js b/packages/cubejs-mysql-aurora-serverless-driver/driver/AuroraServerlessMySqlDriver.js
@@ -1,10 +1,17 @@
-const crypto = require('crypto');
-const dataApi = require('data-api-client');
-const { BaseDriver } = require('@cubejs-backend/base-driver');
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `AuroraServerlessMySqlDriver` and related types
+ * declaration.
+ */
+
 const {
   getEnv,
   assertDataSource,
 } = require('@cubejs-backend/shared');
+const crypto = require('crypto');
+const dataApi = require('data-api-client');
+const { BaseDriver } = require('@cubejs-backend/base-driver');
 
 const GenericTypeToMySql = {
   string: 'varchar(255) CHARACTER SET utf8mb4',
diff --git a/packages/cubejs-mysql-driver/src/MySqlDriver.ts b/packages/cubejs-mysql-driver/src/MySqlDriver.ts
@@ -1,10 +1,16 @@
-import mysql, { Connection, ConnectionConfig, FieldInfo, QueryOptions } from 'mysql';
-import genericPool from 'generic-pool';
-import { promisify } from 'util';
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `MySqlDriver` and related types declaration.
+ */
+
 import {
   getEnv,
   assertDataSource,
 } from '@cubejs-backend/shared';
+import mysql, { Connection, ConnectionConfig, FieldInfo, QueryOptions } from 'mysql';
+import genericPool from 'generic-pool';
+import { promisify } from 'util';
 import {
   BaseDriver,
   GenericDataBaseType,
diff --git a/packages/cubejs-oracle-driver/driver/OracleDriver.js b/packages/cubejs-oracle-driver/driver/OracleDriver.js
@@ -1,8 +1,14 @@
-const { BaseDriver } = require('@cubejs-backend/base-driver');
-import {
+/**
+ * @copyright Cube Dev, Inc.
+ * @license Apache-2.0
+ * @fileoverview The `OracleDriver` and related types declaration.
+ */
+
+const {
   getEnv,
   assertDataSource,
-} from '@cubejs-backend/shared';
+} = require('@cubejs-backend/shared');
+const { BaseDriver } = require('@cubejs-backend/base-driver');
 const oracledb = require('oracledb');
 const { reduce } = require('ramda');
 
diff --git a/packages/cubejs-postgres-driver/src/PostgresDriver.ts b/packages/cubejs-postgres-driver/src/PostgresDriver.ts
diff --git a/packages/cubejs-prestodb-driver/driver/PrestoDriver.js b/packages/cubejs-prestodb-driver/driver/PrestoDriver.js
diff --git a/packages/cubejs-questdb-driver/src/QuestDriver.ts b/packages/cubejs-questdb-driver/src/QuestDriver.ts
diff --git a/packages/cubejs-redshift-driver/src/RedshiftDriver.ts b/packages/cubejs-redshift-driver/src/RedshiftDriver.ts
diff --git a/packages/cubejs-snowflake-driver/src/SnowflakeDriver.ts b/packages/cubejs-snowflake-driver/src/SnowflakeDriver.ts
diff --git a/packages/cubejs-sqlite-driver/driver/SqliteDriver.js b/packages/cubejs-sqlite-driver/driver/SqliteDriver.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`import { DatabricksDriver } from './DatabricksDriver';`
`2`	`2`
`3`	`3`	`export default DatabricksDriver;`
	`4`	`+export { DatabricksDriver };`