Installed AirBnB linter and ran --fix for trivial issues (#48)

* Installed AirBnB linter and ran --fix for trivial issues

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Changed package-lock, added script to auto lint

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Added prettier config

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Added linter, changed github workflow, and linted

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Updated script to remove unnecessary npx, updated fix script to run prettier write.

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Fixed commments

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

* Changed contributing.md

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

Signed-off-by: nithinkdb <nithin.krishnamurthi@databricks.com>

Author: nithinkdb

.eslintrc

@@ -0,0 +1,19 @@
+{
+  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "overrides": [
+    {
+      "files": ["*.js", "*.ts"],
+      "rules": {
+        "class-methods-use-this": "off",
+        "no-underscore-dangle": "off",
+        "consistent-return": "off",
+        "no-param-reassign": "off",
+        "no-bitwise": "off",
+        "@typescript-eslint/no-throw-literal": "off"
+      }
+    }
+  ]
+}

.github/workflows/main.yml

@@ -27,7 +27,8 @@ jobs:
       - name: Check code style
         run: |
           npm ci
-          npm run prettier:check
+          npm run prettier
+          npm run lint
 
   test:
     runs-on: ubuntu-latest

.gitignore

@@ -5,5 +5,6 @@ node_modules
 .nyc_output
 coverage_e2e
 coverage_unit
-
+*.code-workspace
 dist
+*.DS_Store

CONTRIBUTING.md

@@ -100,16 +100,18 @@ npm run e2e
 Code style:
 
 ```bash
-npm run prettier:check
+npm run prettier
 npm run prettier:fix
+npm run lint
+npm run lint:fix
 ```
 
 ## Pull Request Process
 
 1. Update the [CHANGELOG](CHANGELOG.md) with details of your changes, if applicable.
 2. Add any appropriate tests.
 3. Make your code or other changes.
-4. Follow code style: `npm run prettier:fix`
+4. Follow code style: `npm run prettier:fix; npm run lint:fix`
 5. Review guidelines such as
    [How to write the perfect pull request][github-perfect-pr], thanks!
 

lib/DBSQLClient.ts

@@ -1,5 +1,6 @@
 import thrift from 'thrift';
 
+import { EventEmitter } from 'events';
 import TCLIService from '../thrift/TCLIService';
 import TCLIService_types, { TOpenSessionReq } from '../thrift/TCLIService_types';
 import IDBSQLClient, { IDBSQLConnectionOptions } from './contracts/IDBSQLClient';
@@ -12,18 +13,22 @@ import IAuthentication from './connection/contracts/IAuthentication';
 import NoSaslAuthentication from './connection/auth/NoSaslAuthentication';
 import HttpConnection from './connection/connections/HttpConnection';
 import IConnectionOptions from './connection/contracts/IConnectionOptions';
-import { EventEmitter } from 'events';
 import StatusFactory from './factory/StatusFactory';
 import HiveDriverError from './errors/HiveDriverError';
 import { buildUserAgentString, definedOrError } from './utils';
 import PlainHttpAuthentication from './connection/auth/PlainHttpAuthentication';
 
 export default class DBSQLClient extends EventEmitter implements IDBSQLClient {
   private client: TCLIService.Client | null;
+
   private connection: IThriftConnection | null;
+
   private statusFactory: StatusFactory;
+
   private connectionProvider: IConnectionProvider;
+
   private authProvider: IAuthentication;
+
   private thrift = thrift;
 
   constructor() {

lib/DBSQLOperation/getResult.ts

@@ -6,9 +6,8 @@ import JsonResult from '../result/JsonResult';
 function getHandler(schema: TTableSchema | null, data: Array<TRowSet>): IOperationResult {
   if (schema === null) {
     return new NullResult();
-  } else {
-    return new JsonResult(schema, data);
   }
+  return new JsonResult(schema, data);
 }
 
 export default function getResult(schema: TTableSchema | null, data: Array<TRowSet>) {

lib/DBSQLOperation/index.ts

@@ -20,15 +20,21 @@ import getResult from './getResult';
 
 export default class DBSQLOperation implements IOperation {
   private driver: HiveDriver;
+
   private operationHandle: TOperationHandle;
+
   private schema: TTableSchema | null = null;
+
   private data: Array<TRowSet> = [];
+
   private statusFactory = new StatusFactory();
 
   private fetchType: number = 0;
 
   private _hasMoreRows: boolean = false;
+
   private state: number = TOperationState.INITIALIZED_STATE;
+
   private hasResultSet: boolean = false;
 
   constructor(driver: HiveDriver, operationHandle: TOperationHandle) {
@@ -65,15 +71,14 @@ export default class DBSQLOperation implements IOperation {
           return this.firstFetch(chunkSize);
         })
         .then((response) => this.processFetchResponse(response));
-    } else {
-      return this.nextFetch(chunkSize).then((response) => this.processFetchResponse(response));
     }
+    return this.nextFetch(chunkSize).then((response) => this.processFetchResponse(response));
   }
 
   async fetchAll(options?: IFetchOptions): Promise<Array<object>> {
-    let data: Array<object> = [];
+    const data: Array<object> = [];
     do {
-      let chunk = await this.fetchChunk(options);
+      const chunk = await this.fetchChunk(options); // eslint-disable-line no-await-in-loop
       if (chunk) {
         data.push(...chunk);
       }
@@ -88,8 +93,8 @@ export default class DBSQLOperation implements IOperation {
 
     await waitUntilReady(this, options.progress, options.callback);
 
-    return await this.fetch(options.maxRows).then(() => {
-      let data = getResult(this.getSchema(), this.getData());
+    return this.fetch(options.maxRows).then(() => {
+      const data = getResult(this.getSchema(), this.getData());
       this.flush();
       return Promise.resolve(data);
     });
@@ -128,9 +133,7 @@ export default class DBSQLOperation implements IOperation {
       .cancelOperation({
         operationHandle: this.operationHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   /**
@@ -142,9 +145,7 @@ export default class DBSQLOperation implements IOperation {
       .closeOperation({
         operationHandle: this.operationHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   finished(): boolean {

lib/DBSQLOperation/waitUntilReady.ts

@@ -7,7 +7,7 @@ async function isReady(
   progress?: boolean,
   callback?: OperationStatusCallback,
 ): Promise<boolean> {
-  let response = await operation.status(Boolean(progress));
+  const response = await operation.status(Boolean(progress));
 
   if (callback) {
     await Promise.resolve(callback(response));
@@ -46,7 +46,6 @@ export default async function waitUntilReady(
   }
   if (await isReady(operation, progress, callback)) {
     return;
-  } else {
-    return waitUntilReady(operation, progress, callback);
   }
+  return waitUntilReady(operation, progress, callback);
 }

lib/DBSQLSession.ts

@@ -18,7 +18,9 @@ import { definedOrError } from './utils';
 
 export default class DBSQLSession implements IDBSQLSession {
   private driver: HiveDriver;
+
   private sessionHandle: TSessionHandle;
+
   private statusFactory: StatusFactory;
 
   constructor(driver: HiveDriver, sessionHandle: TSessionHandle) {
@@ -234,9 +236,7 @@ export default class DBSQLSession implements IDBSQLSession {
       .closeSession({
         sessionHandle: this.sessionHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   private createOperation(handle: TOperationHandle): IOperation {

lib/connection/auth/PlainHttpAuthentication.ts

@@ -8,7 +8,9 @@ type HttpAuthOptions = AuthOptions & {
 
 export default class PlainHttpAuthentication implements IAuthentication {
   private username: string;
+
   private password: string;
+
   private headers: object;
 
   constructor(options: HttpAuthOptions) {
@@ -27,6 +29,6 @@ export default class PlainHttpAuthentication implements IAuthentication {
   }
 
   private getToken(username: string, password: string): string {
-    return 'Basic ' + Buffer.from(`${username}:${password}`).toString('base64');
+    return `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
   }
 }