ref: Remove tslint-disable comments

Author: AbhiPrasad

.eslintrc.js

@@ -16,18 +16,21 @@ module.exports = {
     },
     {
       // Configuration for typescript files
-      files: ['*.ts', '*.tsx'],
+      files: ['*.ts', '*.tsx', '*.d.ts'],
       extends: ['plugin:@typescript-eslint/recommended', 'prettier/@typescript-eslint'],
       plugins: ['@typescript-eslint'],
       parser: '@typescript-eslint/parser',
+      parserOptions: {
+        project: './tsconfig.json',
+      },
       rules: {
-        // We want to prevent async await usage in our files to prevent uncessary bundle size.
+        // We want to prevent async await usage in our files to prevent uncessary bundle size. Turned off in tests.
         'sentry-sdk/no-async-await': 'error',
 
-        // Make sure variables marked with _ are ignored (ex. _varName)
+        // Unused variables should be removed unless they are marked with and underscore (ex. _varName).
         '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
 
-        // Make sure that all ts-ignore comments are given a description
+        // Make sure that all ts-ignore comments are given a description.
         '@typescript-eslint/ban-ts-comment': [
           'warn',
           {
@@ -37,7 +40,7 @@ module.exports = {
 
         // Types usage should be explicit as possible, so we prevent usage of inferrable types.
         // This is especially important because we have a public API, so usage needs to be as
-        // easy to understand as possible
+        // easy to understand as possible.
         '@typescript-eslint/no-inferrable-types': 'off',
 
         // Enforce type annotations to maintain consistency. This is especially important as
@@ -48,6 +51,10 @@ module.exports = {
         // Consistent ordering of fields, methods and constructors for classes should be enforced
         '@typescript-eslint/member-ordering': 'error',
 
+        // Enforce that unbound methods are called within an expected scope. As we frequently pass data between classes
+        // in SDKs, we should make sure that we are correctly preserving class scope.
+        '@typescript-eslint/unbound-method': 'error',
+
         // Private and protected members of a class should be prefixed with a leading underscore
         '@typescript-eslint/naming-convention': [
           'error',
@@ -65,7 +72,8 @@ module.exports = {
           },
         ],
 
-        // JSDOC comments are required for classes and methods
+        // JSDOC comments are required for classes and methods. As we have a public facing codebase, documentation,
+        // even if it may seems excessive at times, is important to emphasize. Turned off in tests.
         'jsdoc/require-jsdoc': [
           'error',
           { require: { ClassDeclaration: true, MethodDefinition: true }, checkConstructors: false },
@@ -81,6 +89,7 @@ module.exports = {
       rules: {
         'sentry-sdk/no-async-await': 'off',
         'jsdoc/require-jsdoc': 'off',
+        'max-lines': 'off',
       },
     },
     {
@@ -97,8 +106,19 @@ module.exports = {
     // We want to prevent usage of unary operators outside of for loops
     'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
 
-    // disallow usage of console and alert
+    // Disallow usage of console and alert
     'no-console': 'error',
     'no-alert': 'error',
+
+    // Prevent reassignment of function parameters, but still allow object properties to be
+    // reassigned. We want to enforce immutability when possible, but we shouldn't sacrifice
+    // too much efficiency
+    'no-param-reassign': ['error', { props: false }],
+
+    // Prefer use of template expression over string literal concatenation
+    'prefer-template': 'error',
+
+    // Limit maximum file size to reduce complexity. Turned off in tests.
+    'max-lines': 'error',
   },
 };

packages/browser/.eslintrc.js

@@ -10,11 +10,19 @@ module.exports = {
   extends: ['../../.eslintrc.js'],
   ignorePatterns: ['build/**/*', 'dist/**/*', 'esm/**/*', 'examples/**/*', 'scripts/**/*', 'src/loader.js'],
   overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
     {
       files: ['test/**/*'],
       rules: {
         'jsdoc/require-jsdoc': 'off',
         'no-console': 'off',
+        'max-lines': 'off',
+        'prefer-template': 'off',
       },
     },
     {

packages/browser/src/eventbuilder.ts

@@ -71,6 +71,7 @@ export function eventFromUnknownInput(
   if (isErrorEvent(exception as ErrorEvent) && (exception as ErrorEvent).error) {
     // If it is an ErrorEvent with `error` property, extract it to get actual Error
     const errorEvent = exception as ErrorEvent;
+    // eslint-disable-next-line no-param-reassign
     exception = errorEvent.error;
     event = eventFromStacktrace(computeStackTrace(exception as Error));
     return event;

packages/browser/src/helpers.ts

@@ -38,7 +38,6 @@ export function wrap(
   before?: WrappedFunction,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): any {
-  // tslint:disable-next-line:strict-type-predicates
   if (typeof fn !== 'function') {
     return fn;
   }
@@ -65,9 +64,7 @@ export function wrap(
   const sentryWrapped: WrappedFunction = function(this: any): void {
     const args = Array.prototype.slice.call(arguments);
 
-    // tslint:disable:no-unsafe-any
     try {
-      // tslint:disable-next-line:strict-type-predicates
       if (before && typeof before === 'function') {
         before.apply(this, arguments);
       }
@@ -87,7 +84,6 @@ export function wrap(
       //       means the sentry.javascript SDK caught an error invoking your application code. This
       //       is expected behavior and NOT indicative of a bug with sentry.javascript.
       return fn.apply(this, wrappedArguments);
-      // tslint:enable:no-unsafe-any
     } catch (ex) {
       ignoreNextOnError();
 
@@ -211,6 +207,7 @@ export function injectReportDialog(options: ReportDialogOptions = {}): void {
   script.src = new API(options.dsn).getReportDialogEndpoint(options);
 
   if (options.onLoad) {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     script.onload = options.onLoad;
   }
 

packages/browser/src/index.ts

@@ -9,12 +9,10 @@ import * as Transports from './transports';
 let windowIntegrations = {};
 
 // This block is needed to add compatibility with the integrations packages when used with a CDN
-// tslint:disable: no-unsafe-any
 const _window = getGlobalObject<Window>();
 if (_window.Sentry && _window.Sentry.Integrations) {
   windowIntegrations = _window.Sentry.Integrations;
 }
-// tslint:enable: no-unsafe-any
 
 const INTEGRATIONS = {
   ...windowIntegrations,

packages/browser/src/integrations/breadcrumbs.ts

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 import { getCurrentHub } from '@sentry/core';
 import { Event, Integration, Severity } from '@sentry/types';
 import {
@@ -291,11 +292,9 @@ export class Breadcrumbs implements Integration {
     // Use only the path component of the URL if the URL matches the current
     // document (almost all the time when using pushState)
     if (parsedLoc.protocol === parsedTo.protocol && parsedLoc.host === parsedTo.host) {
-      // tslint:disable-next-line:no-parameter-reassignment
       to = parsedTo.relative;
     }
     if (parsedLoc.protocol === parsedFrom.protocol && parsedLoc.host === parsedFrom.host) {
-      // tslint:disable-next-line:no-parameter-reassignment
       from = parsedFrom.relative;
     }
 

packages/browser/src/integrations/trycatch.ts

@@ -162,7 +162,6 @@ export class TryCatch implements Integration {
         options?: boolean | AddEventListenerOptions,
       ): (eventName: string, fn: EventListenerObject, capture?: boolean, secure?: boolean) => void {
         try {
-          // tslint:disable-next-line:no-unbound-method strict-type-predicates
           if (typeof fn.handleEvent === 'function') {
             fn.handleEvent = wrap(fn.handleEvent.bind(fn), {
               mechanism: {

packages/browser/src/integrations/tslint.json

@@ -22,7 +22,6 @@ export function exceptionFromStacktrace(stacktrace: TraceKitStackTrace): Excepti
     exception.stacktrace = { frames };
   }
 
-  // tslint:disable-next-line:strict-type-predicates
   if (exception.type === undefined && exception.value === '') {
     exception.value = 'Unrecoverable error caught';
   }

packages/browser/src/parsers.ts

@@ -164,5 +164,5 @@ export function close(timeout?: number): PromiseLike<boolean> {
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function wrap(fn: (...args: any) => any): any {
-  return internalWrap(fn)(); // tslint:disable-line:no-unsafe-any
+  return internalWrap(fn)();
 }

packages/browser/src/sdk.ts

@@ -17,7 +17,6 @@ export abstract class BaseTransport implements Transport {
 
   public constructor(public options: TransportOptions) {
     this._api = new API(this.options.dsn);
-    // tslint:disable-next-line:deprecation
     this.url = this._api.getStoreEndpointWithUrlEncodedAuth();
   }
 

packages/browser/src/transports/base.ts

@@ -23,6 +23,7 @@ function throwNonError() {
 }
 
 function throwError(message) {
+  // eslint-disable-next-line no-param-reassign
   message = message || "foo";
   try {
     throw new Error(message);
@@ -45,6 +46,7 @@ function throwSameConsecutiveErrors(message) {
 }
 
 function captureMessage(message) {
+  // eslint-disable-next-line no-param-reassign
   message = message || "message";
   Sentry.captureMessage(message);
 }

packages/browser/test/integration/common/triggers.js

@@ -87,6 +87,7 @@
   if (typeof window.CustomEvent === "function") return false;
 
   function CustomEvent(event, params) {
+    // eslint-disable-next-line no-param-reassign
     params = params || { bubbles: false, cancelable: false, detail: null };
     var evt = document.createEvent("CustomEvent");
     evt.initCustomEvent(

packages/browser/test/integration/polyfills/events.js

@@ -61,6 +61,7 @@
 
   function normalizeName(name) {
     if (typeof name !== "string") {
+      // eslint-disable-next-line no-param-reassign
       name = String(name);
     }
     if (/[^a-z0-9\-#$%&'*+.^_`|~]/i.test(name)) {
@@ -71,6 +72,7 @@
 
   function normalizeValue(value) {
     if (typeof value !== "string") {
+      // eslint-disable-next-line no-param-reassign
       value = String(value);
     }
     return value;
@@ -113,7 +115,9 @@
   }
 
   Headers.prototype.append = function(name, value) {
+    // eslint-disable-next-line no-param-reassign
     name = normalizeName(name);
+    // eslint-disable-next-line no-param-reassign
     value = normalizeValue(value);
     var oldValue = this.map[name];
     this.map[name] = oldValue ? oldValue + ", " + value : value;
@@ -124,6 +128,7 @@
   };
 
   Headers.prototype.get = function(name) {
+    // eslint-disable-next-line no-param-reassign
     name = normalizeName(name);
     return this.has(name) ? this.map[name] : null;
   };
@@ -252,6 +257,7 @@
       ) {
         this._bodyArrayBuffer = bufferClone(body);
       } else {
+        // eslint-disable-next-line no-param-reassign
         this._bodyText = body = Object.prototype.toString.call(body);
       }
 
@@ -338,6 +344,7 @@
   }
 
   function Request(input, options) {
+    // eslint-disable-next-line no-param-reassign
     options = options || {};
     var body = options.body;
 
@@ -416,6 +423,7 @@
 
   function Response(bodyInit, options) {
     if (!options) {
+      // eslint-disable-next-line no-param-reassign
       options = {};
     }
 

packages/browser/test/integration/polyfills/fetch.js

@@ -11,7 +11,9 @@ function evaluateInSandbox(sandbox, code) {
 
 function runInSandbox(sandbox, options, code) {
   if (typeof options === "function") {
+    // eslint-disable-next-line no-param-reassign
     code = options;
+    // eslint-disable-next-line no-param-reassign
     options = {};
   }
 

packages/browser/test/integration/suites/helpers.js

@@ -166,9 +166,9 @@ describe('internal wrap()', () => {
       expect(this).equal(context);
     };
 
-    // tslint:disable-next-line:no-unbound-method
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const wrappedFn = wrap(context.fn);
-    // tslint:disable-next-line:no-unbound-method
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const wrappedEventFn = wrap(context.eventFn);
 
     wrappedFn.call(context);

packages/browser/test/tslint.json

@@ -1,7 +1,3 @@
-// tslint:disable:prefer-template
-// tslint:disable:object-literal-sort-keys
-// tslint:disable:max-file-line-count
-
 import { expect } from 'chai';
 
 import { computeStackTrace } from '../../../src/tracekit';

packages/browser/test/unit/integrations/helpers.test.ts

@@ -1,6 +1,3 @@
-// tslint:disable:prefer-template
-// tslint:disable:object-literal-sort-keys
-
 export const OPERA_854 = {
   name: 'foo',
   message:

packages/browser/test/unit/tracekit/original.test.ts

@@ -19,7 +19,6 @@ describe('BaseTransport', () => {
 
   it('has correct endpoint url', () => {
     const transport = new SimpleTransport({ dsn: testDsn });
-    // tslint:disable-next-line:deprecation
     expect(transport.url).equal('https://sentry.io/api/42/store/?sentry_key=123&sentry_version=7');
   });
 });

packages/browser/test/unit/tracekit/originalfixtures.ts

@@ -27,7 +27,6 @@ describe('FetchTransport', () => {
   });
 
   it('inherits composeEndpointUrl() implementation', () => {
-    // tslint:disable-next-line:deprecation
     expect(transport.url).equal(transportUrl);
   });
 

packages/browser/test/unit/transports/base.test.ts

@@ -28,7 +28,6 @@ describe('XHRTransport', () => {
   });
 
   it('inherits composeEndpointUrl() implementation', () => {
-    // tslint:disable-next-line:deprecation
     expect(transport.url).equal(transportUrl);
   });