angular-typed-router-eslint 0.1.1-0

package/README.md

@@ -0,0 +1,3 @@
+# eslint plugin for angular-typed-router
+
+## Attention: Still in experimental phase

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "angular-typed-router-eslint",
+  "version": "0.1.1-0",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./configs/flat-config": "./src/configs/flat-config.js"
+  }
+}

package/src/configs/flat-config.d.ts

@@ -0,0 +1,23 @@
+declare const config: {
+    files: string[];
+    plugins: {
+        'angular-typed-router': {
+            rules: {
+                'no-relative-to-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"relativeTo", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+                'no-trailing-slash-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"navTrailing", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+            };
+        };
+    };
+    rules: {
+        'angular-typed-router/no-relative-to-navigation': string;
+        'angular-typed-router/no-trailing-slash-navigation': string;
+        'no-restricted-imports': (string | {
+            paths: {
+                name: string;
+                importNames: string[];
+                message: string;
+            }[];
+        })[];
+    };
+}[];
+export default config;

package/src/configs/flat-config.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const plugin_1 = require("../lib/plugin");
+const config = [
+    {
+        files: ['**/*.ts', '**/*.html'],
+        plugins: {
+            'angular-typed-router': plugin_1.default,
+        },
+        rules: {
+            'angular-typed-router/no-relative-to-navigation': 'error',
+            'angular-typed-router/no-trailing-slash-navigation': 'error',
+            // Forbid usage of Router and RouterLink from @angular/router
+            'no-restricted-imports': [
+                'error',
+                {
+                    paths: [
+                        {
+                            name: '@angular/router',
+                            importNames: ['Router', 'RouterLink'],
+                            message: 'Use TypedRouter and TypedRouterLink from angular-typed-router instead of Router and RouterLink from @angular/router',
+                        },
+                    ],
+                },
+            ],
+        }
+    }
+];
+exports.default = config;
+module.exports = config;
+//# sourceMappingURL=flat-config.js.map

package/src/configs/flat-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flat-config.js","sourceRoot":"","sources":["../../../../../libs/eslint-plugin/src/configs/flat-config.ts"],"names":[],"mappings":";;AAAA,0CAAmC;AAEnC,MAAM,MAAM,GAAG;IACb;QACE,KAAK,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC;QAC/B,OAAO,EAAE;YACP,sBAAsB,EAAE,gBAAM;SAC/B;QACD,KAAK,EAAE;YACL,gDAAgD,EAAE,OAAO;YACzD,mDAAmD,EAAE,OAAO;YAC5D,6DAA6D;YAC7D,uBAAuB,EAAE;gBACvB,OAAO;gBACP;oBACE,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,iBAAiB;4BACvB,WAAW,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC;4BACrC,OAAO,EAAE,qHAAqH;yBAC/H;qBACF;iBACF;aACF;SACF;KACF;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC;AACtB,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC"}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/plugin';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/plugin"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/eslint-plugin/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B"}

package/src/lib/plugin.d.ts

