@lntvow/eslint-config 9.18.0 → 9.18.3

package/.commitlintrc

@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ],
+  "rules": {}
+}

package/.czrc

@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}

package/.editorconfig

@@ -0,0 +1,14 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false

package/.github/workflows/publish-npm.yml

@@ -0,0 +1,45 @@
+name: publish-npm
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'package.json'
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Set pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - run: pnpm install
+      - run: pnpm build
+      - run: pnpm -r publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_PUBLISH}}

package/.lintstagedrc

@@ -0,0 +1,4 @@
+{
+  "*.{js,jsx,ts,tsx,vue}": ["eslint --fix"],
+  "*.{json,css,scss,md}": ["prettier --write"]
+}

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 120,
+  "semi": false,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "es5",
+  "htmlWhitespaceSensitivity": "ignore",
+  "quoteProps": "consistent",
+  "jsxSingleQuote": true
+}

package/.simple-git-hooks.json

@@ -0,0 +1,4 @@
+{
+  "pre-commit": "npx lint-staged",
+  "commit-msg": "npx commitlint --edit"
+}

package/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+  "cSpell.words": [
+    "astro",
+    "backreference",
+    "bumpp",
+    "chunkname",
+    "esno",
+    "estree",
+    "JETBRAINS",
+    "nonconstructor",
+    "nonoctal",
+    "plusplus",
+    "tsup",
+    "typedefs",
+    "unignore"
+  ],
+  "typescript.tsdk": "node_modules\\typescript\\lib"
+}

package/cli/basic.js

@@ -0,0 +1,48 @@
+import fs from 'fs'
+import * as cheerio from 'cheerio'
+import axios from 'axios'
+import { javascript, notInRecommendedRules } from '../dist/index.js'
+
+axios.get('https://eslint.org/docs/latest/rules/').then(async res => {
+  const $ = cheerio.load(res.data)
+  const allRule = $('.rule').filter((i, e) => !($(e).is('.rule--deprecated') || $(e).is('.rule--removed')))
+
+  const allRulesList = []
+  allRule.each((i, el) => {
+    const ruleName = $(el).find('.rule__name').text()
+    allRulesList.push(ruleName)
+  })
+
+  const recommendedRuleList = []
+  const customRuleList = []
+
+  allRule.each((i, el) => {
+    const ruleName = $(el).find('.rule__name').text()
+    //  .rule__categories__type[aria-hidden="true"]
+    const flag = $(el).find('.rule__categories').children().eq(1).is('.rule__categories__type[aria-hidden="true"]')
+    if (flag) {
+      // console.log('custom', ruleName)
+      customRuleList.push(ruleName)
+    } else {
+      // console.log('recommended', ruleName)
+      recommendedRuleList.push(ruleName)
+    }
+  })
+
+  // fs.writeFileSync('customRuleList.json', JSON.stringify(customRuleList, null, 2))
+  // fs.writeFileSync('recommendedRuleList.json', JSON.stringify(recommendedRuleList, null, 2))
+
+  // //
+
+  // const keyList = Object.keys(rulesMap)
+  const rulesList = Object.keys((await javascript())[0].rules)
+
+  const configNotInRecommendedRulesList = Object.keys(notInRecommendedRules)
+  console.log(
+    'notInRecommendedRules diff: ',
+    configNotInRecommendedRulesList.length,
+    customRuleList.length,
+    customRuleList.filter(key => !configNotInRecommendedRulesList.includes(key))
+  )
+  //
+})

package/cli/vue.js

@@ -0,0 +1,36 @@
+/* eslint-disable id-length */
+
+const axios = require('axios')
+const cheerio = require('cheerio')
+const { rules } = require('../packages/eslint-config-vue')
+
+const keys = Object.keys(rules)
+const eslintKeys = []
+
+axios.get('https://eslint.vuejs.org/rules/').then(res => {
+  const $ = cheerio.load(res.data)
+
+  const filteredElements = $('.group').filter((i, e) =>
+    ['Extension Rules', 'Uncategorized'].includes($(e).find('.item[tabindex="0"] .text').text())
+  )
+
+  filteredElements.each((i, el) => {
+    const list = $(el).find('.items .is-link')
+    list.each((_index, e) => {
+      const ruleName = $(e).find('.item .text').text()
+      eslintKeys.push(ruleName)
+    })
+  })
+
+  const diff = eslintKeys.filter(key => !keys.includes(key))
+  console.log('eslintKeys: ', eslintKeys)
+  console.log('diff: ', diff)
+})
+
+/**
+ * @deprecated 使用 isEmail
+ */
+export function validatorEmail(value) {
+  // eslint-disable-next-line regexp/no-unused-capturing-group
+  return /^([\w-])+@([\w-])+(\.[\w-])+/.test(value)
+}

