@ntnyq/eslint-config 2.0.0-beta.3 → 2.0.0-beta.5

package/README.md

@@ -5,6 +5,25 @@
 [![CI](https://github.com/ntnyq/eslint-config/workflows/CI/badge.svg)](https://github.com/ntnyq/eslint-config/actions)
 [![NPM VERSION](https://img.shields.io/npm/v/@ntnyq/eslint-config/next.svg)](https://www.npmjs.com/package/@ntnyq/eslint-config/v/next)
 
+## Install
+
+```bash
+pnpm add @ntnyq/eslint-config@next eslint-define-config -D
+```
+
+## Usage
+
+Config in `eslint.config.{js,cjs,mjs}`:
+
+```js
+import { defineFlatConfig } from 'eslint-define-config'
+import { all } from '@ntnyq/eslint-config'
+
+export default defineFlatConfig(all)
+```
+
+Make sure to config `"eslint.experimental.useFlatConfig": true` in `.vscode/settings.json`
+
 ## Credits
 
 - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)

package/index.d.ts

@@ -0,0 +1,26 @@
+import type { FlatESLintConfig } from 'eslint-define-config'
+
+// Config
+export type ts = FlatESLintConfig[]
+export type yml = FlatESLintConfig[]
+export type vue = FlatESLintConfig[]
+export type astro = FlatESLintConfig[]
+export type prettier = FlatESLintConfig[]
+export type markdown = FlatESLintConfig[]
+export type jsonc = FlatESLintConfig[]
+export type pkgOrder = FlatESLintConfig[]
+export type imports = FlatESLintConfig[]
+export type js = FlatESLintConfig[]
+export type jsx = FlatESLintConfig[]
+export type unicorn = FlatESLintConfig[]
+export type eslintComments = FlatESLintConfig[]
+
+// Presets
+export type basic = FlatESLintConfig[]
+
+export type all = FlatESLintConfig[]
+
+export type ntnyq = (
+  config?: FlatESLintConfig[],
+  options?: { vue?: boolean; prettier?: boolean; typescript?: boolean },
+) => FlatESLintConfig[]

package/lib/js.js

@@ -15,7 +15,345 @@ export const js = [
       },
       sourceType: 'module',
     },
-    rules: {},
+
+    rules: {
+      // standard v 17.0.0
+      'accessor-pairs': ['error', { setWithoutGet: true, enforceForClassMembers: true }],
+      'array-bracket-spacing': ['error', 'never'],
+      'arrow-spacing': ['error', { before: true, after: true }],
+      'block-spacing': ['error', 'always'],
+      'brace-style': ['error', '1tbs', { allowSingleLine: true }],
+      camelcase: [
+        'error',
+        {
+          allow: ['^UNSAFE_'],
+          properties: 'never',
+          ignoreGlobals: true,
+        },
+      ],
+      'comma-spacing': ['error', { before: false, after: true }],
+      'comma-style': ['error', 'last'],
+      'computed-property-spacing': ['error', 'never', { enforceForClassMembers: true }],
+      'constructor-super': 'error',
+      curly: ['error', 'multi-line'],
+      'default-case-last': 'error',
+      'dot-location': ['error', 'property'],
+      'dot-notation': ['error', { allowKeywords: true }],
+      'eol-last': 'error',
+      'func-call-spacing': ['error', 'never'],
+      indent: [
+        'error',
+        2,
+        {
+          SwitchCase: 1,
+          VariableDeclarator: 1,
+          outerIIFEBody: 1,
+          MemberExpression: 1,
+          FunctionDeclaration: { parameters: 1, body: 1 },
+          FunctionExpression: { parameters: 1, body: 1 },
+          CallExpression: { arguments: 1 },
+          ArrayExpression: 1,
+          ObjectExpression: 1,
+          ImportDeclaration: 1,
+          flatTernaryExpressions: false,
+          ignoreComments: false,
+          ignoredNodes: [
+            'TemplateLiteral *',
+            'JSXElement',
+            'JSXElement > *',
+            'JSXAttribute',
+            'JSXIdentifier',
+            'JSXNamespacedName',
+            'JSXMemberExpression',
+            'JSXSpreadAttribute',
+            'JSXExpressionContainer',
+            'JSXOpeningElement',
+            'JSXClosingElement',
+            'JSXFragment',
+            'JSXOpeningFragment',
+            'JSXClosingFragment',
+            'JSXText',
+            'JSXEmptyExpression',
+            'JSXSpreadChild',
+          ],
+          offsetTernaryExpressions: true,
+        },
+      ],
+      'key-spacing': ['error', { beforeColon: false, afterColon: true }],
+      'keyword-spacing': ['error', { before: true, after: true }],
+      'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }],
+      'multiline-ternary': ['error', 'always-multiline'],
+      'new-cap': ['error', { newIsCap: true, capIsNew: false, properties: true }],
+      'new-parens': 'error',
+      'no-array-constructor': 'error',
+      'no-async-promise-executor': 'error',
+      'no-caller': 'error',
+      'no-class-assign': 'error',
+      'no-compare-neg-zero': 'error',
+      'no-cond-assign': 'error',
+      'no-const-assign': 'error',
+      'no-constant-condition': ['error', { checkLoops: false }],
+      'no-control-regex': 'error',
+      'no-debugger': 'error',
+      'no-delete-var': 'error',
+      'no-dupe-args': 'error',
+      'no-dupe-class-members': 'error',
+      'no-dupe-keys': 'error',
+      'no-duplicate-case': 'error',
+      'no-useless-backreference': 'error',
+      'no-empty': ['error', { allowEmptyCatch: true }],
+      'no-empty-character-class': 'error',
+      'no-empty-pattern': 'error',
+      'no-eval': 'error',
+      'no-ex-assign': 'error',
+      'no-extend-native': 'error',
+      'no-extra-bind': 'error',
+      'no-extra-boolean-cast': 'error',
+      'no-extra-parens': ['error', 'functions'],
+      'no-fallthrough': 'error',
+      'no-floating-decimal': 'error',
+      'no-func-assign': 'error',
+      'no-global-assign': 'error',
+      'no-implied-eval': 'error',
+      'no-import-assign': 'error',
+      'no-invalid-regexp': 'error',
+      'no-irregular-whitespace': 'error',
+      'no-iterator': 'error',
+      'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
+      'no-lone-blocks': 'error',
+      'no-loss-of-precision': 'error',
+      'no-misleading-character-class': 'error',
+      'no-prototype-builtins': 'error',
+      'no-useless-catch': 'error',
+      'no-mixed-operators': [
+        'error',
+        {
+          groups: [
+            ['==', '!=', '===', '!==', '>', '>=', '<', '<='],
+            ['&&', '||'],
+            ['in', 'instanceof'],
+          ],
+          allowSamePrecedence: true,
+        },
+      ],
+      'no-mixed-spaces-and-tabs': 'error',
+      'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0 }],
+      'no-new': 'error',
+      'no-new-func': 'error',
+      'no-new-object': 'error',
+      'no-new-symbol': 'error',
+      'no-new-wrappers': 'error',
+      'no-obj-calls': 'error',
+      'no-octal': 'error',
+      'no-octal-escape': 'error',
+      'no-proto': 'error',
+      'no-redeclare': ['error', { builtinGlobals: false }],
+      'no-regex-spaces': 'error',
+      'no-self-assign': ['error', { props: true }],
+      'no-self-compare': 'error',
+      'no-sequences': 'error',
+      'no-shadow-restricted-names': 'error',
+      'no-sparse-arrays': 'error',
+      'no-tabs': 'error',
+      'no-template-curly-in-string': 'error',
+      'no-this-before-super': 'error',
+      'no-throw-literal': 'error',
+      'no-trailing-spaces': 'error',
+      'no-undef': 'error',
+      'no-undef-init': 'error',
+      'no-unexpected-multiline': 'error',
+      'no-unmodified-loop-condition': 'error',
+      'no-unneeded-ternary': ['error', { defaultAssignment: false }],
+      'no-unreachable': 'error',
+      'no-unreachable-loop': 'error',
+      'no-unsafe-finally': 'error',
+      'no-unsafe-negation': 'error',
+      'no-unused-expressions': [
+        'error',
+        {
+          allowShortCircuit: true,
+          allowTernary: true,
+          allowTaggedTemplates: true,
+        },
+      ],
+      'no-unused-vars': [
+        'error',
+        {
+          args: 'none',
+          caughtErrors: 'none',
+          ignoreRestSiblings: true,
+          vars: 'all',
+        },
+      ],
+      'no-useless-call': 'error',
+      'no-useless-computed-key': 'error',
+      'no-useless-constructor': 'error',
+      'no-useless-rename': 'error',
+      'no-useless-return': 'error',
+      'no-whitespace-before-property': 'error',
+      'object-curly-newline': ['error', { multiline: true, consistent: true }],
+      'object-curly-spacing': ['error', 'always'],
+      'object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }],
+      'padded-blocks': ['error', { blocks: 'never', switches: 'never', classes: 'never' }],
+      'prefer-promise-reject-errors': 'error',
+      'prefer-regex-literals': ['error', { disallowRedundantWrapping: true }],
+      'quote-props': ['error', 'as-needed'],
+      'rest-spread-spacing': ['error', 'never'],
+      semi: ['error', 'never'],
+      'semi-spacing': ['error', { before: false, after: true }],
+      'space-before-blocks': ['error', 'always'],
+      'space-before-function-paren': ['error', 'always'],
+      'space-in-parens': ['error', 'never'],
+      'space-infix-ops': 'error',
+      'space-unary-ops': ['error', { words: true, nonwords: false }],
+      'symbol-description': 'error',
+      'template-tag-spacing': ['error', 'never'],
+      'unicode-bom': ['error', 'never'],
+      'use-isnan': [
+        'error',
+        {
+          enforceForSwitchCase: true,
+          enforceForIndexOf: true,
+        },
+      ],
+      'valid-typeof': ['error', { requireStringLiterals: true }],
+      'wrap-iife': ['error', 'any', { functionPrototypeMethods: true }],
+      'yield-star-spacing': ['error', 'both'],
+      yoda: ['error', 'never'],
+
+      // es6+
+      'no-var': 'error',
+      'prefer-rest-params': 'error',
+      'prefer-spread': 'error',
+      'prefer-template': 'error',
+      'template-curly-spacing': 'error',
+      'generator-star-spacing': 'off',
+      'no-empty-static-block': 'error',
+      'no-new-native-nonconstructor': 'error',
+      'arrow-parens': [
+        'error',
+        'as-needed',
+        {
+          requireForBlockBody: false,
+        },
+      ],
+      quotes: [
+        'error',
+        'single',
+        {
+          avoidEscape: true,
+          allowTemplateLiterals: false,
+        },
+      ],
+      'prefer-const': [
+        'error',
+        {
+          destructuring: 'all',
+          ignoreReadBeforeAssign: true,
+        },
+      ],
+      'prefer-arrow-callback': [
+        'error',
+        {
+          allowNamedFunctions: false,
+          allowUnboundThis: true,
+        },
+      ],
+      'object-shorthand': [
+        'error',
+        'always',
+        {
+          ignoreConstructors: false,
+          avoidQuotes: true,
+        },
+      ],
+      'spaced-comment': [
+        'error',
+        'always',
+        {
+          line: {
+            markers: ['/'],
+            exceptions: ['/', '#'],
+          },
+          block: {
+            markers: ['!'],
+            exceptions: ['*'],
+            balanced: true,
+          },
+        },
+      ],
+
+      // best-practice
+      eqeqeq: ['error', 'smart'],
+      complexity: ['error', { max: 30 }],
+      'array-callback-return': 'error',
+      'block-scoped-var': 'error',
+      'consistent-return': 'off',
+      'no-alert': 'error',
+      'no-case-declarations': 'error',
+      'no-multi-spaces': 'error',
+      'no-multi-str': 'error',
+      'no-with': 'error',
+      'no-void': 'error',
+      'no-useless-escape': 'off',
+      'vars-on-top': 'error',
+      'require-await': 'off',
+      'no-return-assign': 'off',
+      'one-var': ['error', 'never'],
+      'operator-linebreak': ['error', 'before'],
+      'comma-dangle': ['error', 'always-multiline'],
+      'max-params': ['error', { max: 5 }],
+      'max-depth': ['error', { max: 5 }],
+      'max-nested-callbacks': ['error', { max: 10 }],
+      'max-statements-per-line': ['error', { max: 2 }],
+      'max-lines': [
+        'error',
+        {
+          max: 1000,
+          skipComments: true,
+          skipBlankLines: true,
+        },
+      ],
+      'max-lines-per-function': [
+        'error',
+        {
+          max: 100,
+          skipComments: true,
+          skipBlankLines: true,
+        },
+      ],
+      'no-use-before-define': [
+        'error',
+        {
+          functions: false,
+          classes: false,
+          variables: true,
+        },
+      ],
+      'max-len': [
+        'error',
+        {
+          code: 200,
+          tabWidth: 2,
+          comments: 200,
+          ignoreUrls: true,
+          ignoreStrings: true,
+          ignoreRegExpLiterals: true,
+          ignoreTemplateLiterals: true,
+          ignoreTrailingComments: true,
+        },
+      ],
+      'sort-imports': [
+        'error',
+        {
+          ignoreCase: false,
+          ignoreDeclarationSort: true,
+          ignoreMemberSort: false,
+          memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+          allowSeparatedGroups: false,
+        },
+      ],
+    },
   },
 
   {
@@ -56,10 +394,15 @@ export const imports = [
     },
     settings: {
       'import/resolver': {
-        node: { extensions: ['.js', '.mjs', '.ts', '.d.ts'] },
+        node: { extensions: ['.js', '.mjs', '.ts', '.mts', '.d.ts'] },
       },
     },
     rules: {
+      'import/no-unresolved': 'off',
+      'import/no-absolute-path': 'off',
+      'import/no-named-as-default-member': 'off',
+
+      'import/newline-after-import': 'error',
       'import/first': 'error',
       'import/no-mutable-exports': 'error',
       'import/no-duplicates': 'error',
@@ -76,6 +419,7 @@ export const imports = [
             'object',
             'type',
           ],
+          'newlines-between': 'never',
           pathGroups: [{ pattern: '@/**', group: 'internal' }],
           pathGroupsExcludedImportTypes: ['type'],
         },

package/lib/jsonc.js

@@ -54,13 +54,13 @@ export const pkgOrder = [
         {
           pathPattern: '^$',
           order: [
+            'publisher',
             'name',
+            'displayName',
             'type',
             'version',
             'private',
             'packageManager',
-            'publisher',
-            'displayName',
             'description',
             'keywords',
             'license',
@@ -68,15 +68,17 @@ export const pkgOrder = [
             'homepage',
             'repository',
             'funding',
+            'exports',
             'main',
             'module',
-            'types',
             'unpkg',
             'jsdelivr',
-            'exports',
-            'files',
+            // workaround for `type: "module"` with TS `moduleResolution: "node16"`
+            'types',
+            'typesVersions',
             'bin',
             'icon',
+            'files',
             'sideEffects',
             'scripts',
             'peerDependencies',
@@ -89,6 +91,8 @@ export const pkgOrder = [
             'categories',
             'engines',
             'pnpm',
+            'overrides',
+            'resolutions',
             'husky',
             'prettier',
             'nano-staged',

package/lib/ts.js

@@ -19,7 +19,7 @@ export const ts = [
     },
     rules: {
       ...tsPlugin.configs['eslint-recommended'].overrides[0].rules,
-      ...tsPlugin.configs['recommended'].rules,
+      ...tsPlugin.configs.recommended.rules,
 
       '@typescript-eslint/no-unused-vars': 'error',
       '@typescript-eslint/no-redeclare': 'error',

package/lib/vue.js

@@ -57,8 +57,6 @@ export const vue = [
     plugins: {
       vue: vuePlugin,
     },
-    rules: {
-      ...(isVue3 ? vue3Rules : vue2Rules),
-    },
+    rules: isVue3 ? vue3Rules : vue2Rules,
   },
 ]

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@ntnyq/eslint-config",
   "type": "module",
-  "version": "2.0.0-beta.3",
-  "packageManager": "pnpm@8.1.0",
+  "version": "2.0.0-beta.5",
+  "packageManager": "pnpm@8.1.1",
   "description": "",
   "keywords": [],
   "license": "MIT",
@@ -10,16 +10,17 @@
     "name": "ntnyq",
     "email": "ntnyq13@gmail.com"
   },
-  "main": "./index.js",
-  "module": "./index.js",
-  "types": "./index.d.ts",
   "exports": {
     "types": "./index.d.ts",
     "require": "./index.js",
     "import": "./index.js"
   },
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "files": [
     "index.js",
+    "index.d.ts",
     "lib"
   ],
   "publishConfig": {
@@ -30,10 +31,11 @@
   },
   "dependencies": {
     "@eslint/js": "^8.37.0",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
     "astro-eslint-parser": "^0.13.2",
     "eslint-config-prettier": "^8.8.0",
+    "eslint-define-config": "^1.17.0",
     "eslint-plugin-astro": "^0.26.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.27.5",
@@ -55,7 +57,6 @@
     "@types/node": "^18.15.11",
     "bumpp": "^9.1.0",
     "eslint": "^8.37.0",
-    "eslint-define-config": "^1.17.0",
     "husky": "^8.0.3",
     "nano-staged": "^0.8.0",
     "typescript": "5.0.3"