@1stg/eslint-config 11.1.0 → 12.0.1

package/base.js

@@ -1,206 +0,0 @@
-// @ts-check
-
-/** @import { TSESLint } from '@typescript-eslint/utils' */
-
-import eslint from '@eslint/js'
-import eslintCommentsConfigs from '@eslint-community/eslint-plugin-eslint-comments/configs'
-import { isPkgAvailable, tryRequirePkg } from '@pkgr/utils'
-import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
-import css from 'eslint-plugin-css'
-import importX from 'eslint-plugin-import-x'
-import { getGlobals } from 'eslint-plugin-mdx'
-import n from 'eslint-plugin-n'
-import promise from 'eslint-plugin-promise'
-import regexp from 'eslint-plugin-regexp'
-import simpleImportSort from 'eslint-plugin-simple-import-sort'
-import sonarjs from 'eslint-plugin-sonarjs'
-import unicornX from 'eslint-plugin-unicorn-x'
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-
-import {
-  isEslintNodeDepsEnabled,
-  isTsAvailable,
-  isWebpackAvailable,
-  magicNumbers,
-  webpackSpecVars,
-  prettierExtends,
-} from './_util.js'
-
-export const base = tseslint.config([
-  eslint.configs.recommended,
-  eslintCommentsConfigs.recommended,
-  css.configs['flat/recommended'],
-  importX.flatConfigs.recommended,
-  n.configs['flat/recommended'],
-  promise.configs['flat/recommended'],
-  regexp.configs['flat/recommended'],
-  /** @type {TSESLint.FlatConfig.SharedConfigs} */ (sonarjs.configs)
-    .recommended,
-  unicornX.configs.recommended,
-  prettierExtends,
-  isEslintNodeDepsEnabled && isPkgAvailable('eslint-plugin-node-dependencies')
-    ? [
-        /** @type {typeof import('eslint-plugin-node-dependencies')} */ (
-          tryRequirePkg('eslint-plugin-node-dependencies')
-        ).configs['flat/recommended'],
-      ]
-    : [],
-  {
-    name: '@1stg/node',
-    files: ['**/*.{cjs,cts}'],
-    languageOptions: {
-      globals: globals.node,
-    },
-  },
-  {
-    name: '@1stg/base',
-    plugins: {
-      'simple-import-sort': simpleImportSort,
-    },
-    settings: {
-      'import-x/external-module-folders': [
-        'node_modules',
-        'node_modules/@d-ts',
-        'node_modules/@types',
-      ],
-      'import-x/resolver-next': createTypeScriptImportResolver(),
-      n: {
-        convertPath: {
-          '**/bin.*ts': [String.raw`^(src/)?bin\.([cm]?)ts$`, 'lib/bin.$2js'],
-          '**/cli.*ts': [String.raw`^(src/)?cli\.([cm]?)ts$`, 'lib/cli.$2js'],
-        },
-      },
-    },
-    languageOptions: {
-      sourceType: 'module',
-      ecmaVersion: 'latest',
-      globals: {
-        ...globals.builtin,
-        ...(isWebpackAvailable && getGlobals(webpackSpecVars)),
-      },
-    },
-    rules: {
-      '@eslint-community/eslint-comments/disable-enable-pair': [
-        2,
-        {
-          allowWholeFile: true,
-        },
-      ],
-      '@eslint-community/eslint-comments/no-unused-disable': 2,
-      'arrow-body-style': 2,
-      camelcase: [
-        2,
-        {
-          properties: 'never',
-          ignoreDestructuring: true,
-          allow: isWebpackAvailable ? webpackSpecVars : undefined,
-        },
-      ],
-      curly: [2, 'all'],
-      'import-x/first': 2,
-      'import-x/newline-after-import': 2,
-      'import-x/no-duplicates': 2,
-      'import-x/order': [
-        2,
-        {
-          alphabetize: {
-            order: 'asc',
-          },
-          'newlines-between': 'always',
-        },
-      ],
-      'no-control-regex': 0, // replaced by sonarjs/no-control-regex
-      'no-else-return': [
-        2,
-        {
-          allowElseIf: false,
-        },
-      ],
-      'no-empty': [
-        2,
-        {
-          allowEmptyCatch: true,
-        },
-      ],
-      'no-empty-function': 2,
-      'no-labels': isTsAvailable ? 0 : 2, // sonar/no-labels
-      'no-magic-numbers': [
-        2,
-        {
-          enforceConst: true,
-          ignore: magicNumbers,
-          ignoreArrayIndexes: true,
-        },
-      ],
-      'no-negated-condition': 2,
-      'no-process-exit': 0, // suspended by unicorn-x/no-process-exit
-
-      // The following rules are duplicate with `eslint-plugin-import-x`
-      'n/no-extraneous-import': 0,
-      'n/no-extraneous-require': 0,
-      'n/no-missing-import': 0,
-      'n/no-missing-require': 0,
-
-      'n/no-unsupported-features/es-syntax': 0,
-      'n/no-unsupported-features/node-builtins': 0,
-      'n/no-unpublished-import': 0,
-      'n/no-unpublished-require': 0,
-      'prefer-const': [2, { destructuring: 'all' }],
-      'prefer-object-spread': 2,
-      'simple-import-sort/exports': 2,
-      'unicorn-x/catch-error-name': [
-        2,
-        {
-          name: 'error',
-          ignore: ['^e(rr)?$'],
-        },
-      ],
-      'unicorn-x/consistent-function-scoping': 0,
-      'unicorn-x/filename-case': [
-        2,
-        {
-          cases: {
-            kebabCase: true,
-            pascalCase: true,
-          },
-          // ignore UPPER_CASE markdown or yaml filenames
-          ignore: [/^[A-Z](([\dA-Z]+_)*[\dA-Z]+)?\.(mdx?|ya?ml)$/],
-        },
-      ],
-      'unicorn-x/no-array-reduce': 0,
-      'unicorn-x/no-null': 0,
-      'unicorn-x/no-unreadable-array-destructuring': 0, // conflict with `no-unused-vars`
-      'unicorn-x/prefer-module': 0,
-      'unicorn-x/prefer-object-from-entries': 0,
-      'unicorn-x/prevent-abbreviations': 0,
-      'unicorn-x/prefer-export-from': [2, { ignoreUsedVariables: true }],
-    },
-  },
-  {
-    ignores: [
-      '**/.dsh',
-      '**/.history',
-      '**/.type-coverage',
-      '**/.vercel',
-      '**/.yarn',
-      '**/.pnp.*',
-      '**/coverage',
-      '**/dist',
-      '**/lib',
-      '**/node_modules',
-      '**/CHANGELOG.md',
-      '**/yarn.lock',
-      '**/package-lock.json',
-      '**/pnpm-lock.yaml',
-      '**/auto-imports.d.ts',
-      '**/*.less',
-      '**/*.log',
-      '**/*.patch',
-      '**/*.sass',
-      '**/*.scss',
-      '!.github',
-      '!.*.{cjs,js,mjs,cts,ts,mts}',
-    ],
-  },
-])

