eslint-plugin-light 1.0.19 → 1.0.20

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## <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))
+
+
+
 ## <small>1.0.19 (2025-12-12)</small>
 
 * chore: update docs ([dc64df7](https://github.com/novlan1/plugin-light/commits/dc64df7))

package/README.md

@@ -592,6 +592,71 @@ module.exports = {
 | ------ | -------- | ----------------------------------- |
 | regexp | 匹配正则 | `/\[[^\](]*\.\d+[a-zA-Z]+[^\]]*\]/` |
 
+### 4.17. valid-pmd-import
+
+禁止在 `packages/xx` 目录下引入对应的 `pmd-xx` 包，需要使用相对路径。
+
+这个规则主要用于 monorepo 项目中，防止包内部引入自己的发布版本，而是使用相对路径引入源码，避免循环依赖和版本不一致问题。
+
+比如，在 `packages/components` 目录下：
+
+```js
+// ❌ 错误：引入自己的包名
+import { Button } from 'pmd-components';
+const utils = require('pmd-components/lib/utils');
+
+// ✅ 正确：使用相对路径
+import { Button } from '../src';
+const utils = require('../../src/utils');
+```
+
+如果加了 `--fix`，会被自动转换为相对路径。
+
+Usage:
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/valid-pmd-import': 2,
+  },
+}
+```
+
+配置选项：
+
+| 字段    | 说明             | 默认值  |
+| ------- | ---------------- | ------- |
+| baseDir | 包源码的基础目录 | `'src'` |
+
+例如，如果你的包源码不在 `src` 目录：
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/valid-pmd-import': [2, {
+      baseDir: 'lib'
+    }],
+  },
+}
+```
+
+该规则会检查以下导入方式：
+
+- ES6 `import` 语句
+- CommonJS `require()` 调用
+- 动态 `import()` 表达式
+- `export ... from` 语句
+
 ## 5. 更新日志
 
 [点此查看](./CHANGELOG.md)

package/lib/rules/valid-pmd-import.js

@@ -0,0 +1,170 @@
+const path = require('path');
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止在 packages/xx 目录下引入对应的 pmd-xx 包，需要使用相对路径',
+      category: 'Best Practices',
+      recommended: false,
+    },
+    fixable: 'code',
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          baseDir: {
+            type: 'string',
+            description: '基础目录，默认为 src',
+            default: 'src',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+
+  create(context) {
+    const options = context.options[0] || {};
+    const baseDir = options.baseDir || 'src';
+
+    const filename = context.getFilename();
+    const absolutePath = path.resolve(filename);
+
+    // 提取当前包名
+    const getCurrentPackage = (filePath) => {
+      const normalizedPath = path.normalize(filePath);
+      const match = normalizedPath.match(/packages[\\/]([^\\/]+)/);
+      return match ? match[1] : null;
+    };
+
+    const currentPackage = getCurrentPackage(absolutePath);
+    if (!currentPackage) {
+      return {};
+    }
+
+    const pmdPackageName = `pmd-${currentPackage}`;
+
+    /**
+     * 获取应该使用的相对路径
+     */
+    const getRelativePath = (importPath, currentFilePath) => {
+      // 移除包名前缀
+      const subPath = importPath.replace(pmdPackageName, '').replace(/^\/lib/, '');
+
+      const currentDir = path.dirname(currentFilePath);
+
+      // 查找当前包的根目录
+      const parts = absolutePath.split(path.sep);
+      const packageIndex = parts.findIndex((part, index) => part === 'packages' && parts[index + 1] === currentPackage);
+
+      if (packageIndex === -1) {
+        return '.'; // 回退到当前目录
+      }
+
+      // 构建包的根路径
+      const packageRootParts = parts.slice(0, packageIndex + 2);
+      const packageRoot = packageRootParts.join(path.sep);
+
+      // 构建目标路径
+      const targetRelative = subPath ? `${baseDir}${subPath}` : baseDir;
+      const targetPath = path.join(packageRoot, targetRelative);
+
+      // 计算相对路径
+      let relativePath = path.relative(currentDir, targetPath);
+
+      // 处理特殊情况
+      if (relativePath === '') {
+        relativePath = '.';
+      } else if (!relativePath.startsWith('.')) {
+        relativePath = `./${relativePath}`;
+      }
+
+      // 标准化路径分隔符
+      relativePath = relativePath.replace(/\\/g, '/');
+
+      return relativePath;
+    };
+
+    /**
+     * 获取引号字符
+     */
+    const getQuoteChar = (node, sourceCode) => {
+      if (node.source) {
+        const text = sourceCode.getText(node.source);
+        return text[0]; // 第一个字符应该是引号
+      } if (node.arguments && node.arguments[0]) {
+        const text = sourceCode.getText(node.arguments[0]);
+        return text[0];
+      }
+      return '\''; // 默认使用单引号
+    };
+
+    /**
+     * 获取需要修复的节点
+     */
+    const getFixNode = (node) => {
+      if (node.source) return node.source;
+      if (node.arguments && node.arguments[0]) return node.arguments[0];
+      return node;
+    };
+
+    /**
+     * 检查并报告非法引入
+     */
+    const checkAndReport = (node, importPath) => {
+      if (importPath && importPath.startsWith(pmdPackageName)) {
+        const sourceCode = context.getSourceCode();
+        const fixNode = getFixNode(node);
+
+        context.report({
+          node: fixNode,
+          message: `禁止在 packages/${currentPackage} 目录下引入 ${pmdPackageName}，请使用相对路径`,
+          data: { importPath },
+          fix(fixer) {
+            const relativePath = getRelativePath(importPath, absolutePath);
+            const quoteChar = getQuoteChar(node, sourceCode);
+            return fixer.replaceText(fixNode, `${quoteChar}${relativePath}${quoteChar}`);
+          },
+        });
+      }
+    };
+
+    return {
+      ImportDeclaration(node) {
+        if (node.source && node.source.value) {
+          checkAndReport(node, node.source.value);
+        }
+      },
+
+      CallExpression(node) {
+        if (
+          node.callee
+          && node.callee.name === 'require'
+          && node.arguments.length > 0
+          && node.arguments[0].type === 'Literal'
+        ) {
+          checkAndReport(node, node.arguments[0].value);
+        }
+      },
+
+      ImportExpression(node) {
+        if (node.source && node.source.type === 'Literal') {
+          checkAndReport(node, node.source.value);
+        }
+      },
+
+      ExportNamedDeclaration(node) {
+        if (node.source && node.source.value) {
+          checkAndReport(node, node.source.value);
+        }
+      },
+
+      ExportAllDeclaration(node) {
+        if (node.source && node.source.value) {
+          checkAndReport(node, node.source.value);
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-light",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "Simple Eslint Plugin",
   "keywords": [
     "eslint",
@@ -27,7 +27,7 @@
   "dependencies": {
     "minimatch": "^10.0.1",
     "requireindex": "^1.2.0",
-    "t-comm": "^3.0.3"
+    "t-comm": "^3.0.22"
   },
   "devDependencies": {
     "@babel/core": "^7.18.9",