eslint-plugin-light 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## <small>1.0.5 (2025-05-16)</small>
+
+* feat(eslint-plugin-light): add no-import-all-in-one-api rule ([f92123e](https://github.com/novlan1/plugin-light/commits/f92123e))
+* docs: update docs ([0721738](https://github.com/novlan1/plugin-light/commits/0721738))
+
+
+
 ## <small>1.0.4 (2025-04-18)</small>
 
 * chore: update license ([5ba3e91](https://github.com/novlan1/plugin-light/commits/5ba3e91))

package/README.md

@@ -1,6 +1,5 @@
 ## ESLint Plugin Light
 
-
 <p align="center">
   <img src="https://img.shields.io/npm/dw/eslint-plugin-light">
   <img src="https://img.shields.io/npm/unpacked-size/eslint-plugin-light">
@@ -10,25 +9,25 @@
   <img src="https://img.shields.io/github/created-at/novlan1/plugin-light">
 </p>
 
-Simple Eslint plugin.
+简单、易用的 ESLint 插件库。
 
-### 1. Installation
+### 1. 安装
 
-You need to install [ESLint](https://eslint.org/) first.
+首先要安装 [ESLint](https://eslint.org/)。
 
 ```sh
-npm i eslint -D
+pnpm i eslint -D
 ```
 
-Next, install `eslint-plugin-light`.
+然后安装本插件 `eslint-plugin-light`。
 
 ```sh
 npm i eslint-plugin-light -D
 ```
 
-### 2. Usage
+### 2. 使用
 
-Add `light` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+在 `.eslintrc` 配置文件的 `plugins` 中增加本插件 `eslint-plugin-light`，或者省略 `eslint-plugin-` 前缀。
 
 ```json
 {
@@ -38,8 +37,7 @@ Add `light` to the plugins section of your `.eslintrc` configuration file. You c
 }
 ```
 
-
-Then configure the rules you want to use under the rules section.
+然后配置你想使用的规则。
 
 ```json
 {
@@ -49,7 +47,7 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
-or use extends：
+也可以使用本工具提供的扩展。
 
 ```json
 {
@@ -57,16 +55,14 @@ or use extends：
 }
 ```
 
+### 3. 规则
 
-### 3. Supported Rules
-
-#### 3.1. light/valid-vue-comp-import
+#### 3.1. valid-vue-comp-import
 
-禁止从`js`文件中加载`Vue`组件
+禁止从 `js` 文件中加载 `Vue` 组件。
 
 比如，
 
-
 1. 导入地址是`js/ts`文件
 
 ```js
@@ -84,8 +80,6 @@ import SomeComp from 'src/local-component/ui/pages/user/account-manage/xxx.vue';
 
 注意上面的`xxx.vue`是从`index.js`中分析得到的原始文件路径。
 
-
-
 2. 导入一个目录，但目录存在`index.js`，这时候不管存不存在`index.vue`，`uni-app`转换都会失败
 
 ```js
@@ -118,9 +112,9 @@ 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. light/no-plus-turn-number
+#### 3.2. no-plus-turn-number
 
-禁止在`vue`的`template`中用`+`号转换字符串为数字
+禁止在 `vue` 的 `template` 中用 `+` 号转换字符串为数字
 
 比如：
 
@@ -130,7 +124,7 @@ import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 />
 ```
 
-如果加了`--fix`，会被转化成：
+如果加了 `--fix`，会被转化成：
 
 ```html
 <ScheduleItem
@@ -138,7 +132,7 @@ import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 />
 ```
 
-#### 3.3 no-complex-key
+#### 3.3. no-complex-key
 
 不要在`vue`模板中使用复杂的`key`。包括：
 
@@ -178,7 +172,7 @@ getData() {
 `uni-app`中，`key`重复的话，会造成挂载在组件上面的事件参数为`undefined`，从而不成功。
 
 
-#### 3.4  json-parse-try-catch
+#### 3.4. json-parse-try-catch
 
 `JSON.parse` 应该加 `try catch`。
 
@@ -190,7 +184,6 @@ JSON.parse(JSON.stringify(abc));
 
 可以配置 `strict` 参数为 `true`，开启检查。
 
-
 ```js
 // .eslintrc.js
 
@@ -203,3 +196,54 @@ module.exports = {
   },
 }
 ```
+
+#### 3.5. no-import-all-in-one-api
+
+使用 `src/api` 子仓库时， 不应该导入全部接口，而应该按需引入。
+
+Bad case:
+
+```js
+// bad
+import { pubg_fateClient } from 'src/api/git.a.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate.http';
+```
+
+Good case:
+
+```js
+// good
+import { QueryGameListHomePageClient } from 'src/api/git.a.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate/QueryGameListHomePage.http';
+```
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-import-all-in-one-api': 2,
+  },
+}
+```
+
+下面是一个案例，根据这个规则，对一个线上项目进行改造。仅仅改动了[几个文件的几行引入语句](https://git.a.com/pmd-mobile/match/gp-next/commit/20e0050fe10ed767dcb5d77dca76a9b51c23820e)，就减少了主包 `50KB`，效果立竿见影。
+
+之前：
+
+<img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/5/own_mike_p8Sr7F4zjtry4mtR.png" width="600">
+
+之后：
+
+<img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/5/own_mike_MJ8Q5QXEyamnGZXz.png" width="600">
+
+改动的几个文件：
+
+<img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/5/own_mike_rfMPwBYtZmhXrthT.png" width="600">
+
+### 4. 更新日志
+
+[点此查看](./CHANGELOG.md)

package/lib/rules/no-import-all-in-one-api.js

@@ -0,0 +1,50 @@
+const CORE_REG = /src\/api\/[\w.-_/]+\/[a-z][\w-]+.http(.ts)?$/;
+
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止从指定的文件中导入',
+      category: 'Possible Errors',
+      recommended: true,
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          excludes: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      restrictedImport: '不允许从 {{filePath}} 导入。',
+    },
+  },
+  create(context) {
+    // const projectRoot = context.settings.projectRoot ?? process.cwd();
+    const options = context.options[0] || {};
+    const excludes = options.excludes || [];
+
+    return {
+      ImportDeclaration(node) {
+        const sourceValue = node.source.value;
+
+        if (CORE_REG.test(sourceValue)
+          && !excludes.includes(sourceValue)
+        ) {
+          context.report({
+            node,
+            message: `不允许从 ${sourceValue} 导入全部接口，应按需导入`,
+          });
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-light",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Simple Eslint Plugin",
   "keywords": [
     "eslint",