eslint-plugin-light 1.0.0 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,174 @@
-# Changelog
+## <small>1.0.4 (2025-04-18)</small>
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+* chore: update license ([5ba3e91](https://github.com/novlan1/plugin-light/commits/5ba3e91))
+* chore: update license ([7f6a9d9](https://github.com/novlan1/plugin-light/commits/7f6a9d9))
+* docs: update docs ([f055bcd](https://github.com/novlan1/plugin-light/commits/f055bcd))
+* docs: update docs ([ddced10](https://github.com/novlan1/plugin-light/commits/ddced10))
+* docs: update docs ([761f6c4](https://github.com/novlan1/plugin-light/commits/761f6c4))
+* docs: update docs ([bba000b](https://github.com/novlan1/plugin-light/commits/bba000b))
+* docs: update docs ([34dde24](https://github.com/novlan1/plugin-light/commits/34dde24))
+* refactor: use eslint import/order rule ([41afa85](https://github.com/novlan1/plugin-light/commits/41afa85))
+* feat(eslint): add eslint-config-light ([b7af1f7](https://github.com/novlan1/plugin-light/commits/b7af1f7))
+* feat(eslint): use json-parse-try-catch rule ([eca21da](https://github.com/novlan1/plugin-light/commits/eca21da))
+* ci: update build script ([b7ad1e3](https://github.com/novlan1/plugin-light/commits/b7ad1e3))
 
-## 1.0.0 (2023-07-12)
+
+
+## [1.0.0](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.16...v1.0.0) (2023-07-12)
+
+
+### ✨ Features | 新功能
+
+* 添加规则不能使用this.tip_uid，但是没有开启 ([d913d2b](https://github.com/novlan1/eslint-plugin-light/commit/d913d2be33aaa44dbb6615f2d4ac98d4a7acebb0))
+* 新增no-import-vant ([c5b8722](https://github.com/novlan1/eslint-plugin-light/commit/c5b87222db44111338cd1d9d4356695efa20cb93))
+* 优化插件 ([505f17f](https://github.com/novlan1/eslint-plugin-light/commit/505f17f2191fdd6a9f32c67d64420ae115909af2))
+
+
+### ♻️ Code Refactoring | 代码重构
+
+* 插件重命名为light ([21c1dd9](https://github.com/novlan1/eslint-plugin-light/commit/21c1dd93dcd5e31265767cf53121a718826abaad))
+
+
+### ✏️ Documentation | 文档
+
+* 文档更新 ([4f33c36](https://github.com/novlan1/eslint-plugin-light/commit/4f33c36f40bd8c872c586d05cd6ffbd0d21b5f62))
+* 优化readme ([f0183d0](https://github.com/novlan1/eslint-plugin-light/commit/f0183d0b7cd66af9c47d3e389ccc11c572e1f54a))
+
+
+### ✅ Tests | 测试
+
+* 测试用例修正 ([70e9f36](https://github.com/novlan1/eslint-plugin-light/commit/70e9f36fdad34b72d94b85c2590bbb06489fd6aa))
+
+
+### 🚀 Chore | 构建/工程依赖/工具
+
+* 删除无效注释 ([96d5e9d](https://github.com/novlan1/eslint-plugin-light/commit/96d5e9d158c10df93c6f714805eaf8d670d39eeb))
+
+### [0.0.16](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.15...v0.0.16) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 去掉打印信息 ([bde64c7](https://github.com/novlan1/eslint-plugin-light/commit/bde64c765562f5842aa988ee07d2caac27786a6c))
+
+### [0.0.15](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.14...v0.0.15) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 优化包 ([906bcd7](https://github.com/novlan1/eslint-plugin-light/commit/906bcd7a2ff0291d331feef961b479135f11c526))
+
+### [0.0.14](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.13...v0.0.14) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 脚本优化 ([d1e8172](https://github.com/novlan1/eslint-plugin-light/commit/d1e8172ac3777f1377864d3de76a50c55e4122dd))
+* 脚本优化 ([9c6d844](https://github.com/novlan1/eslint-plugin-light/commit/9c6d844aad15475e1af7d97728dfcae84bd99693))
+* **complex-key:** 不要使用复杂的key ([00e981b](https://github.com/novlan1/eslint-plugin-light/commit/00e981b8d81e097576163fa8078a09a315a22cba))
+
+### [0.0.13](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.12...v0.0.13) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 优化脚本 ([ad9b142](https://github.com/novlan1/eslint-plugin-light/commit/ad9b142ee87aba73d45adcef3aa94ac3d5988b31))
+
+### [0.0.12](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.11...v0.0.12) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 脚本优化 ([62f1181](https://github.com/novlan1/eslint-plugin-light/commit/62f11815bb458201991cca99716e773a3281c65b))
+
+### [0.0.11](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.10...v0.0.11) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 脚本优化 ([3047f01](https://github.com/novlan1/eslint-plugin-light/commit/3047f01b89fdbdb8c72b0c5e511afb587d8ffc99))
+* 优化发布脚本 ([a072ae8](https://github.com/novlan1/eslint-plugin-light/commit/a072ae8715352c9452072e8dfa9c85a343cf4f26))
+
+### [0.0.10](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.9...v0.0.10) (2022-07-26)
+
+
+### ✨ Features | 新功能
+
+* 优化发布脚本 ([470a35f](https://github.com/novlan1/eslint-plugin-light/commit/470a35fc55153d41a362cf61492fde120a9ed3f7))
+* 优化error信息 ([453430f](https://github.com/novlan1/eslint-plugin-light/commit/453430ff437d062cd1efa7bff96b87e975b2b414))
+
+### [0.0.9](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.8...v0.0.9) (2022-07-22)
+
+
+### ✨ Features | 新功能
+
+* 优化插件 ([13a84d5](https://github.com/novlan1/eslint-plugin-light/commit/13a84d5ce25788f5d3b3b63b84a0731f179ff12d))
+
+
+### ✏️ Documentation | 文档
+
+* 用法更新 ([78e344d](https://github.com/novlan1/eslint-plugin-light/commit/78e344d61c026f7c38960d41d7038888664ecb85))
+
+### [0.0.8](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.7...v0.0.8) (2022-07-22)
+
+
+### ✏️ Documentation | 文档
+
+* 更新文档 ([d6e3a23](https://github.com/novlan1/eslint-plugin-light/commit/d6e3a23205244f41ecb8b8fff3bb9d9a07a2c734))
+
+
+### 🚀 Chore | 构建/工程依赖/工具
+
+* eslint ([63e2398](https://github.com/novlan1/eslint-plugin-light/commit/63e2398387b466c4e188a7f12a2d08586583f527))
+
+
+### ✨ Features | 新功能
+
+* **number:** 优化插件 ([003f290](https://github.com/novlan1/eslint-plugin-light/commit/003f290563b15d4cc1e8a6585a629bbfba2fce1e))
+
+### [0.0.7](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.6...v0.0.7) (2022-07-22)
+
+
+### ✏️ Documentation | 文档
+
+* 文档优化 ([e7f5bfb](https://github.com/novlan1/eslint-plugin-light/commit/e7f5bfb9e67ac3f7cb9ea182200886feb22c9798))
+* 优化文档 ([44e7b1e](https://github.com/novlan1/eslint-plugin-light/commit/44e7b1e5f5e230363dcfd6923d325e96db9509f4))
+
+
+### ✨ Features | 新功能
+
+* **no-plus-turn-number:** 转化+字符串 ([aa69796](https://github.com/novlan1/eslint-plugin-light/commit/aa69796620c554d745c2b5133b9699c9be363805))
+
+### [0.0.6](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.5...v0.0.6) (2022-07-22)
+
+
+### ✨ Features | 新功能
+
+* 优化插件 ([c0e28fd](https://github.com/novlan1/eslint-plugin-light/commit/c0e28fda4d5ba7c6c90a0ad7fe799342b79e9b49))
+
+### [0.0.5](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.4...v0.0.5) (2022-07-22)
+
+### [0.0.4](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.3...v0.0.4) (2022-07-22)
+
+
+### 🐛 Bug Fixes | Bug 修复
+
+* 兼容性处理 ([ba123c2](https://github.com/novlan1/eslint-plugin-light/commit/ba123c26093d66008e459cdc3bfaf5fea74588e1))
+
+### [0.0.3](https://github.com/novlan1/eslint-plugin-light/compare/v0.0.2...v0.0.3) (2022-07-22)
+
+
+### 🚀 Chore | 构建/工程依赖/工具
+
+* 增加versionrc ([1a8b239](https://github.com/novlan1/eslint-plugin-light/commit/1a8b2393618cbb16003298a1ec5e8b9bf44fb779))
+* version ([dda6406](https://github.com/novlan1/eslint-plugin-light/commit/dda640604dd0bd34bf8937692781edd95b99d6ed))
+
+### 0.0.2 (2022-07-22)
+
+
+### Features
+
+* 安装version ([a295b91](https://github.com/novlan1/eslint-plugin-light/commit/a295b91936a3eaeeda3bbc53d3221d0c0ee4c6f8))
+* 优化插件 ([803d743](https://github.com/novlan1/eslint-plugin-light/commit/803d7434d653776dd70d0ec85b8eb0c20bdbc578))
+* init ([44f3cb3](https://github.com/novlan1/eslint-plugin-light/commit/44f3cb326e7fca1b4b4b54ec8f361b491b84f996))
+* vue组件规则 ([80b3690](https://github.com/novlan1/eslint-plugin-light/commit/80b36908061aab76995f6b7bf1d7f6930bb6f7eb))

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 novlan1
+
+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

@@ -1,23 +1,32 @@
-# eslint-plugin-light
+## ESLint Plugin Light
 
-Eslint plugin.
 
+<p align="center">
+  <img src="https://img.shields.io/npm/dw/eslint-plugin-light">
+  <img src="https://img.shields.io/npm/unpacked-size/eslint-plugin-light">
+  <img src="https://img.shields.io/npm/v/eslint-plugin-light">
+  <img src="https://img.shields.io/npm/l/eslint-plugin-light">
+  <img src="https://img.shields.io/github/last-commit/novlan1/plugin-light">
+  <img src="https://img.shields.io/github/created-at/novlan1/plugin-light">
+</p>
 
-## 1. Installation
+Simple Eslint plugin.
 
-You'll first need to install [ESLint](https://eslint.org/):
+### 1. Installation
+
+You need to install [ESLint](https://eslint.org/) first.
 
 ```sh
-npm i eslint --save-dev
+npm i eslint -D
 ```
 
-Next, install `eslint-plugin-light`:
+Next, install `eslint-plugin-light`.
 
 ```sh
-npm install eslint-plugin-light --save-dev
+npm i eslint-plugin-light -D
 ```
 
-## 2. Usage
+### 2. Usage
 
 Add `light` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
@@ -49,9 +58,9 @@ or use extends：
 ```
 
 
-## 3. Supported Rules
+### 3. Supported Rules
 
-### 3.1. light/valid-vue-comp-import
+#### 3.1. light/valid-vue-comp-import
 
 禁止从`js`文件中加载`Vue`组件
 
@@ -67,7 +76,7 @@ import SomeComp from 'src/local-component/ui/pages/user/account-manage/index.js'
 import SomeComp from 'src/local-component/ui/pages/user/account-manage/index';
 ```
 
-如果加了`--fix`，会被转换为：
+如果加了 `--fix`，会被转换为：
 
 ```js
 import SomeComp from 'src/local-component/ui/pages/user/account-manage/xxx.vue';
@@ -109,7 +118,7 @@ import CComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-new/comp/d.vue';
 ```
 
-### 3.2. light/no-plus-turn-number
+#### 3.2. light/no-plus-turn-number
 
 禁止在`vue`的`template`中用`+`号转换字符串为数字
 
@@ -129,7 +138,7 @@ import DComp from 'src/local-component/module/tip-match/tip-match-schedule-tree-
 />
 ```
 
-### 3.3 no-complex-key
+#### 3.3 no-complex-key
 
 不要在`vue`模板中使用复杂的`key`。包括：
 
@@ -167,3 +176,30 @@ getData() {
 ```
 
 `uni-app`中，`key`重复的话，会造成挂载在组件上面的事件参数为`undefined`，从而不成功。
+
+
+#### 3.4  json-parse-try-catch
+
+`JSON.parse` 应该加 `try catch`。
+
+默认配置会排除下面情况：
+
+```ts
+JSON.parse(JSON.stringify(abc));
+```
+
+可以配置 `strict` 参数为 `true`，开启检查。
+
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  plugins: [
+    'light',
+  ],
+  rules: {
+    'light/json-parse-try-catch': [2, { strict: true }],
+  },
+}
+```

package/lib/rules/json-parse-try-catch.js

@@ -0,0 +1,58 @@
+// 用于检测 JSON.parse 没有用 try catch
+'use strict';
+
+const desc = 'JSON.parse need try catch';
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: desc,
+      category: 'Best Practices',
+    },
+  },
+  schema: [{
+    type: 'object',
+    properties: {
+      strict: {
+        type: 'boolean',
+      },
+    },
+  }],
+  create(context) {
+    const options = context.options?.[0];
+    let strict = options?.strict;
+    if (typeof strict === 'undefined') {
+      strict = false;
+    }
+
+    return {
+      CallExpression(node) {
+        const calleeObjectName = node.callee?.object?.name;
+        const calleePropertyName = node.callee?.property?.name;
+
+        const subNode = node.arguments?.[0];
+        const sbCalleeObjectName = subNode?.callee?.object?.name;
+        const subCalleePropertyName = subNode?.callee?.property?.name;
+
+        if (calleeObjectName === 'JSON'
+          && calleePropertyName === 'parse'
+          && (strict || !(sbCalleeObjectName === 'JSON' && subCalleePropertyName === 'stringify'))
+        ) {
+          let p = node.parent;
+          let hasTryFlg = false;
+
+          while (p && !hasTryFlg) {
+            if (p.type === 'TryStatement') hasTryFlg = true;
+            p = p.parent;
+          }
+
+          if (!hasTryFlg) {
+            context.report(node, desc);
+          }
+        }
+      },
+    };
+  },
+};
+

package/lib/rules/valid-vue-comp-import.js

@@ -1,5 +1,6 @@
-const path = require('path');
 const fs = require('fs');
+const path = require('path');
+
 const jsParser = require('@babel/eslint-parser');
 
 const ROOT_PATH = process.cwd();

package/package.json

@@ -1,50 +1,32 @@
 {
   "name": "eslint-plugin-light",
-  "version": "1.0.0",
-  "description": "eslint插件",
+  "version": "1.0.4",
+  "description": "Simple Eslint Plugin",
   "keywords": [
     "eslint",
     "eslint plugin",
     "eslint-plugin",
     "eslint-plugin-light"
   ],
+  "homepage": "https://novlan1.github.io/plugin-light/zh/eslint-plugin-light.html",
+  "bugs": {
+    "url": "https://github.com/novlan1/plugin-light/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/novlan1/plugin-light"
+  },
+  "license": "MIT",
+  "author": "novlan1",
+  "main": "lib/index.js",
   "files": [
     "lib/",
     "README.md",
     "CHANGELOG.md"
   ],
-  "author": "GuoWangYang",
-  "main": "lib/index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/novlan1/eslint-plugin-light"
-  },
-  "bugs": {
-    "url": "https://github.com/novlan1/eslint-plugin-light/issues"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "homepage": "https://github.com/novlan1/eslint-plugin-light#readme",
-  "scripts": {
-    "lint": "eslint --ext .js,.vue .",
-    "lint:fix": "eslint --fix --ext .js,.vue .",
-    "test": "mocha tests --recursive",
-    "create:mr": "node ./script/create-mr.js",
-    "release": "npm run release-patch && npm publish",
-    "release:first": "standard-version --first-release",
-    "release-major": "standard-version --release-as major",
-    "release-minor": "standard-version --release-as minor",
-    "release-patch": "standard-version --release-as patch"
-  },
   "dependencies": {
     "requireindex": "^1.2.0"
   },
-  "peerDependencies": {
-    "eslint": ">=6",
-    "@babel/eslint-parser": ">=6"
-  },
   "devDependencies": {
     "@babel/core": "^7.18.9",
     "@babel/eslint-parser": "^7.18.9",
@@ -56,8 +38,17 @@
     "mocha": "^9.1.3",
     "standard-version": "^9.5.0"
   },
+  "peerDependencies": {
+    "@babel/eslint-parser": ">=6",
+    "eslint": ">=6"
+  },
   "engines": {
     "node": "12.x || 14.x || >= 16"
   },
-  "license": "ISC"
-}
+  "scripts": {
+    "build": "rm -rf lib && node script/build",
+    "bump": "node ../../script/monorepo/version-simple $PWD",
+    "changelog": "node ../../script/monorepo/changelog $PWD",
+    "release": "node ../../script/monorepo/release $PWD"
+  }
+}