@dineroregnskab/eslint-plugin-custom-rules 2.0.6 → 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,10 +1,16 @@
-const returnReducerRule = require('./rules/reducers-should-always-return');
-const camelCaseRule = require('./rules/camel-case-attributes');
+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,
+        "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.6",
+  "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

package/node_modules/@aashutoshrathi/word-wrap/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014-2016, Jon Schlinkert
-
-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/node_modules/@aashutoshrathi/word-wrap/README.md

@@ -1,182 +0,0 @@
-# word-wrap [![NPM version](https://img.shields.io/npm/v/word-wrap.svg?style=flat)](https://www.npmjs.com/package/word-wrap) [![NPM monthly downloads](https://img.shields.io/npm/dm/word-wrap.svg?style=flat)](https://npmjs.org/package/word-wrap) [![NPM total downloads](https://img.shields.io/npm/dt/word-wrap.svg?style=flat)](https://npmjs.org/package/word-wrap) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/word-wrap.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/word-wrap)
-
-> Wrap words to a specified length.
-
-## Install
-
-Install with [npm](https://www.npmjs.com/):
-
-```sh
-$ npm install --save word-wrap
-```
-
-## Usage
-
-```js
-var wrap = require('word-wrap');
-
-wrap('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.');
-```
-
-Results in:
-
-```
-  Lorem ipsum dolor sit amet, consectetur adipiscing
-  elit, sed do eiusmod tempor incididunt ut labore
-  et dolore magna aliqua. Ut enim ad minim veniam,
-  quis nostrud exercitation ullamco laboris nisi ut
-  aliquip ex ea commodo consequat.
-```
-
-## Options
-
-![image](https://cloud.githubusercontent.com/assets/383994/6543728/7a381c08-c4f6-11e4-8b7d-b6ba197569c9.png)
-
-### options.width
-
-Type: `Number`
-
-Default: `50`
-
-The width of the text before wrapping to a new line.
-
-**Example:**
-
-```js
-wrap(str, {width: 60});
-```
-
-### options.indent
-
-Type: `String`
-
-Default: `` (none)
-
-The string to use at the beginning of each line.
-
-**Example:**
-
-```js
-wrap(str, {indent: '      '});
-```
-
-### options.newline
-
-Type: `String`
-
-Default: `\n`
-
-The string to use at the end of each line.
-
-**Example:**
-
-```js
-wrap(str, {newline: '\n\n'});
-```
-
-### options.escape
-
-Type: `function`
-
-Default: `function(str){return str;}`
-
-An escape function to run on each line after splitting them.
-
-**Example:**
-
-```js
-var xmlescape = require('xml-escape');
-wrap(str, {
-  escape: function(string){
-    return xmlescape(string);
-  }
-});
-```
-
-### options.trim
-
-Type: `Boolean`
-
-Default: `false`
-
-Trim trailing whitespace from the returned string. This option is included since `.trim()` would also strip the leading indentation from the first line.
-
-**Example:**
-
-```js
-wrap(str, {trim: true});
-```
-
-### options.cut
-
-Type: `Boolean`
-
-Default: `false`
-
-Break a word between any two letters when the word is longer than the specified width.
-
-**Example:**
-
-```js
-wrap(str, {cut: true});
-```
-
-## About
-
-### Related projects
-
-* [common-words](https://www.npmjs.com/package/common-words): Updated list (JSON) of the 100 most common words in the English language. Useful for… [more](https://github.com/jonschlinkert/common-words) | [homepage](https://github.com/jonschlinkert/common-words "Updated list (JSON) of the 100 most common words in the English language. Useful for excluding these words from arrays.")
-* [shuffle-words](https://www.npmjs.com/package/shuffle-words): Shuffle the words in a string and optionally the letters in each word using the… [more](https://github.com/jonschlinkert/shuffle-words) | [homepage](https://github.com/jonschlinkert/shuffle-words "Shuffle the words in a string and optionally the letters in each word using the Fisher-Yates algorithm. Useful for creating test fixtures, benchmarking samples, etc.")
-* [unique-words](https://www.npmjs.com/package/unique-words): Return the unique words in a string or array. | [homepage](https://github.com/jonschlinkert/unique-words "Return the unique words in a string or array.")
-* [wordcount](https://www.npmjs.com/package/wordcount): Count the words in a string. Support for english, CJK and Cyrillic. | [homepage](https://github.com/jonschlinkert/wordcount "Count the words in a string. Support for english, CJK and Cyrillic.")
-
-### Contributing
-
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
-
-### Contributors
-
-| **Commits** | **Contributor** | 
-| --- | --- |
-| 43 | [jonschlinkert](https://github.com/jonschlinkert) |
-| 2 | [lordvlad](https://github.com/lordvlad) |
-| 2 | [hildjj](https://github.com/hildjj) |
-| 1 | [danilosampaio](https://github.com/danilosampaio) |
-| 1 | [2fd](https://github.com/2fd) |
-| 1 | [toddself](https://github.com/toddself) |
-| 1 | [wolfgang42](https://github.com/wolfgang42) |
-| 1 | [zachhale](https://github.com/zachhale) |
-
-### Building docs
-
-_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
-
-To generate the readme, run the following command:
-
-```sh
-$ npm install -g verbose/verb#dev verb-generate-readme && verb
-```
-
-### Running tests
-
-Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
-
-```sh
-$ npm install && npm test
-```
-
-### Author
-
-**Jon Schlinkert**
-
-* [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
-
-### License
-
-Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT License](LICENSE).
-
-***
-
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 02, 2017._

package/node_modules/@aashutoshrathi/word-wrap/index.d.ts

@@ -1,50 +0,0 @@
-/**
- * Wrap words to a specified length.
- */
-export = wrap;
-
-declare function wrap(str: string, options?: wrap.IOptions): string;
-
-declare namespace wrap {
-    export interface IOptions {
-
-        /**
-         * The width of the text before wrapping to a new line.
-         * @default ´50´
-         */
-        width?: number;
-
-        /**
-         * The string to use at the beginning of each line.
-         * @default ´´ (none)
-         */
-        indent?: string;
-
-        /**
-         * The string to use at the end of each line.
-         * @default ´\n´
-         */
-        newline?: string;
-
-        /**
-         * An escape function to run on each line after splitting them.
-         * @default (str: string) => string;
-         */
-        escape?: (str: string) => string;
-
-        /**
-         * Trim trailing whitespace from the returned string.
-         * This option is included since .trim() would also strip
-         * the leading indentation from the first line.
-         * @default true
-         */
-        trim?: boolean;
-
-        /**
-         * Break a word between any two letters when the word is longer
-         * than the specified width.
-         * @default false
-         */
-        cut?: boolean;
-    }
-}

package/node_modules/@aashutoshrathi/word-wrap/index.js

@@ -1,52 +0,0 @@
-/*!
- * word-wrap <https://github.com/jonschlinkert/word-wrap>
- *
- * Copyright (c) 2014-2023, Jon Schlinkert.
- * Released under the MIT License.
- */
-
-function trimTabAndSpaces(str) {
-  const lines = str.split('\n');
-  const trimmedLines = lines.map((line) => line.trimEnd());
-  return trimmedLines.join('\n');
-}
-
-module.exports = function(str, options) {
-  options = options || {};
-  if (str == null) {
-    return str;
-  }
-
-  var width = options.width || 50;
-  var indent = (typeof options.indent === 'string')
-    ? options.indent
-    : '';
-
-  var newline = options.newline || '\n' + indent;
-  var escape = typeof options.escape === 'function'
-    ? options.escape
-    : identity;
-
-  var regexString = '.{1,' + width + '}';
-  if (options.cut !== true) {
-    regexString += '([\\s\u200B]+|$)|[^\\s\u200B]+?([\\s\u200B]+|$)';
-  }
-
-  var re = new RegExp(regexString, 'g');
-  var lines = str.match(re) || [];
-  var result = indent + lines.map(function(line) {
-    if (line.slice(-1) === '\n') {
-      line = line.slice(0, line.length - 1);
-    }
-    return escape(line);
-  }).join(newline);
-
-  if (options.trim === true) {
-    result = trimTabAndSpaces(result);
-  }
-  return result;
-};
-
-function identity(str) {
-  return str;
-}

package/node_modules/@aashutoshrathi/word-wrap/package.json

@@ -1,81 +0,0 @@
-{
-  "name": "@aashutoshrathi/word-wrap",
-  "description": "Wrap words to a specified length.",
-  "version": "1.2.6",
-  "homepage": "https://github.com/aashutoshrathi/word-wrap",
-  "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
-  "contributors": [
-    "Aashutosh Rathi <aashutoshrathi@gmail.com>",
-    "Danilo Sampaio <danilo.sampaio@gmail.com> (localhost:8080)",
-    "Fede Ramirez <i@2fd.me> (https://2fd.github.io)",
-    "Joe Hildebrand <joe-github@cursive.net> (https://twitter.com/hildjj)",
-    "Jon Schlinkert <jon.schlinkert@sellside.com> (http://twitter.com/jonschlinkert)",
-    "Todd Kennedy (https://tck.io)",
-    "Waldemar Reusch (https://github.com/lordvlad)",
-    "Wolfgang Faust (http://www.linestarve.com)",
-    "Zach Hale <zachhale@gmail.com> (http://zachhale.com)"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/aashutoshrathi/word-wrap.git"
-  },
-  "bugs": {
-    "url": "https://github.com/aashutoshrathi/word-wrap/issues"
-  },
-  "license": "MIT",
-  "files": [
-    "index.js",
-    "index.d.ts"
-  ],
-  "main": "index.js",
-  "engines": {
-    "node": ">=0.10.0"
-  },
-  "scripts": {
-    "test": "mocha"
-  },
-  "devDependencies": {
-    "gulp-format-md": "^0.1.11",
-    "mocha": "^10.2.0"
-  },
-  "keywords": [
-    "break",
-    "carriage",
-    "line",
-    "new-line",
-    "newline",
-    "return",
-    "soft",
-    "text",
-    "word",
-    "word-wrap",
-    "words",
-    "wrap"
-  ],
-  "typings": "index.d.ts",
-  "verb": {
-    "toc": false,
-    "layout": "default",
-    "tasks": [
-      "readme"
-    ],
-    "plugins": [
-      "gulp-format-md"
-    ],
-    "lint": {
-      "reflinks": true
-    },
-    "related": {
-      "list": [
-        "common-words",
-        "shuffle-words",
-        "unique-words",
-        "wordcount"
-      ]
-    },
-    "reflinks": [
-      "verb",
-      "verb-generate-readme"
-    ]
-  }
-}

package/node_modules/@angular-eslint/bundled-angular-compiler/README.md

@@ -1 +0,0 @@
-# @angular-eslint/bundled-angular-compiler

package/node_modules/@angular-eslint/bundled-angular-compiler/dist/index.d.ts

@@ -1,5 +0,0 @@
-export * from '@angular/compiler';
-import type { MessageBundle, ParsedTemplate, LocalizedString } from '@angular/compiler';
-export type Comment = Required<ParsedTemplate>['commentNodes'][number];
-export type Message = ReturnType<MessageBundle['getMessages']>[number];
-export type I18nMeta = LocalizedString['metaBlock'];