package/eslint.config.mjs

@@ -0,0 +1,8 @@
+import { lntvow } from './packages/eslint-config/dist/index.mjs'
+
+export default lntvow(
+  {
+    rules: {},
+  },
+  { ignores: ['src/typegen.d.ts'] }
+)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lntvow/eslint-config",
-  "version": "9.18.0",
+  "version": "9.18.3",
   "description": "eslint-config",
   "type": "module",
   "keywords": [
@@ -12,19 +12,6 @@
     "type": "git",
     "url": "https://github.com/lntvow/eslint-config.git"
   },
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
   "devDependencies": {
     "@lntvow/dev": "^3.3.3",
     "@types/node": "^22.9.0",
@@ -34,42 +21,14 @@
     "esno": "^4.8.0",
     "tsup": "^8.3.5",
     "vitest": "^2.1.8",
-    "vue": "^3.5.12"
-  },
-  "peerDependencies": {
-    "eslint": ">=9.0.0",
-    "prettier": ">=3.0.0"
-  },
-  "dependencies": {
-    "@eslint/js": "^9.17.0",
-    "@lntvow/utils": "^3.2.2",
-    "@stylistic/eslint-plugin": "^2.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.13.0",
-    "@typescript-eslint/parser": "^8.13.0",
-    "eslint": "^9.17.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-flat-config-utils": "^0.4.0",
-    "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-import-x": "^4.4.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-regexp": "^2.6.0",
-    "eslint-plugin-vitest": "^0.5.4",
-    "eslint-plugin-vue": "^9.30.0",
-    "find-up-simple": "^1.0.0",
-    "globals": "^15.12.0",
-    "local-pkg": "^0.5.0",
-    "parse-gitignore": "^2.0.0",
-    "typescript": "^5.6.3",
-    "vue-eslint-parser": "^9.4.3",
-    "@lntvow/eslint-plugin": "^9.18.0"
+    "unbuild": "^2.0.0"
   },
+  "dependencies": {},
   "scripts": {
-    "dev": "tsup --format esm",
-    "build": "pnpm -r build && pnpm typegen && tsup",
-    "typegen": "esno scripts/typegen.ts",
+    "build": "pnpm -r build",
     "inspect": "pnpm eslint --inspect-config",
     "type-check": "tsc --noEmit",
-    "rimraf": "rimraf ./node_modules/",
+    "rimraf": "rimraf ./node_modules/ && pnpm -r rimraf",
     "commit": "git add . && git-cz",
     "release": "git add . && bumpp package.json packages/*/package.json --all --commit --no-tag --push"
   }

package/packages/eslint-config/build.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: ['src/index.ts'],
+  clean: true,
+  declaration: true,
+  rollup: {
+    emitCJS: true,
+  },
+})

package/packages/eslint-config/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@lntvow/eslint-config",
+  "version": "9.18.3",
+  "description": "eslint-config",
+  "type": "module",
+  "keywords": [
+    "eslint",
+    "eslint-config"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lntvow/eslint-config.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "dev": "tsup --format esm",
+    "build": "pnpm typegen && unbuild",
+    "typegen": "esno scripts/typegen.ts",
+    "rimraf": "rimraf ./node_modules/",
+    "commit": "git add . && git-cz",
+    "release": "git add . && bumpp package.json packages/*/package.json --all --commit --no-tag --push"
+  },
+  "peerDependencies": {
+    "eslint": ">=9.0.0",
+    "prettier": ">=3.0.0"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.17.0",
+    "@lntvow/eslint-plugin": "workspace:^",
+    "@lntvow/utils": "^3.2.2",
+    "@stylistic/eslint-plugin": "^2.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.13.0",
+    "@typescript-eslint/parser": "^8.13.0",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-flat-config-utils": "^0.4.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-import-x": "^4.4.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-regexp": "^2.6.0",
+    "eslint-plugin-vitest": "^0.5.4",
+    "eslint-plugin-vue": "^9.30.0",
+    "find-up-simple": "^1.0.0",
+    "globals": "^15.12.0",
+    "local-pkg": "^0.5.0",
+    "parse-gitignore": "^2.0.0",
+    "typescript": "^5.6.3",
+    "vue-eslint-parser": "^9.4.3"
+  }
+}

