@ntnyq/eslint-config 1.4.0 → 2.0.0-beta.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-PRESENT ntnyq (https://github.com/ntnyq)
+Copyright (c) 2023-PRESENT ntnyq (https://github.com/ntnyq)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,11 @@
+# eslint-config
+
+Flat ESLint config for JavaScript, TypeScript, Vue 2, Vue 3, Prettier.
+
+## Credits
+
+- [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)
+
+## License
+
+[MIT](./LICENSE) License © 2023-PRESENT [ntnyq](https://github.com/ntnyq)

package/index.js

@@ -1,9 +1,9 @@
-/**
- * @file ESLint config
- */
-
-module.exports = {
-  extends: [
-    '@ntnyq/eslint-config-vue',
-  ],
-}
+export * from './lib/js.js'
+export * from './lib/ts.js'
+export * from './lib/yml.js'
+export * from './lib/vue.js'
+export * from './lib/astro.js'
+export * from './lib/jsonc.js'
+export * from './lib/prettier.js'
+export * from './lib/markdown.js'
+export * from './lib/eslint-comments.js'

package/lib/astro.js

@@ -0,0 +1,24 @@
+import astroPlugin, { configs } from 'eslint-plugin-astro'
+import astroParser from 'astro-eslint-parser'
+import { GLOB_EXCLUDE, GLOB_ASTRO } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const astro = [
+  {
+    files: [GLOB_ASTRO],
+    ignores: GLOB_EXCLUDE,
+    plugins: {
+      astro: astroPlugin,
+    },
+    languageOptions: {
+      parser: astroParser,
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+        extraFileExtensions: ['.astro'],
+      },
+    },
+    rules: {
+      ...configs.recommended,
+    },
+  },
+]

package/lib/eslint-comments.js

@@ -0,0 +1,14 @@
+import commentsPlugin from 'eslint-plugin-eslint-comments'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const eslintComments = [
+  {
+    plugins: {
+      'eslint-comments': commentsPlugin,
+    },
+    rules: {
+      ...commentsPlugin.configs.recommended.rules,
+      'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
+    },
+  },
+]

package/lib/js.js

@@ -0,0 +1,156 @@
+import globals from 'globals'
+import jsConfig from '@eslint/js'
+import importPlugin from 'eslint-plugin-import'
+import unicornPlugin from 'eslint-plugin-unicorn'
+import { GLOB_EXCLUDE } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const js = [
+  jsConfig.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.es2021,
+        ...globals.node,
+      },
+      sourceType: 'module',
+    },
+    rules: {},
+  },
+
+  {
+    files: ['**/scripts/*', '**/cli.*'],
+    ignores: GLOB_EXCLUDE,
+    rules: {
+      'no-console': 'off',
+    },
+  },
+
+  {
+    files: ['**/*.{test,spec}.js?(x)'],
+    rules: {
+      'no-unused-expressions': 'off',
+      'max-lines-per-function': 'off',
+    },
+  },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const jsx = [
+  {
+    files: ['**/*.jsx'],
+    ignores: GLOB_EXCLUDE,
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const imports = [
+  {
+    plugins: {
+      import: importPlugin,
+    },
+    settings: {
+      'import/resolver': {
+        node: { extensions: ['.js', '.mjs', '.ts', '.d.ts'] },
+      },
+    },
+    rules: {
+      'import/first': 'error',
+      'import/no-mutable-exports': 'error',
+      'import/no-duplicates': 'error',
+      'import/order': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            'sibling',
+            'index',
+            'object',
+            'type',
+          ],
+          pathGroups: [{ pattern: '@/**', group: 'internal' }],
+          pathGroupsExcludedImportTypes: ['type'],
+        },
+      ],
+    },
+  },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const unicorn = [
+  {
+    plugins: {
+      unicorn: unicornPlugin,
+    },
+    rules: {
+      'unicorn/no-unsafe-regex': 'off',
+
+      'unicorn/error-message': 'error',
+      'unicorn/escape-case': 'error',
+      'unicorn/no-new-buffer': 'error',
+      'unicorn/number-literal-case': 'error',
+      'unicorn/prefer-includes': 'error',
+      'unicorn/prefer-type-error': 'error',
+      'unicorn/throw-new-error': 'error',
+      'unicorn/no-unnecessary-await': 'error',
+      'unicorn/switch-case-braces': ['error', 'avoid'],
+      'unicorn/no-typeof-undefined': 'error',
+      'unicorn/prefer-set-size': 'error',
+      'unicorn/better-regex': 'error',
+      'unicorn/custom-error-definition': 'error',
+      'unicorn/explicit-length-check': 'error',
+      'unicorn/new-for-builtins': 'error',
+      'unicorn/no-console-spaces': 'error',
+      'unicorn/no-for-loop': 'error',
+      'unicorn/no-hex-escape': 'error',
+      'unicorn/no-lonely-if': 'error',
+      'unicorn/prefer-keyboard-event-key': 'error',
+      'unicorn/prefer-math-trunc': 'error',
+      'unicorn/prefer-negative-index': 'error',
+      'unicorn/prefer-node-protocol': 'error',
+      'unicorn/prefer-number-properties': 'error',
+      'unicorn/prefer-optional-catch-binding': 'error',
+      'unicorn/prefer-prototype-methods': 'error',
+      'unicorn/prefer-reflect-apply': 'error',
+
+      'unicorn/prefer-date-now': 'error',
+
+      // String
+      'unicorn/prefer-string-slice': 'error',
+      'unicorn/prefer-string-trim-start-end': 'error',
+      'unicorn/prefer-string-starts-ends-with': 'error',
+
+      // DOM
+      'unicorn/prefer-add-event-listener': 'error',
+      'unicorn/no-invalid-remove-event-listener': 'error',
+      'unicorn/prefer-query-selector': 'error',
+      'unicorn/prefer-modern-dom-apis': 'error',
+      'unicorn/prefer-dom-node-append': 'error',
+      'unicorn/prefer-dom-node-dataset': 'error',
+      'unicorn/prefer-dom-node-remove': 'error',
+      'unicorn/prefer-dom-node-text-content': 'error',
+
+      // Array
+      'unicorn/no-new-array': 'error',
+      'unicorn/no-instanceof-array': 'error',
+      'unicorn/no-array-push-push': 'error',
+      'unicorn/no-array-callback-reference': 'error',
+      'unicorn/no-array-method-this-argument': 'error',
+      'unicorn/prefer-array-find': 'error',
+      'unicorn/prefer-array-some': 'error',
+      'unicorn/prefer-array-flat-map': 'error',
+      'unicorn/prefer-array-index-of': 'error',
+    },
+  },
+]

