@zetavg/eslint-config 0.0.1

package/README.md

@@ -0,0 +1,18 @@
+# ESLint Config
+
+Shared ESLint configurations.
+
+## Install
+
+```bash
+yarn add @zetavg/eslint-config --dev
+```
+
+Then, add the following to your `eslint.config.js` (or `eslint.config.mjs`):
+
+```js
+import { defineConfig } from 'eslint/config';
+import config from '@zetavg/eslint-config';
+
+export default defineConfig([config]);
+```

package/config-sets/default.js

@@ -0,0 +1,18 @@
+import js from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+
+import * as configs from '../configs/index.js';
+
+export default defineConfig([
+  {
+    extends: [
+      js.configs.recommended,
+      configs.prettier,
+      configs.general,
+      configs.noUnusedVars,
+      configs.imports,
+      configs.importsSort,
+      configs.todoComments,
+    ],
+  },
+]);

package/config-sets/index.js

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

package/configs/commonjs.js

@@ -0,0 +1,16 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig([
+  {
+    languageOptions: {
+      sourceType: 'commonjs',
+      globals: {
+        ...globals['commonjs'],
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+]);

package/configs/general.js

@@ -0,0 +1,18 @@
+import { defineConfig } from 'eslint/config';
+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'],
+        process: 'readonly',
+      },
+    },
+  },
+]);

package/configs/imports-sort.js

@@ -0,0 +1,42 @@
+import { defineConfig } from 'eslint/config';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+
+export default defineConfig([
+  {
+    plugins: {
+      'simple-import-sort': simpleImportSort,
+    },
+    rules: {
+      'simple-import-sort/imports': [
+        'warn',
+        {
+          groups: [
+            // Node.js builtins. You could also generate this regex if you use a `.js` config.
+            // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
+            // Note that if you use the `node:` prefix for Node.js builtins,
+            // you can avoid this complexity: You can simply use "^node:".
+            [
+              '^node:',
+              '^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)',
+            ],
+            // Packages. `react` related packages come first.
+            ['^react$', '^react/', '^react-dom', '^react', '^@?\\w'],
+            // Internal packages.
+            [
+              '^(@|@zetavg|components|utils|config|vendored-lib)(/.*|$)',
+            ],
+            // Side effect imports.
+            ['^\\u0000'],
+            // Parent imports. Put `..` last.
+            ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
+            // Other relative imports. Put same-folder imports and `.` last.
+            ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
+            // Style imports.
+            ['^.+\\.s?css$'],
+          ],
+        },
+      ],
+      'simple-import-sort/exports': 'warn',
+    },
+  },
+]);

package/configs/imports.js

@@ -0,0 +1,27 @@
+import { defineConfig } from 'eslint/config';
+import importPlugin from 'eslint-plugin-import';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+
+export default defineConfig([
+  {
+    plugins: {
+      import: {
+        ...importPlugin.flatConfigs.recommended.plugins.import,
+        rules: {
+          ...importPlugin.flatConfigs.recommended.plugins.import.rules,
+          /** Borrowing this rule from [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/6d15a02d48de7ecfc38d0683a8487b2f937d83a0/rules/prefer-node-protocol.js) since the [new import/enforce-node-protocol-usage rule](https://github.com/import-js/eslint-plugin-import/pull/3024) isn't published yet. */
+          'enforce-node-protocol-usage':
+            eslintPluginUnicorn.configs.all.plugins.unicorn.rules[
+              'prefer-node-protocol'
+            ],
+        },
+      },
+    },
+    rules: {
+      'unicorn/prefer-node-protocol': 'off', // With this config, we are using the `import/enforce-node-protocol-usage` rule instead.
+      ...importPlugin.flatConfigs.recommended.rules,
+      'import/enforce-node-protocol-usage': 'warn',
+      'import/no-unresolved': 'off', // This sometimes cannot resolve paths correctly, providing false alerts.
+    },
+  },
+]);

package/configs/index.js

@@ -0,0 +1,9 @@
+export { default as commonjs } from './commonjs.js';
+export { default as general } from './general.js';
+export { default as imports } from './imports.js';
+export { default as importsSort } from './imports-sort.js';
+export { default as json } from './json.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 todoComments } from './todo-comments.js';

package/configs/json.js

@@ -0,0 +1,20 @@
+import json from '@eslint/json';
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig([
+  {
+    plugins: {
+      json,
+    },
+  },
+  {
+    files: ['**/*.json'],
+    ignores: [
+      '**/tsconfig.json', // tsconfig files may contain comments, which ESLint can't parse
+    ],
+    language: 'json/json',
+    rules: {
+      'json/no-duplicate-keys': 'error',
+    },
+  },
+]);

package/configs/no-unused.js

