@yoo-digital/eslint-plugin-angular 1.1.0 → 1.2.1

package/README.md

@@ -6,32 +6,17 @@ Here should live all custom Angular lint rules that eslint does not already prov
 
 ## Linting
 
-Wrong code is yellow underlined in VScode, it can also be raises running : `npm run lint`
+Wrong code is yellow/red underlined in VScode, it can also be raises running : `npm run lint`
 
-## Rule 1 : boolean input conversion (prefer-boolean-attribute-shorthand)
+---
+
+## Rule 1 : boolean input conversion
 
 `booleanAttribute @angular/core`
 
 `BooleanInput @angular/cdk/coercion`
 
-### ⚠️ Important Limitations
-
-**Current Implementation:** This rule enforces shorthand syntax (`<x a />` instead of `<x [a]="true" />`) but **cannot automatically verify**:
-- Whether an input has `transform: booleanAttribute` 
-- What the default value of an input is
-
-This is a technical limitation of Angular ESLint - template rules cannot access the component's TypeScript code.
-
-### Recommended Usage
-
-This rule works best when:
-1. **All boolean inputs** in your project use `booleanAttribute` transform
-2. **Most boolean inputs** have `default = false` or no default
-3. You treat this as a **style guide enforcer** rather than a safety checker
-
-### Configuration
-
-By default, the rule only flags `[attr]="true"` bindings (safe default):
+The rule only flags components inputs `[isVegan]="true"` bindings and ignores `[isVegan]="false"` bindings:
 
 ```json
 {
@@ -41,73 +26,24 @@ By default, the rule only flags `[attr]="true"` bindings (safe default):
 }
 ```
 
-To also enforce removal of `[attr]="false"` bindings:
-
-```json
-{
-  "rules": {
-    "@yoo-digital/eslint-plugin-angular/prefer-boolean-attribute-shorthand": [
-      "error",
-      { "allowFalseLiteral": false }
-    ]
-  }
-}
-```
-
 ### Examples
 
-#### ✅ Recommended Pattern (Default false or no default)
-
-```typescript
-// Component
-@Input({ transform: booleanAttribute }) disabled: boolean = false;
-// OR
-disabled = input<boolean, BooleanInput>(false, { transform: booleanAttribute });
-```
-
-**Template:**
-- ❌ `<button [disabled]="true">` → Should be `<button disabled>`
-- ✅ `<button disabled>` (shorthand for true)
-- ✅ `<button>` (omit for false)
-- ✅ `<button [disabled]="isLoading">` (expressions are allowed)
-
-#### ⚠️ Special Case: Default true (Disable rule if needed)
-
-```typescript
-// Component
-@Input({ transform: booleanAttribute }) enabled: boolean = true;
-```
-
-**Template:**
 ```html
-<!-- eslint-disable-next-line @yoo-digital/eslint-plugin-angular/prefer-boolean-attribute-shorthand -->
-<button [enabled]="false">Explicitly disabled</button>
+<!-- this will raise lint issue -->
+<myMealComponent [isVegan]="true" />
+<!-- false value raises no lint issue (ignored) -->
+<myMealComponent [isVegan]="false" />
 ```
 
-When default is `true`, you may need explicit `[attr]="true"` or `[attr]="false"` bindings.
-
-#### ❌ Without booleanAttribute (Won't work!)
+Lint enforces use of boolean attribute : 
 
 ```typescript
-// Component - Missing transform!
-@Input() checked: boolean = false;
+// Modern signal way
+isVegan = input<boolean, BooleanInput>(false, { transform: booleanAttribute });
+// Old decorator way
+@Input({ transform: booleanAttribute }) isVegan: boolean = false;
 ```
 
-**Template:**
-- ❌ `<input checked>` → Will pass `""` (empty string), NOT boolean!
-- ✅ `<input [checked]="true">` (must use property binding)
-
-### Decorator Syntax
-
-`@Input({ transform: booleanAttribute }) myInput: boolean = false;`
-
-### Signal Input Syntax
-
-`myInput = input<boolean, BooleanInput>(false, { transform: booleanAttribute });`
-
-### Summary
+---
 
-- **Rule enforces**: `[attr]="true"` → `attr` shorthand
-- **Rule assumes**: Inputs have `booleanAttribute` and `default ≠ true`
-- **Manual override**: Use eslint-disable comments for special cases
-- **Best practice**: Ensure all boolean inputs use `booleanAttribute`
+## Rule 2 : ...

