v0.1.0

Author: RexSkz

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+# build files
+lib/

.npmignore

@@ -0,0 +1,7 @@
+src/
+tests/
+
+.gitignore
+.swcrc
+pnpm-lock.yaml
+tsconfig.json

.swcrc

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json.schemastore.org/swcrc",
+  "module": {
+    "type": "commonjs"
+  },
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "tsx": false
+    }
+  }
+}

README.md

@@ -1,2 +1,71 @@
 # eslint-plugin-try-catch-failsafe
-Make sure to use try-catch to wrap some dangerous actions!
+
+Make sure to use try-catch to wrap up some dangerous actions!
+
+## Installation
+
+Use package manager to install this plugin.
+
+```bash
+npm install --save-dev eslint-plugin-try-catch-failsafe
+yarn add -D eslint-plugin-try-catch-failsafe
+pnpm add -D eslint-plugin-try-catch-failsafe
+```
+
+## Usage
+
+Add this plugin to your ESLint configuration.
+
+```json
+{
+  "plugins": [
+    "try-catch-failsafe"
+  ]
+}
+```
+
+## Rules
+
+### try-catch-failsafe/json-parse
+
+- **Default**: `error`
+- **Fixable**: `false`
+
+Make sure to use try-catch to wrap up `JSON.parse`. Notice that the `JSON.parse` in `catch` or `finally` block may also throw an error in JavaScript, so we should wrap them up too.
+
+```js
+// ❌ Error
+JSON.parse('{"foo": "bar"}');
+
+// ❌ Error
+try {
+  // some code that may throw an error
+} catch (e) {
+  JSON.parse('{"foo": "bar"}');
+}
+
+// ❌ Error
+try {
+  // some code that may throw an error
+} finally {
+  JSON.parse('{"foo": "bar"}');
+}
+
+// ✅ OK
+try {
+  JSON.parse('{"foo": "bar"}');
+} catch (e) {
+  console.error(e);
+}
+
+// ✅ OK
+try {
+  // some code that may throw an error
+} finally {
+  try {
+    JSON.parse('{"foo": "bar"}');
+  } finally {}
+}
+```
+
+If you are confident that the `JSON.parse` will not throw an error, you can disable this rule.

package.json

@@ -0,0 +1,43 @@
+{
+  "name": "eslint-plugin-try-catch-failsafe",
+  "version": "0.1.0",
+  "description": "Make sure to use try-catch to wrap some dangerous actions!",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "rm -rf lib && swc src -d lib",
+    "prepack": "pnpm build",
+    "test": "ts-mocha tests/**/*.spec.ts"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "@swc/cli": "^0.1.59",
+    "@swc/core": "^1.3.25",
+    "@types/eslint": "^8.4.10",
+    "@types/estree": "^1.0.0",
+    "@types/expect": "^24.3.0",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.18",
+    "@types/requireindex": "^1.2.0",
+    "eslint": "^8.31.0",
+    "mocha": "^10.2.0",
+    "ts-mocha": "^10.0.0",
+    "typescript": "^4.9.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RexSkz/eslint-plugin-try-catch-failsafe.git"
+  },
+  "author": "Rex Zeng <rex@rexskz.info>",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "try-catch",
+    "try",
+    "catch",
+    "failsafe"
+  ],
+  "license": "MIT"
+}