@lntvow/eslint-config 9.20.3 → 9.21.1

package/README.md

@@ -0,0 +1,43 @@
+# @lntvow/eslint-config
+
+## Usage
+
+install @lntvow/eslint-config
+
+```bash
+pnpm install -D @lntvow/eslint-config
+```
+
+create `eslint.config.js` in your project root
+
+```js
+// eslint.config.js
+import { lntvow } from '@lntvow/eslint-config'
+
+export default lntvow()
+```
+
+## Plugins
+
+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.
+
+| New Prefix | Original Prefix        | Source Plugin                                                                              |
+| ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `ts/*`     | `@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)           |
+
+## Tips
+
+- If the project is installed via `npm` or `yarn`, you can skip this tip.
+- If you do not want to manually install `eslint` and other dependencies, and choose to use `pnpm` for installation, please note the following points:
+  - Due to the symbolic link feature of `pnpm` conflicting with the functionality of `eslint`, some packages must be hoisted to the root of `node_modules`.
+  - Create a `.npmrc` file in the root directory of the project and write `shamefully-hoist=true`. This command is used to hoist dependencies to the root of `node_modules`, then you can reinstall the dependencies.
+- Alternatively, you can also choose to manually install `eslint` and other dependencies to the root of `node_modules`.
+
+## Todo
+
+- `.gitignore` 功能异常
+
+## 注意事项

package/dist/index.cjs

@@ -233,20 +233,23 @@ async function ignores(ignoresList = []) {
 
 async function imports(options = {}) {
   return [
-    // pluginImport.flatConfigs.typescript,
     {
       name: "lntvow/imports/rules",
       plugins: {
         import: pluginImport__default
       },
       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',
+        // Helpful warnings
+        // 禁止重复导入
+        // 'import/export': 'error',
+        // 禁止导入废弃的内容
+        // 'import/no-deprecated': 'warn',
+        // 禁止空的导入
+        // 'import/no-empty-named-blocks': 'error',
+        // 幽灵依赖
+        // 'import/no-extraneous-dependencies': 'error',
+        // 禁止使用var或let进行可变导出
+        // 'import/no-mutable-exports': 'error',
         // // 'import/no-named-as-default': 'error',
         // // 'import/no-named-as-default-member': 'error',
         // // 'import/no-unused-modules': 'error',
@@ -327,6 +330,9 @@ async function javascript(options = {}) {
           // ...globals.es2021,
           // ...globals.node,
         }
+      },
+      linterOptions: {
+        reportUnusedDisableDirectives: "warn"
       }
     },
     {
@@ -506,7 +512,7 @@ const notInRecommendedRules = {
   // 禁用 Object 的构造函数
   "no-octal-escape": "error",
   // 禁止在字符串中使用八进制转义序列
-  "no-param-reassign": "error",
+  "no-param-reassign": "off",
   // 禁止对 function 的参数进行重新赋值
   "no-plusplus": "off",
   // 禁用一元操作符 ++ 和 --
@@ -740,16 +746,16 @@ async function typescript(options = {}) {
       name: "lntvow/typescript/setup",
       plugins: {
         ts: pluginTs__default
-      },
+      }
+    },
+    {
+      name: "lntvow/typescript/rules",
       languageOptions: {
         parser: parserTs__default,
         parserOptions: {
           sourceType: "module"
         }
-      }
-    },
-    {
-      name: "lntvow/typescript/rules",
+      },
       files,
       rules: {
         ...renameRules(pluginTs__default.configs["eslint-recommended"].overrides[0].rules, {