@dineroregnskab/eslint-plugin-custom-rules 1.0.0

package/eslint-plugin-custom-rules.js

@@ -0,0 +1,4 @@
+const returnReducerRule = require('./rules/reducers-should-always-return');
+
+const customRulesplugin = { rules: { "reducers-should-always-return": returnReducerRule } };
+module.exports = customRulesplugin;

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@dineroregnskab/eslint-plugin-custom-rules",
+  "version": "1.0.0",
+  "description": "ESLint plugin with custom rules for Dineroregnskab",
+  "main": "eslint-plugin-custom-rules.js",
+  "scripts": {
+    "test": "node rules/reducers-should-always-return.test.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "eslint": "^8.53.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0"
+  }
+}

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

@@ -0,0 +1,33 @@
+module.exports = {
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Enforce that a ngrx reducer always returns a value, so the store state remains intact.",
+        },
+        fixable: "code",
+        schema: []
+    },
+
+    create(context) {
+        return {
+            FunctionDeclaration(node) {
+                if (node.id.name.endsWith('Reducer')) {
+                    let hasReturnStatement = false;
+
+                    node.body.body.forEach(statement => {
+                        if (statement.type === 'ReturnStatement') {
+                            hasReturnStatement = true;
+                        }
+                    });
+
+                    if (!hasReturnStatement) {
+                        context.report({
+                            node,
+                            message: 'Reducer function must return a value to avoid undefined state.',
+                        });
+                    }
+                }
+            },
+          };
+    }
+};

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

@@ -0,0 +1,42 @@
+const returnReducerRule = require('./reducers-should-always-return');
+const { RuleTester } = require('eslint');
+
+const ruleTester = new RuleTester({
+    parserOptions: { ecmaVersion: 2019 },
+});
+
+ruleTester.run('reducers-should-always-return', returnReducerRule, {
+    valid: [
+        // This reducer returns a value in all code paths
+        {
+            code:
+            `function myReducer(state, action) {
+                if (action.type === 'ACTION_TYPE') {
+                    return { ...state, data: action.data };
+                }
+                return state;
+            }`,
+        },
+    ],
+
+    invalid: [
+        // This reducer doesn't return a value if action.type is not 'ACTION_TYPE'
+        {
+            code:
+                `function badReducer(state, action) {
+                    if (action.type === 'ACTION_TYPE') {
+                        return { ...state, data: action.data };
+                    }
+                }`,
+            errors: [
+                {
+                    message:
+                        'Reducer function must return a value to avoid undefined state.',
+                    type: 'FunctionDeclaration',
+                },
+            ],
+        },
+    ],
+});
+
+console.log('All tests passed!');