@dineroregnskab/eslint-plugin-custom-rules 2.0.7 → 2.1.0

package/README.md

@@ -7,24 +7,63 @@ Custom extended rules for various Dinero specific standards & conventions.
 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
+## Development
+
+Run `npm i` in root and in `/example`.
+
+### Adding rules
 
-Add the rule here:
+- Add the rule here: `dinero-web-2.0/Dinero.Packages/Dinero.EslintCustomRules/rules`
 
-`dinero-web-2.0/Dinero.Packages/Dinero.EslintCustomRules/rules`
+- Add the new js rule to this file `eslint-plugin-custom-rules.js`.
 
-You can test the rule by adding some code to test it on here.
+- You can test the rule by adding some HTML code to test it on here `dinero-web-2.0/Dinero.Packages/Dinero.EslintCustomRules/example`
 
-`dinero-web-2.0/Dinero.Packages/Dinero.EslintCustomRules/example`
+- After adding the rule you can restart the ESLint server in vs code by pressing F1 -> ESLint: Restart ESLint Server.
+
+Add html rules in `test.html` and run test with
+
+```bash
+npm run testhtml
+```
 
-And run:
+Add ts rules in `test.ts` and run test with
 
 ```bash
-npx eslint test.ts
+npm run testts
+```
+
+#### Debugging what the eslint sees
+
+Add a rule, and log it with console log, to see in terminal what is going on. Then run `npm run testhtml` npm script to see it in terminal.
+
+```js
+module.exports = {
+    meta: {
+        type: "suggestion",
+        docs: {
+            description:
+                "Enforce using `danishCurrency` pipe instead of `currency` pipe in Angular HTML templates.",
+        },
+        fixable: "code",
+        schema: [],
+    },
+
+    create(context) {
+        return {
+            // Target the entire file and traverse each node
+            Program(node) {
+                console.log("Parsed Node Types:", node);
+            },
+        };
+    },
+};
+
 ```
 
 ### Publish & install new rule locally
@@ -34,12 +73,14 @@ 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:
@@ -52,9 +93,8 @@ Example:
 npm i
 ````
 
-> **Note: You might need to restart the IDE for the new rule to apply**
+> **Note: You need to restart ESLint to apply new rules. Restart the ESLint server in vs code by pressing F1 -> ESLint: Restart ESLint Server or F1 -> reload window**
 
-#
 See [ESLint custom rule tutorial](https://eslint.org/docs/latest/extend/custom-rule-tutorial) for more.
 
 Useful tool for working with AST tree: [AST Explorer](https://astexplorer.net/)

package/eslint-plugin-custom-rules.js

@@ -1,12 +1,16 @@
-const returnReducerRule = require('./rules/reducers-should-always-return');
-const camelCaseRule = require('./rules/camel-case-attributes');
-const dayjsWithTimeZoneRule = require('./rules/dayjs-with-timezone');
+const returnReducerRule = require("./rules/reducers-should-always-return");
+const camelCaseRule = require("./rules/camel-case-attributes");
+const dayjsWithTimeZoneRule = require("./rules/dayjs-with-timezone");
+const useDanishCurrencyPipeRule = require("./rules/use-danish-currency-pipe");
+const replaceFirstWithTakeRule = require("./rules/replace-first-with-take");
 
 const customRulesPlugin = {
     rules: {
-        'reducers-should-always-return': returnReducerRule,
-        'attr-camel-case-rule': camelCaseRule,
-        'dayjs-with-timezone': dayjsWithTimeZoneRule,
+        "reducers-should-always-return": returnReducerRule,
+        "attr-camel-case-rule": camelCaseRule,
+        "dayjs-with-timezone": dayjsWithTimeZoneRule,
+        "use-danish-currency-pipe": useDanishCurrencyPipeRule,
+        "replace-first-with-take": replaceFirstWithTakeRule,
     },
 };
 

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@dineroregnskab/eslint-plugin-custom-rules",
-  "version": "2.0.7",
+  "version": "2.1.0",
   "description": "ESLint plugin with custom rules for Dinero Regnskab",
   "main": "eslint-plugin-custom-rules.js",
-  "scripts": {
-    "test": ""
-  },
+  "scripts": {},
   "keywords": [],
   "author": "",
   "license": "ISC",

package/rules/replace-first-with-take.js

@@ -0,0 +1,31 @@
+module.exports = {
+    meta: {
+        type: "suggestion",
+        docs: {
+            description:
+                "Replace `first()` with `take(1)` in TypeScript files.",
+        },
+        fixable: "code",
+        schema: [],
+    },
+
+    create(context) {
+        return {
+            // Target CallExpressions like `first()`
+            CallExpression(node) {
+                // Check if the callee (function being called) is `first`
+                if (
+                    node.callee.type === "Identifier" &&
+                    node.callee.name === "first" &&
+                    node.arguments.length === 0 // Ensure `first` is called with no arguments
+                ) {
+                    context.report({
+                        node,
+                        message:
+                            "Replace `first()` with `take(1)` to avoid errors if no value is ever emitted.",
+                    });
+                }
+            },
+        };
+    },
+};

package/rules/use-danish-currency-pipe.js

@@ -0,0 +1,53 @@
+module.exports = {
+    meta: {
+        type: "suggestion",
+        docs: {
+            description:
+                "Enforce using `danishCurrency` pipe instead of `currency` pipe in Angular HTML templates.",
+        },
+        fixable: "code",
+        schema: [],
+    },
+
+    create(context) {
+        return {
+            Program(node) {
+                const templateContent = node.value;
+                const currencyPipeRegex = /\|\s*currency/g;
+
+                let match;
+                while (
+                    (match = currencyPipeRegex.exec(templateContent)) !== null
+                ) {
+                    const matchStart = match.index;
+                    const matchEnd = match.index + match[0].length;
+
+                    const startLine = templateContent
+                        .slice(0, matchStart)
+                        .split("\n").length;
+                    const startColumn =
+                        matchStart -
+                        templateContent.lastIndexOf("\n", matchStart) -
+                        1;
+
+                    const endLine = templateContent
+                        .slice(0, matchEnd)
+                        .split("\n").length;
+                    const endColumn =
+                        matchEnd -
+                        templateContent.lastIndexOf("\n", matchEnd) -
+                        1;
+
+                    context.report({
+                        loc: {
+                            start: { line: startLine, column: startColumn },
+                            end: { line: endLine, column: endColumn },
+                        },
+                        message:
+                            "Use `danishCurrency` instead of `currency` pipe. We can't use Angular's native `currency` pipe because it doesn't support inputs with commas as decimal separators.",
+                    });
+                }
+            },
+        };
+    },
+};

package/willy.yaml

@@ -0,0 +1,5 @@
+type: package
+name: package-eslint-custom-rules
+aliases:
+  - eslint-custom-rules
+  - eslintcustomrules