package/lib/jsonc.js

@@ -0,0 +1,115 @@
+import jsoncPlugin, { configs } from 'eslint-plugin-jsonc'
+import jsoncParser from 'jsonc-eslint-parser'
+import { GLOB_EXCLUDE, GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const jsonc = [
+  {
+    files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC, '**/*rc'],
+    ignores: GLOB_EXCLUDE,
+    plugins: {
+      jsonc: jsoncPlugin,
+    },
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    rules: {
+      ...configs['recommended-with-jsonc'].rules,
+      'jsonc/array-bracket-spacing': ['error', 'never'],
+      'jsonc/comma-dangle': ['error', 'never'],
+      'jsonc/comma-style': ['error', 'last'],
+      'jsonc/indent': ['error', 2],
+      'jsonc/key-spacing': [
+        'error',
+        {
+          beforeColon: false,
+          afterColon: true,
+        },
+      ],
+      'jsonc/no-octal-escape': 'error',
+      'jsonc/object-curly-newline': [
+        'error',
+        {
+          multiline: true,
+          consistent: true,
+        },
+      ],
+      'jsonc/object-curly-spacing': ['error', 'always'],
+      'jsonc/object-property-newline': [
+        'error',
+        {
+          allowMultiplePropertiesPerLine: true,
+        },
+      ],
+    },
+  },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const pkgOrder = [
+  {
+    files: ['**/package.json'],
+    rules: {
+      'jsonc/sort-keys': [
+        'error',
+        {
+          pathPattern: '^$',
+          order: [
+            'name',
+            'type',
+            'version',
+            'private',
+            'packageManager',
+            'publisher',
+            'displayName',
+            'description',
+            'keywords',
+            'license',
+            'author',
+            'homepage',
+            'repository',
+            'funding',
+            'main',
+            'module',
+            'types',
+            'unpkg',
+            'jsdelivr',
+            'exports',
+            'files',
+            'bin',
+            'icon',
+            'sideEffects',
+            'scripts',
+            'peerDependencies',
+            'peerDependenciesMeta',
+            'dependencies',
+            'optionalDependencies',
+            'devDependencies',
+            'activationEvents',
+            'contributes',
+            'categories',
+            'engines',
+            'pnpm',
+            'husky',
+            'prettier',
+            'nano-staged',
+            'lint-staged',
+            'eslintConfig',
+          ],
+        },
+        {
+          pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+          order: { type: 'asc' },
+        },
+        {
+          pathPattern: '^exports.*$',
+          order: ['types', 'require', 'import'],
+        },
+        {
+          pathPattern: '^scripts$',
+          order: { type: 'asc' },
+        },
+      ],
+    },
+  },
+]

package/lib/markdown.js

@@ -0,0 +1,44 @@
+import markdownPlugin from 'eslint-plugin-markdown'
+import { GLOB_EXCLUDE, GLOB_MARKDOWN } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const markdown = [
+  {
+    files: [GLOB_MARKDOWN],
+    ignores: GLOB_EXCLUDE,
+    plugins: {
+      markdown: markdownPlugin,
+    },
+    processor: 'markdown/markdown',
+  },
+  {
+    files: ['**/*.md/*'],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          impliedStrict: true,
+        },
+      },
+    },
+    rules: {
+      ...markdownPlugin.configs.recommended.overrides[1].rules,
+      'no-undef': 'off',
+      'no-alert': 'off',
+      'no-console': 'off',
+      'no-unused-vars': 'off',
+      'no-unused-expressions': 'off',
+      'no-restricted-imports': 'off',
+
+      'import/no-unresolved': 'off',
+
+      '@typescript-eslint/comma-dangle': 'off',
+      '@typescript-eslint/no-redeclare': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-use-before-define': 'off',
+
+      'unused-imports/no-unused-imports': 'off',
+      'unused-imports/no-unused-vars': 'off',
+    },
+  },
+]

