@zetavg/eslint-config 0.0.7 → 0.0.8-pre.10

package/README.md

@@ -5,10 +5,11 @@ Shared ESLint configuration.
 ## Install
 
 ```bash
+# npm
+npm install --save-dev @zetavg/eslint-config eslint prettier
+# pnpm
 pnpm add --save-dev @zetavg/eslint-config eslint prettier
-```
-
-```bash
+# yarn
 yarn add --dev @zetavg/eslint-config eslint prettier
 ```
 

package/config-sets/{default.js → base.js}

@@ -3,15 +3,20 @@ import { defineConfig } from 'eslint/config';
 
 import * as configs from '../configs/index.js';
 
+/**
+ * Base ESLint configuration that should apply to all JavaScript and TypeScript
+ * files.
+ */
 export default defineConfig([
   {
     extends: [
       js.configs.recommended,
       configs.prettier,
-      configs.general,
+      configs.style,
       configs.noUnusedVars,
       configs.imports,
       configs.importsSort,
+      configs.consoleAndDebugger,
       configs.todoComments,
     ],
   },

package/config-sets/index.js

@@ -1 +1 @@
-export { default as default } from './default.js';
+export { default as base } from './base.js';

package/configs/commonjs.js

@@ -1,6 +1,9 @@
 import { defineConfig } from 'eslint/config';
 import globals from 'globals';
 
+/**
+ * CommonJS-specific ESLint configuration. Should only apply to CommonJS files.
+ */
 export default defineConfig([
   {
     languageOptions: {

package/configs/console-and-debugger.js

@@ -0,0 +1,17 @@
+import { defineConfig } from 'eslint/config';
+
+/**
+ * Warns on `console.log` and `debugger` statements to prevent them from
+ * slipping into production code.
+ *
+ * Use `console.info`, `console.warn`, or `console.error` for intentional logging;
+ * reserve `console.log` for temporary debugging only.
+ */
+export default defineConfig([
+  {
+    rules: {
+      'no-console': ['warn', { allow: ['info', 'warn', 'error'] }],
+      'no-debugger': 'warn',
+    },
+  },
+]);

package/configs/{general.js → default-globals.js}

@@ -3,11 +3,6 @@ import globals from 'globals';
 
 export default defineConfig([
   {
-    rules: {
-      curly: ['warn', 'multi-line', 'consistent'],
-      'no-console': ['warn', { allow: ['info', 'warn', 'error'] }],
-      'no-debugger': 'warn',
-    },
     languageOptions: {
       globals: {
         ...globals['shared-node-browser'],

package/configs/imports-sort.js

@@ -1,6 +1,11 @@
 import { defineConfig } from 'eslint/config';
 import simpleImportSort from 'eslint-plugin-simple-import-sort';
 
+/**
+ * Enforces a consistent import ordering convention using automatic sorting,
+ * eliminating the need to debate or manually maintain import order.
+ * Violations are reported as warnings and can be auto-fixed.
+ */
 export default defineConfig([
   {
     plugins: {
@@ -22,9 +27,7 @@ export default defineConfig([
             // Packages. `react` related packages come first.
             ['^react$', '^react/', '^react-dom', '^react', '^@?\\w'],
             // Internal packages.
-            [
-              '^(@|@zetavg|components|utils|config|vendored-lib)(/.*|$)',
-            ],
+            ['^(@|@zetavg|components|utils|config|vendored-lib)(/.*|$)'],
             // Side effect imports.
             ['^\\u0000'],
             // Parent imports. Put `..` last.

package/configs/imports.js

@@ -23,5 +23,13 @@ export default defineConfig([
       'import/enforce-node-protocol-usage': 'warn',
       'import/no-unresolved': 'off', // This sometimes cannot resolve paths correctly, providing false alerts.
     },
+    settings: {
+      'import/ignore': [
+        // `eslint-plugin-import` inspects imported packages to validate exports.
+        // React Native's entry file uses Flow-only syntax, so we skip import
+        // analysis for that package.
+        'node_modules/react-native/',
+      ],
+    },
   },
 ]);

package/configs/index.js

@@ -1,5 +1,6 @@
 export { default as commonjs } from './commonjs.js';
-export { default as general } from './general.js';
+export { default as consoleAndDebugger } from './console-and-debugger.js';
+export { default as defaultGlobals } from './default-globals.js';
 export { default as imports } from './imports.js';
 export { default as importsSort } from './imports-sort.js';
 export { default as json } from './json.js';
@@ -7,4 +8,7 @@ export { default as markdown } from './markdown.js';
 export { default as noUnusedVars } from './no-unused.js';
 export { default as prettier } from './prettier.js';
 export { default as react } from './react.js';
+export { default as style } from './style.js';
 export { default as todoComments } from './todo-comments.js';
+export { default as typescript } from './typescript.js';
+export { default as vitest } from './vitest.js';

package/configs/json.js

@@ -8,11 +8,15 @@ export default defineConfig([
     },
   },
   {
-    files: ['**/*.json'],
-    ignores: [
-      '**/tsconfig.json', // tsconfig files may contain comments, which ESLint can't parse
-    ],
-    language: 'json/json',
+    files: ['**/*.json', '**/*.jsonc'],
+    language: 'json/jsonc',
+    rules: {
+      'json/no-duplicate-keys': 'error',
+    },
+  },
+  {
+    files: ['**/*.json5'],
+    language: 'json/json5',
     rules: {
       'json/no-duplicate-keys': 'error',
     },

package/configs/react.js

@@ -1,16 +1,26 @@
 import { defineConfig } from 'eslint/config';
 import react from 'eslint-plugin-react';
 import reactHooks from 'eslint-plugin-react-hooks';
-import reactRefresh from 'eslint-plugin-react-refresh';
+import reactRefreshPlugin from 'eslint-plugin-react-refresh';
 import globals from 'globals';
 
 export default defineConfig([
   react.configs.flat.recommended,
-  reactHooks.configs['recommended-latest'],
-  reactRefresh.configs.recommended,
+  reactHooks.configs.flat['recommended-latest'] ||
+    reactHooks.configs['recommended-latest'],
+  reactRefreshPlugin.configs.recommended,
   {
     languageOptions: {
       globals: globals.browser,
     },
+    settings: {
+      react: {
+        // eslint-plugin-react uses the legacy `context.getFilename()` API for version auto-detection, which was removed in ESLint v10.
+        // To work around this, we can only specify the React version explicitly. We should update this when eslint-plugin-react releases a new version that supports the new API.
+        // See: https://github.com/vercel/next.js/issues/89764#issuecomment-3928272828
+        // version: 'detect',
+        version: '19',
+      },
+    },
   },
 ]);

package/configs/style.js

@@ -0,0 +1,12 @@
+import { defineConfig } from 'eslint/config';
+
+/**
+ * Enforces consistent code style and formatting rules to improve readability.
+ */
+export default defineConfig([
+  {
+    rules: {
+      curly: ['warn', 'multi-line', 'consistent'],
+    },
+  },
+]);

package/configs/typescript.js

@@ -0,0 +1,15 @@
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+/**
+ * Default ESLint configuration for TypeScript.
+ */
+export default defineConfig([
+  tseslint.configs.recommended,
+  {
+    rules: {
+      // Turned off in favor of the `no-unused/no-unused-vars` rule in `no-unused.js`.
+      '@typescript-eslint/no-unused-vars': 'off',
+    },
+  },
+]);

package/configs/vitest.js

@@ -0,0 +1,4 @@
+import vitest from '@vitest/eslint-plugin';
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig([vitest.configs.recommended]);

package/dist/types/config-sets/index.d.ts

@@ -1 +1 @@
-export { default } from "./default.js";
+export { default as base } from "./base.js";

package/dist/types/configs/default-globals.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@eslint/config-helpers").Config[];
+export default _default;

package/dist/types/configs/index.d.ts

@@ -1,5 +1,6 @@
 export { default as commonjs } from "./commonjs.js";
-export { default as general } from "./general.js";
+export { default as consoleAndDebugger } from "./console-and-debugger.js";
+export { default as defaultGlobals } from "./default-globals.js";
 export { default as imports } from "./imports.js";
 export { default as importsSort } from "./imports-sort.js";
 export { default as json } from "./json.js";
@@ -7,4 +8,7 @@ export { default as markdown } from "./markdown.js";
 export { default as noUnusedVars } from "./no-unused.js";
 export { default as prettier } from "./prettier.js";
 export { default as react } from "./react.js";
+export { default as style } from "./style.js";
 export { default as todoComments } from "./todo-comments.js";
+export { default as typescript } from "./typescript.js";
+export { default as vitest } from "./vitest.js";

package/dist/types/configs/style.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@eslint/config-helpers").Config[];
+export default _default;

package/dist/types/configs/typescript.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@eslint/config-helpers").Config[];
+export default _default;

package/dist/types/configs/vitest.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@eslint/config-helpers").Config[];
+export default _default;

package/dist/types/exports/globals.d.ts

@@ -0,0 +1,3 @@
+export default globals;
+export * from "globals";
+import globals from 'globals';

package/dist/types/exports/typescript-eslint.d.ts

@@ -0,0 +1,3 @@
+export default tsEslint;
+export * from "typescript-eslint";
+import tsEslint from 'typescript-eslint';

package/dist/types/exports/vitest.d.ts

@@ -0,0 +1,2 @@
+export default vitest;
+import vitest from '@vitest/eslint-plugin';

package/exports/globals.js

@@ -0,0 +1,4 @@
+import globals from 'globals';
+export default globals;
+
+export * from 'globals';

package/exports/typescript-eslint.js

@@ -0,0 +1,4 @@
+import tsEslint from 'typescript-eslint';
+export default tsEslint;
+
+export * from 'typescript-eslint';

package/exports/vitest.js

@@ -0,0 +1,2 @@
+import vitest from '@vitest/eslint-plugin';
+export default vitest;

package/package.json

@@ -2,7 +2,25 @@
   "name": "@zetavg/eslint-config",
   "type": "module",
   "main": "index.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "default": "./index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./globals": {
+      "default": "./exports/globals.js",
+      "types": "./dist/types/exports/globals.d.ts"
+    },
+    "./typescript-eslint": {
+      "default": "./exports/typescript-eslint.js",
+      "types": "./dist/types/exports/typescript-eslint.d.ts"
+    },
+    "./vitest": {
+      "default": "./exports/vitest.js",
+      "types": "./dist/types/exports/vitest.d.ts"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/zetavg/es-configs",
@@ -21,7 +39,7 @@
   "peerDependencies": {
     "eslint": "^9 || ^10",
     "prettier": "^3",
-    "typescript": ">=5.8"
+    "typescript": ">=5"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -46,11 +64,11 @@
     "typescript-eslint": "^8"
   },
   "devDependencies": {
-    "@zetavg/prettier-config": "^0.0.7",
-    "@zetavg/tsconfig": "^0.0.7",
+    "@zetavg/prettier-config": "^0.0.8-pre.10",
+    "@zetavg/tsconfig": "^0.0.8-pre.10",
     "eslint": "^9",
     "prettier": "^3",
     "typescript": "~5.8"
   },
-  "version": "0.0.7"
+  "version": "0.0.8-pre.10"
 }

package/presets/default.js

@@ -1,26 +1,29 @@
-import vitest from '@vitest/eslint-plugin';
 import { defineConfig } from 'eslint/config';
-import tseslint from 'typescript-eslint';
 
 import * as configSets from '../config-sets/index.js';
 import * as configs from '../configs/index.js';
 
 export default defineConfig([
   { ignores: ['dist', 'node_modules'] },
-  tseslint.configs.recommended,
-  vitest.configs.recommended,
+  configs.vitest,
   configs.json,
   configs.markdown,
+  configs.defaultGlobals,
   {
     name: 'Configs Applied to All JS/TS Files',
     files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
-    extends: [configSets.default],
+    extends: [configSets.base],
   },
   {
     name: 'Configs for React Files',
     files: ['**/*.[j,t]sx'],
     extends: [configs.react],
   },
+  {
+    name: 'Configs for TypeScript Files',
+    files: ['**/*.{ts,cts,mts,tsx}'],
+    extends: [configs.typescript],
+  },
   {
     name: 'Configs for CommonJS Files',
     files: ['**/*.cjs'],