package/index.d.ts

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

package/index.js

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

package/jest.js

@@ -1,17 +0,0 @@
-// @ts-check
-
-import jest_ from 'eslint-plugin-jest'
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-
-import { test } from './test.js'
-
-export const jest = tseslint.config({
-  name: '@1stg/jest',
-  files: ['**/*.{spec,test}.{js,jsx,ts,tsx}'],
-  extends: [jest_.configs['flat/recommended']],
-  languageOptions: {
-    globals: globals.jest,
-  },
-  rules: test.rules,
-})

package/js-base.js

@@ -1,47 +0,0 @@
-// @ts-check
-
-/** @import { TSESLint } from '@typescript-eslint/utils' */
-
-import { tryFile, tryPkg, tryRequirePkg } from '@pkgr/utils'
-
-/** @type {string | undefined} */
-let configFile
-
-export const isBabelAvailable =
-  tryPkg('@babel/eslint-parser') && tryPkg('@babel/eslint-plugin')
-
-/** @satisfies {TSESLint.FlatConfig.Config} */
-export const jsBase = {
-  name: '@1stg/js-base',
-  files: ['**/*.{cjs,mjs,js,jsx}'],
-  languageOptions: isBabelAvailable
-    ? {
-        parser: tryRequirePkg('@babel/eslint-parser', true),
-        // eslint-disable-next-line no-cond-assign, sonarjs/no-nested-assignment
-        parserOptions: (configFile =
-          tryFile('babel.config.js') ||
-          tryFile('.babelrc.js') ||
-          tryPkg('@1stg/babel-preset/config'))
-          ? { babelOptions: { configFile } }
-          : { requireConfigFile: false },
-      }
-    : {},
-  plugins: /** @type {TSESLint.FlatConfig.Plugins} */ (
-    isBabelAvailable
-      ? {
-          '@babel': /** @type {Omit<TSESLint.FlatConfig.Plugin, 'configs'>} */ (
-            tryRequirePkg('@babel/eslint-plugin', true)
-          ),
-        }
-      : {}
-  ),
-  rules: {
-    camelcase: [2, { properties: 'never', ignoreDestructuring: true }],
-    ...(isBabelAvailable && {
-      'new-cap': 0,
-      'no-unused-expressions': 0,
-      '@babel/new-cap': 2,
-      '@babel/no-unused-expressions': 2,
-    }),
-  },
-}

