@huangjunsen/eslint-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 黄俊森
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +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` 信息

package/configs/recommended.js

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

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@huangjunsen/eslint-plugin",
+  "version": "1.0.0",
+  "description": "自定义eslint插件",
+  "files": [
+    "configs/",
+    "rules/",
+    "README.md"
+  ],
+  "keywords": [
+    "encode",
+    "eslint",
+    "eslint-plugin"
+  ],
+  "main": "src/index.js",
+  "author": "Huangjunsen <951434130@qq.com>",
+  "homepage": "https://github.com/Huang-junsen/js-encode-fe-spec#readme",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Huang-junsen/js-encode-fe-spec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Huang-junsen/js-encode-fe-spec/issues"
+  },
+  "dependencies": {
+    "fs-extra": "^9.0.1",
+    "require-all": "^3.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.7.0",
+    "jest": "^26.6.3"
+  },
+  "scripts": {
+    "test": "jest"
+  }
+}

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

@@ -0,0 +1,59 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,49 @@
+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,
+            },
+          });
+        }
+      },
+    };
+  },
+};