@neralabs/rerail-pack-typescript 0.1.0

package/pack.json

@@ -0,0 +1,189 @@
+{
+  "format": "rerail.rule-pack/v1",
+  "id": "typescript",
+  "name": "TypeScript",
+  "category": "language",
+  "covers": "22 typescript-eslint rules ported to Rerail, 11 of them on and 11 off until turned on, each scored against the tool's own recorded findings on its test fixtures.",
+  "reason": "matches TypeScript",
+  "match": {
+    "any": [
+      {
+        "npmDependencies": [
+          "typescript"
+        ]
+      },
+      {
+        "files": [
+          "**/*.ts",
+          "**/*.mts",
+          "**/*.cts"
+        ],
+        "exclude": [
+          "**/*.d.ts"
+        ],
+        "label": "*.ts files"
+      },
+      {
+        "files": [
+          "**/*.tsx"
+        ],
+        "label": "*.tsx files"
+      }
+    ]
+  },
+  "rules": [
+    {
+      "id": "typescript-eslint-ban-tslint-comment",
+      "document": "rules/typescript-eslint-ban-tslint-comment.json",
+      "title": "typescript-eslint ban-tslint-comment: Disallow `// tslint:<rule-flag>` comments",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-consistent-type-definitions",
+      "document": "rules/typescript-eslint-consistent-type-definitions.json",
+      "title": "typescript-eslint consistent-type-definitions: Enforce type definitions to consistently use either `interface` or `type`",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-default-param-last",
+      "document": "rules/typescript-eslint-default-param-last.json",
+      "title": "typescript-eslint default-param-last: Enforce default parameters to be last",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-array-constructor",
+      "document": "rules/typescript-eslint-no-array-constructor.json",
+      "title": "typescript-eslint no-array-constructor: Disallow generic `Array` constructors",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-confusing-non-null-assertion",
+      "document": "rules/typescript-eslint-no-confusing-non-null-assertion.json",
+      "title": "typescript-eslint no-confusing-non-null-assertion: Disallow non-null assertion in locations that may be confusing",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-dupe-class-members",
+      "document": "rules/typescript-eslint-no-dupe-class-members.json",
+      "title": "typescript-eslint no-dupe-class-members: Disallow duplicate class members",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-duplicate-enum-values",
+      "document": "rules/typescript-eslint-no-duplicate-enum-values.json",
+      "title": "typescript-eslint no-duplicate-enum-values: Disallow duplicate enum member values",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-empty-function",
+      "document": "rules/typescript-eslint-no-empty-function.json",
+      "title": "typescript-eslint no-empty-function: Disallow empty functions",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-extra-non-null-assertion",
+      "document": "rules/typescript-eslint-no-extra-non-null-assertion.json",
+      "title": "typescript-eslint no-extra-non-null-assertion: Disallow extra non-null assertions",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-import-type-side-effects",
+      "document": "rules/typescript-eslint-no-import-type-side-effects.json",
+      "title": "typescript-eslint no-import-type-side-effects: Enforce the use of top-level import type qualifier when an import only has specifiers with inline type qualifiers",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-namespace",
+      "document": "rules/typescript-eslint-no-namespace.json",
+      "title": "typescript-eslint no-namespace: Disallow TypeScript namespaces",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-non-null-asserted-optional-chain",
+      "document": "rules/typescript-eslint-no-non-null-asserted-optional-chain.json",
+      "title": "typescript-eslint no-non-null-asserted-optional-chain: Disallow non-null assertions after an optional chain expression",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-non-null-assertion",
+      "document": "rules/typescript-eslint-no-non-null-assertion.json",
+      "title": "typescript-eslint no-non-null-assertion: Disallow non-null assertions using the ! postfix operator",
+      "group": "typescript-eslint",
+      "examples": {
+        "caught": {
+          "path": "src/config.ts",
+          "text": "export function port(env: Map<string, string>): string {\n  return env.get(\"PORT\")!;\n}\n"
+        },
+        "passes": {
+          "path": "src/config.ts",
+          "text": "export function port(env: Map<string, string>): string {\n  return env.get(\"PORT\") ?? \"8080\";\n}\n"
+        }
+      },
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-unnecessary-type-constraint",
+      "document": "rules/typescript-eslint-no-unnecessary-type-constraint.json",
+      "title": "typescript-eslint no-unnecessary-type-constraint: Disallow unnecessary constraints on generic types",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-unsafe-function-type",
+      "document": "rules/typescript-eslint-no-unsafe-function-type.json",
+      "title": "typescript-eslint no-unsafe-function-type: Disallow using the unsafe built-in Function type",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-unused-expressions",
+      "document": "rules/typescript-eslint-no-unused-expressions.json",
+      "title": "typescript-eslint no-unused-expressions: Disallow unused expressions",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-no-useless-empty-export",
+      "document": "rules/typescript-eslint-no-useless-empty-export.json",
+      "title": "typescript-eslint no-useless-empty-export: Disallow empty exports that don't change anything in a module file",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-no-wrapper-object-types",
+      "document": "rules/typescript-eslint-no-wrapper-object-types.json",
+      "title": "typescript-eslint no-wrapper-object-types: Disallow using confusing built-in primitive class wrappers",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-prefer-as-const",
+      "document": "rules/typescript-eslint-prefer-as-const.json",
+      "title": "typescript-eslint prefer-as-const: Enforce the use of as const over literal type",
+      "group": "typescript-eslint"
+    },
+    {
+      "id": "typescript-eslint-prefer-enum-initializers",
+      "document": "rules/typescript-eslint-prefer-enum-initializers.json",
+      "title": "typescript-eslint prefer-enum-initializers: Require each enum member value to be explicitly initialized",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-prefer-literal-enum-member",
+      "document": "rules/typescript-eslint-prefer-literal-enum-member.json",
+      "title": "typescript-eslint prefer-literal-enum-member: Require all enum members to be literal values",
+      "group": "typescript-eslint",
+      "on": false
+    },
+    {
+      "id": "typescript-eslint-prefer-namespace-keyword",
+      "document": "rules/typescript-eslint-prefer-namespace-keyword.json",
+      "title": "typescript-eslint prefer-namespace-keyword: Require using `namespace` keyword over `module` keyword to declare custom TypeScript modules",
+      "group": "typescript-eslint"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@neralabs/rerail-pack-typescript",
+  "version": "0.1.0",
+  "description": "Rerail rule pack: typescript-eslint rules ported to Rerail code rules.",
+  "license": "Apache-2.0 AND MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neralabs/rerail.git",
+    "directory": "packs/typescript"
+  },
+  "files": [
+    "pack.json",
+    "rules",
+    "licenses",
+    "LICENSE",
+    "NOTICE",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@neralabs/rerail": ">=0.1.0-0 <0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@neralabs/rerail": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "restricted"
+  }
+}

package/rules/typescript-eslint-ban-tslint-comment.json

@@ -0,0 +1,33 @@
+{
+  "format": "rerail.policy/v1",
+  "id": "typescript-eslint-ban-tslint-comment",
+  "revision": 1,
+  "mode": "steer",
+  "description": "Port of typescript-eslint's `ban-tslint-comment` (https://typescript-eslint.io/rules/ban-tslint-comment). Flags comments whose value matches TSLint's enable/disable directive regex; the fix deletes the comment.",
+  "scope": {
+    "include": [
+      "**/*"
+    ],
+    "exclude": []
+  },
+  "clauses": [
+    {
+      "id": "tslint-comment",
+      "forbid": {
+        "ast": {
+          "language": "typescript",
+          "rule": {
+            "kind": "comment",
+            "regex": "^(?P<TEXT>(//|/\\*)\\s*tslint:(enable|disable)(-(line|next-line))?(:|\\s|$|\\*/).*)$"
+          }
+        }
+      },
+      "violation": {
+        "anchor": "witness.span",
+        "code": "@typescript-eslint/ban-tslint-comment",
+        "message": "tslint comment detected: \"$TEXT\"",
+        "fix": ""
+      }
+    }
+  ]
+}

package/rules/typescript-eslint-consistent-type-definitions.json

@@ -0,0 +1 @@
+{"format":"rerail.policy/v1","id":"typescript-eslint-consistent-type-definitions","revision":2,"mode":"steer","description":"Port of typescript-eslint's `consistent-type-definitions` rule with its default option `interface` (https://typescript-eslint.io/rules/consistent-type-definitions). Flags type aliases whose type is an object literal type (through any parentheses) and fixes them to interfaces. Options are declared in the `options` define (the rule's defaults); a variant is a config patch.","scope":{"include":["**/*"],"exclude":[]},"clauses":[{"id":"options","define":{"options":{"option":{"type":"string","nullable":true,"default":null}}}},{"id":"shared","define":{"language":"typescript","utils":{"r1":{"any":[{"has":{"kind":"type_parameters","pattern":"$TP","stopBy":"neighbor"}},{"not":{"has":{"kind":"type_parameters","stopBy":"neighbor"}}}]},"r2":{"inside":{"has":{"regex":"^global$","stopBy":"neighbor"},"kind":"ambient_declaration","stopBy":"end"}},"r3":{"has":{"kind":"type_identifier","pattern":"$N","stopBy":"neighbor"}},"r4":{"has":{"kind":"extends_type_clause","stopBy":"neighbor"}},"r5":{"has":{"kind":"interface_body","pattern":"$B","stopBy":"neighbor"}}}}},{"id":"interface-over-type","forbid":{"ast":{"language":"typescript","rule":{"kind":"type_alias_declaration","all":[{"matches":"r3"},{"has":{"matches":"object-type","stopBy":"neighbor"}},{"matches":"r1"}]},"utils":{"object-type":{"any":[{"kind":"object_type","pattern":"$B","not":{"has":{"kind":"index_signature","stopBy":"neighbor","has":{"kind":"mapped_type_clause","stopBy":"neighbor"}}}},{"kind":"parenthesized_type","has":{"matches":"object-type","stopBy":"neighbor"}}]}},"when":{"option":{"option":{"in":[null,"interface"]}}}}},"violation":{"anchor":"capture.N","code":"@typescript-eslint/consistent-type-definitions","message":"Use an `interface` instead of a `type`.","fix":"interface $N$TP $B"}},{"id":"type-over-interface","forbid":{"ast":{"language":"typescript","rule":{"kind":"interface_declaration","all":[{"matches":"r3"},{"matches":"r5"},{"matches":"r1"},{"not":{"any":[{"matches":"r4"},{"inside":{"kind":"export_statement","stopBy":"neighbor","has":{"regex":"^default$","stopBy":"neighbor"}}},{"matches":"r2"}]}}]},"when":{"option":{"option":"type"}}}},"violation":{"anchor":"capture.N","code":"@typescript-eslint/consistent-type-definitions","message":"Use a `type` instead of an `interface`.","fix":"type $N$TP = $B"}},{"id":"type-over-interface-unfixed","forbid":{"ast":{"language":"typescript","rule":{"kind":"interface_declaration","all":[{"matches":"r3"},{"any":[{"matches":"r4"},{"matches":"r2"}]}]},"when":{"option":{"option":"type"}}}},"violation":{"anchor":"capture.N","code":"@typescript-eslint/consistent-type-definitions","message":"Use a `type` instead of an `interface`."}},{"id":"type-over-interface-export-default","forbid":{"ast":{"language":"typescript","rule":{"kind":"export_statement","all":[{"has":{"regex":"^default$","stopBy":"neighbor"}},{"has":{"kind":"interface_declaration","stopBy":"neighbor","all":[{"matches":"r3"},{"matches":"r5"},{"matches":"r1"},{"not":{"any":[{"matches":"r4"},{"matches":"r2"}]}}]}}]},"when":{"option":{"option":"type"}}}},"violation":{"anchor":"capture.N","code":"@typescript-eslint/consistent-type-definitions","message":"Use a `type` instead of an `interface`.","fix":"type $N$TP = $B\nexport default $N"}}]}

package/rules/typescript-eslint-default-param-last.json

@@ -0,0 +1,55 @@
+{
+  "format": "rerail.policy/v1",
+  "id": "typescript-eslint-default-param-last",
+  "revision": 1,
+  "mode": "steer",
+  "description": "Port of typescript-eslint's `default-param-last` rule (https://typescript-eslint.io/rules/default-param-last), identical to the ESLint base port. Reports a defaulted or optional parameter of a function with a body that is followed by a required, non-rest parameter.",
+  "scope": { "include": ["**/*"], "exclude": [] },
+  "clauses": [
+    {
+      "id": "default-param-not-last",
+      "forbid": {
+        "ast": {
+          "language": "typescript",
+          "utils": {
+            "defaulted": {
+              "any": [
+                { "kind": "optional_parameter" },
+                { "kind": "required_parameter", "has": { "regex": "^=$", "stopBy": "neighbor" } }
+              ]
+            },
+            "plain": {
+              "kind": "required_parameter",
+              "not": {
+                "any": [
+                  { "has": { "regex": "^=$", "stopBy": "neighbor" } },
+                  { "has": { "kind": "rest_pattern", "stopBy": "neighbor" } }
+                ]
+              }
+            }
+          },
+          "rule": {
+            "matches": "defaulted",
+            "precedes": { "matches": "plain", "stopBy": "end" },
+            "inside": {
+              "kind": "formal_parameters",
+              "stopBy": "neighbor",
+              "inside": {
+                "any": [
+                  { "kind": "function_declaration" },
+                  { "kind": "function_expression" },
+                  { "kind": "generator_function_declaration" },
+                  { "kind": "generator_function" },
+                  { "kind": "arrow_function" },
+                  { "kind": "method_definition" }
+                ],
+                "stopBy": "neighbor"
+              }
+            }
+          }
+        }
+      },
+      "violation": { "anchor": "witness.span", "code": "@typescript-eslint/default-param-last", "message": "Default parameters should be last." }
+    }
+  ]
+}

package/rules/typescript-eslint-no-array-constructor.json

@@ -0,0 +1,238 @@
+{
+ "format": "rerail.policy/v1",
+ "id": "typescript-eslint-no-array-constructor",
+ "revision": 1,
+ "mode": "steer",
+ "description": "Port of typescript-eslint's `no-array-constructor` rule (https://typescript-eslint.io/rules/no-array-constructor). Flags `Array(...)` / `new Array(...)` unless called with exactly one argument or type arguments (no scope check: typescript-eslint's version does not resolve `Array`), and fixes to an array literal. Comments inside the argument list are not carried by the `$$$A` capture, so those calls get no fix.",
+ "scope": {
+  "include": [
+   "**/*"
+  ],
+  "exclude": []
+ },
+ "clauses": [
+  {
+   "id": "array-constructor-fix",
+   "forbid": {
+    "ast": {
+     "language": "typescript",
+     "rule": {
+      "all": [
+       {
+        "all": [
+         {
+          "any": [
+           {
+            "kind": "call_expression"
+           },
+           {
+            "kind": "new_expression"
+           }
+          ]
+         },
+         {
+          "has": {
+           "matches": "array-callee"
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "type_arguments"
+           }
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "template_string"
+           }
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "arguments",
+            "count": {
+             "has": {
+              "matches": "arg"
+             },
+             "min": 1,
+             "max": 1
+            }
+           }
+          }
+         }
+        ]
+       },
+       {
+        "any": [
+         {
+          "has": {
+           "kind": "arguments",
+           "pattern": {
+            "context": "f($$$A)",
+            "selector": "arguments"
+           }
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "arguments"
+           }
+          }
+         }
+        ]
+       },
+       {
+        "not": {
+         "has": {
+          "kind": "arguments",
+          "has": {
+           "kind": "comment"
+          }
+         }
+        }
+       }
+      ]
+     },
+     "utils": {
+      "array-callee": {
+       "any": [
+        {
+         "kind": "identifier",
+         "regex": "^Array$"
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "matches": "array-callee"
+         }
+        }
+       ]
+      },
+      "arg": {
+       "not": {
+        "any": [
+         {
+          "regex": "^[(),]$"
+         },
+         {
+          "kind": "comment"
+         }
+        ]
+       }
+      }
+     }
+    }
+   },
+   "violation": {
+    "anchor": "witness.span",
+    "code": "@typescript-eslint/no-array-constructor",
+    "message": "The array literal notation [] is preferable.",
+    "fix": "[$$$A]"
+   }
+  },
+  {
+   "id": "array-constructor",
+   "forbid": {
+    "ast": {
+     "language": "typescript",
+     "rule": {
+      "all": [
+       {
+        "all": [
+         {
+          "any": [
+           {
+            "kind": "call_expression"
+           },
+           {
+            "kind": "new_expression"
+           }
+          ]
+         },
+         {
+          "has": {
+           "matches": "array-callee"
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "type_arguments"
+           }
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "template_string"
+           }
+          }
+         },
+         {
+          "not": {
+           "has": {
+            "kind": "arguments",
+            "count": {
+             "has": {
+              "matches": "arg"
+             },
+             "min": 1,
+             "max": 1
+            }
+           }
+          }
+         }
+        ]
+       },
+       {
+        "has": {
+         "kind": "arguments",
+         "has": {
+          "kind": "comment"
+         }
+        }
+       }
+      ]
+     },
+     "utils": {
+      "array-callee": {
+       "any": [
+        {
+         "kind": "identifier",
+         "regex": "^Array$"
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "matches": "array-callee"
+         }
+        }
+       ]
+      },
+      "arg": {
+       "not": {
+        "any": [
+         {
+          "regex": "^[(),]$"
+         },
+         {
+          "kind": "comment"
+         }
+        ]
+       }
+      }
+     }
+    }
+   },
+   "violation": {
+    "anchor": "witness.span",
+    "code": "@typescript-eslint/no-array-constructor",
+    "message": "The array literal notation [] is preferable."
+   }
+  }
+ ]
+}