@huangjunsen/eslint-plugin 1.0.0 → 1.0.2

package/README.md

@@ -1,39 +1,39 @@
-# eslint-plugin-encode
-
-## 安装
-
-除了本包，你需要同时安装 [ESlint](https://eslint.org/)
-
-```shell
-$ npm install eslint-plugin-encode eslint --save-dev
-```
-
-## 使用
-
-### 引入插件
-
-```js
-// .eslintrc.js
-module.exports = {
-  plugin: ['eslint-config-encode'],
-  rules: {
-    'eslint-plugin-encode/no-secret-info': 'error',
-  },
-};
-```
-
-### 使用 presets
-
-```js
-// .eslintrc.js
-module.exports = {
-  extends: 'plugin:eslint-plugin-encode/recommended',
-};
-```
-
-## 支持的规则
-
-- [`no-broad-semantic-versioning`](https://encode-studio-fe.github.io/fe-spec/plugin/no-broad-semantic-versioning.html) 不要指定宽泛的版本范围
-- [`no-http-url`](https://encode-studio-fe.github.io/fe-spec/plugin/no-http-url.html) 使用 HTTPS 协议头的 URL，而不是 HTTP
-- [`no-js-in-ts-project`](https://encode-studio-fe.github.io/fe-spec/plugin/no-js-in-ts-project.html) 不要在 TS 项目中使用 JS
-- [`no-secret-info`](https://encode-studio-fe.github.io/fe-spec/plugin/no-secret-info.html) 不要在代码中直接设置 `password` `token` and `secret` 信息
+# eslint-plugin-encode
+
+## 安装
+
+除了本包，你需要同时安装 [ESlint](https://eslint.org/)
+
+```shell
+$ npm install eslint-plugin-encode eslint --save-dev
+```
+
+## 使用
+
+### 引入插件
+
+```js
+// .eslintrc.js
+module.exports = {
+  plugin: ['eslint-config-encode'],
+  rules: {
+    'eslint-plugin-encode/no-secret-info': 'error',
+  },
+};
+```
+
+### 使用 presets
+
+```js
+// .eslintrc.js
+module.exports = {
+  extends: 'plugin:eslint-plugin-encode/recommended',
+};
+```
+
+## 支持的规则
+
+- [`no-broad-semantic-versioning`](https://encode-studio-fe.github.io/fe-spec/plugin/no-broad-semantic-versioning.html) 不要指定宽泛的版本范围
+- [`no-http-url`](https://encode-studio-fe.github.io/fe-spec/plugin/no-http-url.html) 使用 HTTPS 协议头的 URL，而不是 HTTP
+- [`no-js-in-ts-project`](https://encode-studio-fe.github.io/fe-spec/plugin/no-js-in-ts-project.html) 不要在 TS 项目中使用 JS
+- [`no-secret-info`](https://encode-studio-fe.github.io/fe-spec/plugin/no-secret-info.html) 不要在代码中直接设置 `password` `token` and `secret` 信息

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import type { ESLint, Rule } from 'eslint';
+export declare const rules: Record<string, Rule.RuleModule>;
+declare const plugin: ESLint.Plugin;
+export declare const configs: {
+    recommended: {
+        plugins: {
+            '@huangjunsen': ESLint.Plugin;
+        };
+        rules: {
+            '@huangjunsen/no-http-url': string;
+            '@huangjunsen/no-secret-info': string;
+        };
+    };
+    'legacy-recommended': {
+        plugins: string[];
+        rules: {
+            '@huangjunsen/no-http-url': string;
+            '@huangjunsen/no-secret-info': string;
+        };
+    };
+};
+export default plugin;

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
+const no_http_url_1 = require("./rules/no-http-url");
+const no_secret_info_1 = require("./rules/no-secret-info");
+const no_broad_semantic_versioning_1 = require("./rules/no-broad-semantic-versioning");
+const no_js_in_ts_project_1 = require("./rules/no-js-in-ts-project");
+// 版本号由构建时注入，避免与 package.json 脱节
+const { version } = require('../package.json');
+exports.rules = {
+    'no-http-url': no_http_url_1.noHttpUrl,
+    'no-secret-info': no_secret_info_1.noSecretInfo,
+    'no-broad-semantic-versioning': no_broad_semantic_versioning_1.noBroadSemanticVersioning,
+    'no-js-in-ts-project': no_js_in_ts_project_1.noJsInTsProject,
+};
+// 兼容 Flat Config 插件对象
+const plugin = {
+    meta: {
+        name: '@huangjunsen/eslint-plugin',
+        version,
+    },
+    rules: exports.rules,
+};
+exports.configs = {
+    // Flat Config recommended 预设
+    recommended: {
+        plugins: {
+            '@huangjunsen': plugin,
+        },
+        rules: {
+            '@huangjunsen/no-http-url': 'warn',
+            '@huangjunsen/no-secret-info': 'error',
+        },
+    },
+    // Legacy Config 兼容预设
+    'legacy-recommended': {
+        plugins: ['@huangjunsen'],
+        rules: {
+            '@huangjunsen/no-http-url': 'warn',
+            '@huangjunsen/no-secret-info': 'error',
+        },
+    },
+};
+plugin.configs = exports.configs;
+exports.default = plugin;

package/dist/rules/no-broad-semantic-versioning.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const noBroadSemanticVersioning: Rule.RuleModule;

package/dist/rules/no-broad-semantic-versioning.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noBroadSemanticVersioning = void 0;
+const path_1 = __importDefault(require("path"));
+exports.noBroadSemanticVersioning = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow broad semantic versioning in package.json',
+            category: 'Best Practices',
+            recommended: true,
+        },
+        schema: [],
+        messages: {
+            noBroadSemanticVersioning: 'The "{{dependencyName}}" is not recommended to use "{{versioning}}"',
+        },
+    },
+    create(context) {
+        const filename = typeof context.filename === 'string' ? context.filename : context.getFilename?.();
+        if (filename && path_1.default.basename(filename) !== 'package.json') {
+            return {};
+        }
+        return {
+            Property(node) {
+                if (node.key &&
+                    node.key.value &&
+                    (node.key.value === 'dependencies' || node.key.value === 'devDependencies') &&
+                    node.value &&
+                    node.value.properties) {
+                    node.value.properties.forEach((property) => {
+                        if (property.key && property.key.value && property.value && property.value.value) {
+                            const dependencyName = property.key.value;
+                            const dependencyVersion = String(property.value.value);
+                            if (dependencyVersion.indexOf('*') > -1 ||
+                                dependencyVersion.indexOf('x') > -1 ||
+                                dependencyVersion.indexOf('>') > -1) {
+                                context.report({
+                                    loc: property.loc,
+                                    messageId: 'noBroadSemanticVersioning',
+                                    data: {
+                                        dependencyName,
+                                        versioning: dependencyVersion,
+                                    },
+                                });
+                            }
+                        }
+                    });
+                }
+            },
+        };
+    },
+};

package/dist/rules/no-http-url.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const noHttpUrl: Rule.RuleModule;

package/dist/rules/no-http-url.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noHttpUrl = void 0;
+exports.noHttpUrl = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Disallow http urls, recommend https',
+            category: 'Possible Errors',
+            recommended: true,
+        },
+        schema: [],
+        messages: {
+            noHttpUrl: 'Recommended "{{url}}" switch to HTTPS',
+        },
+    },
+    create(context) {
+        return {
+            Literal(node) {
+                if (node.value && typeof node.value === 'string' && node.value.startsWith('http:')) {
+                    context.report({
+                        node,
+                        messageId: 'noHttpUrl',
+                        data: {
+                            url: node.value,
+                        },
+                    });
+                }
+            },
+        };
+    },
+};

package/dist/rules/no-js-in-ts-project.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const noJsInTsProject: Rule.RuleModule;

package/dist/rules/no-js-in-ts-project.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noJsInTsProject = void 0;
+const path_1 = __importDefault(require("path"));
+const JS_REG = /\.jsx?$/;
+const DEFAULT_WHITE_LIST = [
+    'commitlint.config.js',
+    'eslintrc.js',
+    'prettierrc.js',
+    'stylelintrc.js',
+];
+exports.noJsInTsProject = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Disallow JS files in TypeScript projects',
+            category: 'Best Practices',
+            recommended: true,
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    whiteList: {
+                        type: 'array',
+                        items: { type: 'string' },
+                    },
+                    autoMerge: {
+                        type: 'boolean',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            noJSInTSProject: 'The "{{fileName}}" is not recommended in TS project',
+        },
+    },
+    create(context) {
+        const fileName = typeof context.filename === 'string' ? context.filename : context.getFilename?.();
+        if (!fileName)
+            return {};
+        const extName = path_1.default.extname(fileName);
+        const ruleOptions = context.options[0] || {};
+        let { whiteList = [], autoMerge = true } = ruleOptions;
+        if (whiteList.length === 0) {
+            whiteList = DEFAULT_WHITE_LIST;
+        }
+        else if (autoMerge) {
+            whiteList = Array.from(new Set([...DEFAULT_WHITE_LIST, ...whiteList]));
+        }
+        const whiteListReg = new RegExp(`(${whiteList.join('|')})$`);
+        if (!whiteListReg.test(fileName) && JS_REG.test(extName)) {
+            context.report({
+                loc: {
+                    start: { line: 1, column: 0 },
+                    end: { line: 1, column: 0 },
+                },
+                messageId: 'noJSInTSProject',
+                data: {
+                    fileName,
+                },
+            });
+        }
+        return {};
+    },
+};

package/dist/rules/no-secret-info.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const noSecretInfo: Rule.RuleModule;

package/dist/rules/no-secret-info.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noSecretInfo = void 0;
+const DEFAULT_DANGEROUS_KEYS = ['secret', 'token', 'password'];
+exports.noSecretInfo = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow secret keys in code',
+            category: 'Security',
+            recommended: true,
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    dangerousKeys: {
+                        type: 'array',
+                        items: { type: 'string' },
+                    },
+                    autoMerge: {
+                        type: 'boolean',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            noSecretInfo: 'Detect that the "{{secret}}" might be a secret token, Please check!',
+        },
+    },
+    create(context) {
+        const ruleOptions = context.options[0] || {};
+        let { dangerousKeys = [], autoMerge = true } = ruleOptions;
+        if (dangerousKeys.length === 0) {
+            dangerousKeys = DEFAULT_DANGEROUS_KEYS;
+        }
+        else if (autoMerge) {
+            dangerousKeys = Array.from(new Set([...DEFAULT_DANGEROUS_KEYS, ...dangerousKeys]));
+        }
+        const reg = new RegExp(dangerousKeys.join('|'), 'i');
+        return {
+            Literal(node) {
+                if (node.value &&
+                    node.parent &&
+                    ((node.parent.type === 'VariableDeclarator' &&
+                        node.parent.id &&
+                        node.parent.id.name &&
+                        reg.test(node.parent.id.name.toLocaleLowerCase())) ||
+                        (node.parent.type === 'Property' &&
+                            node.parent.key &&
+                            node.parent.key.name &&
+                            reg.test(node.parent.key.name.toLocaleLowerCase())))) {
+                    context.report({
+                        node,
+                        messageId: 'noSecretInfo',
+                        data: {
+                            secret: String(node.value),
+                        },
+                    });
+                }
+            },
+        };
+    },
+};

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@huangjunsen/eslint-plugin",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "自定义eslint插件",
   "files": [
-    "configs/",
-    "rules/",
+    "dist/",
     "README.md"
   ],
   "keywords": [
@@ -12,7 +11,11 @@
     "eslint",
     "eslint-plugin"
   ],
