@lntvow/eslint-config 8.5.0 → 9.1.1

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/.env.development

@@ -0,0 +1 @@
+VITE_BASE = '/xxxxx/'

package/.env.production

@@ -0,0 +1 @@
+VITE_BASE = '/xxxxx/'

package/.env.uat

@@ -0,0 +1 @@
+VITE_BASE = '/xxxxx/'

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

@@ -0,0 +1,44 @@
+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@v3
+
+      - name: Set Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Set pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 9
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        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 publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_PUBLISH}}

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# npx commitlint --edit $1

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# npx lint-staged

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/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "cSpell.words": [
+    "astro",
+    "backreference",
+    "bumpp",
+    "JETBRAINS",
+    "nonconstructor",
+    "nonoctal",
+    "plusplus",
+    "tsup",
+    "typedefs",
+    "unignore"
+  ]
+}

package/README.md

@@ -1,37 +1,29 @@
-## 安装
+# @lntvow/eslint-config
 
-安装 @lntvow/eslint-config
+## Usage
 
-```
+install @lntvow/eslint-config
+
+```bash
 pnpm install -D @lntvow/eslint-config
 ```
 
-然后在你的.`eslintrc.*`文件的 "extends" 字段里添加 "@lntvow" 如下图所示
+create `eslint.config.mjs` in your project root
 
-```json
-{
-  "extends": ["@lntvow"]
-}
-```
+```js
+// eslint.config.mjs
+import lntvow from '@lntvow/eslint-config'
 
