@lsby/eslint-plugin 0.0.2

package/.prettierignore

@@ -0,0 +1,51 @@
+# 忽略 node_modules 目录
+node_modules/
+
+# 忽略所有日志文件
+*.log
+
+# 忽略构建输出目录
+dist/
+build/
+
+# 忽略环境变量文件
+.env
+.env.local
+.env.*.local
+
+# 忽略锁文件
+pnpm-lock.yaml
+yarn.lock
+package-lock.json
+
+# 忽略 IDE 配置文件
+.vscode/
+.idea/
+
+# 忽略临时文件
+*.tmp
+*.temp
+
+# 忽略特定文件类型
+*.min.js
+*.min.css
+
+# 忽略特定文件
+pnpm-lock.yaml
+
+# 忽略图片和其他媒体文件
+*.png
+*.jpg
+*.jpeg
+*.gif
+*.svg
+
+# 忽略压缩文件
+*.zip
+*.tar.gz
+*.rar
+
+# 忽略文档
+*.pdf
+*.docx
+*.xlsx

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "semi": false,
+  "endOfLine": "auto",
+  "singleQuote": true,
+  "plugins": ["prettier-plugin-packagejson", "@ianvs/prettier-plugin-sort-imports"],
+  "importOrder": ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^@([^/]+?)/(.*)$", "^[./]"]
+}

package/README.md

@@ -0,0 +1,39 @@
+# eslint-plugin
+
+## 概述
+
+一些自己写的eslint插件
+
+## 安装
+
+1. **安装包**
+
+    ```
+    npm i @lsby/eslint-plugin
+    ```
+
+2. **安装 ESLint**
+
+    确保你的项目中已安装 ESLint 和 TypeScript ESLint 解析器。如果尚未安装，可以使用以下命令进行安装：
+
+    ```
+    npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
+    ```
+
+3. **配置 ESLint**
+
+    在你的 ESLint 配置文件中引入并启用规则：
+
+    ```javascript
+    module.exports = {
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint'],
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended'
+      ],
+      rules: {
+        '@lsby/no-broken-link': 'error',
+      },
+    };
+    ```

package/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    'no-broken-link': require('./lib/rules/no-broken-link'),
+  },
+}

package/lib/rules/no-broken-link.js

@@ -0,0 +1,39 @@
+module.exports = {
+  meta: {
+      type: "problem", // 规则类型，可以是 "problem", "suggestion", 或 "layout"
+      docs: {
+          description: "Check for broken {@link} references in comments",
+          category: "Possible Errors",
+          recommended: false,
+      },
+      schema: [], // 规则的选项配置
+  },
+  create: function(context) {
+      return {
+          Program(node) {
+              const sourceCode = context.getSourceCode();
+              const comments = sourceCode.getAllComments();
+
+              comments.forEach(comment => {
+                  const matches = comment.value.match(/\{@link\s+([^\s}]+)\s*\}/g);
+
+                  if (matches) {
+                      matches.forEach(link => {
+                          const identifier = link.match(/\{@link\s+([^\s}]+)\s*\}/)[1];
+
+                          const variables = context.getScope().variables;
+                          const isDefined = variables.some(variable => variable.name === identifier);
+
+                          if (!isDefined) {
+                              context.report({
+                                  node: comment,
+                                  message: `The identifier "${identifier}" in {@link} is not defined.`,
+                              });
+                          }
+                      });
+                  }
+              });
+          }
+      };
+  }
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@lsby/eslint-plugin",
+  "version": "0.0.2",
+  "main": "index.js",
+  "scripts": {
+    "pub:public": "bumpp && npm publish --access public",
+    "test": "mocha test/**/*.test.js"
+  },
+  "devDependencies": {
+    "@ianvs/prettier-plugin-sort-imports": "^4.2.1",
+    "bumpp": "^9.5.1",
+    "chai": "^5.1.1",
+    "mocha": "^10.7.3",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.1"
+  },
+  "peerDependencies": {
+    "eslint": "^8.56.0"
+  },
+  "packageManager": "pnpm@9.5.0"
+}