@w5s/eslint-config 2.4.5 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/eslint-config",
-  "version": "2.4.5",
+  "version": "3.0.1",
   "description": "ESLint configuration presets",
   "keywords": [
     "eslint",
@@ -18,8 +18,20 @@
   },
   "license": "MIT",
   "author": "Julien Polo <julien.polo@gmail.com>",
-  "type": "commonjs",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./dist/*": "./dist/*"
+  },
   "files": [
     "dist/",
     "src/",
@@ -33,28 +45,25 @@
     "postpack": "npx clean-package restore"
   },
   "dependencies": {
-    "@rushstack/eslint-patch": "^1.1.0",
+    "@stylistic/eslint-plugin": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
-    "@w5s/dev": "^2.5.4",
-    "@w5s/prettier-config": "^2.2.11",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^10.0.0",
+    "@vitest/eslint-plugin": "^1.0.0",
+    "@w5s/dev": "^3.0.0",
+    "@w5s/prettier-config": "^3.0.0",
     "eslint-plugin-import": "^2.25.0",
-    "eslint-plugin-jest": "^29.0.0",
-    "eslint-plugin-jsdoc": "^54.0.0",
+    "eslint-plugin-jsdoc": "^61.0.0",
     "eslint-plugin-jsonc": "^2.4.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-prettier": "^5.0.0-alpha.0",
-    "eslint-plugin-promise": "^7.0.0",
     "eslint-plugin-unicorn": "^56.0.0",
     "eslint-plugin-yml": "^1.1.0",
-    "find-up": "^5.0.0",
-    "parse-gitignore": "^2.0.0"
+    "find-up": "^8.0.0",
+    "jsonc-eslint-parser": "^2.0.0",
+    "parse-gitignore": "^2.0.0",
+    "yaml-eslint-parser": "^1.0.0"
   },
   "peerDependencies": {
-    "eslint": "8.x",
-    "prettier": "2.x || 3.x",
+    "eslint": "9.x",
     "typescript": "4.x || 5.x"
   },
   "peerDependenciesMeta": {
@@ -72,5 +81,5 @@
     "access": "public"
   },
   "sideEffect": false,
-  "gitHead": "199e9b150a80e22d21a35f924e19923aacfe3de3"
+  "gitHead": "e6c0bc4fd44d9d18c42722216aa59549ce64cc05"
 }

package/src/config/createRules.ts

@@ -0,0 +1,5 @@
+export function createRules(prefix: string) {
+  return {
+    [`${prefix}no-unused-vars`]: ['error', { argsIgnorePattern: '^_' }],
+  };
+}

package/src/config/es.ts

@@ -0,0 +1,58 @@
+import globals from 'globals';
+import eslintConfig from '@eslint/js';
+import { Project } from '@w5s/dev';
+import { type PluginOptionsBase, type Config } from '../type.js';
+import type { RuleOptions } from '../typegen/jsonc.js';
+import { createRules } from './createRules.js';
+
+export async function es(
+  options: es.Options,
+) {
+  const { rules = {} } = options;
+
+  return [
+    {
+      name: 'w5s/es/setup',
+      languageOptions: {
+        ecmaVersion: Project.ecmaVersion(),
+        globals: {
+          ...globals.browser,
+          ...globals[`es${Project.ecmaVersion()}`],
+          ...globals.node,
+          __DEV__: 'readonly',
+          __PROD__: 'readonly',
+          __TEST__: 'readonly',
+          document: 'readonly',
+          navigator: 'readonly',
+          window: 'readonly',
+        },
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+          ecmaVersion: Project.ecmaVersion(),
+          sourceType: 'module',
+        },
+        sourceType: 'module',
+      },
+      linterOptions: {
+        reportUnusedDisableDirectives: true,
+      },
+    },
+    {
+      name: 'w5s/es/rules',
+      plugins: {},
+      rules: {
+        ...eslintConfig.configs.recommended.rules,
+        ...createRules(''),
+        ...rules,
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace es {
+  export type Rules = RuleOptions;
+
+  export interface Options extends PluginOptionsBase<Rules> {}
+}

package/src/config/ignores.ts

@@ -0,0 +1,84 @@
+import fs from 'node:fs';
+import nodePath from 'node:path';
+import process from 'node:process';
+import { findUp } from 'find-up';
+import parseGitignore from 'parse-gitignore';
+import type { Config } from '../type.js';
+
+const getGitignore = async (cwd: string, prefix = ''): Promise<Array<string>> => {
+  const gitIgnoreFile = await findUp(nodePath.join(prefix, '.gitignore'), { cwd });
+  if (gitIgnoreFile != null) {
+    const { patterns } = parseGitignore.parse(await fs.promises.readFile(gitIgnoreFile));
+    const returnValue = patterns.map((pattern) => nodePath.join(prefix, pattern));
+    return returnValue;
+  }
+  return [];
+};
+
+export async function ignores(options: ignores.Options = {}) {
+  const cwd = process.cwd();
+  const [ignoreRoot, ignoreAndroid, ignoreIOS] = await Promise.all([
+    getGitignore(cwd),
+    getGitignore(cwd, 'android'),
+    getGitignore(cwd, 'ios'),
+  ]);
+
+  return [
+    {
+      ignores: [
+        '**/node_modules',
+        '**/dist',
+        '**/package-lock.json',
+        '**/yarn.lock',
+        '**/pnpm-lock.yaml',
+        '**/bun.lockb',
+
+        '**/.docusaurus',
+        '**/output',
+        '**/coverage',
+        '**/temp',
+        '**/.temp',
+        '**/tmp',
+        '**/.tmp',
+        '**/.history',
+        '**/.vitepress/cache',
+        '**/.nuxt',
+        '**/.next',
+        '**/.svelte-kit',
+        '**/.vercel',
+        '**/.changeset',
+        '**/.idea',
+        '**/.cache',
+        '**/.output',
+        '**/.vite-inspect',
+        '**/.yarn',
+        '**/vendor',
+        '**/vendors',
+        '**/*.min.*',
+
+        '**/*.timestamp-*.mjs', // esbuild/vite temporary files
+
+        '.modules/',
+        '.go/',
+        '.pnpm-store/',
+        // '!.*',
+        // '.venv/',
+        // 'deprecated/',
+        // 'test-output/',
+        // 'venv/',
+        // '_generated_/',
+
+        ...ignoreRoot,
+        ...ignoreAndroid,
+        ...ignoreIOS,
+        ...(options.ignores ?? []),
+      ] as Array<string>,
+      name: 'w5s/ignore',
+    },
+  ] as const satisfies Array<Config>;
+}
+export namespace ignores {
+  export interface Options {
+    ignores?: string[];
+  }
+}