package/packages/eslint-config/scripts/typegen.ts

@@ -0,0 +1,49 @@
+import fs from 'node:fs'
+import { flatConfigsToRulesDTS } from 'eslint-typegen/core'
+import { builtinRules } from 'eslint/use-at-your-own-risk'
+import {
+  combine,
+  custom,
+  disables,
+  imports,
+  javascript,
+  prettier,
+  regexp,
+  stylistic,
+  test,
+  typescript,
+  vue,
+} from '../src'
+
+const configs = await combine(
+  {
+    plugins: {
+      '': {
+        rules: Object.fromEntries(builtinRules.entries()),
+      },
+    },
+  },
+  custom(),
+  javascript(),
+  prettier(),
+  imports(),
+  typescript(),
+  vue(),
+  regexp(),
+  test(),
+  stylistic(),
+  disables()
+)
+// todo 作用
+const configNames = configs.map(i => i.name).filter(Boolean) as string[]
+
+let dts = await flatConfigsToRulesDTS(configs, {
+  includeAugmentation: false,
+})
+
+dts += `
+// Names of all the configs
+export type ConfigNames = ${configNames.map(i => `'${i}'`).join(' | ')}
+`
+
+fs.writeFileSync('src/typegen.d.ts', dts)

package/packages/eslint-config/src/configs/custom.ts

@@ -0,0 +1,13 @@
+import lntvowPlugin from '@lntvow/eslint-plugin'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function custom(): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      name: 'lntvow/custom/setup',
+      plugins: {
+        lntvow: lntvowPlugin,
+      },
+    },
+  ]
+}

package/packages/eslint-config/src/configs/disables.ts