@@ -0,0 +1,11 @@
+export declare const rules: {
+    'no-relative-to-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"relativeTo", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    'no-trailing-slash-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"navTrailing", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+};
+declare const _default: {
+    rules: {
+        'no-relative-to-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"relativeTo", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+        'no-trailing-slash-navigation': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"navTrailing", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    };
+};
+export default _default;

package/src/lib/plugin.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = void 0;
+const no_relative_to_navigation_1 = require("./rules/no-relative-to-navigation");
+const no_trailing_slash_navigation_1 = require("./rules/no-trailing-slash-navigation");
+exports.rules = {
+    'no-relative-to-navigation': no_relative_to_navigation_1.default,
+    'no-trailing-slash-navigation': no_trailing_slash_navigation_1.default,
+};
+exports.default = { rules: exports.rules };
+//# sourceMappingURL=plugin.js.map

package/src/lib/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../../../libs/eslint-plugin/src/lib/plugin.ts"],"names":[],"mappings":";;;AAAA,iFAAuE;AACvE,uFAA6E;AAEhE,QAAA,KAAK,GAAG;IACnB,2BAA2B,EAAE,mCAAsB;IACnD,8BAA8B,EAAE,sCAAyB;CAC1D,CAAC;AAEF,kBAAe,EAAE,KAAK,EAAL,aAAK,EAAE,CAAC"}

package/src/lib/rules/no-relative-to-navigation.d.ts

@@ -0,0 +1,3 @@
+import { TSESLint } from '@typescript-eslint/utils';
+declare const rule: TSESLint.RuleModule<'relativeTo', []>;
+export default rule;

package/src/lib/rules/no-relative-to-navigation.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow usage of "relativeTo" in router navigation extras to enforce absolute typed navigation.',
+        },
+        schema: [],
+        messages: {
+            relativeTo: 'Usage of "relativeTo" is forbidden. Use absolute paths / commands instead.',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        function isNavigationMember(node) {
+            if (node.computed)
+                return false;
+            if (node.property.type !== 'Identifier')
+                return false;
+            return ['navigate', 'createUrlTree', 'navigateByUrl'].includes(node.property.name);
+        }
+        return {
+            CallExpression(node) {
+                if (node.callee.type === 'MemberExpression' && isNavigationMember(node.callee)) {
+                    for (const arg of node.arguments) {
+                        if (arg.type === 'ObjectExpression') {
+                            for (const prop of arg.properties) {
+                                if (prop.type === 'Property' &&
+                                    !prop.computed &&
+                                    prop.key.type === 'Identifier' &&
+                                    prop.key.name === 'relativeTo') {
+                                    context.report({ node: prop.key, messageId: 'relativeTo' });
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+        };
+    },
+};
+exports.default = rule;
+//# sourceMappingURL=no-relative-to-navigation.js.map

package/src/lib/rules/no-relative-to-navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-relative-to-navigation.js","sourceRoot":"","sources":["../../../../../../libs/eslint-plugin/src/lib/rules/no-relative-to-navigation.ts"],"names":[],"mappings":";;AAEA,MAAM,IAAI,GAA0C;IAClD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,kGAAkG;SAChH;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,UAAU,EAAE,4EAA4E;SACzF;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,SAAS,kBAAkB,CAAC,IAA+B;YACzD,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,KAAK,CAAC;YAChC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY;gBAAE,OAAO,KAAK,CAAC;YACtD,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrF,CAAC;QAED,OAAO;YACL,cAAc,CAAC,IAAI;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC/E,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;wBACjC,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;4BACpC,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;gCAClC,IACE,IAAI,CAAC,IAAI,KAAK,UAAU;oCACxB,CAAC,IAAI,CAAC,QAAQ;oCACd,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY;oCAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,EAC9B,CAAC;oCACD,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;gCAC9D,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/src/lib/rules/no-trailing-slash-navigation.d.ts

@@ -0,0 +1,3 @@
+import { TSESLint } from '@typescript-eslint/utils';
+declare const rule: TSESLint.RuleModule<'navTrailing', []>;
+export default rule;

package/src/lib/rules/no-trailing-slash-navigation.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Forbids usage of trailing slashes in navigation usage sites:
+// 1. <a routerLink="foo/bar/"> (plain attribute)
+// 2. router.navigateByUrl('foo/bar/')
+// 3. router.navigateByUrl('/foo/bar/')
+// Root '/' is allowed.
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow trailing slash in routerLink attributes and navigateByUrl string arguments.',
+        },
+        fixable: 'code',
+        messages: {
+            navTrailing: 'Navigation target "{{path}}" must not end with a trailing slash.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        const sourceCode = context.getSourceCode();
+        function reportAndFixLiteral(node) {
+            const path = node.value;
+            if (typeof path !== 'string')
+                return;
+            if (path.length > 1 && path.endsWith('/')) {
+                context.report({
+                    node,
+                    messageId: 'navTrailing',
+                    data: { path },
+                    fix(fixer) {
+                        const fixed = path.replace(/\/+$/g, '');
+                        return fixer.replaceText(node, `'${fixed}'`);
+                    },
+                });
+            }
+        }
+        function checkCallExpression(node) {
+            if (node.callee.type !== 'MemberExpression' || node.callee.computed)
+                return;
+            const prop = node.callee.property;
+            if (prop.type !== 'Identifier')
+                return;
+            if (prop.name !== 'navigateByUrl')
+                return;
+            const first = node.arguments[0];
+            if (first && first.type === 'Literal' && typeof first.value === 'string') {
+                reportAndFixLiteral(first);
+            }
+        }
+        // Template (HTML) files: naive regex scan for routerLink=".../" occurrences (plain attribute only)
+        function scanTemplateTextOnce() {
+            const text = sourceCode.getText();
+            // regex matches routerLink=".../" capturing path group 1
+            const attrRegex = /routerLink\s*=\s*"([^"\n]*?)"/g; // simple attribute matcher
+            let match;
+            while ((match = attrRegex.exec(text))) {
+                const full = match[0];
+                const path = match[1];
+                if (path.length > 1 && path.endsWith('/')) {
+                    // Location of the path literal inside the attribute
+                    const pathStartIdx = match.index + full.indexOf('"') + 1;
+                    const pathEndIdx = pathStartIdx + path.length; // exclusive
+                    context.report({
+                        loc: {
+                            start: sourceCode.getLocFromIndex(pathStartIdx),
+                            end: sourceCode.getLocFromIndex(pathEndIdx),
+                        },
+                        messageId: 'navTrailing',
+                        data: { path },
+                        fix(fixer) {
+                            const fixed = path.replace(/\/+$/g, '');
+                            return fixer.replaceTextRange([pathStartIdx, pathEndIdx], fixed);
+                        },
+                    });
+                }
+            }
+        }
+        let scanned = false;
+        return {
+            Program() {
+                // Run once per file; HTML templates also come through with Program root when using angular-eslint
+                if (!scanned) {
+                    scanTemplateTextOnce();
+                    scanned = true;
+                }
+            },
+            CallExpression: checkCallExpression,
+        };
+    },
+};
+exports.default = rule;
+//# sourceMappingURL=no-trailing-slash-navigation.js.map

package/src/lib/rules/no-trailing-slash-navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-trailing-slash-navigation.js","sourceRoot":"","sources":["../../../../../../libs/eslint-plugin/src/lib/rules/no-trailing-slash-navigation.ts"],"names":[],"mappings":";;AAEA,+DAA+D;AAC/D,iDAAiD;AACjD,sCAAsC;AACtC,uCAAuC;AACvC,uBAAuB;AAEvB,MAAM,IAAI,GAA2C;IACnD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,sFAAsF;SACpG;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,WAAW,EAAE,kEAAkE;SAChF;QACD,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAE3C,SAAS,mBAAmB,CAAC,IAA0C;YACrE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YACxB,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,OAAO;YACrC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAE,aAAa;oBACxB,IAAI,EAAE,EAAE,IAAI,EAAE;oBACd,GAAG,CAAC,KAAK;wBACP,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBACxC,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC;oBAC/C,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,SAAS,mBAAmB,CAAC,IAA6B;YACxD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,OAAO;YAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAClC,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY;gBAAE,OAAO;YACvC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe;gBAAE,OAAO;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACzE,mBAAmB,CAAC,KAA6C,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QAED,mGAAmG;QACnG,SAAS,oBAAoB;YAC3B,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;YAClC,yDAAyD;YACzD,MAAM,SAAS,GAAG,gCAAgC,CAAC,CAAC,2BAA2B;YAC/E,IAAI,KAA6B,CAAC;YAClC,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACtB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1C,oDAAoD;oBAClD,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACzD,MAAM,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,YAAY;oBAC3D,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE;4BACH,KAAK,EAAE,UAAU,CAAC,eAAe,CAAC,YAAY,CAAC;4BAC/C,GAAG,EAAE,UAAU,CAAC,eAAe,CAAC,UAAU,CAAC;yBAC5C;wBACD,SAAS,EAAE,aAAa;wBACxB,IAAI,EAAE,EAAE,IAAI,EAAE;wBACd,GAAG,CAAC,KAAK;4BACP,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;4BACxC,OAAO,KAAK,CAAC,gBAAgB,CAAC,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;wBACnE,CAAC;qBACF,CAAC,CAAC;gBACP,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,OAAO;YACL,OAAO;gBACL,kGAAkG;gBAClG,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,oBAAoB,EAAE,CAAC;oBACvB,OAAO,GAAG,IAAI,CAAC;gBACjB,CAAC;YACH,CAAC;YACD,cAAc,EAAE,mBAAmB;SACpC,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}