Refactor eslint, prettier

Author: CatsMiaow

.eslintrc

@@ -2,64 +2,66 @@
   "root": true,
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
+    "project": true,
     "tsconfigRootDir": ".",
-    "project": "tsconfig.json",
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "sonarjs", "jest"],
+  "plugins": ["@typescript-eslint", "sonarjs", "jest", "prettier"],
   "extends": [
     "eslint:recommended",
     "airbnb-base",
     "airbnb-typescript/base",
     "plugin:jest/recommended",
     "plugin:sonarjs/recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+    "plugin:@typescript-eslint/strict-type-checked",
+    "plugin:@typescript-eslint/stylistic-type-checked",
+    "plugin:prettier/recommended"
   ],
   "ignorePatterns": ["**/node_modules/**", "dist/**", "src/entity/**"],
-  "rules": { // These rules are for reference only.
+  "rules": {
+    // These rules are for reference only.
+    //#region eslint
     "class-methods-use-this": "off",
     // https://github.com/typescript-eslint/typescript-eslint/issues/1277
     "consistent-return": "off",
     "func-names": "off",
-    "max-len": ["error", { "code": 140, "ignoreTemplateLiterals": true }],
+    "max-len": ["error", { "code": 140, "ignoreTemplateLiterals": true, "ignoreUrls": true }],
     "newline-per-chained-call": "off",
     "no-await-in-loop": "off",
     "no-continue": "off",
     // https://github.com/airbnb/javascript/issues/1342
     "no-param-reassign": ["error", { "props": false }],
     // https://github.com/airbnb/javascript/issues/1271
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js#L334-L352
+    // https://github.com/airbnb/javascript/blob/fd77bbebb77362ddecfef7aba3bf6abf7bdd81f2/packages/eslint-config-airbnb-base/rules/style.js#L340-L358
     "no-restricted-syntax": ["error", "ForInStatement", "LabeledStatement", "WithStatement"],
     "no-underscore-dangle": ["error", { "allow": ["_id"] }],
     "no-void": ["error", { "allowAsStatement": true }],
     "object-curly-newline": "off",
     "spaced-comment": ["error", "always", { "line": { "markers": ["/", "#region", "#endregion"] } }],
+    //#endregion
 
-    // Change eslint rule to @typescript-eslint rule
-    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
-    "no-dupe-class-members": "off",
-    "no-duplicate-imports": "off",
-    "no-loop-func": "off",
-    "no-return-await": "off",
-    "no-unused-expressions": "off",
-    "object-curly-spacing": "off",
-
-    "import/extensions": ["error", "never"],
+    //#region import
+    // https://github.com/tportio/tportio.github.io/issues/13
+    "import/extensions": "off",
     // https://github.com/benmosher/eslint-plugin-import/issues/1753
     "import/named": "off",
     "import/no-default-export": "error",
-    "import/order": ["error", { "groups": [["builtin", "external", "internal"]], "newlines-between": "always", "alphabetize": { "order": "asc", "caseInsensitive": true } }],
+    "import/order": [
+      "error",
+      {
+        "groups": [["builtin", "external", "internal"]],
+        "newlines-between": "always",
+        "alphabetize": { "order": "asc", "caseInsensitive": true }
+      }
+    ],
     "import/prefer-default-export": "off",
+    //#endregion
 
-    "@typescript-eslint/consistent-indexed-object-style": "error",
+    //#region @typescript-eslint
     "@typescript-eslint/consistent-type-assertions": ["error", { "assertionStyle": "angle-bracket" }],
-    "@typescript-eslint/explicit-function-return-type": "error",
-    "@typescript-eslint/explicit-member-accessibility": ["error", { "overrides": { "constructors": "no-public" } }],
     "@typescript-eslint/lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
-    "@typescript-eslint/member-delimiter-style": "error",
-    "@typescript-eslint/member-ordering": "error",
-    "@typescript-eslint/naming-convention": ["error",
+    "@typescript-eslint/naming-convention": [
+      "error",
       { "selector": "default", "format": ["strictCamelCase"] },
       { "selector": "variable", "format": ["strictCamelCase", "UPPER_CASE", "StrictPascalCase"] },
       // https://github.com/microsoft/TypeScript/issues/9458
@@ -69,30 +71,13 @@
       { "selector": "typeLike", "format": ["StrictPascalCase"] },
       { "selector": "enumMember", "format": ["UPPER_CASE"] }
     ],
-    "@typescript-eslint/no-dupe-class-members": "error",
-    "@typescript-eslint/no-duplicate-imports": "error",
-    "@typescript-eslint/no-floating-promises": ["error", { "ignoreIIFE": true, "ignoreVoid": true }],
-    "@typescript-eslint/no-inferrable-types": ["error", { "ignoreParameters": true, "ignoreProperties": true }],
-    "@typescript-eslint/no-loop-func": "error",
-    "@typescript-eslint/no-misused-promises": ["error", { "checksVoidReturn": false }],
-    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
-    "@typescript-eslint/no-unnecessary-condition": "error",
-    "@typescript-eslint/no-unnecessary-qualifier": "error",
-    "@typescript-eslint/no-unnecessary-type-arguments": "error",
-    "@typescript-eslint/no-unnecessary-type-assertion": "error",
-    "@typescript-eslint/no-unnecessary-type-constraint": "error",
-    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-extraneous-class": "off",
     "@typescript-eslint/no-unsafe-member-access": "off",
-    "@typescript-eslint/no-unused-expressions": "error",
-    "@typescript-eslint/object-curly-spacing": ["error", "always"],
-    "@typescript-eslint/prefer-includes": "off",
-    "@typescript-eslint/prefer-optional-chain": "error",
-    "@typescript-eslint/promise-function-async": "error",
-    "@typescript-eslint/restrict-template-expressions": "off",
-    "@typescript-eslint/return-await": "error",
-    "@typescript-eslint/typedef": ["error", { "memberVariableDeclaration": true, "parameter": true, "propertyDeclaration": true }],
-    "@typescript-eslint/unbound-method": ["error", { "ignoreStatic": true }],
+    //#endregion
 
-    "sonarjs/no-duplicate-string": "off"
+    //#region sonarjs
+    "sonarjs/no-duplicate-string": "off",
+    "sonarjs/cognitive-complexity": ["error", 25]
+    //#endregion
   }
 }

bin/entity.ts

@@ -13,20 +13,22 @@ if (!process.env.DB_HOST) {
 }
 
 (async (): Promise<void> => {
-  const response = await prompts([{
-    type: 'text',
-    name: 'db',
-    message: 'Please enter a database name.',
-    validate: (value: string): boolean => !!value,
-  }, /* {
+  const response = await prompts([
+    {
+      type: 'text',
+      name: 'db',
+      message: 'Please enter a database name.',
+      validate: (value: string): boolean => !!value,
+    } /* {
     type: 'select',
     name: 'db',
     message: 'Please select a database name.',
     choices: [
       { title: 'db1' },
       { title: 'db2' },
     ],
-  } */]);
+  } */,
+  ]);
 
   const { db } = <{ db: string }>response;
   const MODEL_DIR = pathJoin(__dirname, '../src/entity', db);
