fix: eslint settings, lint errors (#3348)

* fix: eslint config * fix: adaptive-expressions-ie11 lint errors * fix: botbuilder-ai-orchestrator lint errors * fix: bot-integration-tests lint errors * fix: botbuilder-applicationinsights lint errors * fix: botbuilder-azure lint errors * fix: botbuilder-dialogs-adaptive-teams lint errors * fix: botbuilder-testing lint errors Co-authored-by: Steven Gum <14935595+stevengum@users.noreply.github.com>
microsoft · Mar 5, 2021 · 866b662 · 866b662
1 parent 95e48f2
commit 866b662
Show file tree

Hide file tree

Showing 35 changed files with 1,131 additions and 834 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,16 +2,6 @@
   "env": {
     "es6": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:security/recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "prettier",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint",
-    "plugin:jsdoc/recommended"
-  ],
   "ignorePatterns": [
     "_ts3.4/",
     "dist/",
@@ -28,15 +18,27 @@
   },
   "plugins": [
     "@typescript-eslint",
-    "prettier",
+    "import",
     "jsdoc",
-    "security",
-    "import"
+    "lodash",
+    "prettier",
+    "security"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jsdoc/recommended",
+    "plugin:security/recommended",
+    "plugin:prettier/recommended"
   ],
   "settings": {
     "jsdoc": {
       "ignoreInternal": true,
-      "ignorePrivate": true
+      "ignorePrivate": true,
+      "tagNamePreference": {
+        "augments": "extends"
+      }
     }
   },
   "rules": {
@@ -60,6 +62,13 @@
         "peerDependencies": false
       }
     ],