package/dist/rules/prefer-boolean-attribute-shorthand.d.ts

@@ -1,37 +1,25 @@
 import type { TSESLint } from '@typescript-eslint/utils';
-interface Options {
-    allowFalseLiteral?: boolean;
-}
-type MessageIds = 'preferTrue' | 'preferFalse' | 'suggestTrue' | 'suggestRemove';
+type MessageIds = 'preferTrue' | 'suggestTrue';
 export declare const RULE_NAME = "prefer-boolean-attribute-shorthand";
 /**
- * IMPORTANT LIMITATIONS:
+ * This rule enforces shorthand syntax for boolean inputs bound to true.
  *
- * Angular ESLint template rules cannot directly access the TypeScript component class
- * to check for booleanAttribute transforms or default values. This would require:
- * 1. Access to the TypeScript program (not available in template parser services)
- * 2. Cross-file analysis (template -> component.ts)
- * 3. Complex AST traversal and decorator/signal input analysis
+ * BEHAVIOR:
+ * - [attr]="true"  → Warns and suggests: attr
+ * - [attr]="false" → No warning (ignored)
+ * - attr           → OK (already shorthand)
  *
- * The current implementation enforces shorthand syntax for [attr]="true" bindings
- * but cannot verify:
- * - Whether the input has `transform: booleanAttribute`
- * - What the default value of the input is
+ * ASSUMPTIONS:
+ * This rule assumes that boolean inputs use Angular's booleanAttribute transform,
+ * which allows the shorthand syntax to work correctly. The presence of the attribute
+ * alone (without a binding) will be interpreted as true.
  *
- * RECOMMENDATIONS FOR USERS:
- * 1. Only use this rule in projects where ALL boolean inputs have booleanAttribute
- * 2. If an input has default=true, manually disable the rule for that binding
- * 3. Consider the rule as a style guide enforcer, not a safety checker
+ * LIMITATIONS:
+ * Cannot verify at lint-time whether:
+ * - The input actually has `transform: booleanAttribute`
+ * - The input's default value
  *
- * FUTURE ENHANCEMENTS:
- * To implement the full feature set requested would require creating a SEPARATE
- * TypeScript ESLint rule that:
- * - Runs on .ts component files (not templates)
- * - Analyzes @Component decorators to find template  references
- * - Parses templates and cross-references with component inputs
- * - Reports errors in both .ts and template files
- *
- * This would be a significantly more complex multi-file analysis rule.
+ * Use this rule in projects where boolean inputs consistently use booleanAttribute.
  */
-export declare const preferBooleanAttributeShorthandRule: TSESLint.RuleModule<MessageIds, Options[]>;
+export declare const preferBooleanAttributeShorthandRule: TSESLint.RuleModule<MessageIds, []>;
 export {};

package/dist/rules/prefer-boolean-attribute-shorthand.js

