@polyv/eslint-config 0.8.0 → 1.0.0

package/README.md

@@ -1,74 +1,123 @@
-# 保利威前端工程 ESLint 通用配置
+# @polyv/eslint-config
 
-## 安装和使用
+这是面向 ESLint 10.x 的 flat config 配置包，包含通用插件配置、JavaScript 配置、TypeScript 配置、Vue2 补充配置和微信小程序专项配置。
 
-确保 Node.js 版本符合 **^20.10.0**（未测试其他版本的可用性），运行 npm 命令安装：
+## 安装
 
 ```bash
-npm install @polyv/eslint-config --save-dev
+npm install @polyv/eslint-config eslint@^10 --save-dev
 ```
 
-在项目中创建 `.eslintrc.js`（一般在根目录下创建），根据工程的开发语言和框架配置 `extends` 字段：
+## 配置导航
+
+- [通用配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/common/README.md)：必须显式组合的基础配置，包含通用忽略项、运行 ESLint 时消费项目目录内的 `.gitignore`、`polyv` plugin 注册，以及 `promise`、`sonarjs`、`import-x` 推荐规则。
+- [Import-X 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/importx/README.md)：提供 `eslint-plugin-import-x` 推荐规则和 node resolver 设置，已被通用配置继承。
+- [SonarJS 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/sonarjs/README.md)：提供 `eslint-plugin-sonarjs` 推荐规则和项目内覆盖规则，已被通用配置继承。
+- [JavaScript 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/js/README.md)：纯 JavaScript 项目使用，需和 `polyv.configs.common` 一起组合。
+- [TypeScript 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/ts/README.md)：TypeScript 或 TypeScript + JavaScript 混合项目使用，已集成 JavaScript 配置，需和 `polyv.configs.common` 一起组合。
+- [Vue2 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/vue2/README.md)：Vue2 项目使用，提供 Vue2 SFC 解析、Vue2 essential 规则、ESLint 8 `for-vue2-js.js` 迁移规则和 Vue2 TypeScript 返回类型推导 settings。
+- [小程序配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/miniprogram/README.md)：微信小程序项目使用，开启 `polyv/no-relative-directory-index-imports` 并处理小程序专项忽略。
+- [Prettier 配置](https://github.com/polyv/eslint-config/blob/main/eslint10/configs/prettier/README.md)：接入 `eslint-plugin-prettier/recommended` 和共享 Prettier 选项，需要放在配置数组最后。
+
+## 规则导航
+
+- [explicit-module-boundary-types](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/explicit-module-boundary-types/README.md)：要求导出函数显式声明模块边界类型，同时允许通过 options 或 settings 放开特定命名的返回类型推导。
+- [no-relative-directory-index-imports](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/no-relative-directory-index-imports/README.md)：禁止依赖相对目录的 `index` 文件兜底解析，避免微信小程序 npm 构建后的运行时解析失败。
+- [no-vue-component-variable-name-conflict](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/no-vue-component-variable-name-conflict/README.md)：禁止 Vue `<script setup>` 中的组件导入名和 lower camel 本地声明产生命名冲突。
+
+## 快速选择
+
+纯 JavaScript 项目：
 
 ```javascript
-/* eslint-env node */
-
-// 纯 JavaScript 工程的配置
-module.exports = {
-  root: true,
-  extends: [
-    './node_modules/@polyv/eslint-config/lib/for-js'
-  ]
-};
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.js
+];
 ```
 
+TypeScript 或 TypeScript + JavaScript 混合项目：
+
 ```javascript
-/* eslint-env node */
-
-// 纯 TypeScript 工程的配置
-module.exports = {
-  root: true,
-  extends: [
-    './node_modules/@polyv/eslint-config/lib/for-js',
-    './node_modules/@polyv/eslint-config/lib/for-ts'
-  ]
-};
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.ts
+];
 ```
 
+Vue2 JavaScript 项目：
+
 ```javascript
-/* eslint-env node */
-
-// Vue.js 2.x 工程（JavaScript）的配置
-module.exports = {
-  root: true,
-  extends: [
-    './node_modules/@polyv/eslint-config/lib/for-vue2-js'
-  ]
-};
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.js,
+  ...polyv.configs.vue2
+];
 ```
 
-## 注意点
+Vue2 TypeScript 项目：
 
-### 严格模式
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.ts,
+  ...polyv.configs.vue2
+];
+```
 
-部分规则在严格模式下（环境变量 `STRICT_LINT` 不为 `false` 时），告警级别为错误，其他情况为警告。这些规则包括：
+微信小程序项目：
 
-- sonarjs/no-nested-template-literals
-- @typescript-eslint/naming-convention
-- vue/custom-event-name-casing
-- vue/no-mutating-props
-- vue/multi-word-component-names
-- vue/attribute-hyphenation
-- vue/v-on-event-hyphenation
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
 
-### 生产环境构建的差异
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.miniprogram
+];
+```
+
+需要接入 Prettier 时，把 `polyv.configs.prettier` 放在最后：
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.js,
+  ...polyv.configs.prettier
+];
+```
+
+## 插件和规则
 
-部分规则在环境变量 `NODE_ENV` 为 `production` 时，告警级别为错误，其他情况下为警告。这些规则包括：
+- `polyv.configs.common` 会默认注册 `polyv` plugin。如果已经引用了 `polyv.configs.common`，则无需额外注册该插件。
+- 只需要单独使用自定义规则时，可以引入 `plugin` 或 `@polyv/eslint-config/plugin` 后手动注册。
+- 当前自定义规则：
+  - [polyv/explicit-module-boundary-types](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/explicit-module-boundary-types/README.md)：要求导出函数显式声明模块边界类型，同时允许指定函数或方法省略返回类型。
+  - [polyv/no-relative-directory-index-imports](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/no-relative-directory-index-imports/README.md)：用于禁止依赖相对目录的 `index` 文件兜底解析。
+  - [polyv/no-vue-component-variable-name-conflict](https://github.com/polyv/eslint-config/blob/main/eslint10/rules/no-vue-component-variable-name-conflict/README.md)：用于禁止 Vue `<script setup>` 中的组件导入名和 lower camel 本地声明产生命名冲突。
 
-- no-debugger
-- no-unused-vars
-- no-constant-condition
-- no-empty
-- sonarjs/no-duplicate-string
-- @typescript-eslint/no-unused-vars
-- @typescript-eslint/explicit-module-boundary-types
+## Prettier 配置
+
+消费项目如果需要单独给 Prettier 使用共享配置，可以引入：
+
+```javascript
+// prettier.config.mjs
+import prettierConfig from '@polyv/eslint-config/prettier-config';
+
+export default prettierConfig;
+```

package/configs/common/README.md

@@ -0,0 +1,87 @@
+# 通用配置
+
+`polyv.configs.common` 是接入本包预设配置时必须显式组合的基础配置。
+
+## 使用方式
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common
+];
+```
+
+也可以通过子路径单独引入：
+
+```javascript
+// eslint.config.mjs
+import common from '@polyv/eslint-config/configs/common';
+
+export default [
+  ...common
+];
+```
+
+## 配置内容
+
+- 配置通用忽略项：`node_modules/`、`dest/`、`dist/`、`.dist/`、`coverage/`、`pnpm-lock.yaml`、`package-lock.json`。
+- 会递归读取运行 ESLint 时消费项目目录内的 `.gitignore`，让不提交到 git 的产物文件也进入 ESLint 忽略范围；扫描时会跳过 `.git`、`node_modules`、`dest`、`dist`、`.dist`、`coverage`。
+- 默认注册 `polyv` plugin；如果已经引用 `polyv.configs.common`，消费项目无需额外注册该插件。
+- 继承 [Import-X 配置](../importx/README.md)，启用 `eslint-plugin-import-x` 推荐规则和 node resolver。
+- 启用 `eslint-plugin-promise` 的 `flat/recommended` 配置。
+- 继承 [SonarJS 配置](../sonarjs/README.md)，启用 `eslint-plugin-sonarjs` 推荐规则和项目内覆盖规则。
+
+## 规则命名
+
+导入相关规则使用 `import-x/...` 命名空间，例如：
+
+```javascript
+// eslint.config.mjs
+{
+  rules: {
+    'import-x/no-duplicates': 'error'
+  }
+}
+```
+
+## 插件用法
+
+如果没有使用 `polyv.configs.common`，但需要单独启用 Polyv 自定义规则，可以手动注册插件：
+
+```javascript
+// eslint.config.mjs
+import { plugin as polyvPlugin } from '@polyv/eslint-config';
+
+export default [
+  {
+    plugins: {
+      polyv: polyvPlugin
+    },
+    rules: {
+      'polyv/explicit-module-boundary-types': 'error',
+      'polyv/no-relative-directory-index-imports': 'error'
+    }
+  }
+];
+```
+
+也可以从子路径单独引入 plugin：
+
+```javascript
+// eslint.config.mjs
+import polyvPlugin from '@polyv/eslint-config/plugin';
+
+export default [
+  {
+    plugins: {
+      polyv: polyvPlugin
+    },
+    rules: {
+      'polyv/explicit-module-boundary-types': 'error',
+      'polyv/no-relative-directory-index-imports': 'error'
+    }
+  }
+];
+```

