useConsistentMemberAccessibility

Diagnostic Category: lint/nursery/useConsistentMemberAccessibility

TypeScript and TSX

Since: v1.9.0

Sources:

Same as: @typescript-eslint/explicit-member-accessibility

Require consistent accessibility modifiers on class properties and methods.

TypeScript allows placing explicit public, protected, and private accessibility modifiers in front of class members. The modifiers exist solely in the type system and just serve to describe who is allowed to access those members. Leaving off accessibility modifiers makes for less code to read and write. Members are public by default.

However, adding in consistent accessibility modifiers can be helpful in codebases with many classes for enforcing proper privacy of members. Some developers also find it preferable for code readability to keep member publicity explicit.

Examples

Invalid

`"accessibility": "noPublic"` (default value)

Use the following configuration to disallow all explicit public modifiers:

{
    "options": {
        "accessibility": "noPublic"
    }
}

The following patterns are considered incorrect code with noPublic:

class Animal {
  public constructor(breed, name) {
    // ...
  }
}

class Animal {
  constructor(
    public breed,
    name,
  ) {
    // ...
  }
}

class Animal {
  public animalName: string;
}

class Pet {
  public get name(): string {
    return this.animalName;
  }
}

class Pet {
  public set name(value: string) {
    this.animalName = value;
  }
}

class Dog {
  public walk() {
    // ...
  }
}

`"accessibility": "explicit"`

Use the following configuration to enforce the presence of explicit modifiers wherever possible:

{
    "options": {
        "accessibility": "explicit"
    }
}

The following patterns are considered incorrect code with accessibility set to explicit:

class Animal {
  constructor( // Invalid: Missing accessibility modifier
    public breed,
    name,
  ) {
    this.animalName = name;
  }
  private animalName: string; // OK: Modifier must be present
  public get name(): string { // OK: Modifier must be present
    return this.animalName;
  }
  public set name(value: string) { // OK: Modifier must be present
    this.animalName = value;
  }
  protected walk() { // OK: Modifier must be present
    // ...
  }
}

`"accessibility": "none"`

Use the following configuration to disallow all explicit visibility modifiers:

{
    "options": {
        "accessibility": "none"
    }
}

The following patterns are considered incorrect code with accessibility set to none:

class Animal {
  protected constructor(breed, name) {
    // ...
  }
}

class Animal {
  constructor(
    protected breed,
    name,
  ) {
    // ...
  }
}

class Animal {
  private animalName: string;
}

class Animal {
  protected get name(): string {
    return this.animalName;
  }
}

class Pet {
  private set name(value: string) {
    this.animalName = value;
  }
}

class Dog {
  public walk() {
    // ...
  }
}

Valid

The following patterns are considered correct code with the default options noPublic:

{
    "options": {
        "accessibility": "noPublic"
    }
}

class Animal {
  constructor(
    private breed,
    name,
  ) {
    this.animalName = name;
  }
  private animalName: string; // Property
  get name(): string {
    // get accessor
    return this.animalName;
  }
  set name(value: string) {
    // set accessor
    this.animalName = value;
  }
  protected walk() {
    // method
  }
}

The following patterns are considered correct code with the accessibility set to explicit:

{
    "options": {
        "accessibility": "explicit"
    }
}

class Animal {
  public constructor(
    public breed,
    name,
  ) {
    // Parameter property and constructor
    this.animalName = name;
  }
  private animalName: string; // Property
  public get name(): string {
    // get accessor
    return this.animalName;
  }
  public set name(value: string) {
    // set accessor
    this.animalName = value;
  }
  protected walk() {
    // method
  }
}

The following patterns are considered correct code with the accessibility set to none:

{
    "options": {
        "accessibility": "none"
    }
}

class Animal {
  constructor(
    breed,
    name,
  ) {
    // Parameter property and constructor
    this.name = name;
  }
  animalName: string; // Property
  get name(): string {
    // get accessor
    return this.animalName;
  }
  set name(value: string) {
    // set accessor
    this.animalName = value;
  }
  walk() {
    // method
  }
}

Options

The rule supports the following options:

{
    "options": {
        "accessibility": "explicit"
    }
}

`accessibility`

This option determines the required accessibility modifiers on class properties and methods. It can be set to one of the following values:

noPublic - forbid the use of public (a safe fix will remove it).
explicit - requires an accessibility modifier for every member that allows that (a safe fix will add public).
none - forbid all accessibility modifiers (public, protected, private).

Default: noPublic

useConsistentMemberAccessibility

Examples

Invalid

"accessibility": "noPublic" (default value)

"accessibility": "explicit"

"accessibility": "none"