package/lib/presets.js

@@ -0,0 +1,24 @@
+import jsConfig from '@eslint/js'
+import { ts } from './ts.js'
+import { yml } from './yml.js'
+import { vue } from './vue.js'
+import { markdown } from './markdown.js'
+import { jsonc, pkgOrder } from './jsonc.js'
+import { imports, js, jsx, unicorn } from './js.js'
+import { eslintComments } from './eslint-comments.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const presetBasic = [
+  jsConfig.configs.recommended,
+  ...js,
+  ...jsx,
+  ...ts,
+  ...vue,
+  ...yml,
+  ...imports,
+  ...unicorn,
+  ...jsonc,
+  ...pkgOrder,
+  ...markdown,
+  ...eslintComments,
+]

package/lib/prettier.js

@@ -0,0 +1,19 @@
+import prettierPlugin from 'eslint-plugin-prettier'
+import prettierConfig from 'eslint-config-prettier'
+
+const prettierConflictRules = { ...prettierConfig.rules }
+delete prettierConflictRules['vue/html-self-closing']
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const prettier = [
+  {
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    rules: {
+      ...prettierConflictRules,
+      ...prettierPlugin.configs.recommended.rules,
+      'prettier/prettier': 'warn',
+    },
+  },
+]

package/lib/shared.js

