build: Switch @sentry/integrations to using eslint

AbhiPrasad · AbhiPrasad · commit 8b38062e21d9 · 2020-08-11T08:07:02.000-04:00
diff --git a/.eslintignore b/.eslintignore
@@ -1,7 +1,6 @@
 # THIS IS A TEMPORARY FILE
 # THIS WILL BE REMOVED AFTER WE FINISH ESLINT UPGRADE
 
-packages/integrations/**/*
 packages/node/**/*
 packages/react/**/*
 packages/tracing/**/*
diff --git a/dangerfile.ts b/dangerfile.ts
@@ -6,7 +6,7 @@ import { CLIEngine } from 'eslint';
 import { resolve } from 'path';
 import { promisify } from 'util';
 
-const PACKAGES = ['integrations', 'node'];
+const PACKAGES = ['node'];
 const EXTENSIONS = ['.js', '.jsx', '.ts', '.tsx'];
 
 /**
diff --git a/packages/integrations/.eslintrc.js b/packages/integrations/.eslintrc.js
@@ -0,0 +1,29 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  extends: ['../../.eslintrc.js'],
+  ignorePatterns: ['build/**/*', 'dist/**/*', 'esm/**/*', 'examples/**/*', 'scripts/**/*'],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    {
+      files: ['test/**/*'],
+      env: {
+        mocha: true,
+      },
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+      },
+    },
+  ],
+};
diff --git a/packages/integrations/package.json b/packages/integrations/package.json
@@ -45,13 +45,12 @@
     "build:bundle": "rollup --config",
     "clean": "rimraf dist coverage esm build .rpt2_cache",
     "link:yarn": "yarn link",
-    "lint": "run-s lint:prettier lint:tslint",
+    "lint": "run-s lint:prettier lint:eslint",
     "lint:prettier": "prettier-check \"{src,test}/**/*.ts\"",
-    "lint:tslint": "tslint -t stylish -p .",
-    "lint:tslint:json": "tslint --format json -p . | tee lint-results.json",
-    "fix": "run-s fix:tslint fix:prettier",
+    "lint:eslint": "eslint . --cache --cache-location '../../eslintcache/' --format stylish",
+    "fix": "run-s fix:eslint fix:prettier",
     "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
-    "fix:tslint": "tslint --fix -t stylish -p .",
+    "fix:eslint": "eslint . --format stylish --fix",
     "test": "jest",
     "test:watch": "jest --watch"
   },
diff --git a/packages/integrations/rollup.config.js b/packages/integrations/rollup.config.js
@@ -1,8 +1,9 @@
+import * as fs from 'fs';
+
 import { terser } from 'rollup-plugin-terser';
 import typescript from 'rollup-plugin-typescript2';
 import resolve from 'rollup-plugin-node-resolve';
 import commonjs from 'rollup-plugin-commonjs';