package/js.js

@@ -1,22 +0,0 @@
-// @ts-check
-
-import jsdoc from 'eslint-plugin-jsdoc'
-import tseslint from 'typescript-eslint'
-
-import { isTsAvailable } from './_util.js'
-import { jsBase } from './js-base.js'
-
-const jsdocConfig = jsdoc.configs['flat/recommended']
-
-export const js = tseslint.config({
-  ...jsBase,
-  name: '@1stg/js',
-  extends: [jsdocConfig],
-  rules: {
-    ...jsBase.rules,
-    'jsdoc/require-jsdoc': 0,
-    'jsdoc/require-param-description': 0,
-    'jsdoc/tag-lines': 0, // conflict with `prettier-plugin-jsdoc`
-  },
-  settings: isTsAvailable ? { jsdoc: { mode: 'typescript' } } : undefined,
-})

package/loose.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils'
-
-export const loose: TSESLint.FlatConfig.ConfigArray

package/loose.js

@@ -1,39 +0,0 @@
-// @ts-check
-
-import tseslint from 'typescript-eslint'
-
-import { recommended } from './recommended.js'
-
-export const loose = tseslint.config([
-  recommended,
-  {
-    rules: {
-      '@angular-eslint/template/no-negated-async': 0,
-      '@typescript-eslint/member-ordering': 0,
-      '@typescript-eslint/naming-convention': 0,
-      '@typescript-eslint/no-explicit-any': 0,
-      '@typescript-eslint/no-floating-promises': 0,
-      '@typescript-eslint/no-magic-numbers': 0,
-      '@typescript-eslint/no-type-alias': 0,
-      '@typescript-eslint/no-unnecessary-condition': 0,
-      '@typescript-eslint/no-unsafe-assignment': 0,
-      '@typescript-eslint/no-unsafe-member-access': 0,
-      '@typescript-eslint/no-unsafe-return': 0,
-      '@typescript-eslint/prefer-ts-expect-error': 0,
-      '@typescript-eslint/restrict-plus-operands': 0,
-      '@typescript-eslint/sort-type-union-intersection-members': 0,
-      '@typescript-eslint/unbound-method': 0,
-      'accessor-pairs': 0,
-      'no-magic-numbers': 0,
-      'no-negated-condition': 0, // not auto-fixable
-      'promise/always-return': 0,
-      'promise/catch-or-return': 0,
-      'unicorn-x/explicit-length-check': 0,
-      'unicorn-x/no-array-for-each': 0,
-      'unicorn-x/no-fn-reference-in-iterator': 0,
-      'unicorn-x/prefer-number-properties': 0,
-      'unicorn-x/prefer-prototype-methods': 0,
-      'unicorn-x/prefer-spread': 0,
-    },
-  },
-])

