Convert all server packages to ESLint (#821)

This commit fully converts all lerna-managed **_server_** packages to use ESLint rather than TSLint.

For each package the following was done:

- Updated all code to address ESLint rules or ignore them
- Removed the tslint.json file from the project
- Updated eslintrc to use the `no-tslint` config
- (if needed) added an .editorconfig file to help VSCode format indentation properly
- Added eslint plugin dependencies to package.json and remove tslint dependency
- Updated tslint task
- Removed all // tslint comments
- Alphabetized rules in eslintrc

Author: tylerbutler

packages/utils/build-common/package.json

@@ -14,6 +14,11 @@
     "@typescript-eslint/eslint-plugin-tslint": "^2.9.0",
     "@typescript-eslint/parser": "^2.9.0",
     "eslint": "^6.7.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.1.7",
+    "eslint-plugin-react": "^7.16.0",
+    "eslint-plugin-unicorn": "^14.0.1",
     "tslint": "^5.20.0",
     "tslint-microsoft-contrib": "^6.0.0",
     "typescript": "~3.4.5"

packages/utils/eslint-config-fluid/default.js

@@ -62,6 +62,12 @@ module.exports = {
                 "lintFile": "./tslint.json"
             }
         ],
+        "import/no-unresolved": [
+            "error",
+            {
+                "caseSensitive": false
+            }
+        ],
         "no-case-declarations": "off"
     },
     "settings": {

packages/utils/eslint-config-fluid/no-tslint.js

@@ -181,6 +181,12 @@ module.exports = {
         ],
         "import/no-internal-modules": "error",
         "import/no-unassigned-import": "error",
+        "import/no-unresolved": [
+            "error",
+            {
+                "caseSensitive": false
+            }
+        ],
         "import/order": "error",
         "linebreak-style": "off",
         "max-classes-per-file": "off",

samples/chaincode/chat-3/package.json

@@ -20,7 +20,7 @@
     "start:live": "webpack-dev-server --config webpack.config.js --package package.json --env.mode live",
     "start:localhost": "webpack-dev-server --config webpack.config.js --package package.json --env.mode localhost",
     "tsc": "tsc",
-    "tslint": "npm run eslint",
+    "tslint": "tslint --project tsconfig.json --format verbose",
     "webpack": "webpack --env=\"production\""
   },
   "dependencies": {

server/routerlicious/packages/gitresources/.eslintignore

@@ -0,0 +1 @@
+*.spec.ts

server/routerlicious/packages/gitresources/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+    "extends": [
+        "@microsoft/eslint-config-fluid/no-tslint"
+    ],
+    "rules": {}
+}

server/routerlicious/packages/gitresources/package.json

@@ -13,14 +13,24 @@
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
     "clean": "rimraf dist *.tsbuildinfo *.build.log",
+    "eslint": "eslint --ext=ts,tsx --format stylish src",
+    "eslint:fix": "eslint --ext=ts,tsx --format stylish src --fix",
     "tsc": "tsc",
-    "tslint": "tslint --project tsconfig.json --format verbose"
+    "tslint": "npm run eslint"
   },
   "devDependencies": {
+    "@microsoft/eslint-config-fluid": "^0.13.0",
     "@microsoft/fluid-build-common": "^0.13.0",
+    "@typescript-eslint/eslint-plugin": "^2.9.0",
+    "@typescript-eslint/parser": "^2.9.0",
     "concurrently": "^4.1.0",
+    "eslint": "^6.7.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.1.7",
+    "eslint-plugin-react": "^7.16.0",
+    "eslint-plugin-unicorn": "^14.0.1",
     "rimraf": "^2.6.2",
-    "tslint": "^5.20.0",
     "typescript": "~3.4.5"
   }
 }

server/routerlicious/packages/kafka-orderer/.eslintignore

@@ -0,0 +1 @@
+*.spec.ts

server/routerlicious/packages/kafka-orderer/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+    "extends": [
+        "@microsoft/eslint-config-fluid/no-tslint"
+    ],
+    "rules": {}
+}

server/routerlicious/packages/kafka-orderer/package.json

@@ -14,21 +14,27 @@
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --ext=ts,tsx --format stylish src",
+    "eslint:fix": "eslint --ext=ts,tsx --format stylish src --fix",
     "tsc": "tsc",
-    "tslint": "tslint --project tsconfig.json --format verbose"
+    "tslint": "npm run eslint"
   },
   "dependencies": {
     "@microsoft/fluid-protocol-definitions": "^0.1001.0",
     "@microsoft/fluid-server-services-core": "^0.1001.0",
     "@types/lodash": "^4.14.118",
-    "@types/node": "^10.14.6",
-    "lodash": "^4.17.11"
+    "@types/node": "^10.14.6"
   },
   "devDependencies": {
     "@microsoft/fluid-build-common": "^0.13.0",
     "concurrently": "^4.1.0",
+    "eslint": "^6.7.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.1.7",
+    "eslint-plugin-react": "^7.16.0",
+    "eslint-plugin-unicorn": "^14.0.1",
     "rimraf": "^2.6.2",
-    "tslint": "^5.20.0",
     "typescript": "~3.4.5"
   }