package/src/config/imports.ts

@@ -0,0 +1,32 @@
+import { PluginOptionsBase, StylisticConfig, type Config } from '../type.js';
+import type { RuleOptions } from '../typegen/import.js';
+// @ts-ignore
+import importPlugin from 'eslint-plugin-import';
+
+const importConfig = importPlugin.flatConfigs['recommended'];
+
+export async function imports(options: imports.Options = {}) {
+  const { rules = {}, stylistic = true } = options;
+  const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
+  return [
+    {
+      name: 'w5s/import/rules',
+      plugins: importConfig.plugins ?? {},
+      rules: {
+        ...(importConfig?.rules),
+        ...(stylisticEnabled
+          ? {
+              // Stylistic rules
+            }
+          : {}),
+        ...rules,
+      },
+    },
+  ] as [Config] satisfies Array<Config>;
+}
+
+export namespace imports {
+  export type Rules = RuleOptions;
+
+  export interface Options extends PluginOptionsBase<Rules> {}
+}

package/src/config/jsdoc.ts

@@ -0,0 +1,53 @@
+import { interopDefault } from '@w5s/dev';
+import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+import type { RuleOptions } from '../typegen/jsdoc.js';
+
+export async function jsdoc(options: jsdoc.Options = {}): Promise<readonly Config[]> {
+  const [jsdocPlugin] = await Promise.all([
+    interopDefault(import('eslint-plugin-jsdoc')),
+  ] as const);
+  const { rules = {}, stylistic = true } = options;
+  const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
+
+  return [
+    {
+      name: 'w5s/jsdoc/setup',
+      plugins: {
+        jsdoc: jsdocPlugin,
+      },
+    },
+    {
+      name: 'w5s/jsdoc/rules',
+      rules: {
+        ...(jsdocPlugin.configs['flat/recommended'].rules),
+        'jsdoc/no-undefined-types': 'off', // https://github.com/gajus/eslint-plugin-jsdoc/issues/839
+        'jsdoc/require-hyphen-before-param-description': ['warn', 'always'],
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param-description': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/tag-lines': ['warn', 'any', { startLines: 1 }],
+        'jsdoc/valid-types': 'off', // FIXME: reports lots of false positive
+        // 'strict': ['error', 'safe'],
+        ...(stylisticEnabled
+          ? {
+              // ...(jsdocPlugin.configs['flat/stylistic'].rules),
+              'jsdoc/check-alignment': 'warn',
+              'jsdoc/multiline-blocks': 'warn',
+            }
+          : {}),
+        ...rules,
+      },
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+        },
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace jsdoc {
+  export type Rules = RuleOptions;
+
+  export interface Options extends PluginOptionsBase<Rules> {}
+}

package/src/config/jsonc.ts

@@ -0,0 +1,237 @@
+/* cSpell:disable */
+import { interopDefault, Project } from '@w5s/dev';
+import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+import type { RuleOptions } from '../typegen/jsonc.js';
+
+const defaultFiles = [`**/${Project.extensionsToGlob(['.json', '.json5', '.jsonc'])}`];
+
+export async function jsonc(options: jsonc.Options = {}): Promise<readonly Config[]> {
+  const [jsoncPlugin, jsoncParser] = await Promise.all([
+    interopDefault(import('eslint-plugin-jsonc')),
+    interopDefault(import('jsonc-eslint-parser')),
+  ] as const);
+  const { files = defaultFiles, rules = {}, stylistic = true } = options;
+  const { enabled: stylisticEnabled, indent } = StylisticConfig.from(stylistic);
+
+  return [
+    {
+      name: 'w5s/jsonc/setup',
+      plugins: {
+        jsonc: jsoncPlugin,
+      },
+    },
+    {
+      files,
+      languageOptions: {
+        parser: jsoncParser,
+      },
+      name: 'w5s/jsonc/rules',
+      rules: {
+        ...(jsoncPlugin.configs['flat/recommended-with-json'][0]?.rules),
+        ...(stylisticEnabled
+          ? {
+              'jsonc/array-bracket-spacing': ['error', 'never'],
+              'jsonc/comma-dangle': ['error', 'never'],
+              'jsonc/comma-style': ['error', 'last'],
+              'jsonc/indent': ['error', indent],
+              'jsonc/key-spacing': ['error', { afterColon: true, beforeColon: false }],
+              'jsonc/object-curly-newline': ['error', { consistent: true, multiline: true }],
+              'jsonc/object-curly-spacing': ['error', 'always'],
+              'jsonc/object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }],
+              'jsonc/quote-props': 'error',
+              'jsonc/quotes': 'error',
+            }
+          : {}),
+        ...rules,
+      },
+    },
+    stylisticEnabled ? sortPackageJson() : {},
+    stylisticEnabled ? sortTsconfigJson() : {},
+  ] as [Config, Config, Config, Config] satisfies Array<Config>;
+}
+
+function sortTsconfigJson() {
+  return {
+    files: ['tsconfig*.json'],
+    rules: {
+      'jsonc/sort-keys': [
+        'error',
+        {
+          order: ['$schema', 'display', 'extends', 'compilerOptions', 'include', 'exclude', 'files', 'references'],
+          pathPattern: '^$',
+        },
+        {
+          order: { type: 'asc' },
+          pathPattern: '.*',
+        },
+      ],
+    },
+  };
+}
+
+function sortPackageJson() {
+  return {
+    files: ['package.json'],
+    rules: {
+      'jsonc/sort-keys': [
+        'error',
+        {
+          order: [
+            '$schema',
+            'name',
+            'displayName',
+            'version',
+            'private',
+            'description',
+            'categories',
+            'keywords',
+            'homepage',
+            'bugs',
+            'repository',
+            'funding',
+            'license',
+            'qna',
+            'author',
+            'maintainers', // Key order (per item): name, email, url
+            'contributors', // Key order (per item): name, email, url
+            'publisher',
+            'sideEffects',
+            'type',
+            'imports',
+            'exports',
+            'main',
+            'svelte',
+            'umd:main',
+            'jsdelivr',
+            'unpkg',
+            'module',
+            'source',
+            'jsnext:main',
+            'browser',
+            'react-native',
+            'types',
+            'typesVersions',
+            'typings',
+            'style',
+            'example',
+            'examplestyle',
+            'assets',
+            'bin',
+            'man',
+            'directories', // Key order: lib, bin, man, doc, example, test
+            'files', // Unique items
+            'workspaces',
+            'binary', // Key order: module_name, module_path, remote_path, package_name, host
+            'scripts', // Script sort
+            'betterScripts', // Script sort
+            'contributes',
+            'activationEvents', // Unique items
+            'husky', // Sorts the hooks field using git hook sort
+            'simple-git-hooks', // Key sort using git hook sort
+            'pre-commit',
+            'commitlint',
+            'lint-staged',
+            'config',
+            'nodemonConfig',
+            'browserify',
+            'babel',
+            'browserslist',
+            'xo',
+            'prettier', // Prettier sort
+            'eslintConfig', // ESLint sort
+            'eslintIgnore',
+            'npmpackagejsonlint', // Key sort (also recognizes: npmPackageJsonLintConfig, npmpkgjsonlint)
+            'release',
+            'remarkConfig',
+            'stylelint',
+            'ava',
+            'jest',
+            'mocha',
+            'nyc',
+            'tap',
+            'resolutions',
+            'dependencies',
+            'devDependencies',
+            'dependenciesMeta', // Key sort (deep)
+            'peerDependencies',
+            'peerDependenciesMeta', // Key sort (deep)
+            'optionalDependencies',
+            'bundledDependencies',
+            'bundleDependencies',
+            'extensionPack',
+            'extensionDependencies',
+            'flat',
+            'packageManager',
+            'engines',
+            'engineStrict',
+            'volta', // Key order: node, npm, yarn
+            'languageName',
+            'os',
+            'cpu',
+            'preferGlobal',
+            'publishConfig',
+            'icon',
+            'badges', // Key order (per item): description, url, href
+            'galleryBanner',
+            'preview',
+            'markdown',
+          ],
+          pathPattern: '^$',
+        },
+        {
+          order: ['url', 'email'],
+          pathPattern: `^bugs$`,
+        },
+        ...['repository', 'funding', 'license', 'author'].map((key) => ({
+          order: ['type', 'name', 'email', 'url'],
+          pathPattern: `^${key}$`,
+        })),
+        ...['scripts', 'betterScripts'].map((key) => ({
+          order: { type: 'asc' },
+          pathPattern: `^${key}$`,
+        })),
+        ...[
+          'bin',
+          'contributes',
+          'commitlint',
+          'config',
+          'nodemonConfig',
+          'browserify',
+          'babel',
+          'xo',
+          'release',
+          'remarkConfig',
+          'ava',
+          'jest',
+          'mocha',
+          'nyc',
+          'tap',
+          'resolutions',
+          'engines',
+          'engineStrict',
+          'preferGlobal',
+          'publishConfig',
+          'galleryBanner',
+        ].map((key) => ({
+          order: { type: 'asc' },
+          pathPattern: `^${key}$`,
+        })),
+        {
+          order: { type: 'asc' },
+          pathPattern: '^(?:dev|peer|optional|bundled|extension)?[Dd]ependencies$',
+        },
+        {
+          order: ['types', 'require', 'import'],
+          pathPattern: '^exports.*$',
+        },
+      ],
+
+    },
+  };
+}
+
+export namespace jsonc {
+  export type Rules = RuleOptions;
+
+  export interface Options extends PluginOptionsBase<Rules> {}
+}

package/src/config/node.ts

@@ -0,0 +1,42 @@
+import { interopDefault } from '@w5s/dev';
+import { type Config, type PluginOptionsBase } from '../type.js';
+import type { RuleOptions } from '../typegen/node.js';
+
+export async function node(options: node.Options = {}) {
+  const [nodePlugin] = await Promise.all([
+    interopDefault(import('eslint-plugin-n')),
+  ] as const);
+  const { rules = {} } = options;
+  return [
+    {
+      name: 'w5s/node/setup',
+      plugins: {
+        node: nodePlugin,
+      },
+    },
+    {
+      name: 'w5s/node/rules',
+      rules: {
+        // 'node/handle-callback-err': ['error', '^(err|error|_error)$'],
+        'node/no-deprecated-api': 'error',
+        'node/no-exports-assign': 'error',
+        'node/no-new-require': 'error',
+        'node/no-path-concat': 'error',
+        'node/no-sync': 'error',
+        'node/prefer-global/buffer': ['error', 'never'],
+        'node/prefer-global/console': ['error', 'always'],
+        // 'node/prefer-global/process': ['error', 'never'],
+        'node/prefer-global/url': ['error', 'always'],
+        'node/prefer-global/url-search-params': ['error', 'always'],
+        'node/process-exit-as-throw': 'error',
+        ...rules,
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace node {
+  export type Rules = RuleOptions;
+
+  export interface Options extends Omit<PluginOptionsBase<Rules>, 'files' | 'stylistic'> {}
+}

package/src/config/stylistic.ts

@@ -0,0 +1,50 @@
+import { interopDefault } from '@w5s/dev';
+import { StylisticConfig, type PluginOptionsBase, type Config, type StylisticParameters } from '../type.js';
+import type { RuleOptions } from '../typegen/style.js';
+
+export async function stylistic(options: stylistic.Options = {}) {
+  const [stylisticPlugin] = await Promise.all([
+    interopDefault(import('@stylistic/eslint-plugin')),
+  ] as const);
+  const { rules = {} } = options;
+  const { enabled: stylisticEnabled, indent, jsx, quotes, semi } = StylisticConfig.from(options);
+  const config = stylisticEnabled
+    ? stylisticPlugin.configs.customize({
+        indent,
+        jsx,
+        pluginName: 'style',
+        quotes,
+        semi,
+      })
+    : { rules: {} };
+
+  return [
+    {
+      name: 'w5s/style/setup',
+      plugins: {
+        style: stylisticPlugin,
+      },
+    },
+    {
+      name: 'w5s/style/rules',
+      rules: {
+        ...(stylisticEnabled
+          ? {
+              ...config.rules,
+              'style/arrow-parens': ['error', 'always'],
+              'style/brace-style': ['error', '1tbs'],
+              'style/operator-linebreak': ['error', 'after', { overrides: { ':': 'before', '?': 'before', '|>': 'before' } }],
+              'style/quotes': ['error', quotes ?? StylisticConfig.default.quotes, { avoidEscape: true, allowTemplateLiterals: true }],
+            }
+          : {}),
+        ...rules,
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace stylistic {
+  export type Rules = RuleOptions;
+
+  export interface Options extends Pick<PluginOptionsBase<Rules>, 'rules'>, StylisticParameters {}
+}

package/src/config/test.ts

@@ -0,0 +1,44 @@
+import { interopDefault, Project } from '@w5s/dev';
+import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+import type { RuleOptions } from '../typegen/test.js';
+
+const sourceGlob = Project.extensionsToGlob(Project.sourceExtensions());
+const defaultFiles = [
+  `**/__mocks__/**/${sourceGlob}`,
+  `**/__tests__/**/${sourceGlob}`,
+  `**/?(*.)+(spec|test)${sourceGlob.slice(1)}`,
+];
+
+export async function test(options: test.Options = {}) {
+  const [vitestPlugin] = await Promise.all([
+    interopDefault(import('@vitest/eslint-plugin')),
+  ] as const);
+  const { files = defaultFiles, rules = {}, stylistic = true } = options;
+  const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
+
+  return [
+    {
+      name: 'w5s/test/setup',
+      plugins: {
+        test: vitestPlugin,
+      },
+    },
+    {
+      files,
+      name: 'w5s/test/rules',
+      rules: {
+        ...vitestPlugin.configs.recommended.rules,
+        ...(stylisticEnabled
+          ? {}
+          : {}),
+        ...rules,
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace test {
+  export type Rules = RuleOptions;
+
+  export interface Options extends PluginOptionsBase<Rules> {}
+}