-## 温馨提示
+export default lntvow()
+```
 
-1. 如果项目是 `npm` 或者 `yarn` 安装的跳过本提示
-2. 由于 `pnpm` 软链和 `eslint` 以及 `prettier` 功能冲突 所以部分包必须平铺在 `node_modules` 根目录下
-3. 项目根目录下新建文件 `.npmrc` 并写入 `shamefully-hoist=true` 该指令表示平铺依赖到 `node_modules` 根目录
+## Plugins
 
-```
-shamefully-hoist=true
-```
+Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
 
-本项目使用的依赖如下:
-
-- [eslint]
-- [prettier]
-- [eslint-plugin-prettier]
-- [eslint-plugin-import]
-- [eslint-import-resolver-alias]
-- [eslint-plugin-unicorn]
-- [@typescript-eslint/eslint-plugin]
-- [@typescript-eslint/parser]
-- [eslint-plugin-vue]
+| New Prefix     | Original Prefix        | Source Plugin                                                                              |
+| -------------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `typescript/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `vue/*`        | `@vue/*`               | [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)                            |
+| `import/*`     | `import-x/*`           | [eslint-plugin-import-x](https://github.com/un-es/eslint-plugin-import-x)                  |
+| `style/*`      | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |

package/api/basic.js

@@ -0,0 +1,22 @@
+import * as cheerio from 'cheerio'
+import axios from 'axios'
+import { javascript } from '../dist/index.js'
+
+// Const basicKeys = Object.keys(basicRules);
+const rulesMap = {}
+
+axios.get('https://eslint.org/docs/latest/rules/').then(async res => {
+  const $ = cheerio.load(res.data),
+    filteredElements = $('.rule').filter((i, e) => !($(e).is('.rule--deprecated') || $(e).is('.rule--removed')))
+
+  filteredElements.each((i, el) => {
+    const ruleName = $(el).find('.rule__name').text()
+    rulesMap[ruleName] = 2
+  })
+
+  const keyList = Object.keys(rulesMap)
+  const rulesList = Object.keys((await javascript())[0].rules)
+
+  const diff = keyList.filter(key => !rulesList.includes(key))
+  console.log('diff: ', diff)
+})

package/api/vue.js

@@ -0,0 +1,34 @@
+/* eslint-disable unicorn/prefer-top-level-await */
+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) => {
+    return ['Extension Rules', 'Uncategorized'].includes($(e).find('.item[tabindex="0"] .text').text())
+  })
+
+  filteredElements.each((i, el) => {
+    const list = $(el).find('.items .is-link')
+    list.each((i, 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) {
+  return /^([\w-])+@([\w-])+(\.[\w-])+/.test(value)
+}

package/commitlint.config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {},
+}

package/eslint.config.js

@@ -0,0 +1,21 @@
+import pluginStylistic from '@stylistic/eslint-plugin'
+import { lntvow, GLOB_SRC, renameRules } from './dist/index.js'
+
+const config = await lntvow({
+  vue: true,
+  typescript: true,
+  gitignore: {
+  },
+})
+
+const files = [GLOB_SRC]
+
+// 1
+export default [
+  ...config,
+  {
+    // rules: {
+    //   'style/quotes': 'error',
+    // },
+  },
+]

package/package.json

@@ -1,19 +1,53 @@
 {
   "name": "@lntvow/eslint-config",
-  "version": "8.5.0",
-  "description": "eslint配置文件",
-  "main": "index.js",
-  "keywords": [],
+  "version": "9.1.1",
   "author": "lntvow",
+  "type": "module",
   "license": "MIT",
-  "files": [
-    "index.js",
-    "README.md"
-  ],
+  "engines": {
+    "node": ">=18.12.0",
+    "pnpm": ">=9.0.0"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@types/eslint": "^8.56.10",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/node": "^20.12.12",
+    "axios": "^1.7.2",
+    "bumpp": "^9.4.1",
+    "cheerio": "1.0.0-rc.12",
+    "rimraf": "^5.0.7",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "vue": "^3.4.27"
+  },
   "dependencies": {
-    "@lntvow/eslint-config-vue": "8.5.0"
+    "@eslint/js": "^9.3.0",
+    "@lntvow/utils": "^3.0.3",
+    "@stylistic/eslint-plugin": "^2.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
+    "@typescript-eslint/parser": "^7.10.0",
+    "eslint": "^9.3.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-flat-config-utils": "^0.2.5",
+    "eslint-plugin-import-x": "^0.5.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-vue": "^9.26.0",
+    "find-up": "^7.0.0",
+    "globals": "^15.3.0",
+    "local-pkg": "^0.5.0",
+    "parse-gitignore": "^2.0.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.5",
+    "vue-eslint-parser": "^9.4.2"
   },
-  "peerDependencies": {
-    "eslint": "^8.43.0"
+  "scripts": {
+    "dev": "pnpm build --watch",
+    "build": "tsup",
+    "commit": "git add . && git-cz",
+    "rimraf": "rimraf ./node_modules/",
+    "release": "git add . && bumpp package.json --all --commit --no-tag --push"
   }
 }

package/packages/eslint-config-ts/index.js

@@ -0,0 +1,85 @@
+module.exports = {
+  extends: [
+    '@lntvow/eslint-config-basic',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/strict',
+    'plugin:@typescript-eslint/stylistic',
+  ],
+  settings: {
+    'import/resolver': { typescript: true },
+  },
+  overrides: [
+    {
+      files: ['*.js', '*.cjs'],
+      // 禁用js文件的类型检查
+      extends: ['plugin:@typescript-eslint/disable-type-checked'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 0, // 允许使用require
+        '@typescript-eslint/consistent-type-assertions': 0, // 禁用js文件的类型检查
+      },
+    },
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      // 禁用js文件的类型检查
+      rules: {
+        'spaced-comment': 0, // 警用注释检查
+      },
+    },
+    {
+      files: ['*.ts', '*.tsx', '*.vue'],
+      rules: {
+        /**
+         * 重写import规则
+         */
+        'import/namespace': 0, //  导入校验
+        'import/no-cycle': 0, // 循环导入
+        'import/no-unused-modules': 0, // 导入未使用的模块
+        'import/no-named-as-default': 0, // 校验导出名称
+        'import/no-unresolved': 0, // 导入目录校验
+
+        /**
+         * 重写ts规则
+         */
+        '@typescript-eslint/no-non-null-assertion': 0, // 允许使用!断言
+        '@typescript-eslint/ban-types': 0, //  允许使用object
+        '@typescript-eslint/no-explicit-any': 0, // 允许使用any
+        '@typescript-eslint/ban-ts-comment': 0, // 允许使用ts注释
+
+        '@typescript-eslint/no-unused-vars': 1, // 未使用的变量 警告
+
+        /**
+         * 重写js规则
+         */
+        'no-undef': 0, // ts自带 允许使用未定义的变量
+        'no-use-before-define': 0,
+        '@typescript-eslint/no-use-before-define': [
+          2,
+          {
+            functions: false,
+            classes: true,
+            variables: false,
+            allowNamedExports: false,
+            enums: true,
+            typedefs: true,
+            ignoreTypeReferences: true,
+          },
+        ], // 变量定义前禁止使用
+        'lines-around-comment': 'off',
+        '@typescript-eslint/lines-around-comment': [
+          2,
+          {
+            allowBlockStart: true,
+            allowObjectStart: true,
+            allowArrayStart: true,
+            allowClassStart: true,
+            allowEnumStart: true,
+            allowInterfaceStart: true,
+            allowModuleStart: true,
+            allowTypeStart: true,
+          },
+        ], // 注释空行,
+      },
+    },
+  ],
+  rules: {},
+}

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

@@ -0,0 +1,18 @@
+{
+  "name": "@lntvow/eslint-config-ts",
+  "version": "8.5.0",
+  "description": "eslint/ts配置文件",
+  "main": "index.js",
+  "keywords": [],
+  "author": "lntvow",
+  "license": "MIT",
+  "files": [
+    "index.js"
+  ],
+  "dependencies": {
+    "@lntvow/eslint-config-basic": "workspace:*",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/parser": "^6.2.0",
+    "eslint-import-resolver-typescript": "^3.5.5"
+  }
+}

package/packages/eslint-plugin/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    get: require('./rules/get'),
+  },
+}