@@ -0,0 +1,47 @@
+import { GLOB_SRC, GLOB_SRC_EXT } from '../globs'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function disables(): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      files: [`scripts/${GLOB_SRC}`],
+      name: 'lntvow/disables/scripts',
+      rules: {
+        'no-console': 'off',
+        // 'ts/explicit-function-return-type': 'off',
+        // 'unicorn/consistent-function-scoping': 'off',
+      },
+    },
+    {
+      files: [`cli/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
+      name: 'lntvow/disables/cli',
+      rules: {
+        'no-console': 'off',
+      },
+    },
+    {
+      files: ['**/*.d.?([cm])ts'],
+      name: 'lntvow/disables/dts',
+      rules: {
+        // 'eslint-comments/no-unlimited-disable': 'off',
+        // 'import/no-duplicates': 'off',
+        // 'no-restricted-syntax': 'off',
+        // 'unused-imports/no-unused-vars': 'off',
+      },
+    },
+    {
+      files: ['**/*.{test,spec}.([tj])s?(x)'],
+      name: 'lntvow/disables/test',
+      rules: {
+        'no-unused-expressions': 'off',
+      },
+    },
+    {
+      files: ['**/*.js', '**/*.cjs'],
+      name: 'lntvow/disables/cjs',
+      rules: {
+        'ts/no-require-imports': 'off',
+      },
+    },
+  ]
+}

package/packages/eslint-config/src/configs/gitignore.ts

@@ -0,0 +1,45 @@
+import fs from 'fs'
+import { castArray } from '@lntvow/utils'
+import parse from 'parse-gitignore'
+import type { FlatGitignoreOptions, TypedFlatConfigItem } from '../types'
+
+export async function gitignore(options: FlatGitignoreOptions): Promise<TypedFlatConfigItem[]> {
+  const { findUpSync } = await import('find-up-simple')
+
+  const {
+    name = '.gitignore',
+    root = false,
+    files: _files = root ? name : findUpSync(name) || [],
+    strict = false,
+  } = options
+
+  const files = castArray(_files)
+
+  const ignores = []
+  for (const file of files) {
+    let content
+    try {
+      content = fs.readFileSync(file, 'utf8')
+    } catch (error) {
+      if (strict) throw error
+      continue
+    }
+    const globs = parse(content).globs()
+    for (const glob of globs) {
+      if (glob.type === 'ignore') {
+        ignores.push(...glob.patterns)
+      } else if (glob.type === 'unignore') {
+        ignores.push(...glob.patterns.map((pattern: string) => `!${pattern}`))
+      }
+    }
+  }
+
+  if (strict && files.length === 0) throw new Error('No .gitignore file found')
+
+  return [
+    {
+      name: 'lntvow/gitignore',
+      ignores,
+    },
+  ]
+}

package/packages/eslint-config/src/configs/ignores.ts

@@ -0,0 +1,11 @@
+import { GLOB_EXCLUDE } from '../globs'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function ignores(ignoresList: string[] = []): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      name: 'lntvow/ignores',
+      ignores: [...GLOB_EXCLUDE, ...ignoresList],
+    },
+  ]
+}

package/packages/eslint-config/src/configs/imports.ts

@@ -0,0 +1,78 @@
+import pluginImport from 'eslint-plugin-import-x'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function imports(options: { typescript?: boolean } = {}): Promise<TypedFlatConfigItem[]> {
+  const { typescript = false } = options
+
+  return [
+    {
+      name: 'lntvow/imports/rules',
+      plugins: {
+        import: pluginImport,
+      },
+      rules: {
+        // Helpful warnings
+        // 'import/export': 'error',
+        // 'import/no-deprecated': 'error',
+        // 'import/no-empty-named-blocks': 'error',
+        // // 幽灵依赖
+        // 'import/no-extraneous-dependencies': 'off',
+        // 'import/no-mutable-exports': 'error',
+        // 'import/no-named-as-default': 'error',
+        // 'import/no-named-as-default-member': 'error',
+        // 'import/no-unused-modules': 'error',
+
+        // Module systems
+        // 'import/no-amd': 'off',
+        // 'import/no-commonjs': 'off',
+        // 'import/no-import-module-exports': 'off',
+        // 'import/no-nodejs-modules': 'off',
+        // 'import/unambiguous': 'off',
+
+        // Static analysis
+        // 'import/default': 'error',
+        // 'import/named': 'error',
+        // 'import/namespace': 'error',
+        // 'import/no-absolute-path': 'error',
+        // 'import/no-cycle': 'off',
+        // 'import/no-dynamic-require': 'off',
+        // 'import/no-internal-modules': 'off',
+        // 'import/no-relative-packages': 'off',
+        // 'import/no-relative-parent-imports': 'off',
+        // 'import/no-restricted-paths': 'off',
+        // 'import/no-self-import': 'off',
+        'import/no-unresolved': 'error',
+        // 'import/no-useless-path-segments': 'error',
+        // 'import/no-webpack-loader-syntax': 'error',
+
+        // Style guide
+        // 'import/consistent-type-specifier-style': 'off',
+        // 'import/dynamic-import-chunkname': 'off',
+        // 'import/exports-last': 'off',
+        // 'import/extensions': 'off',
+        'import/first': 'error',
+        // 'import/group-exports': 'off',
+        // 'import/max-dependencies': 'off',
+        'import/newline-after-import': 'error',
+        // 'import/no-anonymous-default-export': 'off',
+        // 'import/no-default-export': 'off',
+        'import/no-duplicates': 'error',
+        // 'import/no-named-default': 'off',
+        // 'import/no-named-export': 'off',
+        // 'import/no-namespace': 'off',
+        // 'import/no-unassigned-import': 'off',
+        'import/order': 'error',
+        // 'import/prefer-default-export': 'off',
+      },
+      settings: {
+        'import-x/resolver': {
+          alias: {
+            map: [['@', './src']],
+            extensions: ['.ts', '.js', '.jsx', '.tsx', '.d.ts'],
+          },
+          node: true,
+        },
+      },
+    },
+  ]
+}

package/packages/eslint-config/src/configs/index.ts

@@ -0,0 +1,23 @@
+export * from './custom'
+
+export * from './disables'
+
+export * from './gitignore'
+
+export * from './ignores'
+
+export * from './imports'
+
+export * from './javascript'
+
+export * from './prettier'
+
+export * from './regexp'
+
+export * from './stylistic'
+
+export * from './test'
+
+export * from './typescript'
+
+export * from './vue'