← Back to rules

typescript/class-literal-property-style Style

🚧 An auto-fix is planned for this rule, but not implemented at this time.

What it does

Enforces a consistent style for exposing literal values on classes.

Why is this bad?

Mixing readonly fields and trivial literal getters for the same kind of value makes class APIs inconsistent and harder to scan.

Examples

Examples of incorrect code for this rule (default "fields"):

class C {
  get name() {
    return "oxc";
  }
}

Examples of correct code for this rule:

class C {
  readonly name = "oxc";
}

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "rules": {
    "typescript/class-literal-property-style": "error"
  }
}

CLI

oxlint --deny typescript/class-literal-property-style

References

• Rule Source