DEV: Improve code style with turning on few ESlint rules (#5130)

* turn on prettier rules for API
* turn on general TS rules

Author: pawelangelow

.eslintrc.js

@@ -261,9 +261,6 @@ module.exports = {
       rules: {
         semi: 'off',
         '@typescript-eslint/semi': 'off',
-        '@typescript-eslint/no-unused-vars': 'off',
-        '@typescript-eslint/no-use-before-define': 'off',
-        '@typescript-eslint/no-unused-expressions': 'off',
         'sonarjs/no-identical-functions': 'off',
         'sonarjs/prefer-immediate-return': 'off',
         'sonarjs/no-duplicate-string': 'off',
@@ -274,14 +271,10 @@ module.exports = {
         'no-underscore-dangle': 'off',
         'import/no-duplicates': 'off',
         'no-console': 'off',
-        'prettier/prettier': 'off',
         'prefer-destructuring': 'off',
         'no-unneeded-ternary': 'off',
         'prefer-template': 'off',
         'prefer-const': 'off',
-        '@typescript-eslint/naming-convention': 'off',
-        '@typescript-eslint/lines-between-class-members': 'off',
-        '@typescript-eslint/no-shadow': 'off',
         // REDUNDANT: These are OFF by default in newer Airbnb config
         // 'prefer-arrow-callback': 'off',
         // 'no-restricted-syntax': 'off',
@@ -427,7 +420,9 @@ module.exports = {
     'node_modules',
     'release',
     'redisinsight/ui/src/packages/**/icons/*.js*',
+    'redisinsight/ui/src/packages/**',
     'redisinsight/api/report/**',
+    'redisinsight/api/static/**',
     'redisinsight/api/migration/**',
     // Config files that don't need linting
     '.eslintrc.js',

redisinsight/api/config/default.ts

@@ -114,11 +114,8 @@ export default {
     databaseManagement: process.env.RI_DATABASE_MANAGEMENT !== 'false',
     maxPayloadSize: process.env.RI_MAX_PAYLOAD_SIZE || '512MB',
     cors: {
-      origin: process.env.RI_CORS_ORIGIN
-        ? process.env.RI_CORS_ORIGIN
-        : '*',
-      credentials:
-        process.env.RI_CORS_CREDENTIALS === 'true',
+      origin: process.env.RI_CORS_ORIGIN ? process.env.RI_CORS_ORIGIN : '*',
+      credentials: process.env.RI_CORS_CREDENTIALS === 'true',
     },
   },
   statics: {

redisinsight/api/config/logger.ts

@@ -6,10 +6,7 @@ import {
 } from 'nest-winston';
 import { join } from 'path';
 import config from 'src/utils/config';
-import {
-  prepareLogsData,
-  prettyFileFormat,
-} from 'src/utils/logsFormatter';
+import { prepareLogsData, prettyFileFormat } from 'src/utils/logsFormatter';
 
 const PATH_CONFIG = config.get('dir_path');
 const LOGGER_CONFIG = config.get('logger');

redisinsight/api/src/common/decorators/client-metadata/client-metadata.decorator.ts

@@ -38,17 +38,24 @@ export const clientMetadataParamFactory = (
     uniqueId = req.params?.[options.uniqueIdParam];
   }
 
-  const clientMetadata = plainToInstance(ClientMetadata, {
-    sessionMetadata: sessionMetadataFromRequestExecutionContext(undefined, ctx),
-    databaseId,
-    uniqueId,
-    context: options?.context || ClientContext.Common,
-    db: options?.ignoreDbIndex
-      ? undefined
-      : req?.headers?.[API_HEADER_DATABASE_INDEX],
-  }, {
-    groups: ['security'],
-  });
+  const clientMetadata = plainToInstance(
+    ClientMetadata,
+    {
+      sessionMetadata: sessionMetadataFromRequestExecutionContext(
+        undefined,
+        ctx,
+      ),
+      databaseId,
+      uniqueId,
+      context: options?.context || ClientContext.Common,
+      db: options?.ignoreDbIndex
+        ? undefined
+        : req?.headers?.[API_HEADER_DATABASE_INDEX],
+    },
+    {
+      groups: ['security'],
+    },
+  );
 
   const errors = validator.validateSync(clientMetadata, {
     whitelist: false, // we need this to allow additional fields if needed for flexibility

redisinsight/api/src/common/decorators/session/session-metadata.decorator.ts

@@ -34,7 +34,9 @@ export const sessionMetadataFromRequest = (
     requestMetadata,
   };
 
-  const session = plainToInstance(SessionMetadata, requestSession, { groups: ['security'] });
+  const session = plainToInstance(SessionMetadata, requestSession, {
+    groups: ['security'],
+  });
 
   const errors = validator.validateSync(session, {
     whitelist: false, // we need this to allow additional fields if needed for flexibility

redisinsight/api/src/common/logger/app-logger.spec.ts

@@ -22,22 +22,30 @@ const logLevels = Object.keys(mockWinstonLogger);
 jest.spyOn(WinstonModule, 'createLogger').mockReturnValue(mockWinstonLogger);
 
 const getSessionMetadata = () =>
-  plainToInstance(SessionMetadata, {
-    userId: '123',
-    sessionId: 'test-session-id',
-    requestMetadata: {
-      any: 'data',
+  plainToInstance(
+    SessionMetadata,
+    {
+      userId: '123',
+      sessionId: 'test-session-id',
+      requestMetadata: {
+        any: 'data',
+      },
     },
-  }, { groups: ['security' ] });
+    { groups: ['security'] },
+  );
 
 const getClientMetadata = () =>
-  plainToInstance(ClientMetadata, {
-    sessionMetadata: getSessionMetadata(),
-    databaseId: 'db-123',
-    context: ClientContext.Browser,
-    uniqueId: 'unique-id',
-    db: 1,
-  }, { groups: ['security' ] });
+  plainToInstance(
+    ClientMetadata,
+    {
+      sessionMetadata: getSessionMetadata(),
+      databaseId: 'db-123',
+      context: ClientContext.Browser,
+      uniqueId: 'unique-id',
+      db: 1,
+    },
+    { groups: ['security'] },
+  );
 
 describe('AppLogger', () => {
   let logger: AppLogger;

redisinsight/api/src/common/logger/app-logger.ts

@@ -109,7 +109,9 @@ export class AppLogger implements LoggerService {
       context,
       error,
       ...instanceToPlain(userMetadata),
-      data: optionalParamsCopy?.length ? logDataToPlain(optionalParamsCopy) : undefined,
+      data: optionalParamsCopy?.length
+        ? logDataToPlain(optionalParamsCopy)
+        : undefined,
     };
   }
 

redisinsight/api/src/common/middlewares/body-parser.middleware.ts

@@ -22,7 +22,10 @@ export default (
     return res
       .status(HttpStatus.PAYLOAD_TOO_LARGE)
       .set('Access-Control-Allow-Origin', serverConfig.cors.origin)
-      .set('Access-Control-Allow-Credentials', `${serverConfig.cors.credentials}`)
+      .set(
+        'Access-Control-Allow-Credentials',
+        `${serverConfig.cors.credentials}`,
+      )
       .json(exception.getResponse());
   }
 

redisinsight/api/src/constants/error-messages.ts

@@ -44,7 +44,8 @@ export default {
     `Could not connect to ${url}, please check the CA or Client certificate.`,
   INCORRECT_CREDENTIALS: (url) =>
     `Could not connect to ${url}, please check the Username or Password.`,
-  DATABASE_DEFAULT_USER_DISABLED: 'Database does not have default user enabled.',
+  DATABASE_DEFAULT_USER_DISABLED:
+    'Database does not have default user enabled.',
   DATABASE_MANAGEMENT_IS_DISABLED:
     'Database connection management is disabled.',
   CA_CERT_EXIST: 'This ca certificate name is already in use.',
@@ -159,7 +160,8 @@ export default {
     'Encountered a timeout error while attempting to retrieve data',
   RDI_VALIDATION_ERROR: 'Validation error',
   INVALID_RDI_INSTANCE_ID: 'Invalid rdi instance id.',
-  UNSAFE_BIG_JSON_LENGTH: 'This JSON is too large. Try opening it with Redis Insight Desktop.',
+  UNSAFE_BIG_JSON_LENGTH:
+    'This JSON is too large. Try opening it with Redis Insight Desktop.',
 
   // database settings
   DATABASE_SETTINGS_NOT_FOUND: 'Could not find settings for this database',

redisinsight/api/src/init-helper.ts

@@ -46,25 +46,25 @@ export const migrateHomeFolder = async () => {
 };
 
 /**
- * Remove old folders
+ * Remove a folder
  */
-export const removeOldFolders = async () => {
+export const removeFolder = async (path: string) => {
   try {
-    // remove old folders
-    await PATH_CONFIG.oldFolders?.map(removeFolder);
+    if (await fs.pathExists(path)) {
+      await fs.rm(path, { recursive: true, force: true });
+    }
   } catch (e) {
     // continue initialization even without removing
   }
 };
 
 /**
- * Remove a folder
+ * Remove old folders
  */
-export const removeFolder = async (path: string) => {
+export const removeOldFolders = async () => {
   try {
-    if (await fs.pathExists(path)) {
-      await fs.rm(path, { recursive: true, force: true });
-    }
+    // remove old folders
+    await PATH_CONFIG.oldFolders?.map(removeFolder);
   } catch (e) {
     // continue initialization even without removing
   }