-import * as fs from 'fs';
 
 const terserInstance = terser({
   mangle: {
diff --git a/packages/integrations/src/angular.ts b/packages/integrations/src/angular.ts
@@ -10,11 +10,6 @@ const angularPattern = /^\[((?:[$a-zA-Z0-9]+:)?(?:[$a-zA-Z0-9]+))\] (.*?)\n?(\S+
  * Provides an $exceptionHandler for AngularJS
  */
 export class Angular implements Integration {
-  /**
-   * @inheritDoc
-   */
-  public name: string = Angular.id;
-
   /**
    * @inheritDoc
    */
@@ -25,9 +20,15 @@ export class Angular implements Integration {
    */
   public static moduleName: string = 'ngSentry';
 
+  /**
+   * @inheritDoc
+   */
+  public name: string = Angular.id;
+
   /**
    * Angular's instance
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private readonly _angular: any;
 
   /**
@@ -38,8 +39,9 @@ export class Angular implements Integration {
   /**
    * @inheritDoc
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public constructor(options: { angular?: any } = {}) {
-    // tslint:disable-next-line: no-unsafe-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this._angular = options.angular || getGlobalObject<any>().angular;
   }
 
@@ -57,7 +59,8 @@ export class Angular implements Integration {
     // tslint:disable: no-unsafe-any
     this._angular.module(Angular.moduleName, []).config([
       '$provide',
-      ($provide: any) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      ($provide: any): void => {
         $provide.decorator('$exceptionHandler', ['$delegate', this._$exceptionHandlerDecorator.bind(this)]);
       },
     ]);
@@ -67,9 +70,9 @@ export class Angular implements Integration {
   /**
    * Angular's exceptionHandler for Sentry integration
    */
-  // tslint:disable-next-line: no-unsafe-any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private _$exceptionHandlerDecorator($delegate: any): any {
-    return (exception: Error, cause?: string) => {
+    return (exception: Error, cause?: string): void => {
       const hub = this._getCurrentHub && this._getCurrentHub();
 
       if (hub && hub.getIntegration(Angular)) {
diff --git a/packages/integrations/src/captureconsole.ts b/packages/integrations/src/captureconsole.ts
@@ -8,12 +8,12 @@ export class CaptureConsole implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = CaptureConsole.id;
+  public static id: string = 'CaptureConsole';
 
   /**
    * @inheritDoc
    */
-  public static id: string = 'CaptureConsole';
+  public name: string = CaptureConsole.id;
 
   /**
    * @inheritDoc
@@ -42,7 +42,8 @@ export class CaptureConsole implements Integration {
         return;
       }
 
-      fill(global.console, level, (originalConsoleLevel: () => any) => (...args: any[]) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      fill(global.console, level, (originalConsoleLevel: () => any) => (...args: any[]): void => {
         const hub = getCurrentHub();
 
         if (hub.getIntegration(CaptureConsole)) {
diff --git a/packages/integrations/src/debug.ts b/packages/integrations/src/debug.ts
@@ -12,12 +12,12 @@ export class Debug implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Debug.id;
+  public static id: string = 'Debug';
 
   /**
    * @inheritDoc
    */
-  public static id: string = 'Debug';
+  public name: string = Debug.id;
 
   /** JSDoc */
   private readonly _options: DebugOptions;
@@ -40,12 +40,12 @@ export class Debug implements Integration {
     addGlobalEventProcessor((event: Event, hint?: EventHint) => {
       const self = getCurrentHub().getIntegration(Debug);
       if (self) {
-        // tslint:disable:no-console
-        // tslint:disable:no-debugger
         if (self._options.debugger) {
+          // eslint-disable-next-line no-debugger
           debugger;
         }
 
+        /* eslint-disable no-console */
         consoleSandbox(() => {
           if (self._options.stringify) {
             console.log(JSON.stringify(event, null, 2));
@@ -59,6 +59,7 @@ export class Debug implements Integration {
             }
           }
         });
+        /* eslint-enable no-console */
       }
       return event;
     });
diff --git a/packages/integrations/src/dedupe.ts b/packages/integrations/src/dedupe.ts
@@ -5,7 +5,7 @@ export class Dedupe implements Integration {
   /**
    * @inheritDoc
    */
-  private _previousEvent?: Event;
+  public static id: string = 'Dedupe';
 
   /**
    * @inheritDoc
@@ -15,7 +15,7 @@ export class Dedupe implements Integration {
   /**
    * @inheritDoc
    */
-  public static id: string = 'Dedupe';
+  private _previousEvent?: Event;
 
   /**
    * @inheritDoc
@@ -92,7 +92,7 @@ export class Dedupe implements Integration {
 
     if (exception) {
       try {
-        // @ts-ignore
+        // @ts-ignore Object could be undefined
         return exception.values[0].stacktrace.frames;
       } catch (_oO) {
         return undefined;
diff --git a/packages/integrations/src/ember.ts b/packages/integrations/src/ember.ts
@@ -6,31 +6,32 @@ export class Ember implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Ember.id;
+  public static id: string = 'Ember';
+
   /**
    * @inheritDoc
    */
-  public static id: string = 'Ember';
+  public name: string = Ember.id;
 
   /**
    * @inheritDoc
    */
-  private readonly _Ember: any; // tslint:disable-line:variable-name
+  // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
+  private readonly _Ember: any;
 
   /**
    * @inheritDoc
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public constructor(options: { Ember?: any } = {}) {
-    // tslint:disable-next-line: no-unsafe-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this._Ember = options.Ember || getGlobalObject<any>().Ember;
   }
 
   /**
    * @inheritDoc
    */
   public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    // tslint:disable:no-unsafe-any
-
     if (!this._Ember) {
       logger.error('EmberIntegration is missing an Ember instance');
       return;
@@ -50,6 +51,7 @@ export class Ember implements Integration {
       }
     };
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this._Ember.RSVP.on('error', (reason: any): void => {
       if (getCurrentHub().getIntegration(Ember)) {
         getCurrentHub().withScope(scope => {
diff --git a/packages/integrations/src/extraerrordata.ts b/packages/integrations/src/extraerrordata.ts
@@ -11,12 +11,12 @@ export class ExtraErrorData implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = ExtraErrorData.id;
+  public static id: string = 'ExtraErrorData';
 
   /**
    * @inheritDoc
    */
-  public static id: string = 'ExtraErrorData';
+  public name: string = ExtraErrorData.id;
 
   /**
    * @inheritDoc
diff --git a/packages/integrations/src/reportingobserver.ts b/packages/integrations/src/reportingobserver.ts
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { EventProcessor, Hub, Integration } from '@sentry/types';
 import { getGlobalObject, supportsReportingObserver } from '@sentry/utils';
 
@@ -55,11 +56,12 @@ export class ReportingObserver implements Integration {
   /**
    * @inheritDoc
    */
-  public readonly name: string = ReportingObserver.id;
+  public static id: string = 'ReportingObserver';
+
   /**
    * @inheritDoc
    */
-  public static id: string = 'ReportingObserver';
+  public readonly name: string = ReportingObserver.id;
 
   /**
    * Returns current hub.
diff --git a/packages/integrations/src/rewriteframes.ts b/packages/integrations/src/rewriteframes.ts
@@ -5,11 +5,6 @@ type StackFrameIteratee = (frame: StackFrame) => StackFrame;
 
 /** Rewrite event frames paths */
 export class RewriteFrames implements Integration {
-  /**
-   * @inheritDoc
-   */
-  public name: string = RewriteFrames.id;
-
   /**
    * @inheritDoc
    */
@@ -18,29 +13,12 @@ export class RewriteFrames implements Integration {
   /**
    * @inheritDoc
    */
-  private readonly _root?: string;
+  public name: string = RewriteFrames.id;
 
   /**
    * @inheritDoc
    */
-  private readonly _iteratee: StackFrameIteratee = (frame: StackFrame) => {
-    if (!frame.filename) {
-      return frame;
-    }
-    // Check if the frame filename begins with `/` or a Windows-style prefix such as `C:\`
-    const isWindowsFrame = /^[A-Z]:\\/.test(frame.filename);
-    const startsWithSlash = /^\//.test(frame.filename);
-    if (isWindowsFrame || startsWithSlash) {
-      const filename = isWindowsFrame
-        ? frame.filename
-            .replace(/^[A-Z]:/, '') // remove Windows-style prefix
-            .replace(/\\/g, '/') // replace all `\\` instances with `/`
-        : frame.filename;
-      const base = this._root ? relative(this._root, filename) : basename(filename);
-      frame.filename = `app:///${base}`;
-    }
-    return frame;
-  };
+  private readonly _root?: string;
 
   /**
    * @inheritDoc
@@ -80,6 +58,28 @@ export class RewriteFrames implements Integration {
     return event;
   }
 
+  /**
+   * @inheritDoc
+   */
+  private readonly _iteratee: StackFrameIteratee = (frame: StackFrame) => {
+    if (!frame.filename) {
+      return frame;
+    }
+    // Check if the frame filename begins with `/` or a Windows-style prefix such as `C:\`
+    const isWindowsFrame = /^[A-Z]:\\/.test(frame.filename);
+    const startsWithSlash = /^\//.test(frame.filename);
+    if (isWindowsFrame || startsWithSlash) {
+      const filename = isWindowsFrame
+        ? frame.filename
+            .replace(/^[A-Z]:/, '') // remove Windows-style prefix
+            .replace(/\\/g, '/') // replace all `\\` instances with `/`
+        : frame.filename;
+      const base = this._root ? relative(this._root, filename) : basename(filename);
+      frame.filename = `app:///${base}`;
+    }
+    return frame;
+  };
+
   /** JSDoc */
   private _processExceptionsEvent(event: Event): Event {
     try {
@@ -88,7 +88,7 @@ export class RewriteFrames implements Integration {
         exception: {
           ...event.exception,
           // The check for this is performed inside `process` call itself, safe to skip here
-          // tslint:disable-next-line:no-non-null-assertion
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           values: event.exception!.values!.map(value => ({
             ...value,
             stacktrace: this._processStacktrace(value.stacktrace),
diff --git a/packages/integrations/src/sessiontiming.ts b/packages/integrations/src/sessiontiming.ts
diff --git a/packages/integrations/src/transaction.ts b/packages/integrations/src/transaction.ts
diff --git a/packages/integrations/src/vue.ts b/packages/integrations/src/vue.ts
diff --git a/packages/integrations/test/extraerrordata.test.ts b/packages/integrations/test/extraerrordata.test.ts
diff --git a/packages/integrations/tslint.json b/packages/integrations/tslint.json