@@ -0,0 +1,61 @@
+// @ts-check
+
+export const GLOB_SRC = '**/*.?([mt])[jt]s?(x)'
+
+export const GLOB_JS = '**/*.?([mt])js'
+export const GLOB_JSX = '**/*.?([mt])jsx'
+
+export const GLOB_TS = '**/*.?([mt])ts'
+export const GLOB_TSX = '**/*.?([mt])tsx'
+
+export const GLOB_STYLE = '**/*.{c,le,sc}ss'
+export const GLOB_CSS = '**/*.css'
+export const GLOB_LESS = '**/*.less'
+export const GLOB_SCSS = '**/*.scss'
+
+export const GLOB_JSON = '**/*.json'
+export const GLOB_JSON5 = '**/*.json5'
+export const GLOB_JSONC = '**/*.jsonc'
+
+export const GLOB_VUE = '**/*.vue'
+export const GLOB_ASTRO = '**/*.astro'
+
+export const GLOB_MARKDOWN = '**/*.md'
+export const GLOB_YAML = '**/*.y?(a)ml'
+export const GLOB_HTML = '**/*.htm?(l)'
+
+export const GLOB_ALL_SRC = /** @type {const} */ ([
+  GLOB_SRC,
+  GLOB_STYLE,
+  GLOB_JSON,
+  GLOB_JSON5,
+  GLOB_MARKDOWN,
+  GLOB_VUE,
+  GLOB_YAML,
+  GLOB_HTML,
+])
+
+export const GLOB_NODE_MODULES = /** @type {const} */ ('**/node_modules/**')
+export const GLOB_DIST = /** @type {const} */ ('**/dist/**')
+export const GLOB_LOCKFILE = /** @type {const} */ ([
+  '**/package-lock.json',
+  '**/yarn.lock',
+  '**/pnpm-lock.yaml',
+])
+export const GLOB_EXCLUDE = /** @type {const} */ ([
+  GLOB_NODE_MODULES,
+  GLOB_DIST,
+  ...GLOB_LOCKFILE,
+  '**/CHANGELOG*.md',
+  '**/*.min.*',
+  '**/LICENSE*',
+  '**/output',
+  '**/coverage',
+  '**/temp',
+  '**/fixtures',
+  '**/__snapshots__',
+  '**/auto-import.d.ts',
+  '**/components.d.ts',
+  '**/.npmrc',
+  '**/.yarnrc',
+])

package/lib/ts.js

@@ -0,0 +1,70 @@
+import tsParser from '@typescript-eslint/parser'
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+import { GLOB_EXCLUDE, GLOB_TS, GLOB_TSX } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const ts = [
+  {
+    files: [GLOB_TS, GLOB_TSX],
+    ignores: GLOB_EXCLUDE,
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+    },
+    rules: {
+      ...tsPlugin.configs['eslint-recommended'].overrides[0].rules,
+      ...tsPlugin.configs['recommended'].rules,
+
+      '@typescript-eslint/no-unused-vars': 'error',
+      '@typescript-eslint/no-redeclare': 'error',
+      '@typescript-eslint/consistent-type-imports': [
+        'error',
+        {
+          prefer: 'type-imports',
+          fixStyle: 'separate-type-imports',
+          disallowTypeAnnotations: false,
+        },
+      ],
+      '@typescript-eslint/prefer-as-const': 'warn',
+
+      '@typescript-eslint/ban-types': 'off',
+      '@typescript-eslint/camelcase': 'off',
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/ban-ts-ignore': 'off',
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/naming-convention': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/triple-slash-reference': 'off',
+      '@typescript-eslint/no-parameter-properties': 'off',
+      '@typescript-eslint/explicit-member-accessibility': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+    },
+  },
+
+  {
+    files: ['**/*.d.ts'],
+    ignores: GLOB_EXCLUDE,
+    rules: {
+      'import/no-duplicates': 'off',
+      'import/newline-after-import': 'off',
+    },
+  },
+
+  {
+    files: ['**/*.{spec,test}.ts?(x)'],
+    rules: {
+      'no-unused-expressions': 'off',
+      'max-lines-per-function': 'off',
+    },
+  },
+]

