feat(eslint): Add new eslint rules (#3545)

* feat(eslint): Add naming convention for typeLike
* feat(eslint): Make class member accessibility explicit

package.json

@@ -9,6 +9,7 @@
     "fix": "lerna run --parallel fix",
     "link:yarn": "lerna run --stream --concurrency 1 link:yarn",
     "lint": "lerna run --parallel lint",
+    "lint:eslint": "lerna run --parallel lint:eslint",
     "test": "lerna run --stream --concurrency 1 --sort test",
     "codecov": "codecov",
     "pack:changed": "lerna run pack --since",

packages/browser/src/transports/fetch.ts

@@ -81,7 +81,7 @@ export class FetchTransport extends BaseTransport {
    */
   private _fetch: typeof fetch;
 
-  constructor(options: TransportOptions, fetchImpl: FetchImpl = getNativeFetchImplementation()) {
+  public constructor(options: TransportOptions, fetchImpl: FetchImpl = getNativeFetchImplementation()) {
     super(options);
     this._fetch = fetchImpl;
   }

packages/eslint-config-sdk/src/index.js

@@ -52,7 +52,9 @@ module.exports = {
         // 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
+        // Private and protected members of a class should be prefixed with a leading underscore.
+        // typeLike declarations (class, interface, typeAlias, enum, typeParameter) should be
+        // PascalCase.
         '@typescript-eslint/naming-convention': [
           'error',
           {
@@ -67,6 +69,10 @@ module.exports = {
             format: ['camelCase'],
             leadingUnderscore: 'require',
           },
+          {
+            selector: 'typeLike',
+            format: ['PascalCase'],
+          },
         ],
 
         // Prefer for-of loop over for loop if index is only used to access array
@@ -98,6 +104,10 @@ module.exports = {
         // instead of any. This is especially important for methods that expose a public API, as users
         // should know exactly what they have to provide to use those methods. Turned off in tests.
         '@typescript-eslint/no-unsafe-member-access': 'error',
+
+        // Be explicit about class member accessibility (public, private, protected). Turned off
+        // on tests for ease of use.
+        '@typescript-eslint/explicit-member-accessibility': ['error'],
       },
     },
     {
@@ -134,6 +144,7 @@ module.exports = {
         'no-unused-expressions': 'off',
         '@typescript-eslint/no-unused-expressions': 'off',
         '@typescript-eslint/no-unsafe-member-access': 'off',
+        '@typescript-eslint/explicit-member-accessibility': 'off',
       },
     },
     {

packages/gatsby/test/integration.test.tsx

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { render } from '@testing-library/react';
 import { useEffect } from 'react';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import * as React from 'react';
 
 import { onClientEntry } from '../gatsby-browser';

packages/hub/src/session.ts

@@ -29,15 +29,15 @@ export class Session implements SessionInterface {
   public ipAddress?: string;
   public init: boolean = true;
 
-  constructor(context?: Omit<SessionContext, 'started' | 'status'>) {
+  public constructor(context?: Omit<SessionContext, 'started' | 'status'>) {
     if (context) {
       this.update(context);
     }
   }
 
   /** JSDoc */
   // eslint-disable-next-line complexity
-  update(context: SessionContext = {}): void {
+  public update(context: SessionContext = {}): void {
     if (context.user) {
       if (context.user.ip_address) {
         this.ipAddress = context.user.ip_address;
@@ -89,7 +89,7 @@ export class Session implements SessionInterface {
   }
 
   /** JSDoc */
-  close(status?: Exclude<SessionStatus, SessionStatus.Ok>): void {
+  public close(status?: Exclude<SessionStatus, SessionStatus.Ok>): void {
     if (status) {
       this.update({ status });
     } else if (this.status === SessionStatus.Ok) {
@@ -100,7 +100,7 @@ export class Session implements SessionInterface {
   }
 
   /** JSDoc */
-  toJSON(): {
+  public toJSON(): {
     init: boolean;
     sid: string;
     did?: string;
@@ -151,7 +151,7 @@ export class SessionFlusher implements SessionFlusherLike {
   private _isEnabled: boolean = true;
   private _transport: Transport;
 
-  constructor(transport: Transport, attrs: ReleaseHealthAttributes) {
+  public constructor(transport: Transport, attrs: ReleaseHealthAttributes) {
     this._transport = transport;
     // Call to setInterval, so that flush is called every 60 seconds
     this._intervalId = setInterval(() => this.flush(), this.flushTimeout * 1000);

packages/nextjs/src/utils/metadataBuilder.ts

@@ -13,7 +13,7 @@ export class MetadataBuilder {
   private _options: NextjsOptions;
   private _packageNames: string[];
 
-  constructor(options: NextjsOptions, packages: string[]) {
+  public constructor(options: NextjsOptions, packages: string[]) {
     this._options = options;
     this._packageNames = packages;
   }

packages/node/src/integrations/onuncaughtexception.ts

@@ -5,6 +5,8 @@ import { logger } from '@sentry/utils';
 import { NodeClient } from '../client';
 import { logAndExitProcess } from './utils/errorhandling';
 
+type OnFatalErrorHandler = (firstError: Error, secondError?: Error) => void;
+
 /** Global Promise Rejection handler */
 export class OnUncaughtException implements Integration {
   /**
@@ -53,17 +55,15 @@ export class OnUncaughtException implements Integration {
     let firstError: Error;
 
     return (error: Error): void => {
-      type onFatalErrorHandlerType = (firstError: Error, secondError?: Error) => void;
-
-      let onFatalError: onFatalErrorHandlerType = logAndExitProcess;
+      let onFatalError: OnFatalErrorHandler = logAndExitProcess;
       const client = getCurrentHub().getClient<NodeClient>();
 
       if (this._options.onFatalError) {
         // eslint-disable-next-line @typescript-eslint/unbound-method
         onFatalError = this._options.onFatalError;
       } else if (client && client.getOptions().onFatalError) {
         // eslint-disable-next-line @typescript-eslint/unbound-method
-        onFatalError = client.getOptions().onFatalError as onFatalErrorHandlerType;
+        onFatalError = client.getOptions().onFatalError as OnFatalErrorHandler;
       }
 
       if (!caughtFirstError) {

packages/tracing/test/integrations/mongo.test.ts

@@ -10,15 +10,15 @@ class Collection {
   public namespace: string = 'mockedNamespace';
 
   // Method that can have a callback as last argument, or return a promise otherwise.
-  insertOne(_doc: unknown, _options: unknown, callback?: () => void) {
+  public insertOne(_doc: unknown, _options: unknown, callback?: () => void) {
     if (typeof callback === 'function') {
       callback();
       return;
     }
     return Promise.resolve();
   }
   // Method that has no callback as last argument, and doesnt return promise.
-  initializeOrderedBulkOp() {
+  public initializeOrderedBulkOp() {
     return {};
   }
 }