typescript/class-literal-property-style Style

💡 A suggestion is available for this rule for some violations.

Enforces a consistent style for exposing literal values on classes.

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

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";
}

Configuration

This rule accepts one of the following string values:

Enforce using readonly fields for literal values.

Examples of incorrect code with this option:

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

Examples of correct code with this option:

class C {
  readonly name = "oxc";
}

Enforce using getters for literal values.

Examples of incorrect code with this option:

class C {
  readonly name = "oxc";
}

Examples of correct code with this option:

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

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

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

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

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "typescript/class-literal-property-style": "error",
  },
});

bash

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

This rule was added in v1.47.0.