Skip to content
Sarj Code Standards

no-enum

Disallow TypeScript enum; use string-literal unions or as const objects instead.

noEnum Rule source Tests Catalog JSON

Why

Literal unions keep type-only domains explicit, while constant objects make runtime values deliberate. This policy also avoids compiler-dependent const-enum inlining contracts.

Fix

Use a literal union or an as const object after checking runtime member access, numeric reverse mappings, serialized values, and public consumers.

Examples

Before — flagged Keep executable authored code in scope
src/status.ts
// ordinary header
const marker = "auto-generated file";
enum Mode {
  Start,
}
console.log(Mode.Start, marker);
After — preferred Respect a native generated banner
src/status.ts
// auto-generated file
const marker = "auto-generated file";
enum Mode {
  Start,
}
console.log(Mode.Start, marker);
Before — flagged A numeric enum emits a mutable runtime object
src/status.ts
enum Status {
  Active,
  Inactive,
}
After — preferred A string-literal union has no emitted runtime enum
src/status.ts
type Status = "active" | "inactive";

Options

{
  "additionalProperties": false,
  "properties": {
    "ignoreFiles": {
      "description": "Additional generated-file globs to ignore; shared generated paths and header markers are always ignored.",
      "items": { "type": "string" },
      "type": "array"
    }
  },
  "type": "object"
}

References