@dineroregnskab/eslint-plugin-custom-rules 1.0.6 → 1.0.8

package/README.md

@@ -0,0 +1,62 @@
+# Dinero custom ESLint rules
+
+Custom extended rules for various Dinero specific standards & conventions.
+
+## Installation
+
+Bundled with dinero.Frontend & dinero.Admin package.json, so a general npm install will include it as default.
+
+Explicit install:
+```bash
+npm install @dineroregnskab/eslint-plugin-eslint-custom-rules@latest --save-dev
+```
+
+## Adding rules
+
+Add the rule here:
+
+`dinero-web-2.0/Dinero.Packages/Dinero.eslintCustomRules/rules`
+
+You can test the rule by adding some code to test it on here.
+
+`dinero-web-2.0/Dinero.Packages/Dinero.eslintCustomRules/example`
+
+And run:
+
+```bash
+npx eslint test.ts
+```
+
+### Publish & install new rule locally
+
+Run:
+
+```bash
+npm patch
+```
+```bash
+npm publish
+```
+
+- In dinero.Frontend and/or dinero.Admin, update the root `package.json` file with the newly published version number.
+- Locate the `eslintrc` file and add the new rule in the rules property (under `"files": ["*.html"]`, `"files": ["*.ts"]` etc. respectively).
+> **Note: The reference here must be in the format of the package name without "eslint-plugin" + rule name**
+
+Example:
+
+`"@dineroregnskab/custom-rules/reducers-should-always-return": ["warn"]`
+
+- Run
+
+```bash
+npm i
+````
+
+> **Note: You might need to restart the IDE for the new rule to apply**
+
+#
+See [ESLint custom rule tutorial](https://eslint.org/docs/latest/extend/custom-rule-tutorial) for more.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dineroregnskab/eslint-plugin-custom-rules",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "ESLint plugin with custom rules for Dineroregnskab",
   "main": "eslint-plugin-custom-rules.js",
   "scripts": {
@@ -18,5 +18,8 @@
   "files": [
     "**/*",
     "!example/**/*"
-  ]
+  ],
+  "dependencies": {
+    "esquery": "^1.5.0"
+  }
 }

package/rules/reducers-should-always-return.js

@@ -22,10 +22,10 @@ module.exports = {
                                 handler.type === 'FunctionExpression' ||
                                 handler.type === 'ArrowFunctionExpression';
                             const isBlockStatement =
-                                handler.body.type === 'BlockStatement';
+                                handler?.body?.type === 'BlockStatement';
                             const hasNoReturn =
                                 isBlockStatement &&
-                                !handler.body.body.some(
+                                !handler?.body?.body.some(
                                     (statement) =>
                                         statement.type === 'ReturnStatement',
                                 );