package/configs/common/index.mjs

@@ -0,0 +1,86 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { includeIgnoreFile } from 'eslint/config';
+import promisePlugin from 'eslint-plugin-promise';
+import importx from '../importx/index.mjs';
+import sonarjs from '../sonarjs/index.mjs';
+import polyvPlugin from '../../plugin.mjs';
+
+const skippedGitignoreSearchDirectories = new Set([
+  '.git',
+  'node_modules',
+  'dest',
+  'dist',
+  '.dist',
+  'coverage'
+]);
+
+function findGitignoreFiles(root) {
+  const gitignoreFiles = [];
+  const pendingDirectories = [root];
+
+  while (pendingDirectories.length > 0) {
+    const directory = pendingDirectories.pop();
+
+    let entries;
+    try {
+      entries = fs.readdirSync(directory, { withFileTypes: true });
+    } catch {
+      continue;
+    }
+
+    for (const entry of entries) {
+      const entryPath = path.join(directory, entry.name);
+
+      if (entry.isFile() && entry.name === '.gitignore') {
+        gitignoreFiles.push(entryPath);
+        continue;
+      }
+
+      if (entry.isDirectory() && !skippedGitignoreSearchDirectories.has(entry.name)) {
+        pendingDirectories.push(entryPath);
+      }
+    }
+  }
+
+  return gitignoreFiles;
+}
+
+const consumerRoot = fs.realpathSync(process.cwd());
+const consumerGitignorePaths = findGitignoreFiles(consumerRoot);
+const consumerGitignoreConfig = consumerGitignorePaths.length > 0
+  ? includeIgnoreFile(consumerGitignorePaths, {
+      // 读取消费项目内的 .gitignore，让未提交到 git 的产物文件也进入 ESLint 忽略范围。
+      gitignoreResolution: true,
+      name: 'polyv/consumer-gitignore'
+    })
+  : [];
+
+export default [
+  ...consumerGitignoreConfig,
+  {
+    ignores: [
+      'node_modules/**',
+      '**/node_modules/**',
+      'dest/**',
+      '**/dest/**',
+      'dist/**',
+      '**/dist/**',
+      '.dist/**',
+      '**/.dist/**',
+      'coverage/**',
+      'pnpm-lock.yaml',
+      'package-lock.json'
+    ]
+  },
+  {
+    plugins: {
+      // 注册 Polyv 自定义规则插件，供各场景配置按需启用 polyv/* 规则。
+      polyv: polyvPlugin
+    }
+  },
+  ...importx,
+  // 启用 promise 推荐规则，检查 Promise 常见错误写法。
+  promisePlugin.configs['flat/recommended'],
+  ...sonarjs
+];

