eslint-plugin-light 1.0.15 → 1.0.18

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## <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))
+
+
+
+## <small>1.0.17 (2025-07-23)</small>
+
+* feat(eslint-plugin): add no-direct-img-src rule ([4223182](https://github.com/novlan1/plugin-light/commits/4223182))
+
+
+
+## <small>1.0.16 (2025-07-18)</small>
+
+* feat(eslint): add no-todo-comment rule ([8b555b7](https://github.com/novlan1/plugin-light/commits/8b555b7))
+
+
+
 ## <small>1.0.15 (2025-06-16)</small>
 
 * feat(eslint-plugin-light): add img v-lazy ([5807b47](https://github.com/novlan1/plugin-light/commits/5807b47))

package/README.md

@@ -205,14 +205,14 @@ Bad case:
 
 ```js
 // bad
-import { pubg_fateClient } from 'src/api/git.a.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate.http';
+import { pubg_fateClient } from 'src/api/git.aow.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';
+import { QueryGameListHomePageClient } from 'src/api/git.aow.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate/QueryGameListHomePage.http';
 ```
 
 Usage:
@@ -242,14 +242,14 @@ module.exports = {
   rules: {
     'light/no-import-all-in-one-api': [2, {
       excludes: [
-        'src/api/git.a.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate.http',
+        'src/api/git.aow.com/itrpcprotocol/esport/esport_cgi/pubg_fate/pubg_fate.http',
       ]
     }],
   },
 }
 ```
 
-下面是一个案例，根据这个规则，对一个线上项目进行改造。仅仅改动了[几个文件的几行引入语句](https://git.a.com/pmd-mobile/match/gp-next/commit/20e0050fe10ed767dcb5d77dca76a9b51c23820e)，就减少了主包 `50KB`，效果立竿见影。
+下面是一个案例，根据这个规则，对一个线上项目进行改造。仅仅改动了[几个文件的几行引入语句](https://git.aow.com/pmd-mobile/match/gp-next/commit/20e0050fe10ed767dcb5d77dca76a9b51c23820e)，就减少了主包 `50KB`，效果立竿见影。
 
 之前：
 
@@ -414,7 +414,7 @@ module.exports = {
 
 ### 3.12. img-v-lazy
 
-强制 `img` 标签使用 `v-lazy` 而不是 `:src`。
+强制 `img` 标签使用 `v-lazy` 而不是 `:src`，可用于 Vue 项目中。
 
 Usage:
 
@@ -431,6 +431,92 @@ module.exports = {
 }
 ```
 
+### 3.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 图片。
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-direct-img-src': 2,
+
+    // 传入参数
+    'light/no-direct-img-src': [2, {
+      componentName: 'MyCdnImage',
+    }],
+  },
+}
+```
+
+配置选项：
+
+| 字段          | 说明                   | 默认值     |
+| ------------- | ---------------------- | ---------- |
+| componentName | 提示词中的自定义组件名 | `CdnImage` |
+
+### 3.14. no-todo-comment
+
+不允许存在 TODO。可防止调试代码被意外带到线上。
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-todo-comment': 2,
+  },
+}
+```
+
+配置选项：
+
+| 字段    | 说明       | 默认值  |
+| ------- | ---------- | ------- |
+| keyword | 检查关键词 | `TODO:` |
+
+### 3.15. no-decimal-in-brackets
+
+禁止在方括号类名中使用小数点。背景：
+
+>小程序中不能使用 `pr-[.28rem]` 这种，可以使用 `pr-1.12`，同时在`tailwind.config.js` 中配置下 `theme.extend.padding = {1.12: '.28rem'}`。
+>
+>原因是`uni-app`会把`class`中的`[.`解析成`\[\`放到`wxss`中，导致编译错误。
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/no-decimal-in-brackets': 2,
+  },
+}
+```
+
+配置选项：
+
+| 字段   | 说明     | 默认值                              |
+| ------ | -------- | ----------------------------------- |
+| regexp | 匹配正则 | `/\[[^\](]*\.\d+[a-zA-Z]+[^\]]*\]/` |
+
 ## 4. 更新日志
 
 [点此查看](./CHANGELOG.md)

package/lib/rules/no-decimal-in-brackets.js

@@ -0,0 +1,53 @@
+const utils = require('eslint-plugin-vue/lib/utils');
+const TEST_REGEX = /\[[^\](]*\.\d+[a-zA-Z]+[^\]]*\]/;
+
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止在方括号类名中使用小数点',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          regexp: {
+            type: 'object',
+            default: TEST_REGEX,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create(context) {
+    const options = context.options[0] || {};
+    const regex = options.regexp ?? TEST_REGEX;
+
+    return utils.defineTemplateBodyVisitor(context, {
+      'VAttribute[key.name=\'class\']'(node) {
+        if (!node.value || node.value.type !== 'VLiteral') return;
+
+
+        const classValue = node.value.value.trim();
+
+
+        const classNames = classValue.split(/\s+/).filter(c => c.trim());
+        const errorList = classNames.filter(item => regex.test(item));
+
+        if (!errorList?.length) {
+          return;
+        }
+
+        context.report({
+          node,
+          loc: node.value.loc,
+          message: `禁止在方括号类名中使用小数点: ${errorList.join(', ')}`,
+        });
+      },
+    });
+  },
+};

package/lib/rules/no-direct-img-src.js

@@ -0,0 +1,43 @@
+const DEFAULT_COMPONENT_NAME = 'CdnImage';
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止直接使用 img src，必须使用封装的自定义组件',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    fixable: 'code',
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          componentName: {
+            type: 'string',
+            default: DEFAULT_COMPONENT_NAME,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create(context) {
+    return {
+      JSXOpeningElement(node) {
+        if (node.name.name === 'img') {
+          const srcAttribute = node.attributes.find(attr => attr.type === 'JSXAttribute' && attr.name.name === 'src');
+          const options = context.options[0] || {};
+          const componentName = options.componentName ?? DEFAULT_COMPONENT_NAME;
+
+          if (srcAttribute) {
+            context.report({
+              node,
+              message: `禁止直接使用 img src，必须使用封装的 ${componentName} 组件`,
+            });
+          }
+        }
+      },
+    };
+  },
+};

package/lib/rules/no-todo-comment.js

@@ -0,0 +1,42 @@
+const DEFAULT_KEYWORD = 'TODO:';
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止使用未规范的TODO注释',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          keyword: {
+            type: 'string',
+            default: DEFAULT_KEYWORD,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create(context) {
+    const sourceCode = context.getSourceCode();
+    const comments = sourceCode.getAllComments();
+
+    comments.forEach((comment) => {
+      const options = context.options[0] || {};
+      const keyword = options.keyword ?? DEFAULT_KEYWORD;
+
+      if (comment.value.includes(keyword)) {
+        context.report({
+          node: comment,
+          message: '不允许 TODO 存在',
+        });
+      }
+    });
+
+    return {};
+  },
+};

package/lib/test/no-decimal-in-brackets.js

@@ -0,0 +1,35 @@
+const { RuleTester } = require('eslint');
+
+const rule = require('../rules/no-decimal-in-brackets');
+
+const ERROR_MESSAGE = '禁止在方括号类名中使用小数点';
+const ruleTester = new RuleTester({
+  parser: require.resolve('vue-eslint-parser'),
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+});
+
+ruleTester.run('no-decimal-in-brackets', rule, {
+  valid: [
+    '<template><div class="pl-[1rem]"></div></template>',
+
+    '<template><div class="pl-[0.1]"></div></template>',  // 允许小数点后无字母
+    '<template><div class="bg-[red]"></div></template>',  // 允许纯字母
+    '<template><div class="text-[24]"></div></template>', // 允许纯数字
+
+    '<template><div class="bg-[rgba(0,0,0,.5)]"></div></template>',  // 允许函数中的小数点
+    '<template><div class="opacity-[.5]"></div></template>',  // 允许小数点前无数字
+  ],
+  invalid: [
+    {
+      code: '<template><div class=\'pl-[0.1rem]\'></div></template>',
+      errors: [{ message: `${ERROR_MESSAGE}: pl-[0.1rem]` }],
+    },
+    {
+      code: '<template><div class=\'text-[0.1rem] pl-[22.1px]\'></div></template>',
+      errors: [{ message: `${ERROR_MESSAGE}: text-[0.1rem], pl-[22.1px]` }],
+    },
+  ],
+});

package/lib/test/no-direct-img-src.js

@@ -0,0 +1,39 @@
+const { RuleTester } = require('eslint');
+
+const rule = require('../rules/no-direct-img-src');
+
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+});
+
+const ERROR_MESSAGE = '禁止直接使用 img src，必须使用封装的 CdnImage 组件';
+
+
+ruleTester.run('no-direct-img-src', rule, {
+  valid: [
+    {
+      code: '<CdnImage src="image.png" alt="example" />',
+    },
+    {
+      code: '<div><CdnImage src="image.jpg" /></div>',
+    },
+  ],
+  invalid: [
+    {
+      code: '<img src="image.png" alt="example" />',
+      errors: [{ message: ERROR_MESSAGE }],
+    },
+    {
+      code: '<img src={require("./image.jpg")} className="img" />',
+      errors: [{ message: ERROR_MESSAGE }],
+    },
+  ],
+});
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-light",
-  "version": "1.0.15",
+  "version": "1.0.18",
   "description": "Simple Eslint Plugin",
   "keywords": [
     "eslint",
@@ -38,7 +38,8 @@
     "eslint-plugin-eslint-plugin": "^4.0.1",
     "eslint-plugin-node": "^11.1.0",
     "mocha": "^9.1.3",
-    "standard-version": "^9.5.0"
+    "standard-version": "^9.5.0",
+    "vue-eslint-parser": "^9.4.3"
   },
   "peerDependencies": {
     "@babel/eslint-parser": ">=6",