Enhance eslint config

Author: Shinigami92

.eslintrc.js

@@ -33,30 +33,52 @@ module.exports = defineConfig({
     quotes: ['error', 'single', { avoidEscape: true }],
     semi: ['error', 'always'],
 
-    '@typescript-eslint/ban-ts-comment': 'off',
-    '@typescript-eslint/explicit-function-return-type': [
+    '@typescript-eslint/array-type': [
       'error',
-      { allowExpressions: true },
+      { default: 'array-simple', readonly: 'generic' },
     ],
-    '@typescript-eslint/interface-name-prefix': 'off',
-    '@typescript-eslint/member-ordering': 'off',
-    '@typescript-eslint/consistent-type-imports': [
+    '@typescript-eslint/ban-ts-comment': 'error',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/naming-convention': [
       'error',
-      { prefer: 'type-imports' },
+      {
+        format: ['PascalCase'],
+        selector: ['class', 'interface', 'typeAlias', 'typeParameter'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+      },
     ],
-    '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-inferrable-types': 'off',
-    '@typescript-eslint/no-non-null-assertion': 'off',
-    '@typescript-eslint/no-parameter-properties': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'error',
     '@typescript-eslint/no-unsafe-assignment': 'off',
-    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'error',
+    '@typescript-eslint/padding-line-between-statements': [
+      'error',
+      { blankLine: 'always', prev: 'block-like', next: '*' },
+    ],
     '@typescript-eslint/prefer-nullish-coalescing': 'warn',
     '@typescript-eslint/prefer-optional-chain': 'warn',
-    '@typescript-eslint/prefer-readonly': ['warn'],
-    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/prefer-readonly': 'warn',
+    '@typescript-eslint/restrict-template-expressions': [
+      'error',
+      { allowNumber: true, allowBoolean: true },
+    ],
     '@typescript-eslint/typedef': [
       'warn',
       { memberVariableDeclaration: true, variableDeclaration: true },
     ],
   },
+  overrides: [
+    {
+      // Rule files are generated by `generate:rules` script
+      files: ['src/rules/**/*.d.ts'],
+      rules: {
+        '@typescript-eslint/array-type': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+      },
+    },
+  ],
 });

package.json

@@ -5,10 +5,10 @@
   "main": "src/index.js",
   "module": "src/index.mjs",
   "scripts": {
-    "clean": "rm -Rf dist pnpm-lock.yaml node_modules",
+    "clean": "rimraf .eslintcache dist pnpm-lock.yaml node_modules",
     "check": "tsc",
-    "format": "prettier --write .",
-    "lint": "eslint .",
+    "format": "prettier --cache --write .",
+    "lint": "eslint --cache --cache-strategy content .",
     "typecheck": "vitest typecheck",
     "test": "vitest",
     "coverage": "vitest run --coverage",
@@ -87,6 +87,7 @@
     "json-schema-to-typescript": "~12.0.0",
     "prettier": "2.8.7",
     "prettier-plugin-organize-imports": "~3.2.2",
+    "rimraf": "~5.0.0",
     "ts-dedent": "~2.2.0",
     "tsx": "~3.12.6",
     "typescript": "~5.0.4",

pnpm-lock.yaml

@@ -64,7 +64,7 @@ function generateRuleIndexFile(
  * Print a report after having generated rules files for a plugin.
  */
 function printGenerationReport(
-  rules: [string, Rule.RuleModule][],
+  rules: Array<[string, Rule.RuleModule]>,
   failedRules: string[],
 ): void {
   const msg: string = `  ✅ Generated ${
@@ -76,6 +76,7 @@ function printGenerationReport(
   if (failedRules.length) {
     logger.log(logger.colors.red(`  ❌ Failed ${failedRules.length} rules`));
   }
+
   logger.log('');
 }
 
@@ -118,6 +119,7 @@ async function generateRulesFiles(
 
   return { failedRules };
 }
+
 /**
  * If it doesn't exist, create the directory that will contain the plugin's rule files.
  */

scripts/generate-rule-files/index.ts

@@ -12,6 +12,7 @@ export class JsDocBuilder {
     if (line) {
       this.content.push(line);
     }
+
     return this;
   }
 

scripts/generate-rule-files/src/js-doc-builder.ts

@@ -84,6 +84,7 @@ export const PLUGIN_REGISTRY: Readonly<Record<string, Plugin>> = {
 } as const;
 
 export async function loadPlugin(plugin: Plugin): Promise<Plugin> {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const mod: any = await import(plugin.module);
   const rules: PluginRules =
     plugin.module === 'eslint'

scripts/generate-rule-files/src/plugins-map.ts

@@ -45,4 +45,4 @@ export type KnownExtensions = LiteralUnion<
  *
  * @see [Extends](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
  */
-export type Extends = KnownExtensions | Array<KnownExtensions>;
+export type Extends = KnownExtensions | KnownExtensions[];

src/config/extends/index.d.ts

@@ -93,4 +93,4 @@ export interface Override {
 /**
  * Overrides.
  */
-export type Overrides = Array<Override>;
+export type Overrides = Override[];

src/config/overrides.d.ts

@@ -61,6 +61,7 @@ export interface FlatESLintConfigItem {
    *
    * @see [Configuring shared settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-shared-settings)
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   settings?: Record<string, any>;
 }
 

src/flat-config/index.d.ts

@@ -28,7 +28,7 @@ export function defineFlatConfig(config: FlatESLintConfig): FlatESLintConfig;
  * @returns Flat ESLint config.
  */
 export function defineFlatConfig(
-  config: readonly FlatESLintConfig[],
+  config: ReadonlyArray<FlatESLintConfig>,
 ): FlatESLintConfig[];
 
 export * from './config';