package/overrides.d.ts

@@ -1,25 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils'
-
-export const js: TSESLint.FlatConfig.ConfigArray
-export const ts: TSESLint.FlatConfig.ConfigArray
-export const dTs: TSESLint.FlatConfig.Config
-export const react: TSESLint.FlatConfig.ConfigArray
-export const vue: TSESLint.FlatConfig.ConfigArray
-export const angular: TSESLint.FlatConfig.ConfigArray
-export const md: TSESLint.FlatConfig.ConfigArray
-export const mdx: TSESLint.FlatConfig.ConfigArray
-export const test: TSESLint.FlatConfig.Config
-export const tests: TSESLint.FlatConfig.Config
-export const jest: TSESLint.FlatConfig.ConfigArray
-export const script: TSESLint.FlatConfig.Config
-export const scripts: TSESLint.FlatConfig.Config
-export const story: TSESLint.FlatConfig.Config
-export const stories: TSESLint.FlatConfig.Config
-export const config: TSESLint.FlatConfig.Config
-export const configs: TSESLint.FlatConfig.Config
-export const jsonc: TSESLint.FlatConfig.ConfigArray
-export const json5: TSESLint.FlatConfig.ConfigArray
-export const toml: TSESLint.FlatConfig.ConfigArray
-export const yaml: TSESLint.FlatConfig.ConfigArray
-export const yml: TSESLint.FlatConfig.ConfigArray
-export const overrides: TSESLint.FlatConfig.ConfigArray

package/overrides.js

