eslint-plugin-light 1.0.20 → 1.0.21

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## <small>1.0.21 (2026-01-04)</small>
+
+* feat(eslint-plugin-light): add no-src-imports-in-components rule ([b960951](https://github.com/novlan1/plugin-light/commits/b960951))
+
+
+
 ## <small>1.0.20 (2025-12-18)</small>
 
 * feat(project-config-pixui): add try-catch for version-info ([775fb7b](https://github.com/novlan1/plugin-light/commits/775fb7b))

package/README.md

@@ -657,6 +657,150 @@ module.exports = {
 - 动态 `import()` 表达式
 - `export ... from` 语句
 
+### 4.18. no-src-imports-in-components
+
+#### 4.18.1. 规则说明
+
+禁止在指定目录下使用特定前缀的导入路径，强制使用相对路径。这个规则主要用于确保某些目录（如 `src/components`）中的代码可以被独立发布为 npm 包，不依赖项目的绝对路径导入。
+
+#### 4.18.2. 为什么需要这个规则？
+
+当你的项目中某些目录（如 `src/components`）需要被发布为独立的 npm 包时，这些目录中的代码不应该使用项目特定的绝对路径（如 `src/...`），而应该使用相对路径。这样可以确保：
+
+1. 代码的可移植性
+2. 包的独立性
+3. 避免发布后的路径解析问题
+
+#### 4.18.3. 配置选项
+
+```typescript
+{
+  restrictedPaths: string[],    // 需要限制的目录路径列表
+  bannedPrefixes: string[],     // 禁止使用的导入路径前缀列表
+  message?: string              // 自定义错误消息（可选）
+}
+```
+
+#### 4.18.4. 使用示例
+
+##### 4.18.4.1. 基本用法（使用默认配置）
+
+```typescript
+// .eslintrc.js
+module.exports = {
+  rules: {
+    'light/no-src-imports-in-components': 'error',
+  },
+};
+```
+
+默认配置：
+
+- `restrictedPaths`: `['src/components']`
+- `bannedPrefixes`: `['src']`
+
+##### 4.18.4.2. 自定义配置
+
+```typescript
+// .eslintrc.js
+module.exports = {
+  rules: {
+    'light/no-src-imports-in-components': ['error', {
+      // 指定多个需要限制的目录
+      restrictedPaths: ['src/components', 'src/lib', 'packages/ui'],
+      
+      // 指定多个禁止的导入前缀
+      bannedPrefixes: ['src', '@/', '~/'],
+      
+      // 可选：自定义错误消息
+      message: '该目录将被发布为独立包，请使用相对路径导入',
+    }],
+  },
+};
+```
+
+##### 4.18.4.3. 只检查特定目录
+
+```typescript
+// .eslintrc.js
+module.exports = {
+  rules: {
+    'light/no-src-imports-in-components': ['error', {
+      restrictedPaths: ['src/components'],
+      bannedPrefixes: ['src'],
+    }],
+  },
+};
+```
+
+#### 4.18.5. 错误示例
+
+假设配置为：
+
+```typescript
+{
+  restrictedPaths: ['src/components'],
+  bannedPrefixes: ['src']
+}
+```
+
+在 `src/components/Button/Button.tsx` 中：
+
+```typescript
+// ❌ 错误：使用了 src 开头的导入
+import { back } from 'src/app/route/route';
+import { utils } from 'src/utils/helper';
+
+// ✅ 正确：使用相对路径
+import { back } from '../../app/route/route';
+import { utils } from '../../utils/helper';
+
+// ✅ 正确：导入 npm 包
+import React from 'react';
+import { Button } from 'antd';
+```
+
+#### 4.18.6. 配置参数详解
+
+##### 4.18.6.1. restrictedPaths
+
+类型：`string[]`  
+默认值：`['src/components']`
+
+指定需要应用此规则的目录列表。规则会检查文件路径是否包含这些目录。
+
+示例：
+
+```typescript
+restrictedPaths: ['src/components', 'src/lib', 'packages/ui']
+```
+
+##### 4.18.6.2. bannedPrefixes
+
+类型：`string[]`  
+默认值：`['src']`
+
+指定禁止使用的导入路径前缀列表。任何以这些前缀开头的导入都会被标记为错误。
+
+示例：
+
+```typescript
+bannedPrefixes: ['src', '@/', '~/']
+```
+
+##### 4.18.6.3. message
+
+类型：`string`  
+默认值：无（使用默认错误消息）
+
+自定义错误消息。如果不设置，将使用默认消息模板。
+
+示例：
+
+```typescript
+message: '该目录将被发布为独立的 npm 包，请使用相对路径导入'
+```
+
 ## 5. 更新日志
 
 [点此查看](./CHANGELOG.md)

package/lib/rules/no-src-imports-in-components.js

@@ -0,0 +1,101 @@
+'use strict';
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止在指定目录下使用特定前缀的导入路径，必须使用相对路径',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    fixable: null,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          restrictedPaths: {
+            type: 'array',
+            description: '需要限制的目录路径列表',
+            items: {
+              type: 'string',
+            },
+            default: ['src/components'],
+          },
+          bannedPrefixes: {
+            type: 'array',
+            description: '禁止使用的导入路径前缀列表',
+            items: {
+              type: 'string',
+            },
+            default: ['src', 'src/'],
+          },
+          message: {
+            type: 'string',
+            description: '自定义错误消息',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      noSrcImport: '在 {{directory}} 目录下不允许使用 "{{prefix}}" 开头的导入路径，请使用相对路径。该目录会被发布为独立的 npm 包。',
+      customMessage: '{{message}}',
+    },
+  },
+
+  create(context) {
+    // 获取配置选项
+    const options = context.options[0] || {};
+    const restrictedPaths = options.restrictedPaths || ['src/components'];
+    const bannedPrefixes = options.bannedPrefixes || ['src'];
+    const customMessage = options.message;
+
+    return {
+      ImportDeclaration(node) {
+        // 获取当前文件的绝对路径
+        const filename = context.getFilename();
+
+        // 标准化路径（统一使用正斜杠）
+        const normalizedPath = filename.replace(/\\/g, '/');
+
+        // 检查文件是否在任何受限目录下
+        const matchedDirectory = restrictedPaths.find((restrictedPath) => {
+          const normalizedRestrictedPath = restrictedPath.replace(/\\/g, '/');
+          return normalizedPath.includes(`/${normalizedRestrictedPath}/`)
+                 || normalizedPath.includes(`/${normalizedRestrictedPath}`);
+        });
+
+        if (!matchedDirectory) {
+          return;
+        }
+
+        // 获取导入路径
+        const importPath = node.source.value;
+
+        // 检查是否使用了任何被禁止的前缀
+        const matchedPrefix = bannedPrefixes.find(prefix => importPath === prefix || importPath.startsWith(`${prefix}/`));
+
+        if (matchedPrefix) {
+          if (customMessage) {
+            context.report({
+              node: node.source,
+              messageId: 'customMessage',
+              data: {
+                message: customMessage,
+              },
+            });
+          } else {
+            context.report({
+              node: node.source,
+              messageId: 'noSrcImport',
+              data: {
+                directory: matchedDirectory,
+                prefix: matchedPrefix,
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};

package/package.json

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