+    "jsdoc/check-tag-names": [
+      "error",
+      {
+        "definedTags": ["remarks"]
+      }
+    ],
+    "jsdoc/empty-tags": "off",
     "jsdoc/require-jsdoc": [
       "error",
       {
@@ -71,6 +80,7 @@
     "jsdoc/require-param-type": "off",
     "jsdoc/require-returns": "error",
     "jsdoc/require-returns-type": "off",
+    "lodash/import-scope": [2],
     "no-unused-vars": "off",
     "no-var": "error",
     "prettier/prettier": "error",
@@ -79,8 +89,9 @@
   "overrides": [
     {
       "files": [
-        "*.test.js",
-        "*.test.ts"
+        "*.test.*",
+        "test/**/*",
+        "tests/**/*"
       ],
       "env": {
         "mocha": true,
@@ -89,22 +100,22 @@
       "rules": {
         "@typescript-eslint/no-var-requires": "off",
         "import/no-extraneous-dependencies": "off",
+        "jsdoc/require-jsdoc": "off",
+        "jsdoc/require-param": "off",
+        "jsdoc/require-returns": "off",
         "security/detect-non-literal-fs-filename": "off"
       }
     },
     {
       "files": [
-        "babel.config.js",
-        "webpack.config.js"
+        "*.config.js"
       ],
-      "globals": {
-        "__dirname": true,
-        "module": true,
-        "require": true
+      "env": {
+        "node": true
       },
       "rules": {
         "@typescript-eslint/no-var-requires": "off"
       }
     }
   ]
-}
+}
diff --git a/libraries/adaptive-expressions-ie11/.eslintrc.json b/libraries/adaptive-expressions-ie11/.eslintrc.json
@@ -1,4 +1,3 @@
 {
-    "extends": "../../.eslintrc.json",
-    "plugins": ["only-warn"]
+    "extends": "../../.eslintrc.json"
 }
diff --git a/libraries/adaptive-expressions-ie11/package.json b/libraries/adaptive-expressions-ie11/package.json
@@ -20,7 +20,9 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "adaptive-expressions": "4.1.6",
-    "core-js": "^3.3.2"
+    "clean-webpack-plugin": "^3.0.0",
+    "core-js": "^3.3.2",
+    "terser-webpack-plugin": "^4.2.3"
   },
   "devDependencies": {
     "@babel/core": "^7.6.4",
@@ -31,8 +33,6 @@
     "@babel/preset-typescript": "^7.6.0",
     "@babel/runtime": "^7.6.3",
     "babel-loader": "^8.0.6",
-    "clean-webpack-plugin": "^3.0.0",
-    "terser-webpack-plugin": "^4.2.3",
     "ts-loader": "^7.0.5",
     "typescript": "3.5.3",
     "webpack": "^4.43.0",

diff --git a/libraries/bot-integration-tests/.eslintrc.json b/libraries/bot-integration-tests/.eslintrc.json
@@ -1,4 +1,3 @@
 {
-    "extends": "../../.eslintrc.json",
-    "plugins": ["only-warn"]
+    "extends": "../../.eslintrc.json"
 }
diff --git a/libraries/bot-integration-tests/src/channelServiceRoutes.test.ts b/libraries/bot-integration-tests/src/channelServiceRoutes.test.ts
@@ -16,6 +16,7 @@ describe('ChannelServiceRoutes - Integration Tests', function () {
 
         routes.register(app);
 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const bfRoutes = (app._router.stack as Array<any>).filter((layer) => {
             const route: express.IRoute = layer.route;
             if (route) {
@@ -36,6 +37,7 @@ describe('ChannelServiceRoutes - Integration Tests', function () {
 
         routes.register(app, '/test');
 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const bfRoutes = (app._router.stack as Array<any>).filter((layer) => {
             const route: express.IRoute = layer.route;
             if (route) {

diff --git a/libraries/botbuilder-ai-orchestrator/.eslintrc.json b/libraries/botbuilder-ai-orchestrator/.eslintrc.json
@@ -1,4 +1,3 @@
 {
-    "extends": "../../.eslintrc.json",
-    "plugins": ["only-warn"]
+    "extends": "../../.eslintrc.json"
 }
diff --git a/libraries/botbuilder-ai-orchestrator/package.json b/libraries/botbuilder-ai-orchestrator/package.json
@@ -30,6 +30,7 @@
     "adaptive-expressions": "4.1.6",
     "botbuilder-core": "4.1.6",
     "botbuilder-dialogs": "4.1.6",
+    "botbuilder-dialogs-declarative": "4.1.6",
     "orchestrator-core": "4.12.0-preview",
     "uuid": "^8.3.2"
   },

diff --git a/libraries/botbuilder-ai-orchestrator/src/orchestratorAdaptiveRecognizer.ts b/libraries/botbuilder-ai-orchestrator/src/orchestratorAdaptiveRecognizer.ts
@@ -22,6 +22,7 @@ import {
 import { Activity, RecognizerResult } from 'botbuilder-core';
 import { Converter, ConverterFactory, DialogContext, Recognizer, RecognizerConfiguration } from 'botbuilder-dialogs';
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const oc = require('orchestrator-core');
 
 export interface OrchestratorAdaptiveRecognizerConfiguration extends RecognizerConfiguration {

diff --git a/libraries/botbuilder-ai-orchestrator/src/orchestratorComponentRegistration.ts b/libraries/botbuilder-ai-orchestrator/src/orchestratorComponentRegistration.ts
@@ -6,11 +6,11 @@
  * Licensed under the MIT License.
  */
 
-import { ComponentRegistration } from 'botbuilder-core';
+import { ComponentDeclarativeTypes, DeclarativeType } from 'botbuilder-dialogs-declarative';
 import { OrchestratorAdaptiveRecognizer } from './orchestratorAdaptiveRecognizer';
 
-export class OrchestratorComponentRegistration extends ComponentRegistration {
-    public getDeclarativeTypes(_resourceExplorer: unknown) {
+export class OrchestratorComponentRegistration implements ComponentDeclarativeTypes {
+    public getDeclarativeTypes(_resourceExplorer: unknown): DeclarativeType[] {
         return [
             {
                 kind: OrchestratorAdaptiveRecognizer.$kind,

diff --git a/libraries/botbuilder-ai-orchestrator/tests/mockResolver.js b/libraries/botbuilder-ai-orchestrator/tests/mockResolver.js
@@ -2,12 +2,15 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
 class MockResolver {
     constructor(score) {
         this._score = score;
     }
 
-    score(text) {
+    score(_text) {
         return this._score;
     }
 }
@@ -19,4 +22,4 @@ class TestAdapterSettings {
     }
 }
 
-module.exports = { MockResolver, TestAdapterSettings };
+module.exports = { MockResolver, TestAdapterSettings };
diff --git a/libraries/botbuilder-ai-orchestrator/tsconfig.json b/libraries/botbuilder-ai-orchestrator/tsconfig.json
@@ -7,7 +7,7 @@
     "outDir": "lib",
     "rootDir": "src",
     "skipLibCheck": true
-    },
+  },
   "include": [
     "src/**/*"
   ]

diff --git a/libraries/botbuilder-applicationinsights/.eslintrc.json b/libraries/botbuilder-applicationinsights/.eslintrc.json
@@ -1,4 +1,3 @@
 {
-    "extends": "../../.eslintrc.json",
-    "plugins": ["only-warn"]
+    "extends": "../../.eslintrc.json"
 }
diff --git a/libraries/botbuilder-applicationinsights/src/applicationInsightsTelemetryClient.ts b/libraries/botbuilder-applicationinsights/src/applicationInsightsTelemetryClient.ts
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * @module botbuilder-applicationinsights
  */
@@ -6,6 +7,9 @@
  * Licensed under the MIT License.
  */
 import * as appInsights from 'applicationinsights';
+import * as cls from 'cls-hooked';
+import * as crypto from 'crypto';
+
 import {
     Activity,
     BotTelemetryClient,
@@ -16,22 +20,19 @@ import {
     TelemetryTrace,
     TelemetryPageView,
 } from 'botbuilder-core';
-import * as cls from 'cls-hooked';
-import * as crypto from 'crypto';
-const ns: any = cls.createNamespace('my.request');
 
 // This is the currently recommended work-around for using Application Insights with async/await
 // https://github.com/Microsoft/ApplicationInsights-node.js/issues/296
 // This allows AppInsights to automatically apply the appropriate context objects deep inside the async/await chain.
-// tslint:disable-next-line:no-submodule-imports
 import {
     CorrelationContext,
     CorrelationContextManager,
 } from 'applicationinsights/out/AutoCollection/CorrelationContextManager';
-const origGetCurrentContext: any = CorrelationContextManager.getCurrentContext;
 
-function getCurrentContext(): any {
-    // tslint:disable-next-line:no-backbone-get-set-outside-model
+const origGetCurrentContext = CorrelationContextManager.getCurrentContext;
+const ns = cls.createNamespace('my.request');
+
+function getCurrentContext(): CorrelationContext {
     return ns.get('ctx') || origGetCurrentContext();
 }
 
@@ -44,15 +45,12 @@ export const ApplicationInsightsWebserverMiddleware: any = (req: any, res: any,
     const activity: Partial<Activity> = req.body;
     if (activity && activity.id) {
         const context: CorrelationContext = appInsights.getCorrelationContext();
-
-        // tslint:disable-next-line:no-string-literal
         context['activity'] = req.body;
     }
 
     ns.bindEmitter(req);
     ns.bindEmitter(res);
     ns.run((): void => {
-        // tslint:disable-next-line:no-backbone-get-set-outside-model
         ns.set('ctx', origGetCurrentContext());
         next();
     });
@@ -77,6 +75,7 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 
     /**
      * Creates a new instance of the [ApplicationInsightsTelemetryClient](xref:botbuilder-applicationinsights.ApplicationInsightsTelemetryClient) class.
+     *
      * @param instrumentationKey The ApplicationInsights instrumentation key.
      * @remarks The settings parameter is passed directly into appInsights.setup().
      * https://www.npmjs.com/package/applicationinsights#basic-usage
@@ -101,20 +100,25 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
      * Provides access to the Application Insights configuration that is running here.
      * Allows developers to adjust the options, for example:
      * `appInsightsClient.configuration.setAutoCollectDependencies(false)`
+     *
+     * @returns app insights configuration
      */
     get configuration(): appInsights.Configuration {
         return this.config;
     }
 
     /**
      * Provides direct access to the telemetry client object, which might be necessary for some operations.
+     *
+     * @returns app insights telemetry client
      */
     get defaultClient(): appInsights.TelemetryClient {
         return this.client;
     }
 
     /**
      * Sends information about an external dependency (outgoing call) in the application.
+     *
      * @param telemetry The [TelemetryDependency](xref:botbuilder-core.TelemetryDependency) to track.
      */
     public trackDependency(telemetry: TelemetryDependency): void {
@@ -123,6 +127,7 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 
     /**
      * Logs custom events with extensible named fields.
+     *
      * @param telemetry The [TelemetryEvent](xref:botbuilder-core.TelemetryEvent) to track.
      */
     public trackEvent(telemetry: TelemetryEvent): void {
@@ -131,6 +136,7 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 
     /**
      * Logs a system exception.
+     *
      * @param telemetry The [TelemetryException](xref:botbuilder-core.TelemetryException) to track.
      */
     public trackException(telemetry: TelemetryException): void {
@@ -139,6 +145,7 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 
     /**
      * Sends a trace message.
+     *
      * @param telemetry The [TelemetryTrace](xref:botbuilder-core.TelemetryTrace) to track.
      */
     public trackTrace(telemetry: TelemetryTrace): void {
@@ -147,6 +154,7 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 
     /**
      * Logs a dialog entry as an Application Insights page view.
+     *
      * @param telemetry The [TelemetryPageView](xref:botbuilder-core.TelemetryPageView) to track.
      */
     public trackPageView(telemetry: TelemetryPageView): void {
@@ -167,7 +175,6 @@ export class ApplicationInsightsTelemetryClient implements BotTelemetryClient, B
 function addBotIdentifiers(envelope: appInsights.Contracts.Envelope, context: { [name: string]: any }): boolean {
     if (context.correlationContext && context.correlationContext.activity) {
         const activity: Partial<Activity> = context.correlationContext.activity;
-        // tslint:disable-next-line:no-string-literal
         const telemetryItem: any = envelope.data['baseData']; // TODO: update when envelope ts definition includes baseData
         const userId: string = activity.from ? activity.from.id : '';
         const channelId: string = activity.channelId || '';