@@ -1,252 +0,0 @@
-// @ts-check
-
-/** @import { TSESLint } from '@typescript-eslint/utils' */
-
-import { jsoncFiles, nonJsonRcFiles, preferPrettier } from '@1stg/config'
-import { isPkgAvailable } from '@pkgr/utils'
-import * as eslintMdx from 'eslint-mdx'
-import jsonc_ from 'eslint-plugin-jsonc'
-import * as markup_ from 'eslint-plugin-markup'
-import * as mdx_ from 'eslint-plugin-mdx'
-import toml_ from 'eslint-plugin-toml'
-import yml_ from 'eslint-plugin-yml'
-import tseslint from 'typescript-eslint'
-
-import {
-  isReactPluginAvailable,
-  isTsAvailable,
-  magicNumbers,
-  nonSourceRules,
-  prettierExtends,
-} from './_util.js'
-import { jsBase } from './js-base.js'
-import { js } from './js.js'
-import { test } from './test.js'
-import { resolveSettings, tsBase } from './ts-base.js'
-
-export const ts = tseslint.config(
-  tsBase,
-  {
-    name: '@1stg/code-block',
-    files: ['**/*.{md,mdx}/**/*.{cts,mts,ts,tsx}'],
-    languageOptions: {
-      parserOptions: {
-        project: null,
-      },
-    },
-  },
-  {
-    name: '@1stg/ts',
-    files: ['**/*.{cts,mts,ts,tsx}'],
-    ignores: [
-      '**/*.{md,mdx}/**/*.{cts,mts,ts,tsx}',
-      '*.d.{cts,mts,ts}',
-      '*.d.*.{cts,mts,ts}',
-    ],
-    extends: [tseslint.configs.recommendedTypeChecked],
-    rules: {
-      '@typescript-eslint/no-floating-promises': [2, { ignoreVoid: true }],
-      '@typescript-eslint/no-magic-numbers': [
-        2,
-        {
-          enforceConst: true,
-          ignore: magicNumbers,
-          ignoreArrayIndexes: true,
-          ignoreEnums: true,
-          ignoreNumericLiteralTypes: true,
-          ignoreReadonlyClassProperties: true,
-        },
-      ],
-      '@typescript-eslint/no-unnecessary-condition': 2,
-      '@typescript-eslint/no-unnecessary-qualifier': 2,
-      '@typescript-eslint/no-unnecessary-type-arguments': 2,
-      '@typescript-eslint/prefer-optional-chain': 2,
-      '@typescript-eslint/prefer-readonly': 2,
-      '@typescript-eslint/prefer-reduce-type-parameter': 2,
-      '@typescript-eslint/prefer-string-starts-ends-with': 2,
-      '@typescript-eslint/require-array-sort-compare': [
-        2,
-        { ignoreStringArrays: true },
-      ],
-      '@typescript-eslint/restrict-plus-operands': 2,
-      'no-constant-condition': 0,
-      'no-magic-numbers': 0,
-    },
-  },
-  {
-    files: ['**/*.cts'],
-    rules: {
-      '@typescript-eslint/no-require-imports': 0,
-    },
-  },
-)
-
-/** @satisfies {TSESLint.FlatConfig.Config} */
-export const dTs = {
-  name: '@1stg/d-ts',
-  files: ['**/*.d.{cts,mts,ts}', '**/*.d.*.{cts,mts,ts}'],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/no-extraneous-class': 0,
-    '@typescript-eslint/no-namespace': 0,
-    '@typescript-eslint/no-unused-vars': 0,
-    'import-x/no-duplicates': 0,
-    'import-x/order': 0,
-  },
-}
-
-export const markup = tseslint.config(
-  {
-    name: '@1stg/markup-html',
-    files: ['**/*.html'],
-    extends: [markup_.configs.flatRecommended],
-    rules: {
-      'prettier/prettier': [preferPrettier ? 0 : 2, { parser: 'html' }],
-    },
-  },
-  {
-    name: '@1stg/markup-pug',
-    files: ['**/*.pug'],
-    extends: [markup_.configs.flatRecommended, ...prettierExtends],
-  },
-)
-
-export const md = tseslint.config(
-  {
-    name: '@1stg/md',
-    files: ['**/*.md'],
-    extends: [mdx_.configs.flat],
-    rules: {
-      'prettier/prettier': preferPrettier ? 0 : 2,
-    },
-  },
-  mdx_.configs.flatCodeBlocks,
-)
-
-const react = isReactPluginAvailable ? await import('./react.js') : undefined
-
-export const mdx = tseslint.config(
-  {
-    name: '@1stg/mdx',
-    files: ['**/*.mdx'],
-    extends: [react?.reactJsx, mdx_.configs.flat].filter(Boolean),
-    languageOptions: {
-      ...jsBase.languageOptions,
-      parser: eslintMdx,
-    },
-    settings: react?.reactJsx
-      ? { ...react.reactJsx[0].settings, ...resolveSettings }
-      : resolveSettings,
-    rules: {
-      'prettier/prettier': preferPrettier ? 0 : 2,
-    },
-  },
-  mdx_.configs.flatCodeBlocks,
-)
-
-/** @satisfies {TSESLint.FlatConfig.Config} */
-export const script = {
-  name: '@1stg/script',
-  files: ['**/scripts/**/*'],
-  rules: nonSourceRules,
-}
-
-export const scripts = script
-
-/** @satisfies {TSESLint.FlatConfig.Config} */
-export const story = {
-  name: '@1stg/story',
-  files: ['**/.storybook/**/*', '**/stories/**/*'],
-  rules: nonSourceRules,
-}
-
-export const stories = story
-
-/** @satisfies {TSESLint.FlatConfig.Config} */
-export const config = {
-  name: '@1stg/config',
-  files: ['**/.*.js', '**/*.config.{js,ts}'],
-  rules: nonSourceRules,
-}
-
-export const configs = config
-
-export const json = tseslint.config({
-  name: '@1stg/json',
-  files: ['**/.*rc', '**/*.json'],
-  ignores: [...nonJsonRcFiles, ...jsoncFiles],
-  extends: [
-    jsonc_.configs['flat/recommended-with-json'],
-    jsonc_.configs['flat/prettier'],
-  ],
-})
-
-export const jsonc = tseslint.config({
-  name: '@1stg/jsonc',
-  files: jsoncFiles,
-  extends: [
-    jsonc_.configs['flat/recommended-with-jsonc'],
-    jsonc_.configs['flat/prettier'],
-  ],
-})
-
-export const json5 = tseslint.config({
-  name: '@1stg/json5',
-  files: ['**/*.json5'],
-  extends: [
-    jsonc_.configs['flat/recommended-with-json5'],
-    jsonc_.configs['flat/prettier'],
-  ],
-})
-
-export const toml = tseslint.config({
-  name: '@1stg/toml',
-  files: ['**/*.toml'],
-  extends: [toml_.configs['flat/recommended']],
-})
-
-export const yaml = tseslint.config({
-  files: ['**/*.yml', '**/*.yaml'],
-  extends: [yml_.configs['flat/recommended'], yml_.configs['flat/prettier']],
-})
-
-export const yml = yaml
-
-export const overrides = tseslint.config(
-  js,
-  isTsAvailable ? ts : [],
-  react?.react || [],
-  // The order matters, the later should to be preferred
-  markup,
-  isPkgAvailable('eslint-plugin-vue')
-    ? await import('./vue.js').then(({ vue }) => vue)
-    : [],
-  isPkgAvailable('angular-eslint')
-    ? await import('./angular.js').then(({ angular }) => angular)
-    : [],
-  md,
-  mdx,
-  isPkgAvailable('eslint-plugin-jest')
-    ? await import('./jest.js').then(({ jest }) => jest)
-    : [],
-  isPkgAvailable('@vitest/eslint-plugin')
-    ? await import('./vitest.js').then(({ vitest }) => vitest)
-    : [],
-  test,
-  scripts,
-  stories,
-  configs,
-  dTs,
-  json,
-  jsonc,
-  json5,
-  toml,
-  yaml,
-  // https://github.com/prettier/eslint-config-prettier#curly
-  {
-    name: '@1stg/prettier',
-    rules: {
-      curly: [2, 'all'],
-    },
-  },
-)