package/packages/eslint-plugin/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@lntvow/eslint-plugin",
+  "version": "8.5.0",
+  "description": "eslint/plugin文件",
+  "main": "index.js",
+  "keywords": [],
+  "author": "lntvow",
+  "license": "MIT",
+  "files": [
+    "index.js"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "eslint": ">=8.43.0"
+  }
+}

package/packages/eslint-plugin/rules/get.js

@@ -0,0 +1,18 @@
+module.exports = {
+  create(content) {
+    const options = content.options[1]
+    return {
+      ExpressionStatement(node) {
+        const callee = node.expression.callee
+        console.log('callee: ', callee)
+        const name = callee.property.name
+        if (options[name] === 2) {
+          content.report({
+            node,
+            message: `不能使用console.${name}`,
+          })
+        }
+      },
+    }
+  },
+}

package/packages/eslint-plugin/test/get.test.js

@@ -0,0 +1,39 @@
+const rule = require('../rules/get')
+const RuleTester = require('eslint').RuleTester
+
+const ruleTester = new RuleTester()
+
+ruleTester.run('get', rule, {
+  valid: [
+    {
+      name: 'success',
+      code: 'var a = 10',
+    },
+  ],
+  invalid: [
+    {
+      name: 'hash log',
+      code: "console.log('context: ', context.options)",
+      options: [
+        2,
+        {
+          log: 2,
+          warn: 2,
+        },
+      ],
+      errors: [{ message: '不能使用console.log' }],
+    },
+    {
+      name: 'hash warn',
+      code: "console.warn('context: ', context.options)",
+      options: [
+        2,
+        {
+          log: 2,
+          warn: 2,
+        },
+      ],
+      errors: [{ message: '不能使用console.warn' }],
+    },
+  ],
+})

package/src/configs/gitignore.ts

@@ -0,0 +1,34 @@
+import fs from 'fs'
+import { findUpSync } from 'find-up'
+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 { name = '.gitignore', root = false, files: _files = root ? name : findUpSync(name) || [] } = options
+  const files = castArray(_files)
+
+  const ignores = []
+  for (const file of files) {
+    try {
+      const content = fs.readFileSync(file, 'utf8')
+
+      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}`))
+        }
+      }
+    } catch (error) {
+      throw new Error(`Failed to read file: ${file}`)
+    }
+  }
+
+  return [
+    {
+      ignores,
+    },
+  ]
+}

package/src/configs/ignores.ts

@@ -0,0 +1,10 @@
+import { GLOB_EXCLUDE } from 'src/globs'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function ignores(): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      ignores: [...GLOB_EXCLUDE],
+    },
+  ]
+}

package/src/configs/imports.ts

@@ -0,0 +1,17 @@
+import pluginImport from 'eslint-plugin-import-x'
+import type { TypedFlatConfigItem } from '../types'
+
+export async function imports(): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      name: 'lntvow/imports/rules',
+      plugins: {
+        import: pluginImport,
+      },
+      rules: {
+        'import/order': 'error',
+        'import/newline-after-import': 'error',
+      },
+    },
+  ]
+}

package/src/configs/index.ts

@@ -0,0 +1,8 @@
+export * from './gitignore'
+export * from './ignores'
+export * from './imports'
+export * from './javascript'
+export * from './prettier'
+export * from './stylistic'
+export * from './typescript'
+export * from './vue'