-  "main": "src/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "peerDependencies": {
+    "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0"
+  },
   "author": "Huangjunsen <951434130@qq.com>",
   "homepage": "https://github.com/Huang-junsen/js-encode-fe-spec#readme",
   "license": "ISC",
@@ -23,15 +26,15 @@
   "bugs": {
     "url": "https://github.com/Huang-junsen/js-encode-fe-spec/issues"
   },
-  "dependencies": {
-    "fs-extra": "^9.0.1",
-    "require-all": "^3.0.0"
-  },
+  "dependencies": {},
   "devDependencies": {
-    "eslint": "^8.7.0",
-    "jest": "^26.6.3"
+    "eslint": "^8.57.0",
+    "jest": "^30.5.1",
+    "typescript": "^5.0.4",
+    "@types/node": "^20.12.7"
   },
   "scripts": {
-    "test": "jest"
+    "build": "rm -rf dist && tsc",
+    "test": "npm run build && jest"
   }
 }

package/configs/recommended.js

@@ -1,7 +0,0 @@
-module.exports = {
-  plugins: ['eslint-plugin-encode'],
-  rules: {
-    'eslint-plugin-encode/no-http-url': 'warn',
-    'eslint-plugin-encode/no-secret-info': 'error',
-  },
-};

package/rules/no-broad-semantic-versioning.js