package/configs/importx/README.md

@@ -0,0 +1,51 @@
+# Import-X 配置
+
+`polyv.configs.importx` 用于提供 `eslint-plugin-import-x` 的推荐规则和 Node resolver 配置。
+
+## 使用方式
+
+通常不需要单独引入该配置，`polyv.configs.common` 已经继承了 `polyv.configs.importx`：
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common
+];
+```
+
+如果只需要 import-x 能力，也可以单独组合：
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.importx
+];
+```
+
+也可以通过子路径单独引入：
+
+```javascript
+// eslint.config.mjs
+import importx from '@polyv/eslint-config/configs/importx';
+
+export default [
+  ...importx
+];
+```
+
+## 配置内容
+
+- 启用 `eslint-plugin-import-x` 的 `flatConfigs.recommended`。
+- 通过 `import-x/ignore` 忽略 `vite-plugin-dts`，避免该包 ESM/CJS 导出形态差异触发 import-x 误报。
+- 配置 `import-x/resolver` 使用 node resolver。
+- resolver 扩展名包含 `.js`、`.cjs`、`.mjs`、`.jsx`、`.ts`、`.tsx`、`.mts`、`.cts`、`.d.ts`。
+- 集中维护导入导出规则，例如 `import-x/default`、`import-x/export`、`import-x/first`、`import-x/named`、`import-x/namespace`、`import-x/no-absolute-path`、`import-x/no-duplicates`、`import-x/no-named-as-default`、`import-x/no-named-default`、`import-x/no-unresolved` 和 `import-x/no-webpack-loader-syntax`。
+- 针对本包自身的 `eslint.config.mjs` 关闭 `import-x/no-named-as-default-member`，避免默认导出访问 `configs` 时误报。
+
+## 注意事项
+
+ESLint 10 下的 import 能力按 `eslint-plugin-import-x` README 的写法接入，使用 `import { importX } from 'eslint-plugin-import-x'` 和 `import-x/...` 规则命名空间。

