eslint-plugin-hyoban 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stephen Zhou
+
+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,19 @@
+# eslint-plugin-hyoban
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+
+Prefer early return pattern to clean if else statement
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/eslint-plugin-hyoban?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/eslint-plugin-hyoban
+[npm-downloads-src]: https://img.shields.io/npm/dm/eslint-plugin-hyoban?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/eslint-plugin-hyoban
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/eslint-plugin-hyoban?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=eslint-plugin-hyoban
+[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
+[jsdocs-href]: https://www.jsdocs.io/package/eslint-plugin-hyoban

package/dist/index.cjs

@@ -0,0 +1,126 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@typescript-eslint/utils');
+
+var version = "0.0.1";
+
+const createRule = utils.ESLintUtils.RuleCreator((name)=>`https://github.com/hyoban/eslint-plugin-hyoban/blob/main/src/rules/${name}.`);
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+const expressionTypesNoCheck = new Set([
+    utils.AST_NODE_TYPES.ConditionalExpression,
+    utils.AST_NODE_TYPES.JSXElement,
+    utils.AST_NODE_TYPES.TSAsExpression
+]);
+const rule$1 = createRule({
+    name: 'no-extra-space-jsx-expression',
+    meta: {
+        type: 'layout',
+        fixable: 'whitespace',
+        docs: {
+            description: 'No extra space in jsx expression'
+        },
+        messages: {
+            noExtraSpaceJsxExpression: 'No extra space in jsx expression'
+        },
+        schema: []
+    },
+    defaultOptions: [],
+    create (context) {
+        function check(node, isExit) {
+            const { expression } = node;
+            if (expressionTypesNoCheck.has(expression.type) || expression.type === utils.AST_NODE_TYPES.ArrowFunctionExpression && expression.body.type !== utils.AST_NODE_TYPES.BlockStatement) return;
+            const containerRange = node.range;
+            const expressionRange = expression.range;
+            const noSpace = isExit ? containerRange[1] - expressionRange[1] === 1 : expressionRange[0] - containerRange[0] === 1;
+            if (noSpace) return;
+            const rangeToRemove = isExit ? [
+                expressionRange[1],
+                containerRange[1] - 1
+            ] : [
+                containerRange[0] + 1,
+                expressionRange[0]
+            ];
+            context.report({
+                node,
+                loc: {
+                    start: context.sourceCode.getLocFromIndex(rangeToRemove[0]),
+                    end: context.sourceCode.getLocFromIndex(rangeToRemove[1])
+                },
+                messageId: 'noExtraSpaceJsxExpression',
+                fix: (fixer)=>fixer.removeRange(rangeToRemove)
+            });
+        }
+        return {
+            'JSXExpressionContainer:exit' (node) {
+                check(node, true);
+            },
+            JSXExpressionContainer (node) {
+                check(node);
+            }
+        };
+    }
+});
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+function isConditionRevertNeedBracket(node) {
+    return !(node.type === utils.AST_NODE_TYPES.Identifier || node.type === utils.AST_NODE_TYPES.Literal || node.type === utils.AST_NODE_TYPES.MemberExpression || node.type === utils.AST_NODE_TYPES.CallExpression);
+}
+function getIndentation(node) {
+    return ' '.repeat(node.loc.start.column);
+}
+function isNodeNeedEarlyReturn(node) {
+    return node.type === utils.AST_NODE_TYPES.ReturnStatement || node.type === utils.AST_NODE_TYPES.ThrowStatement || node.type === utils.AST_NODE_TYPES.ContinueStatement;
+}
+const rule = createRule({
+    name: 'prefer-early-return',
+    meta: {
+        docs: {
+            description: 'Prefer early return pattern to clean if else statement'
+        },
+        messages: {
+            preferEarlyReturn: 'Return early to clean this if else statement'
+        },
+        type: 'suggestion',
+        schema: [],
+        fixable: 'code'
+    },
+    defaultOptions: [],
+    create (context) {
+        return {
+            IfStatement (node) {
+                if (!node.alternate) return;
+                if (isNodeNeedEarlyReturn(node.alternate) || node.alternate.type === utils.AST_NODE_TYPES.BlockStatement && node.alternate.body.some((statement)=>isNodeNeedEarlyReturn(statement))) {
+                    context.report({
+                        node: node.alternate,
+                        messageId: 'preferEarlyReturn',
+                        fix (fixer) {
+                            const condition = context.sourceCode.getText(node.test);
+                            const revertCondition = isConditionRevertNeedBracket(node.test) ? `!(${condition})` : `!${condition}`;
+                            let ifText = context.sourceCode.getText(node.consequent);
+                            ifText = ifText.startsWith('{') && ifText.endsWith('}') ? ifText.replace(/^{/, '').replace(/}$/, '').replaceAll('\n  ', '\n').slice(1, -1) : `${getIndentation(node)}${ifText}`;
+                            const elseText = context.sourceCode.getText(node.alternate);
+                            return [
+                                fixer.replaceText(node, `if (${revertCondition}) ${elseText}\n${ifText}`)
+                            ];
+                        }
+                    });
+                }
+            }
+        };
+    }
+});
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+var index = {
+    meta: {
+        name: 'hyoban',
+        version
+    },
+    rules: {
+        'prefer-early-return': rule,
+        'no-extra-space-jsx-expression': rule$1
+    }
+};
+
+exports.default = index;

package/dist/index.d.cts

@@ -0,0 +1,14 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+declare const _default: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: {
+        'prefer-early-return': ESLintUtils.RuleModule<"preferEarlyReturn", [], ESLintUtils.RuleListener>;
+        'no-extra-space-jsx-expression': ESLintUtils.RuleModule<"noExtraSpaceJsxExpression", [], ESLintUtils.RuleListener>;
+    };
+};
+
+export { _default as default };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+declare const _default: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: {
+        'prefer-early-return': ESLintUtils.RuleModule<"preferEarlyReturn", [], ESLintUtils.RuleListener>;
+        'no-extra-space-jsx-expression': ESLintUtils.RuleModule<"noExtraSpaceJsxExpression", [], ESLintUtils.RuleListener>;
+    };
+};
+
+export { _default as default };