@@ -53,7 +55,7 @@ if (!process.env.DB_HOST) {
   try {
     execSync(`typeorm-model-generator ${generatorConfig.join(' ')}`, { stdio: 'pipe' });
   } catch (error) {
-    console.error(`> Failed to load '${db}' database.\n${error}`);
+    console.error(`> Failed to load '${db}' database.`, error);
     return;
   }
 
@@ -68,4 +70,4 @@ if (!process.env.DB_HOST) {
   writeFileSync(pathJoin(MODEL_DIR, 'index.ts'), files.join('\n'));
 
   console.log(`> '${db}' database entities has been created: ${MODEL_DIR}`);
-})();
+})().catch(console.error);

bin/ormconfig.ts

@@ -7,7 +7,7 @@ import { configuration } from '../src/config';
 
 dotenv.config();
 const ormconfig = async (): Promise<DataSource> => {
-  const config = <{ db: DataSourceOptions }> await configuration();
+  const config = <{ db: DataSourceOptions }>await configuration();
 
   return new DataSource({
     ...config.db,

jest.config.ts

@@ -164,11 +164,7 @@ const jestConfig: Config = {
   ],
 
   // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  testPathIgnorePatterns: [
-    '/node_modules/',
-    '/dist/',
-    '/e2e/',
-  ],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/', '/e2e/'],
 
   // The regexp pattern or array of patterns that Jest uses to detect test files
   // testRegex: [],
@@ -183,10 +179,13 @@ const jestConfig: Config = {
 
   // A map from regular expressions to paths to transformers
   transform: {
-    '^.+\\.tsx?$': ['ts-jest', {
-      tsconfig: 'tsconfig.json',
-      isolatedModules: true,
-    }],
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.json',
+        isolatedModules: true,
+      },
+    ],
   },
 
   // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation

src/app.middleware.ts

@@ -5,24 +5,28 @@ import helmet from 'helmet';
 import passport from 'passport';
 
 export function middleware(app: INestApplication): INestApplication {
-  const isProduction = (process.env.NODE_ENV === 'production');
+  const isProduction = process.env.NODE_ENV === 'production';
 
   app.use(compression());
-  app.use(session({
-    // Requires 'store' setup for production
-    secret: 'tEsTeD',
-    resave: false,
-    saveUninitialized: true,
-    cookie: { secure: isProduction },
-  }));
+  app.use(
+    session({
+      // Requires 'store' setup for production
+      secret: 'tEsTeD',
+      resave: false,
+      saveUninitialized: true,
+      cookie: { secure: isProduction },
+    }),
+  );
   app.use(passport.initialize());
   app.use(passport.session());
   // https://github.com/graphql/graphql-playground/issues/1283#issuecomment-703631091
   // https://github.com/graphql/graphql-playground/issues/1283#issuecomment-1012913186
-  app.use(helmet({
-    contentSecurityPolicy: isProduction ? undefined : false,
-    crossOriginEmbedderPolicy: isProduction ? undefined : false,
-  }));
+  app.use(
+    helmet({
+      contentSecurityPolicy: isProduction ? undefined : false,
+      crossOriginEmbedderPolicy: isProduction ? undefined : false,
+    }),
+  );
   // app.enableCors();
 
   return app;

src/app.module.ts

@@ -48,13 +48,16 @@ import { SampleModule } from './sample';
     DebugSampleModule,
     // Module Router
     // https://docs.nestjs.com/recipes/router-module
-    RouterModule.register([{
-      path: 'test',
-      module: SampleModule,
-    }, {
-      path: 'test',
-      module: DebugSampleModule,
-    }]),
+    RouterModule.register([
+      {
+        path: 'test',
+        module: SampleModule,
+      },
+      {
+        path: 'test',
+        module: DebugSampleModule,
+      },
+    ]),
   ],
   providers: [
     // Global Guard, Authentication check on all routers

src/app.ts

@@ -12,7 +12,7 @@ import { AppModule } from './app.module';
  * https://github.com/nestjs/nest/issues/2249#issuecomment-494734673
  */
 async function bootstrap(): Promise<string> {
-  const isProduction = (process.env.NODE_ENV === 'production');
+  const isProduction = process.env.NODE_ENV === 'production';
   const app = await NestFactory.create<NestExpressApplication>(AppModule, {
     bufferLogs: true,
   });
@@ -33,7 +33,7 @@ async function bootstrap(): Promise<string> {
   return app.getUrl();
 }
 
-(async (): Promise<void> => {
+void (async (): Promise<void> => {
   try {
     const url = await bootstrap();
     NestLogger.log(url, 'Bootstrap');

src/auth/auth.service.ts

@@ -29,8 +29,8 @@ export class AuthService {
       return false;
     }
 
-    const payload = <{ sub: string }> this.jwt.decode(refreshToken);
-    return (payload.sub === data.userId);
+    const payload = <{ sub: string }>this.jwt.decode(refreshToken);
+    return payload.sub === data.userId;
   }
 
   public jwtSign(data: Payload): JwtSign {
@@ -42,23 +42,27 @@ export class AuthService {
     };
   }
 
-  public getPayload(token: string): Payload | void {
+  public getPayload(token: string): Payload | null {
     try {
-      const payload = <JwtPayload | null> this.jwt.decode(token);
+      const payload = <JwtPayload | null>this.jwt.decode(token);
       if (!payload) {
-        return;
+        return null;
       }
 
       return { userId: payload.sub, username: payload.username, roles: payload.roles };
     } catch {
       // Unexpected token i in JSON at position XX
+      return null;
     }
   }
 
   private getRefreshToken(sub: string): string {
-    return this.jwt.sign({ sub }, {
-      secret: this.config.get('jwtRefreshSecret'),
-      expiresIn: '7d', // Set greater than the expiresIn of the access_token
-    });
+    return this.jwt.sign(
+      { sub },
+      {
+        secret: this.config.get('jwtRefreshSecret'),
+        expiresIn: '7d', // Set greater than the expiresIn of the access_token
+      },
+    );
   }
 }

src/auth/guards/authenticated.guard.ts

@@ -20,8 +20,8 @@ export class AuthenticatedGuard implements CanActivate {
 
   public getRequest(context: ExecutionContext): Request {
     if (context.getType<GqlContextType>() === 'graphql') {
-      const ctx = GqlExecutionContext.create(context).getContext();
-      return <Request>ctx.req;
+      const ctx = GqlExecutionContext.create(context).getContext<{ req: Request }>();
+      return ctx.req;
     }
 
     return context.switchToHttp().getRequest<Request>();

src/auth/guards/jwt-auth.guard.ts

@@ -8,8 +8,8 @@ export class JwtAuthGuard extends AuthGuard('jwt') {
   // @ts-expect-error: is not assignable to type '<T = any>(context: ExecutionContext) => T'
   public override getRequest(context: ExecutionContext): Request {
     if (context.getType<GqlContextType>() === 'graphql') {
-      const ctx = GqlExecutionContext.create(context).getContext();
-      return <Request>ctx.req;
+      const ctx = GqlExecutionContext.create(context).getContext<{ req: Request }>();
+      return ctx.req;
     }
 
     return context.switchToHttp().getRequest<Request>();

src/auth/guards/jwt-verify.guard.ts

@@ -8,8 +8,8 @@ export class JwtVerifyGuard extends AuthGuard('jwt-verify') {
   // @ts-expect-error: is not assignable to type '<T = any>(context: ExecutionContext) => T'
   public override getRequest(context: ExecutionContext): Request {
     if (context.getType<GqlContextType>() === 'graphql') {
-      const ctx = GqlExecutionContext.create(context).getContext();
-      return <Request>ctx.req;
+      const ctx = GqlExecutionContext.create(context).getContext<{ req: Request }>();
+      return ctx.req;
     }
 
     return context.switchToHttp().getRequest<Request>();

src/auth/guards/local-login.guard.ts

@@ -5,7 +5,7 @@ import type { Request } from 'express';
 @Injectable()
 export class LocalLoginGuard extends AuthGuard('local') implements CanActivate {
   public override async canActivate(context: ExecutionContext): Promise<boolean> {
-    const result = <boolean> await super.canActivate(context);
+    const result = <boolean>await super.canActivate(context);
     const request = context.switchToHttp().getRequest<Request>();
     await super.logIn(request);
 

src/auth/strategies/jwt-verify.strategy.ts

@@ -11,7 +11,7 @@ export class JwtVerifyStrategy extends PassportStrategy(Strategy, 'jwt-verify')
     super({
       jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
       ignoreExpiration: true, // Expiration of the access_token is not checked when processing the refresh_token.
-      secretOrKey: config.get('jwtSecret'),
+      secretOrKey: config.get<string>('jwtSecret'),
     });
   }