@lincy/eslint-config 3.3.0 → 3.4.0

package/README.md

@@ -1,11 +1,11 @@
-# @lincy/eslint-config
+# @lincy/eslint-config Eslint扁平化规则
 
 [![npm](https://img.shields.io/npm/v/@lincy/eslint-config?color=444&label=)](https://npmjs.com/package/@lincy/eslint-config)
 
 - 单引号，无结尾分号
 - 自动格式化
 - 专为与 TypeScript、Vue(2/3) 一起使用而设计，开箱即用
-- Lint 也适用于 json、yaml、markdown
+- 也适用于 json、yaml、markdown、react
 - import导入排序, 对象字⾯量项尾逗号
 - 合理的默认值，最佳实践，只需一行配置
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
@@ -52,20 +52,20 @@ For example:
 
 ```jsonc
 {
-  // Enable the flat config support
+  // 开启eslint扁平化配置
   "eslint.experimental.useFlatConfig": true,
 
-  // Disable the default formatter
+  // 禁用默认的格式化
   "prettier.enable": false,
   "editor.formatOnSave": false,
 
-  // Auto fix
+  // 开启自动修复
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true,
     "source.organizeImports": false
   },
 
-  // Silent the stylistic rules in you IDE, but still auto fix them
+  // 在 IDE 中静默样式规则，但仍会自动修复它们
   "eslint.rules.customizations": [
     { "rule": "@stylistic/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
@@ -78,10 +78,7 @@ For example:
     { "rule": "*semi", "severity": "off" }
   ],
 
-  // The following is optional.
-  // It's better to put under project setting `.vscode/settings.json`
-  // to avoid conflicts with working with different eslint configs
-  // that does not support all formats.
+  // 为所有支持的语言启用 eslint
   "eslint.validate": [
     "javascript",
     "javascriptreact",
@@ -102,6 +99,8 @@ For example:
 通常你只需要导入 `lincy` 预设：
 
 #### esm
+如果 package.json 中开启了`"type": "module",`
+
 ```js
 // eslint.config.js
 import lincy from '@lincy/eslint-config'
@@ -113,6 +112,8 @@ export default lincy()
 ```
 
 #### cjs
+如果 package.json 中没有开启`"type": "module",`
+
 ```js
 // eslint.config.js
 const lincy = require('@lincy/eslint-config').lincy
@@ -143,6 +144,18 @@ export default lincy({
     test: false, // 默认值: true
     // 是否启用 markdown 规则
     markdown: false, // 默认值: true
+    // 覆盖规则
+    overrides: {},
+
+    // 工厂函数第一个参数默认为各规则的开关, 但是也可以作为追加规则使用, 当包含以下键名将会自动整合到一个规则里
+    files: [],
+    ignores: [],
+    languageOptions: {},
+    linterOptions: {},
+    processor: {},
+    plugins: {},
+    rules: [],
+    settings: {}
 })
 ```
 
@@ -160,7 +173,7 @@ const autoImport = JSON.parse(
 
 export default lincy(
     {
-    // Configures for config
+        // 配置, 参考上一个代码块
     },
     // 启用 unocss
     {
@@ -181,13 +194,6 @@ export default lincy(
             },
         },
     },
-    // 自定义排除文件(夹)
-    {
-        ignores: [
-            '**/assets',
-            '**/static',
-        ],
-    },
     // 你还可以继续配置多个 ESLint Flat Configs
     {
         files: ['**/*.ts'],
@@ -237,13 +243,13 @@ export default [
 ]
 ```
 
-查看 [configs](https://github.com/lincenying/eslint-config/blob/main/src/configs) 和 [factory](https://github.com/lincenying/eslint-config/blob/ main/src/factory.ts）了解更多详细信息。
+查看 [configs](https://github.com/lincenying/eslint-config/blob/main/src/configs) 和 [factory](https://github.com/lincenying/eslint-config/blob/main/src/factory.ts）了解更多详细信息。
 
-> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.
+> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) and [antfu/eslint-config](https://github.com/antfu/eslint-config) for the inspiration and reference.
 
 ## Plugins Renaming
 
-由于平面配置支持显式提供了插件名称，因此我们重命名了一些插件以使它们更加一致并隐藏实现细节。
+由于扁平化配置支持显式提供了插件名称，因此我们重命名了一些插件以使它们更加一致并隐藏实现细节。
 
 | New Prefix | Original Prefix | Source Plugin |
 | --- | --- | --- |
@@ -267,10 +273,21 @@ type foo = { bar: 2 }
 
 ```js
 // eslint.config.js
-import antfu from '@antfu/eslint-config'
+import lincy from '@lincy/eslint-config'
 
-export default antfu(
-    { vue: true, typescript: true },
+export default lincy(
+    {
+        isInEditor: true,
+        vue: true,
+        typescript: true,
+        stylistic: true,
+        gitignore: true,
+        test: true,
+        jsonc: true,
+        yaml: true,
+        markdown: true,
+        overrides: {}
+    },
     {
         // 记得在这里指定文件 glob，否则可能会导致 vue 插件处理非 vue 文件
         files: ['**/*.vue'],
@@ -291,26 +308,37 @@ export default antfu(
 
 ```js
 // eslint.config.js
-import antfu from '@antfu/eslint-config'
+import lincy from '@lincy/eslint-config'
 
-export default antfu({
+export default lincy({
+    stylistic: {
+        indent: 4
+    },
     overrides: {
+        // 重写vue规则
         vue: {
             'vue/operator-linebreak': ['error', 'before'],
         },
+        // 重写ts规则
         typescript: {
             'ts/consistent-type-definitions': ['error', 'interface'],
         },
+        // 重写js规则
         javascript: {},
         stylistic: {
-            'antfu/consistent-list-newline': 'off',
+            'antfu/consistent-list-newline': 'error',
         },
         yaml: {},
+        jsonc: {},
+        markdown: {},
+        test: {},
+
+        // 追加自定义排除文件(夹)
         ignores: [
             '**/assets',
             '**/static',
         ]
-    // ...
+        // ...
     }
 })
 ```
@@ -330,6 +358,68 @@ export default lincy({
 })
 ```
 
+### React
+react拓展规则
+
+安装react插件
+
+```bash
+npm i -D eslint-plugin-react eslint-plugin-react-hooks
+```
+
+```js
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+import pluginReact from 'eslint-plugin-react'
+import pluginReactHooks from 'eslint-plugin-react-hooks'
+
+export default lincy(
+    {
+        vue: false,
+    },
+    // react 相关规则
+    {
+        files: ['**/*.{jsx,tsx}'],
+        settings: {
+            react: {
+                version: '17.0',
+            },
+        },
+        plugins: {
+            'react': pluginReact,
+            'react-hooks': pluginReactHooks,
+        },
+        languageOptions: {
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+            },
+        },
+        rules: {
+            ...pluginReact.configs.all.rules,
+            ...pluginReactHooks.configs.recommended.rules,
+            'react/jsx-filename-extension': 'off', // 禁止可能包含 JSX 文件扩展名
+            'react/jsx-first-prop-new-line': 'off', // 强制 JSX 中第一个属性的正确位置
+            'react/jsx-no-bind': 'off', // .bind()JSX 属性中禁止使用箭头函数
+            'react/forbid-component-props': 'off', // 禁止组件上使用某些 props
+            'react/jsx-max-props-per-line': ['error', { maximum: 4 }], // 在 JSX 中的单行上强制执行最多 props 数量
+            'react/jsx-no-literals': 'off', // 禁止在 JSX 中使用字符串文字
+            'react/jsx-one-expression-per-line': 'off', // 每行一个 JSX 元素
+            'react/no-danger': 'off', // 禁止使用 dangerouslySetInnerHTML
+            'react/jsx-max-depth': 'off', // 强制 JSX 最大深度
+            'react/jsx-newline': 'off', // 在 jsx 元素和表达式之后换行
+            'react/require-default-props': 'off', // 为每个非必需 prop 强制执行 defaultProps 定义
+            'react/jsx-props-no-spreading': 'off', // 强制任何 JSX 属性都不会传播
+            'react/no-unsafe': 'off', // 禁止使用不安全的生命周期方法
+            'jsx-quotes': ['error', 'prefer-double'], // 强制在 JSX 属性中一致使用双引号或单引号
+            'react/react-in-jsx-scope': 'off', // 使用 JSX 时需要引入 React
+            'react/hook-use-state': 'off', // useState 钩子值和 setter 变量的解构和对称命名
+        },
+    },
+)
+```
+
 ### Lint Staged
 
 如果你想在每次提交之前应用 lint 和自动修复，你可以将以下内容添加到你的 `package.json` 中：

package/dist/chunk-YG22WGT3.js

@@ -0,0 +1,40 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var __privateWrapper = (obj, member, setter, getter) => ({
+  set _(value) {
+    __privateSet(obj, member, value, setter);
+  },
+  get _() {
+    return __privateGet(obj, member, getter);
+  }
+});
+
+export {
+  __publicField,
+  __privateGet,
+  __privateAdd,
+  __privateSet,
+  __privateWrapper
+};