package/configs/importx/index.mjs

@@ -0,0 +1,52 @@
+import { importX } from 'eslint-plugin-import-x';
+
+export default [
+  // 启用 import-x 推荐规则，检查导入导出正确性和常见导入问题。
+  importX.flatConfigs.recommended,
+  {
+    settings: {
+      // import-x/ignore 匹配的是解析后的路径；vite-plugin-dts 已覆盖该包的 ESM/CJS 导出形态差异，避免 import-x 产生误报。
+      'import-x/ignore': ['vite-plugin-dts'],
+      'import-x/resolver': {
+        node: {
+          extensions: ['.js', '.cjs', '.mjs', '.jsx', '.ts', '.tsx', '.mts', '.cts', '.d.ts']
+        }
+      }
+    },
+    rules: {
+      // 检查默认导入是否真实存在。
+      'import-x/default': 'error',
+      // 检查导出语句是否有效。
+      'import-x/export': 'error',
+      // 要求 import 语句放在文件顶部。
+      'import-x/first': 'error',
+      // 检查具名导入是否真实存在。
+      'import-x/named': 'error',
+      // 检查命名空间导入后的成员访问是否真实存在。
+      'import-x/namespace': 'error',
+      // 禁止使用绝对路径导入。
+      'import-x/no-absolute-path': ['error', {
+        esmodule: true,
+        commonjs: true,
+        amd: false
+      }],
+      // 禁止重复导入同一个模块。
+      'import-x/no-duplicates': 'error',
+      // 警告容易和默认导入混淆的具名导出命名。
+      'import-x/no-named-as-default': 'warn',
+      // 禁止用具名方式导入 default。
+      'import-x/no-named-default': 'error',
+      // 当前项目不检查路径解析，避免别名和构建工具路径误报。
+      'import-x/no-unresolved': 'off',
+      // 禁止在导入路径中使用 webpack loader 语法。
+      'import-x/no-webpack-loader-syntax': 'error'
+    }
+  },
+  {
+    files: ['eslint.config.mjs'],
+    rules: {
+      // 本包自检配置通过默认导出访问 configs，关闭 import-x 的默认成员误报。
+      'import-x/no-named-as-default-member': 'off'
+    }
+  }
+];