-}
+}

server/routerlicious/packages/kafka-orderer/src/kafkaOrderer.ts

@@ -12,7 +12,8 @@ import {
     MessageType,
 } from "@microsoft/fluid-protocol-definitions";
 import * as core from "@microsoft/fluid-server-services-core";
-import * as _ from "lodash";
+
+/* eslint-disable no-null/no-null */
 
 export class KafkaOrdererConnection implements core.IOrdererConnection {
     public static async create(
@@ -43,16 +44,16 @@ export class KafkaOrdererConnection implements core.IOrdererConnection {
         return this._parentBranch;
     }
 
-    private _parentBranch: string;
+    private readonly _parentBranch: string;
 
     constructor(
         public readonly existing: boolean,
         document: core.IDocument,
-        private producer: core.IProducer,
+        private readonly producer: core.IProducer,
         public readonly tenantId: string,
         public readonly documentId: string,
         public readonly clientId: string,
-        private client: IClient,
+        private readonly client: IClient,
         public readonly maxMessageSize: number,
         public readonly serviceConfiguration: IServiceConfiguration,
     ) {
@@ -129,7 +130,7 @@ export class KafkaOrdererConnection implements core.IOrdererConnection {
     private submitRawOperation(messages: core.IRawOperationMessage[]) {
         // Add trace
         messages.forEach((message) => {
-            const operation = message.operation as IDocumentMessage;
+            const operation = message.operation;
             if (operation && operation.traces === undefined) {
                 operation.traces = [];
             } else if (operation && operation.traces && operation.traces.length > 1) {
@@ -142,6 +143,7 @@ export class KafkaOrdererConnection implements core.IOrdererConnection {
             }
         });
 
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         this.producer.send(messages, this.tenantId, this.documentId);
     }
 }
@@ -160,11 +162,11 @@ export class KafkaOrderer implements core.IOrderer {
     private existing: boolean;
 
     constructor(
-        private producer: core.IProducer,
-        private tenantId: string,
-        private documentId: string,
-        private maxMessageSize: number,
-        private serviceConfiguration: IServiceConfiguration,
+        private readonly producer: core.IProducer,
+        private readonly tenantId: string,
+        private readonly documentId: string,
+        private readonly maxMessageSize: number,
+        private readonly serviceConfiguration: IServiceConfiguration,
     ) {
     }
 
@@ -186,24 +188,25 @@ export class KafkaOrderer implements core.IOrderer {
             clientId,
             this.serviceConfiguration);
 
-        // document is now existing regardless of the original value
+        // Document is now existing regardless of the original value
         this.existing = true;
 
         return connection;
     }
 
+    // eslint-disable-next-line @typescript-eslint/promise-function-async
     public close() {
         return Promise.resolve();
     }
 }
 
 export class KafkaOrdererFactory {
-    private ordererMap = new Map<string, Promise<core.IOrderer>>();
+    private readonly ordererMap = new Map<string, Promise<core.IOrderer>>();
 
     constructor(
-        private producer: core.IProducer,
-        private maxMessageSize: number,
-        private serviceConfiguration: IServiceConfiguration,
+        private readonly producer: core.IProducer,
+        private readonly maxMessageSize: number,
+        private readonly serviceConfiguration: IServiceConfiguration,
     ) {
     }
 

server/routerlicious/packages/lambdas-driver/.eslintignore

@@ -0,0 +1 @@
+*.spec.ts

server/routerlicious/packages/lambdas-driver/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+    "extends": [
+        "@microsoft/eslint-config-fluid/no-tslint"
+    ],
+    "rules": {
+        "@typescript-eslint/strict-boolean-expressions": "off"
+    }
+}

server/routerlicious/packages/lambdas-driver/package.json

@@ -15,10 +15,12 @@
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --ext=ts,tsx --format stylish src",
+    "eslint:fix": "eslint --ext=ts,tsx --format stylish src --fix",
     "test": "mocha --recursive dist/test -r make-promises-safe",
     "test:coverage": "nyc npm test -- --reporter mocha-junit-reporter --reporter-options mochaFile=nyc/junit-report.xml",
     "tsc": "tsc",
-    "tslint": "tslint --project tsconfig.json --format verbose"
+    "tslint": "npm run eslint"
   },
   "dependencies": {
     "@microsoft/fluid-core-utils": "0.13.17538",
@@ -32,18 +34,27 @@
     "winston": "^3.1.0"
   },
   "devDependencies": {
+    "@microsoft/eslint-config-fluid": "^0.13.0",
     "@microsoft/fluid-build-common": "^0.13.0",
     "@microsoft/fluid-server-test-utils": "^0.1001.0",
+    "@typescript-eslint/eslint-plugin": "^2.9.0",
+    "@typescript-eslint/parser": "^2.9.0",
     "@types/async": "^2.0.50",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^5.2.5",
     "@types/nconf": "^0.0.37",
     "@types/node": "^10.14.6",
     "concurrently": "^4.1.0",
+    "eslint": "^6.7.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.1.7",
+    "eslint-plugin-react": "^7.16.0",
+    "eslint-plugin-unicorn": "^14.0.1",
     "make-promises-safe": "^5.1.0",
     "mocha": "^5.2.0",
+    "nyc": "^14.1.1",
     "rimraf": "^2.6.2",
-    "tslint": "^5.20.0",
     "typescript": "~3.4.5"
   },
   "nyc": {

server/routerlicious/packages/lambdas-driver/src/document-router/contextManager.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { IContext } from "@microsoft/fluid-server-services-core";
 import * as assert from "assert";
 import { EventEmitter } from "events";
+import { IContext } from "@microsoft/fluid-server-services-core";
 import { DocumentContext } from "./documentContext";
 
 // Constant representing the previous checkpointed offset
@@ -16,7 +16,7 @@ const LastCheckpointedOffset = -1;
  * from them.
  */
 export class DocumentContextManager extends EventEmitter {
-    private contexts: DocumentContext[] = [];
+    private readonly contexts: DocumentContext[] = [];
 
     // Head and tail represent our processing position of the queue. Head is the latest message seen and
     // tail is the last message processed
@@ -28,7 +28,7 @@ export class DocumentContextManager extends EventEmitter {
 
     private closed = false;
 
-    constructor(private partitionContext: IContext) {
+    constructor(private readonly partitionContext: IContext) {
         super();
     }
 

server/routerlicious/packages/lambdas-driver/src/document-router/documentContext.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { IContext } from "@microsoft/fluid-server-services-core";
 import * as assert from "assert";
 import { EventEmitter } from "events";
+import { IContext } from "@microsoft/fluid-server-services-core";
 
 export class DocumentContext extends EventEmitter implements IContext {
     // We track two offsets - head and tail. Head represents the largest offset related to this document we

server/routerlicious/packages/lambdas-driver/src/document-router/documentLambda.ts

@@ -15,10 +15,13 @@ import { DocumentContextManager } from "./contextManager";
 import { DocumentPartition } from "./documentPartition";
 
 export class DocumentLambda implements IPartitionLambda {
-    private documents = new Map<string, DocumentPartition>();
-    private contextManager: DocumentContextManager;
+    private readonly documents = new Map<string, DocumentPartition>();
+    private readonly contextManager: DocumentContextManager;
 
-    constructor(private factory: IPartitionLambdaFactory, private config: Provider, context: IContext) {
+    constructor(
+        private readonly factory: IPartitionLambdaFactory,
+        private readonly config: Provider,
+        context: IContext) {
         this.contextManager = new DocumentContextManager(context);
         this.contextManager.on("error", (error, restart) => {
             context.error(error, restart);
@@ -65,7 +68,7 @@ export class DocumentLambda implements IPartitionLambda {
             this.documents.set(routingKey, document);
         } else {
             document = this.documents.get(routingKey);
-            // setHead assumes it will always receive increasing offsets. So we need to split the creation case
+            // SetHead assumes it will always receive increasing offsets. So we need to split the creation case
             // from the update case.
             document.context.setHead(kafkaMessage.offset);
         }

server/routerlicious/packages/lambdas-driver/src/document-router/documentPartition.ts

@@ -11,8 +11,8 @@ import * as winston from "winston";
 import { DocumentContext } from "./documentContext";
 
 export class DocumentPartition {
-    private q: AsyncQueue<IKafkaMessage>;
-    private lambdaP: Promise<IPartitionLambda>;
+    private readonly q: AsyncQueue<IKafkaMessage>;
+    private readonly lambdaP: Promise<IPartitionLambda>;
     private lambda: IPartitionLambda;
     private corrupt = false;
 
@@ -23,15 +23,15 @@ export class DocumentPartition {
         documentId: string,
         public context: DocumentContext) {
 
-        // default to the git tenant if not specified
+        // Default to the git tenant if not specified
         const clonedConfig = _.cloneDeep((config as any).get());
         clonedConfig.tenantId = tenantId;
         clonedConfig.documentId = documentId;
         const documentConfig = new Provider({}).defaults(clonedConfig).use("memory");
 
         this.q = queue(
             (message: IKafkaMessage, callback) => {
-                // winston.verbose(`${message.topic}:${message.partition}@${message.offset}`);
+                // Winston.verbose(`${message.topic}:${message.partition}@${message.offset}`);
                 try {
                     if (!this.corrupt) {
                         this.lambda.handler(message);
@@ -46,7 +46,7 @@ export class DocumentPartition {
                     this.corrupt = true;
                 }
 
-                // handle the next message
+                // Handle the next message
                 callback();
             },
             1);

server/routerlicious/packages/lambdas-driver/src/document-router/index.ts

@@ -9,7 +9,7 @@ import { DocumentLambdaFactory } from "./lambdaFactory";
 
 export async function create(config: Provider): Promise<IPartitionLambdaFactory> {
     const pluginConfig = config.get("documentLambda") as string | object;
-    // tslint:disable-next-line:non-literal-require
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const plugin = (typeof pluginConfig === "object" ? pluginConfig : require(pluginConfig)) as IPlugin;
 
     // Factory used to create document lambda processors