package/dist/index.js

@@ -0,0 +1,124 @@
+import { ESLintUtils, AST_NODE_TYPES } from '@typescript-eslint/utils';
+
+var version = "0.0.1";
+
+const createRule = ESLintUtils.RuleCreator((name)=>`https://github.com/hyoban/eslint-plugin-hyoban/blob/main/src/rules/${name}.`);
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+const expressionTypesNoCheck = new Set([
+    AST_NODE_TYPES.ConditionalExpression,
+    AST_NODE_TYPES.JSXElement,
+    AST_NODE_TYPES.TSAsExpression
+]);
+const rule$1 = createRule({
+    name: 'no-extra-space-jsx-expression',
+    meta: {
+        type: 'layout',
+        fixable: 'whitespace',
+        docs: {
+            description: 'No extra space in jsx expression'
+        },
+        messages: {
+            noExtraSpaceJsxExpression: 'No extra space in jsx expression'
+        },
+        schema: []
+    },
+    defaultOptions: [],
+    create (context) {
+        function check(node, isExit) {
+            const { expression } = node;
+            if (expressionTypesNoCheck.has(expression.type) || expression.type === AST_NODE_TYPES.ArrowFunctionExpression && expression.body.type !== AST_NODE_TYPES.BlockStatement) return;
+            const containerRange = node.range;
+            const expressionRange = expression.range;
+            const noSpace = isExit ? containerRange[1] - expressionRange[1] === 1 : expressionRange[0] - containerRange[0] === 1;
+            if (noSpace) return;
+            const rangeToRemove = isExit ? [
+                expressionRange[1],
+                containerRange[1] - 1
+            ] : [
+                containerRange[0] + 1,
+                expressionRange[0]
+            ];
+            context.report({
+                node,
+                loc: {
+                    start: context.sourceCode.getLocFromIndex(rangeToRemove[0]),
+                    end: context.sourceCode.getLocFromIndex(rangeToRemove[1])
+                },
+                messageId: 'noExtraSpaceJsxExpression',
+                fix: (fixer)=>fixer.removeRange(rangeToRemove)
+            });
+        }
+        return {
+            'JSXExpressionContainer:exit' (node) {
+                check(node, true);
+            },
+            JSXExpressionContainer (node) {
+                check(node);
+            }
+        };
+    }
+});
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+function isConditionRevertNeedBracket(node) {
+    return !(node.type === AST_NODE_TYPES.Identifier || node.type === AST_NODE_TYPES.Literal || node.type === AST_NODE_TYPES.MemberExpression || node.type === AST_NODE_TYPES.CallExpression);
+}
+function getIndentation(node) {
+    return ' '.repeat(node.loc.start.column);
+}
+function isNodeNeedEarlyReturn(node) {
+    return node.type === AST_NODE_TYPES.ReturnStatement || node.type === AST_NODE_TYPES.ThrowStatement || node.type === AST_NODE_TYPES.ContinueStatement;
+}
+const rule = createRule({
+    name: 'prefer-early-return',
+    meta: {
+        docs: {
+            description: 'Prefer early return pattern to clean if else statement'
+        },
+        messages: {
+            preferEarlyReturn: 'Return early to clean this if else statement'
+        },
+        type: 'suggestion',
+        schema: [],
+        fixable: 'code'
+    },
+    defaultOptions: [],
+    create (context) {
+        return {
+            IfStatement (node) {
+                if (!node.alternate) return;
+                if (isNodeNeedEarlyReturn(node.alternate) || node.alternate.type === AST_NODE_TYPES.BlockStatement && node.alternate.body.some((statement)=>isNodeNeedEarlyReturn(statement))) {
+                    context.report({
+                        node: node.alternate,
+                        messageId: 'preferEarlyReturn',
+                        fix (fixer) {
+                            const condition = context.sourceCode.getText(node.test);
+                            const revertCondition = isConditionRevertNeedBracket(node.test) ? `!(${condition})` : `!${condition}`;
+                            let ifText = context.sourceCode.getText(node.consequent);
+                            ifText = ifText.startsWith('{') && ifText.endsWith('}') ? ifText.replace(/^{/, '').replace(/}$/, '').replaceAll('\n  ', '\n').slice(1, -1) : `${getIndentation(node)}${ifText}`;
+                            const elseText = context.sourceCode.getText(node.alternate);
+                            return [
+                                fixer.replaceText(node, `if (${revertCondition}) ${elseText}\n${ifText}`)
+                            ];
+                        }
+                    });
+                }
+            }
+        };
+    }
+});
+
+// eslint-disable-next-line unused-imports/no-unused-imports
+var index = {
+    meta: {
+        name: 'hyoban',
+        version
+    },
+    rules: {
+        'prefer-early-return': rule,
+        'no-extra-space-jsx-expression': rule$1
+    }
+};
+
+export { index as default };

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "eslint-plugin-hyoban",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@8.15.4",
+  "description": "Prefer early return pattern to clean if else statement",
+  "author": {
+    "name": "hyoban",
+    "url": "https://github.com/hyoban"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/hyoban/eslint-plugin-hyoban#readme",
+  "repository": "hyoban/eslint-plugin-hyoban",
+  "bugs": "https://github.com/hyoban/eslint-plugin-hyoban/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@typescript-eslint/utils": "^7.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.27",
+    "@typescript-eslint/rule-tester": "^7.2.0",
+    "bunchee": "^4.4.8",
+    "dedent": "^1.5.1",
+    "eslint": "^8.57.0",
+    "eslint-config-hyoban": "^0.2.1",
+    "lint-staged": "^15.2.2",
+    "release-it": "^17.1.1",
+    "release-it-pnpm": "4.0.2",
+    "simple-git-hooks": "^2.10.0",
+    "typescript": "^5.4.2",
+    "vitest": "^1.3.1"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  },
+  "scripts": {
+    "build": "bunchee",
+    "dev": "bunchee -w",
+    "lint": "eslint .",
+    "test": "vitest",
+    "typecheck": "tsc"
+  }
+}