package/configs/js/README.md

@@ -0,0 +1,34 @@
+# JavaScript 配置
+
+`polyv.configs.js` 用于纯 JavaScript 项目。它包含 `@eslint/js` 的推荐配置，并迁移 ESLint 8 `for-js.js` 中仍适用于 ESLint 10 的规则语义。
+
+## 使用方式
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.js
+];
+```
+
+纯 JavaScript 项目使用 `configs.js`；TypeScript 或 TypeScript + JavaScript 混合项目应使用 `configs.ts`，因为 `configs.ts` 已经集成 `configs.js`。
+
+## 配置内容
+
+- 启用 `@eslint/js` 的 `js.configs.recommended`。
+- 配置 JavaScript 文件范围：`**/*.{js,cjs,mjs,jsx}`。
+- 注入 browser 和 node 全局变量。
+- 迁移基础代码风格规则，例如分号、函数括号前空格、操作符换行、尾逗号、空行和尾随空格。
+- 迁移基础质量规则，例如 `no-debugger`、`no-unused-vars`、`no-use-before-define`、`no-var`、`no-empty`。
+- 迁移 `promise` 相关规则；相关插件由 `polyv.configs.common` 统一提供。
+- `import-x` 相关规则统一放在 `polyv.configs.importx` 中，并由 `polyv.configs.common` 继承。
+- `sonarjs` 相关规则统一放在 `polyv.configs.sonarjs` 中，并由 `polyv.configs.common` 继承。
+
+## 注意事项
+
+- `configs.js` 不注册 `polyv`、`import-x`、`promise` 或 `sonarjs` 插件，也不维护 `import-x/*` 或 `sonarjs/*` 规则。
+- 接入时必须显式组合 `polyv.configs.common`，否则 `import-x/*`、`promise/*`、`sonarjs/*` 规则无法加载。
+- `.cjs` 文件会被设置为 `sourceType: 'commonjs'`。

package/configs/js/index.mjs

@@ -0,0 +1,104 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import { devWarnProdError } from '../../utils.mjs';
+
+const jsFiles = ['**/*.{js,cjs,mjs,jsx}'];
+
+export default [
+  js.configs.recommended,
+  {
+    files: jsFiles,
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      }
+    },
+    rules: {
+      // 要求语句结尾必须使用分号。
+      semi: ['error', 'always'],
+      // 约束函数括号前空格：普通函数不留空格，async 箭头函数留空格。
+      'space-before-function-paren': ['error', {
+        anonymous: 'never',
+        named: 'never',
+        asyncArrow: 'always'
+      }],
+      // 要求操作符换行时放在行尾，但三元表达式的问号和冒号放在行首。
+      'operator-linebreak': ['error', 'after', {
+        overrides: {
+          '?': 'before',
+          ':': 'before'
+        }
+      }],
+      // 只允许多行结构使用尾逗号，单行结构不允许。
+      'comma-dangle': ['error', 'only-multiline'],
+      // 禁止行尾空格，但允许注释中保留尾随空格。
+      'no-trailing-spaces': ['error', {
+        ignoreComments: true
+      }],
+      // 限制连续空行最多 2 行。
+      'no-multiple-empty-lines': ['error', {
+        max: 2
+      }],
+      // 要求立即执行函数的调用括号包在函数表达式内部。
+      'wrap-iife': ['error', 'inside'],
+      // 禁止可能与比较运算混淆的箭头函数写法。
+      'no-confusing-arrow': 'error',
+      // 允许代码块内出现首尾空行。
+      'padded-blocks': 'off',
+
+      // 要求标识符使用驼峰命名。
+      camelcase: 'error',
+      // 禁止 debugger；生产环境报错，其他环境警告。
+      'no-debugger': devWarnProdError,
+      // 检查未使用变量；生产环境报错，其他环境警告。
+      'no-unused-vars': [devWarnProdError, {
+        vars: 'all',
+        args: 'after-used',
+        ignoreRestSiblings: true,
+        caughtErrors: 'none'
+      }],
+      // 允许变量赋值后未再被读取，避免历史代码中的中间赋值触发新规则。
+      'no-useless-assignment': 'off',
+      // 禁止变量在定义前使用，但允许函数和类提前使用。
+      'no-use-before-define': ['error', {
+        functions: false,
+        classes: false,
+        variables: true
+      }],
+      // 禁止在循环中定义可能捕获循环变量的函数。
+      'no-loop-func': 'error',
+      // 禁止使用 javascript: URL。
+      'no-script-url': 'error',
+      // 允许只实例化对象而不保存返回值。
+      'no-new': 'off',
+      // 禁止常量条件；生产环境报错，其他环境警告。
+      'no-constant-condition': devWarnProdError,
+      // 禁止空代码块，但允许空 catch。
+      'no-empty': [devWarnProdError, {
+        allowEmptyCatch: true
+      }],
+      // 允许 else 中只有一个 if。
+      'no-lonely-if': 'off',
+      // 禁止 var，统一使用 let 或 const。
+      'no-var': 'error',
+      // 允许普通字符串里出现类似模板字符串占位符的文本。
+      'no-template-curly-in-string': 'off',
+      // 要求 Promise reject 使用 Error 对象。
+      'prefer-promise-reject-errors': 'error',
+
+      // 检查 Promise 构造函数参数命名。
+      'promise/param-names': 'error',
+      // 建议使用 async/await 替代 then 链。
+      'promise/prefer-await-to-then': 'warn',
+    }
+  },
+  {
+    files: ['**/*.{cjs}'],
+    languageOptions: {
+      sourceType: 'commonjs'
+    }
+  }
+];