@@ -4,67 +4,40 @@ exports.preferBooleanAttributeShorthandRule = exports.RULE_NAME = void 0;
 const utils_1 = require("@angular-eslint/utils");
 exports.RULE_NAME = 'prefer-boolean-attribute-shorthand';
 /**
- * IMPORTANT LIMITATIONS:
+ * This rule enforces shorthand syntax for boolean inputs bound to true.
  *
- * Angular ESLint template rules cannot directly access the TypeScript component class
- * to check for booleanAttribute transforms or default values. This would require:
- * 1. Access to the TypeScript program (not available in template parser services)
- * 2. Cross-file analysis (template -> component.ts)
- * 3. Complex AST traversal and decorator/signal input analysis
+ * BEHAVIOR:
+ * - [attr]="true"  → Warns and suggests: attr
+ * - [attr]="false" → No warning (ignored)
+ * - attr           → OK (already shorthand)
  *
- * The current implementation enforces shorthand syntax for [attr]="true" bindings
- * but cannot verify:
- * - Whether the input has `transform: booleanAttribute`
- * - What the default value of the input is
+ * ASSUMPTIONS:
+ * This rule assumes that boolean inputs use Angular's booleanAttribute transform,
+ * which allows the shorthand syntax to work correctly. The presence of the attribute
+ * alone (without a binding) will be interpreted as true.
  *
- * RECOMMENDATIONS FOR USERS:
- * 1. Only use this rule in projects where ALL boolean inputs have booleanAttribute
- * 2. If an input has default=true, manually disable the rule for that binding
- * 3. Consider the rule as a style guide enforcer, not a safety checker
+ * LIMITATIONS:
+ * Cannot verify at lint-time whether:
+ * - The input actually has `transform: booleanAttribute`
+ * - The input's default value
  *
- * FUTURE ENHANCEMENTS:
- * To implement the full feature set requested would require creating a SEPARATE
- * TypeScript ESLint rule that:
- * - Runs on .ts component files (not templates)
- * - Analyzes @Component decorators to find template  references
- * - Parses templates and cross-references with component inputs
- * - Reports errors in both .ts and template files
- *
- * This would be a significantly more complex multi-file analysis rule.
+ * Use this rule in projects where boolean inputs consistently use booleanAttribute.
  */
 exports.preferBooleanAttributeShorthandRule = {
     meta: {
         type: 'suggestion',
         docs: {
-            description: 'Prefer boolean input attribute shorthand instead of binding to literal true/false. NOTE: This rule assumes inputs have booleanAttribute transform and does not have default=true.',
+            description: 'Prefer boolean input attribute shorthand when binding to true (e.g., use "disabled" instead of [disabled]="true").',
         },
         hasSuggestions: true,
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    allowFalseLiteral: { type: 'boolean' },
-                },
-                additionalProperties: false,
-            },
-        ],
+        schema: [],
         messages: {
-            preferTrue: 'Use attribute shorthand "{{attr}}" instead of [{{attr}}]="true". WARNING: Only works if input has booleanAttribute transform.',
-            preferFalse: 'Avoid binding [{{attr}}]="false"; remove the binding if default is false.',
+            preferTrue: 'Use attribute shorthand "{{attr}}" instead of [{{attr}}]="true".',
             suggestTrue: 'Replace with attribute shorthand {{attr}}',
-            suggestRemove: 'Remove the false binding',
         },
     },
-    defaultOptions: [
-        {
-            allowFalseLiteral: true, // Changed default to true for safety
-        },
-    ],
+    defaultOptions: [],
     create(context) {
-        // Robust to missing options: default to [{}] if undefined
-        const optionsArr = context.options ?? [{}];
-        const options = optionsArr[0] ?? {};
-        const allowFalseLiteral = options.allowFalseLiteral ?? true; // Default to true for safety
         const parserServices = (0, utils_1.getTemplateParserServices)(context);
         return {
             BoundAttribute(node) {
@@ -72,14 +45,14 @@ exports.preferBooleanAttributeShorthandRule = {
                 if (!value || !value.ast)
                     return;
                 const ast = value.ast;
+                // Only check for boolean literals
                 if (ast?.constructor?.name === 'LiteralPrimitive' && typeof ast.value === 'boolean') {
-                    const attrName = node.name;
-                    const loc = parserServices.convertNodeSourceSpanToLoc(node.sourceSpan);
-                    const start = node.sourceSpan.start.offset;
-                    const end = node.sourceSpan.end.offset;
+                    // Only warn for [attr]="true", ignore [attr]="false"
                     if (ast.value === true) {
-                        // Enforce shorthand for true bindings
-                        // NOTE: This assumes the input has booleanAttribute and default != true
+                        const attrName = node.name;
+                        const loc = parserServices.convertNodeSourceSpanToLoc(node.sourceSpan);
+                        const start = node.sourceSpan.start.offset;
+                        const end = node.sourceSpan.end.offset;
                         context.report({
                             loc,
                             messageId: 'preferTrue',
@@ -93,21 +66,7 @@ exports.preferBooleanAttributeShorthandRule = {
                             ],
                         });
                     }
-                    else if (ast.value === false && !allowFalseLiteral) {
-                        // Only flag false bindings if explicitly configured
-                        context.report({
-                            loc,
-                            messageId: 'preferFalse',
-                            data: { attr: attrName },
-                            suggest: [
-                                {
-                                    messageId: 'suggestRemove',
-                                    data: { attr: attrName },
-                                    fix: (fixer) => fixer.replaceTextRange([start, end], ''),
-                                },
-                            ],
-                        });
-                    }
+                    // [attr]="false" is explicitly ignored - no warning
                 }
             },
         };

package/package.json

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