@yoo-digital/eslint-plugin-angular 0.1.9

package/README.md

@@ -0,0 +1,6 @@
+# eslint-plugin-angular
+
+## eslint-plugin-angular
+
+To define custom lint rules for Angular. Similar to eslint-config-angular where existing rules are set.
+

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export declare const rules: Record<string, any>;
+export declare const configs: {
+    default: {
+        plugins: string[];
+        rules: {
+            '@yoo-digital/angular/prefer-boolean-attribute-shorthand': string;
+        };
+    };
+    recommended: {
+        plugins: string[];
+        rules: {
+            '@yoo-digital/angular/prefer-boolean-attribute-shorthand': string;
+        };
+    };
+};

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
+const rules_1 = require("./rules");
+exports.rules = {
+    'prefer-boolean-attribute-shorthand': rules_1.preferBooleanAttributeShorthandRule,
+};
+exports.configs = {
+    default: {
+        plugins: ['@yoo-digital/eslint-plugin-angular'],
+        rules: {
+            '@yoo-digital/angular/prefer-boolean-attribute-shorthand': 'warn',
+        },
+    },
+    recommended: {
+        plugins: ['@yoo-digital/eslint-plugin-angular'],
+        rules: {
+            '@yoo-digital/angular/prefer-boolean-attribute-shorthand': 'error',
+        },
+    },
+};
+module.exports = {
+    rules: exports.rules,
+    configs: exports.configs,
+};

package/dist/rules/index.d.ts

@@ -0,0 +1 @@
+export { preferBooleanAttributeShorthandRule, RULE_NAME } from './prefer-boolean-attribute-shorthand';

package/dist/rules/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RULE_NAME = exports.preferBooleanAttributeShorthandRule = void 0;
+var prefer_boolean_attribute_shorthand_1 = require("./prefer-boolean-attribute-shorthand");
+Object.defineProperty(exports, "preferBooleanAttributeShorthandRule", { enumerable: true, get: function () { return prefer_boolean_attribute_shorthand_1.preferBooleanAttributeShorthandRule; } });
+Object.defineProperty(exports, "RULE_NAME", { enumerable: true, get: function () { return prefer_boolean_attribute_shorthand_1.RULE_NAME; } });

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

@@ -0,0 +1,8 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+interface Options {
+    allowFalseLiteral?: boolean;
+}
+type MessageIds = 'preferTrue' | 'preferFalse' | 'suggestTrue' | 'suggestRemove';
+export declare const RULE_NAME = "prefer-boolean-attribute-shorthand";
+export declare const preferBooleanAttributeShorthandRule: TSESLint.RuleModule<MessageIds, Options[]>;
+export {};

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

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preferBooleanAttributeShorthandRule = exports.RULE_NAME = void 0;
+const utils_1 = require("@angular-eslint/utils");
+exports.RULE_NAME = 'prefer-boolean-attribute-shorthand';
+exports.preferBooleanAttributeShorthandRule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Prefer boolean input attribute shorthand instead of binding to literal true/false.',
+        },
+        hasSuggestions: true,
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    allowFalseLiteral: { type: 'boolean' },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            preferTrue: 'Use attribute shorthand "{{attr}}" instead of [{{attr}}]="true".',
+            preferFalse: 'Avoid binding [{{attr}}]="false"; remove the binding or ensure default is false.',
+            suggestTrue: 'Replace with attribute shorthand {{attr}}',
+            suggestRemove: 'Remove the false binding',
+        },
+    },
+    defaultOptions: [
+        {
+            allowFalseLiteral: false,
+        },
+    ],
+    create(context) {
+        // Robust to missing options: default to [{}] if undefined
+        const optionsArr = context.options ?? [{}];
+        const options = optionsArr[0] ?? {};
+        const allowFalseLiteral = options.allowFalseLiteral ?? false;
+        const parserServices = (0, utils_1.getTemplateParserServices)(context);
+        return {
+            BoundAttribute(node) {
+                const { value } = node;
+                if (!value || !value.ast)
+                    return;
+                const ast = value.ast;
+                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;
+                    if (ast.value === true) {
+                        context.report({
+                            loc,
+                            messageId: 'preferTrue',
+                            data: { attr: attrName },
+                            suggest: [
+                                {
+                                    messageId: 'suggestTrue',
+                                    data: { attr: attrName },
+                                    fix: (fixer) => fixer.replaceTextRange([start, end], attrName),
+                                },
+                            ],
+                        });
+                    }
+                    else if (ast.value === false && !allowFalseLiteral) {
+                        context.report({
+                            loc,
+                            messageId: 'preferFalse',
+                            data: { attr: attrName },
+                            suggest: [
+                                {
+                                    messageId: 'suggestRemove',
+                                    data: { attr: attrName },
+                                    fix: (fixer) => fixer.replaceTextRange([start, end], ''),
+                                },
+                            ],
+                        });
+                    }
+                }
+            },
+        };
+    },
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@yoo-digital/eslint-plugin-angular",
+  "version": "0.1.9",
+  "description": "Yoo Digital custom Angular ESLint plugin providing prefer-boolean-attribute-shorthand rule.",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint src --ext .ts",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "angular",
+    "lint",
+    "yoo-digital"
+  ],
+  "author": "Yoo Digital",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yoo-digital/eslint-plugin-angular.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yoo-digital/eslint-plugin-angular/issues"
+  },
+  "homepage": "https://github.com/yoo-digital/eslint-plugin-angular#readme",
+  "peerDependencies": {
+    "eslint": "^8.57.0",
+    "typescript": ">=5.5.0 <5.7.0",
+  "@angular-eslint/eslint-plugin": ">=19.0.0 <21.0.0",
+  "@angular-eslint/template-parser": ">=19.0.0 <21.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "@typescript-eslint/utils": "^8.7.0",
+    "eslint": "^8.57.0",
+    "@angular-eslint/eslint-plugin": "^20.5.0",
+    "@angular-eslint/template-parser": "^20.5.0",
+    "@types/node": "^20.11.0"
+  }
+}