@yoo-digital/eslint-plugin-angular 0.1.9 → 1.0.0

package/README.md

@@ -1,6 +1,35 @@
 # eslint-plugin-angular
 
-## eslint-plugin-angular
+## Custom lint purpose
 
-To define custom lint rules for Angular. Similar to eslint-config-angular where existing rules are set.
+Here should live all custom Angular lint rules that eslint does not already provide.
 
+## Linting
+
+Wrong code is yellow underlined in VScode, it can also be raises running : `npm run lint`
+
+## Rule 1 : boolean input conversion
+
+`booleanAttribute @angular/core`
+
+`BooleanInput @angular/cdk/coercion`
+
+### Examples
+
+`<myComp [myBoolInput]="true" ` must be `<myComp myBoolInput`
+
+`<myComp [myBoolInput]="false"` must be `<myComp `
+
+`<myComp [myBoolInput]="2+2===4"` is accepted
+
+### Decorator
+
+`@Input({ transform: booleanAttribute }) myInput: boolean = true;`
+
+### Signal
+
+`myInput = input<boolean, BooleanInput>(true, {transform: booleanAttribute,});`
+
+### Exception
+
+If a **required** boolean input needs to be false, no choice, `[myRequiredInput]="false"` must be written. Therefore boolean input should never be required.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yoo-digital/eslint-plugin-angular",
-  "version": "0.1.9",
+  "version": "1.0.0",
   "description": "Yoo Digital custom Angular ESLint plugin providing prefer-boolean-attribute-shorthand rule.",
   "type": "commonjs",
   "main": "dist/index.js",