package/configs/miniprogram/README.md

@@ -0,0 +1,50 @@
+# 小程序配置
+
+`polyv.configs.miniprogram` 用于微信小程序项目，重点处理小程序 npm 构建后的相对目录 `index` 解析问题。
+
+## 使用方式
+
+```javascript
+// eslint.config.mjs
+import polyv from '@polyv/eslint-config';
+
+export default [
+  ...polyv.configs.common,
+  ...polyv.configs.miniprogram
+];
+```
+
+如果项目使用 TypeScript，请在消费项目自己的 ESLint 配置中先配置 TypeScript parser，再叠加 `polyv.configs.common` 和 `polyv.configs.miniprogram`。
+
+## 配置内容
+
+- 忽略微信小程序构建 npm 后生成的 `miniprogram_npm/` 目录。
+- 注入小程序全局变量：`App`、`Component`、`Page`、`getApp`、`wx`。
+- 关闭 `import-x/no-useless-path-segments`，避免它建议移除显式 `/index`，从而和小程序路径要求冲突。
+- 开启 `polyv/no-relative-directory-index-imports`，禁止依赖相对目录的 `index` 文件兜底解析。
+- 单元测试相关文件会关闭 `polyv/no-relative-directory-index-imports`，包括 `test/`、`tests/`、`__test__/`、`__tests__/` 目录，以及 `*.test.*`、`*.spec.*` 文件。
+
+## 自定义规则
+
+`polyv/no-relative-directory-index-imports` 用于禁止这类写法：
+
+```javascript
+// bad.js
+import helper from './helper';
+const utils = require('./utils');
+```
+
+应显式写成：
+
+```javascript
+// good.js
+import helper from './helper/index';
+const utils = require('./utils/index');
+```
+
+该规则同时处理 `./`、`.`、`../`、`..` 等目录入口写法。
+
+## 注意事项
+
+- `polyv` plugin 由 `polyv.configs.common` 统一注册。
+- `configs.miniprogram` 不内联引入 `common`，消费项目必须显式组合 `polyv.configs.common`。