package/lib/vue.js

@@ -0,0 +1,23 @@
+import vuePlugin from 'eslint-plugin-vue'
+import vueParser from 'vue-eslint-parser'
+import { GLOB_EXCLUDE, GLOB_VUE } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const vue = [
+  {
+    files: [GLOB_VUE],
+    ignores: GLOB_EXCLUDE,
+    plugins: {
+      vue: vuePlugin,
+    },
+    languageOptions: {
+      parser: vueParser,
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+      },
+    },
+    rules: {
+      ...vuePlugin.configs['vue3-recommended'],
+    },
+  },
+]

package/lib/yml.js

@@ -0,0 +1,22 @@
+import ymlPlugin, { configs } from 'eslint-plugin-yml'
+import ymlParser from 'yaml-eslint-parser'
+import { GLOB_EXCLUDE, GLOB_YAML } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfig[]} */
+export const yml = [
+  {
+    files: [GLOB_YAML],
+    ignores: GLOB_EXCLUDE,
+    languageOptions: {
+      parser: ymlParser,
+    },
+    plugins: {
+      yml: ymlPlugin,
+    },
+    rules: {
+      ...configs.standard.rules,
+      ...configs.prettier.rules,
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+]

package/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@ntnyq/eslint-config",
-  "version": "1.4.0",
+  "type": "module",
+  "version": "2.0.0-beta.1",
+  "packageManager": "pnpm@7.28.0",
   "description": "",
   "keywords": [],
   "license": "MIT",
@@ -8,31 +10,61 @@
     "name": "ntnyq",
     "email": "ntnyq13@gmail.com"
   },
-  "main": "index.js",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./index.js",
+    "import": "./index.js"
+  },
   "files": [
-    "index.js"
+    "index.js",
+    "lib"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "eslint": "^8.30.0"
+  },
   "dependencies": {
+    "@eslint/js": "^8.35.0",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
     "@typescript-eslint/parser": "^5.54.0",
+    "astro-eslint-parser": "^0.11.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-astro": "^0.23.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsonc": "^2.6.0",
     "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-n": "^15.6.1",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-unicorn": "^45.0.2",
+    "eslint-plugin-vue": "^9.9.0",
     "eslint-plugin-yml": "^1.5.0",
+    "globals": "^13.20.0",
     "jsonc-eslint-parser": "^2.1.0",
-    "yaml-eslint-parser": "^1.1.0",
-    "@ntnyq/eslint-config-vue": "1.4.0"
-  },
-  "publishConfig": {
-    "access": "public"
+    "prettier": "^2.8.4",
+    "vue-eslint-parser": "^9.1.0",
+    "yaml-eslint-parser": "^1.1.0"
   },
   "devDependencies": {
+    "@ntnyq/prettier-config": "^1.3.1",
+    "@types/node": "^18.14.2",
+    "bumpp": "^9.0.0",
     "eslint": "^8.35.0",
-    "typescript": "^4.9.5"
+    "eslint-define-config": "^1.15.0",
+    "husky": "^8.0.3",
+    "nano-staged": "^0.8.0",
+    "typescript": "5.0.0-beta"
+  },
+  "engines": {
+    "node": ">=14.19.0"
+  },
+  "prettier": "@ntnyq/prettier-config",
+  "scripts": {
+    "lint": "eslint .",
+    "release": "bumpp && pnpm publish --tag next"
   }
 }