@@ -1,59 +0,0 @@
-const path = require('path');
-
-const RULE_NAME = 'no-broad-semantic-versioning';
-
-module.exports = {
-  name: RULE_NAME,
-  meta: {
-    type: 'problem',
-    fixable: null,
-    messages: {
-      noBroadSemanticVersioning:
-        'The "{{dependencyName}}" is not recommended to use "{{versioning}}"',
-    },
-  },
-
-  create(context) {
-    if (path.basename(context.getFilename()) !== 'package.json') {
-      return {};
-    }
-
-    const cwd = context.getCwd();
-
-    return {
-      Property: function handleRequires(node) {
-        if (
-          node.key &&
-          node.key.value &&
-          (node.key.value === 'dependencies' || node.key.value === 'devDependencies') &&
-          node.value &&
-          node.value.properties
-        ) {
-          node.value.properties.forEach((property) => {
-            if (property.key && property.key.value) {
-              const dependencyName = property.key.value;
-              const dependencyVersion = property.value.value;
-              if (
-                // *
-                dependencyVersion.indexOf('*') > -1 ||
-                // x.x
-                dependencyVersion.indexOf('x') > -1 ||
-                // > x
-                dependencyVersion.indexOf('>') > -1
-              ) {
-                context.report({
-                  loc: property.loc,
-                  messageId: 'noBroadSemanticVersioning',
-                  data: {
-                    dependencyName,
-                    versioning: dependencyVersion,
-                  },
-                });
-              }
-            }
-          });
-        }
-      },
-    };
-  },
-};