package/react.js

@@ -1,67 +0,0 @@
-// @ts-check
-
-import react_ from '@eslint-react/eslint-plugin'
-import { tryRequirePkg } from '@pkgr/utils'
-import tseslint from 'typescript-eslint'
-
-import { isTsAvailable, prettierExtends } from './_util.js'
-
-export const reactJsx = tseslint.config({
-  name: '@1stg/react-jsx',
-  extends: [react_.configs.recommended, prettierExtends],
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-})
-
-const reactHooks_ = tryRequirePkg('eslint-plugin-react-hooks')
-const reactRefresh = tryRequirePkg('eslint-plugin-react-refresh', true)
-
-export const react = tseslint.config(
-  {
-    name: '@1stg/react',
-    files: ['**/*.{js,jsx,tsx}'],
-    extends: [reactRefresh?.configs.recommended(), reactJsx].filter(Boolean),
-    rules: {
-      '@eslint-react/avoid-shorthand-boolean': 2,
-      // '@eslint-react/naming-convention/handler-prop': [
-      //   2,
-      //   {
-      //     eventHandlerPrefix: false,
-      //     eventHandlerPropPrefix: 'on',
-      //   },
-      // ],
-      'sonarjs/function-name': isTsAvailable
-        ? [2, { format: String.raw`^_?[a-zA-Z][a-zA-Z0-9]*\$?$` }]
-        : 0,
-    },
-  },
-  {
-    name: '@1stg/react-tsx',
-    files: ['**/*.tsx'],
-    rules: {
-      '@eslint-react/display-name': 0,
-    },
-  },
-  reactHooks_
-    ? {
-        name: '@1stg/react-hooks',
-        files: ['**/*.{js,jsx,ts,tsx}'],
-        plugins: { 'react-hooks': reactHooks_ },
-        rules: {
-          'react-hooks/rules-of-hooks': 2,
-          'react-hooks/exhaustive-deps': 2,
-        },
-      }
-    : [],
-  {
-    name: '@1stg/react-ts',
-    files: ['**/*.{ts,tsx}'],
-    rules: {
-      'no-restricted-imports': [2, 'prop-types'],
-      '@eslint-react/prop-types': 0,
-    },
-  },
-)

package/recommended.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils'
-
-export const recommended: TSESLint.FlatConfig.ConfigArray