eslint-plugin-light 1.0.18 → 1.0.19

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## <small>1.0.19 (2025-12-12)</small>
+
+* chore: update docs ([dc64df7](https://github.com/novlan1/plugin-light/commits/dc64df7))
+* chore: update docs ([bd72447](https://github.com/novlan1/plugin-light/commits/bd72447))
+* chore: update t-comm@2.0.16 ([8c5d294](https://github.com/novlan1/plugin-light/commits/8c5d294))
+* chore: use updateManifestCore of t-comm ([1c149ab](https://github.com/novlan1/plugin-light/commits/1c149ab))
+* chore(eslint-plugin-light): add no-non-index-import ([64a7b0b](https://github.com/novlan1/plugin-light/commits/64a7b0b))
+* docs: update docs ([43f864d](https://github.com/novlan1/plugin-light/commits/43f864d))
+* docs: update docs ([c88907f](https://github.com/novlan1/plugin-light/commits/c88907f))
+
+
+
 ## <small>1.0.18 (2025-08-08)</small>
 
 * feat(eslint): add no-decimal-in-brackets rule ([a4c2b0d](https://github.com/novlan1/plugin-light/commits/a4c2b0d))

package/README.md

@@ -11,7 +11,11 @@
 
 简单、易用的 ESLint 插件库。
 
-## 1. 安装
+## 1. 作者
+
+**novlan1**
+
+## 2. 安装
 
 首先要安装 [ESLint](https://eslint.org/)。
 
@@ -25,7 +29,7 @@ pnpm i eslint -D
 npm i eslint-plugin-light -D
 ```
 
-## 2. 使用
+## 3. 使用
 
 在 `.eslintrc` 配置文件的 `plugins` 中增加本插件 `eslint-plugin-light`，或者省略 `eslint-plugin-` 前缀。
 
@@ -55,9 +59,9 @@ npm i eslint-plugin-light -D
 }
 ```
 
-## 3. 规则
+## 4. 规则
 
-### 3.1. valid-vue-comp-import
+### 4.1. valid-vue-comp-import
 
 禁止从 `js` 文件中加载 `Vue` 组件。
 
@@ -112,7 +116,7 @@ import CComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-new/comp/d.vue';
 ```
 
-### 3.2. no-plus-turn-number
+### 4.2. no-plus-turn-number
 
 禁止在 `vue` 的 `template` 中用 `+` 号转换字符串为数字
 
@@ -132,7 +136,7 @@ import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 />
 ```
 
-### 3.3. no-complex-key
+### 4.3. no-complex-key
 
 不要在`vue`模板中使用复杂的`key`。包括：
 
@@ -172,7 +176,7 @@ getData() {
 `uni-app`中，`key`重复的话，会造成挂载在组件上面的事件参数为`undefined`，从而不成功。
 
 
-### 3.4. json-parse-try-catch
+### 4.4. json-parse-try-catch
 
 `JSON.parse` 应该加 `try catch`。
 
@@ -197,7 +201,7 @@ module.exports = {
 }
 ```
 
-### 3.5. no-import-all-in-one-api
+### 4.5. no-import-all-in-one-api
 
 使用 `src/api` 子仓库时， 不应该导入全部接口，而应该按需引入。
 
@@ -263,7 +267,7 @@ module.exports = {
 
 <img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/5/own_mike_rfMPwBYtZmhXrthT.png" width="600">
 
-### 3.6. no-js-file
+### 4.6. no-js-file
 
 运行时文件不允许使用 `js/jsx`，只允许 `ts/tsx`。子工程的 `config.js` 会自动排除。
 
@@ -291,7 +295,7 @@ module.exports = {
 | include | 检查的列表，`glob` 模式 | `['src/{project,local-component,local-logic}/**/*.{js,jsx}']` |
 | exclude | 排除的列表，`glob` 模式 | `['src/project/*/config.js']`                                 |
 
-### 3.7. valid-file-name
+### 4.7. valid-file-name
 
 文件命名格式只允许使用 [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case)。子工程的 `App.vue` 会自动排除。
 
@@ -321,7 +325,7 @@ module.exports = {
 | include | 检查的列表，`glob` 模式 | `['src/**/*']`              |
 | exclude | 排除的列表，`glob` 模式 | `['src/project/*/App.vue']` |
 
-### 3.8. no-multiple-script
+### 4.8. no-multiple-script
 
 禁止 Vue 文件中存在多个 `<script>`。
 
@@ -342,8 +346,7 @@ module.exports = {
 
 <img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/5/own_mike_w7ADssRftSYE6myr.png" width="900">
 
-
-### 3.9. valid-spelling
+### 4.9. valid-spelling
 
 校验正确的拼写，比如不能用"帐号"，要使用"账号"，不能使用"登陆",要使用"登录"。
 
@@ -368,7 +371,7 @@ module.exports = {
 | -------- | ------------------------ | -------------------------------- |
 | spelling | 错误拼写和正确拼写的映射 | `{ 帐号: '账号', 登陆: '登录' }` |
 
-### 3.10. valid-shaohou
+### 4.10. valid-shaohou
 
 校验正确的"稍候"和"稍后"，稍候后面不加词，稍后后面需要加词，比如"请稍候/请稍后再试"。
 
@@ -387,7 +390,7 @@ module.exports = {
 }
 ```
 
-### 3.11. classname-per-line
+### 4.11. classname-per-line
 
 限制 Vue 中每行只有`1`个CSS类名，可以配置阈值。
 
@@ -412,7 +415,7 @@ module.exports = {
 | ------ | -------------------------------- | ------ |
 | counts | 检查阈值，小于阈值时，可以在一行 | `3`    |
 
-### 3.12. img-v-lazy
+### 4.12. img-v-lazy
 
 强制 `img` 标签使用 `v-lazy` 而不是 `:src`，可用于 Vue 项目中。
 
@@ -431,11 +434,11 @@ module.exports = {
 }
 ```
 
-### 3.13. no-direct-img-src
+### 4.13. no-direct-img-src
 
 在 `jsx/tsx` 中禁止直接使用 `img src`，必须使用封装的 [`CdnImage` 组件](https://novlan1.github.io/docs/press-pix/zh-CN/cdn-image.html)，可用于 React 项目中。
 
-与 [img-v-lazy 规则](#_3-12-img-v-lazy) 类似，都是为了防止直接使用 COS 图片，而不是 CDN 图片。
+与 [img-v-lazy 规则](#_4-12-img-v-lazy) 类似，都是为了防止直接使用 COS 图片，而不是 CDN 图片。
 
 Usage:
 
@@ -463,7 +466,7 @@ module.exports = {
 | ------------- | ---------------------- | ---------- |
 | componentName | 提示词中的自定义组件名 | `CdnImage` |
 
-### 3.14. no-todo-comment
+### 4.14. no-todo-comment
 
 不允许存在 TODO。可防止调试代码被意外带到线上。
 
@@ -488,7 +491,79 @@ module.exports = {
 | ------- | ---------- | ------- |
 | keyword | 检查关键词 | `TODO:` |
 
-### 3.15. no-decimal-in-brackets
+### 4.15. no-non-index-import
+
+限制只能从 `pmd-*` 包的 `lib` 目录下的模块第一层 `index` 引入，禁止从非 `index` 文件引入。
+
+目的是为了保证模块导入的规范性，避免直接导入包内的具体实现文件，便于包的维护和重构。
+
+允许的导入格式：
+
+```js
+// ✅ 直接导入模块（隐式index）
+import Toast from 'pmd-widget/lib/toast';
+import EventBus from 'pmd-tools/lib/e-bus';
+
+// ✅ 显式导入index文件
+import Toast from 'pmd-widget/lib/toast/index';
+import EventBus from 'pmd-tools/lib/e-bus/index';
+
+// ✅ 导入目录（隐式index）
+import * as Utils from 'pmd-tools/lib/utils/';
+```
+
+禁止的导入格式：
+
+```js
+// ❌ 直接导入非index文件
+import ToastComponent from 'pmd-widget/lib/toast/Toast.vue';
+import helper from 'pmd-tools/lib/utils/helper.js';
+
+// ❌ 多级目录的非index文件
+import DeepComponent from 'pmd-widget/lib/toast/components/Modal.vue';
+```
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-non-index-import': 2,
+  },
+}
+```
+
+配置选项：
+
+| 字段    | 说明                           | 默认值  |
+| ------- | ------------------------------ | ------- |
+| exclude | 排除的导入路径前缀数组         | `[]`    |
+
+例如，排除特定包的检查：
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-non-index-import': [2, {
+      exclude: [
+        'pmd-special/lib',
+      ]
+    }],
+  },
+}
+```
+
+### 4.16. no-decimal-in-brackets
 
 禁止在方括号类名中使用小数点。背景：
 
@@ -517,6 +592,6 @@ module.exports = {
 | ------ | -------- | ----------------------------------- |
 | regexp | 匹配正则 | `/\[[^\](]*\.\d+[a-zA-Z]+[^\]]*\]/` |
 
-## 4. 更新日志
+## 5. 更新日志
 
 [点此查看](./CHANGELOG.md)

package/lib/rules/no-non-index-import.js

@@ -0,0 +1,142 @@
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '限制只能从目录第一层index引入，禁止从非index文件引入',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    fixable: null,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          exclude: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+
+  create(context) {
+    const options = context.options?.[0] || {};
+    const exclude = options.exclude || [];
+    return {
+      ImportDeclaration(node) {
+        const importPath = node.source.value;
+
+        if (!importPath.startsWith('pmd-')) {
+          return;
+        }
+
+        // 解析路径
+        const parsed = parseImportPath(importPath);
+        if (!parsed) {
+          return;
+        }
+
+        const foundExcludePrefix = exclude.find(item => importPath.startsWith(item));
+        if (foundExcludePrefix) {
+          return;
+        }
+
+        // 检查是否是允许的导入模式
+        if (!isValidImport(parsed)) {
+          context.report({
+            node,
+            message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index',
+          });
+        }
+      },
+    };
+  },
+};
+
+function parseImportPath(importPath) {
+  // 匹配 pmd-widget/lib/toast 或 pmd-tools/lib/time
+  const pattern = /^@tencent\/(pmd-(?:[\w-]+))\/lib\/(.+)/;
+  const match = importPath.match(pattern);
+
+  if (!match) {
+    return null;
+  }
+
+  const packageName = match[1];
+  const remainingPath = match[2];
+
+  // 移除末尾的斜杠
+  const normalizedPath = remainingPath.endsWith('/')
+    ? remainingPath.slice(0, -1)
+    : remainingPath;
+
+  // 分割路径
+  const parts = normalizedPath.split('/');
+
+  // 获取文件名
+  const lastPart = parts[parts.length - 1];
+  const isIndexFile = lastPart === 'index';
+
+  // 判断是否是目录（以斜杠结尾或最后一部分是index）
+  const isDirectory = importPath.endsWith('/') || isIndexFile;
+
+  // 获取真正的模块名
+  let moduleName = parts[0];
+  let subPath = '';
+
+  if (parts.length > 1 && parts[parts.length - 1] === 'index') {
+    // 如果是 package/lib/module/index 格式
+    moduleName = parts[0];
+    subPath = parts.slice(0, -1).join('/');
+  } else {
+    moduleName = parts[0];
+    subPath = normalizedPath;
+  }
+
+  return {
+    packageName,
+    libPath: remainingPath,
+    fullPath: normalizedPath,
+    moduleName,
+    fileName: lastPart,
+    isIndexFile,
+    isDirectory,
+    parts,
+    subPath,
+  };
+}
+
+function isValidImport(parsed) {
+  const { parts, fileName, isDirectory, isIndexFile } = parsed;
+
+  // 情况1: 直接导入模块根目录（隐式index）
+  // 如: pmd-widget/lib/toast
+  if (parts.length === 1) {
+    return true;
+  }
+
+  // 情况2: 导入目录（以斜杠结尾），隐式index
+  // 如: pmd-tools/lib/e-bus/
+  if (isDirectory && !isIndexFile) {
+    return true;
+  }
+
+  // 情况3: 显式导入index文件
+  // 如: pmd-widget/lib/toast/index
+  if (isIndexFile && parts.length === 2 && fileName === 'index') {
+    return true;
+  }
+
+  // 情况4: 如果有多级目录，但最后一级是index，且总共只有两级
+  // 如: package/lib/module/index
+  if (parts.length === 2 && fileName === 'index') {
+    return true;
+  }
+
+  // 其他情况都是不允许的
+  return false;
+}

package/lib/test/index.js

@@ -0,0 +1,5 @@
+require('./no-decimal-in-brackets');
+require('./no-direct-img-src');
+require('./no-non-index-import');
+
+console.log('所有测试通过！');

package/lib/test/no-non-index-import.js

@@ -0,0 +1,55 @@
+const { RuleTester } = require('eslint');
+
+const rule = require('../rules/no-non-index-import');
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2015,
+    sourceType: 'module',
+  },
+});
+
+ruleTester.run('no-non-index-import', rule, {
+  valid: [
+    // 正确的导入方式
+    'import { Toast } from \'pmd-widget/lib/toast\';',
+    'import { Toast } from \'pmd-widget/lib/toast/index\';',
+    'import { timeStampFormat } from \'pmd-tools/lib/time\';',
+    'import { getGlobalEBus } from \'pmd-tools/lib/e-bus/\';',
+    'import { something } from \'pmd-widget/lib/button\';',
+    'import { something } from \'pmd-widget/lib/button/index\';',
+
+    // 不相关的导入应该被忽略
+    'import React from \'react\';',
+    'import { something } from \'./local-module\';',
+    'import { something } from \'../utils\';',
+  ],
+
+  invalid: [
+    // 错误的导入方式
+    {
+      code: 'import { Toast } from \'pmd-widget/lib/toast/index-web\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+    {
+      code: 'import { timeStampFormat } from \'pmd-tools/lib/time/index-web\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+    {
+      code: 'import { getGlobalEBus } from \'pmd-tools/lib/e-bus/global\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+    {
+      code: 'import { something } from \'pmd-widget/lib/toast/utils\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+    {
+      code: 'import { something } from \'pmd-widget/lib/component/button\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+    {
+      code: 'import { something } from \'pmd-widget/lib/component/button\';',
+      errors: [{ message: '只能从目录第一层index引入。允许格式: package/lib/module 或 package/lib/module/index，禁止: package/lib/module/non-index' }],
+    },
+  ],
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-light",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "description": "Simple Eslint Plugin",
   "keywords": [
     "eslint",
@@ -27,7 +27,7 @@
   "dependencies": {
     "minimatch": "^10.0.1",
     "requireindex": "^1.2.0",
-    "t-comm": "^1.5.40"
+    "t-comm": "^3.0.3"
   },
   "devDependencies": {
     "@babel/core": "^7.18.9",
@@ -52,6 +52,7 @@
     "build": "rm -rf lib && node script/build",
     "bump": "node ../../script/monorepo/version-simple $PWD",
     "changelog": "node ../../script/monorepo/changelog $PWD",
-    "release": "node ../../script/monorepo/release $PWD"
+    "release": "node ../../script/monorepo/release $PWD",
+    "test": "node ./src/test/index.js"
   }
 }