package/rules/no-http-url.js

@@ -1,28 +0,0 @@
-const RULE_NAME = 'no-http-url';
-
-module.exports = {
-  name: RULE_NAME,
-  meta: {
-    type: 'suggestion',
-    fixable: null,
-    messages: {
-      noHttpUrl: 'Recommended "{{url}}" switch to HTTPS',
-    },
-  },
-  create(context) {
-    return {
-      Literal: function handleRequires(node) {
-        console.log(node.value);
-        if (node.value && typeof node.value === 'string' && node.value.startsWith('http:')) {
-          context.report({
-            node,
-            messageId: 'noHttpUrl',
-            data: {
-              url: node.value,
-            },
-          });
-        }
-      },
-    };
-  },
-};

package/rules/no-js-in-ts-project.js

@@ -1,58 +0,0 @@
-const path = require('path');
-
-const RULE_NAME = 'no-js-in-ts-project';
-
-const JS_REG = /\.jsx?$/;
-
-const DEFAULT_WHITE_LIST = [
-  'commitlint.config.js',
-  'eslintrc.js',
-  'prettierrc.js',
-  'stylelintrc.js',
-];
-
-module.exports = {
-  name: RULE_NAME,
-  meta: {
-    type: 'suggestion',
-    fixable: null,
-    messages: {
-      noJSInTSProject: 'The "{{fileName}}" is not recommended in TS project',
-    },
-  },
-
-  create(context) {
-    const fileName = context.getFilename();
-    const extName = path.extname(fileName);
-    const ruleOptions = context.options[0] || {};
-    let { whiteList = [], autoMerge = true } = ruleOptions;
-    if (whiteList.length === 0) {
-      whiteList = DEFAULT_WHITE_LIST;
-    } else if (autoMerge) {
-      whiteList = [...new Set([...DEFAULT_WHITE_LIST, ...whiteList])];
-    }
-    const whiteListReg = new RegExp(`(${whiteList.join('|')})$`);
-
-    if (!whiteListReg.test(fileName) && JS_REG.test(extName)) {
-      context.report({
-        loc: {
-          start: {
-            line: 0,
-            column: 0,
-          },
-          end: {
-            line: 0,
-            column: 0,
-          },
-        },
-        messageId: 'noJSInTSProject',
-        data: {
-          fileName,
-        },
-      });
-    }
-
-    // Necessary
-    return {};
-  },
-};

package/rules/no-secret-info.js

@@ -1,49 +0,0 @@
-const RULE_NAME = 'no-secret-info';
-
-const DEFAULT_DANGEROUS_KEYS = ['secret', 'token', 'password'];
-
-module.exports = {
-  meta: {
-    type: 'problem',
-    fixable: null,
-    messages: {
-      noSecretInfo: 'Detect that the "{{secret}}" might be a secret token, Please check!',
-    },
-  },
-
-  create(context) {
-    const ruleOptions = context.options[0] || {};
-    let { dangerousKeys = [], autoMerge = true } = ruleOptions;
-    if (dangerousKeys.length === 0) {
-      dangerousKeys = DEFAULT_DANGEROUS_KEYS;
-    } else if (autoMerge) {
-      dangerousKeys = [...new Set(...DEFAULT_DANGEROUS_KEYS, ...dangerousKeys)];
-    }
-    const reg = new RegExp(dangerousKeys.join('|'));
-
-    return {
-      Literal: function handleRequires(node) {
-        if (
-          node.value &&
-          node.parent &&
-          ((node.parent.type === 'VariableDeclarator' &&
-            node.parent.id &&
-            node.parent.id.name &&
-            reg.test(node.parent.id.name.toLocaleLowerCase())) ||
-            (node.parent.type === 'Property' &&
-              node.parent.key &&
-              node.parent.key.name &&
-              reg.test(node.parent.key.name.toLocaleLowerCase())))
-        ) {
-          context.report({
-            node,
-            messageId: 'noSecretInfo',
-            data: {
-              secret: node.value,
-            },
-          });
-        }
-      },
-    };
-  },
-};