@@ -0,0 +1,26 @@
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+export default defineConfig([
+  {
+    plugins: {
+      'no-unused': {
+        rules: {
+          'no-unused-vars': tseslint.plugin.rules['no-unused-vars'],
+        },
+      },
+    },
+    rules: {
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      'no-unused/no-unused-vars': [
+        'warn',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+        },
+      ],
+    },
+  },
+]);

package/configs/prettier.js

@@ -0,0 +1,16 @@
+import { defineConfig } from 'eslint/config';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
+export default defineConfig([
+  {
+    extends: [eslintPluginPrettierRecommended],
+    rules: {
+      'prettier/prettier': [
+        'warn',
+        {
+          singleQuote: true,
+        },
+      ],
+    },
+  },
+]);

package/configs/react.js

@@ -0,0 +1,16 @@
+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 globals from 'globals';
+
+export default defineConfig([
+  react.configs.flat.recommended,
+  reactHooks.configs['recommended-latest'],
+  reactRefresh.configs.recommended,
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
+]);

package/configs/todo-comments.js

@@ -0,0 +1,25 @@
+import { defineConfig } from 'eslint/config';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+
+export default defineConfig([
+  {
+    plugins: {
+      'todo-comments': {
+        rules: {
+          'expiring-todo-comments':
+            eslintPluginUnicorn.configs.all.plugins.unicorn.rules[
+              'expiring-todo-comments'
+            ],
+        },
+      },
+    },
+    rules: {
+      'no-warning-comments': 'off',
+      'unicorn/expiring-todo-comments': 'off',
+      'todo-comments/expiring-todo-comments': [
+        'warn',
+        { allowWarningComments: false },
+      ],
+    },
+  },
+]);

package/eslint.config.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from 'eslint/config';
+
+import config from './index.js';
+
+export default defineConfig([config]);

package/index.js

@@ -0,0 +1,15 @@
+import globals from 'globals';
+
+import * as configSets from './config-sets/index.js';
+import * as configs from './configs/index.js';
+import * as presets from './presets/index.js';
+
+const defaultExport = [...presets.default];
+defaultExport.globals = globals;
+defaultExport.configs = configs;
+defaultExport.configSets = configSets;
+defaultExport.presets = presets;
+
+export default defaultExport;
+
+export { configs, configSets, globals, presets };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@zetavg/eslint-config",
+  "type": "module",
+  "main": "index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "lint": "eslint .",
+    "build:types": "tsc",
+    "build": "yarn build:types",
+    "watch:types": "yarn build:types --watch --preserveWatchOutput",
+    "watch": "yarn watch:types",
+    "pack-package": "yarn pack",
+    "publish-packed-package": "npm publish package.tgz --access public",
+    "clean": "rm -rf package.tgz"
+  },
+  "peerDependencies": {
+    "eslint": "^9",
+    "prettier": "^3",
+    "typescript": "~5.8"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@eslint/js": "^9",
+    "@eslint/json": "^0.12",
+    "@eslint/markdown": "^6",
+    "@types/eslint": "^9",
+    "@vitest/eslint-plugin": "^1",
+    "eslint-config-prettier": ">= 7.0.0 <10.0.0 || >=10.1.0",
+    "eslint-plugin-import": "^2",
+    "eslint-plugin-prettier": "^5",
+    "eslint-plugin-react": "^7",
+    "eslint-plugin-react-hooks": "^5",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "eslint-plugin-simple-import-sort": "^12",
+    "eslint-plugin-unicorn": "^59",
+    "globals": "^16",
+    "typescript-eslint": "^8"
+  },
+  "devDependencies": {
+    "@zetavg/prettier-config": "workspace:^",
+    "@zetavg/tsconfig": "workspace:^",
+    "eslint": "^9",
+    "prettier": "^3",
+    "typescript": "~5.8"
+  },
+  "version": "0.0.1"
+}

package/presets/default.js

@@ -0,0 +1,30 @@
+import markdown from '@eslint/markdown';
+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.json,
+  markdown.configs.recommended,
+  {
+    name: 'Configs Applied to All JS/TS Files',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    extends: [configSets.default],
+  },
+  {
+    name: 'Configs for React Files',
+    files: ['**/*.[j,t]sx'],
+    extends: [configs.react],
+  },
+  {
+    name: 'Configs for CommonJS Files',
+    files: ['**/*.cjs'],
+    extends: [configs.commonjs],
+  },
+]);

package/presets/index.js

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

package/prettier.config.mjs

@@ -0,0 +1,10 @@
+import defaultConfig from '@zetavg/prettier-config';
+
+/**
+ * @type {import("prettier").Config}
+ */
+const config = {
+  ...defaultConfig,
+};
+
+export default config;

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@zetavg/tsconfig",
+  "include": ["**/*.js"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "outDir": "dist/types",
+    "emitDeclarationOnly": true
+  }
+}