useAdjacentGetterSetter

JavaScript (and super languages)

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/nursery/useAdjacentGetterSetter
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as grouped-accessor-pairs

Description

Enforce that getters and setters for the same property are adjacent in class and object definitions.

When defining a property in a class or object, it’s common to have both a getter and a setter. This rule enforces that getter is defined right before the setter, making the code more maintainable and easier to read.

Examples

Invalid

Name getter and setter are not adjacent:

1
class User {
2
  get name() { return this._name; }
3
  constructor() {}
4
  set name(value) { this._name = value; }
5
}

code-block.js:2:7 lint/nursery/useAdjacentGetterSetter ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Getter should be defined right before the setter.
  
    1 │ class User {
  > 2 │   get name() { return this._name; }
      │       ^^^^
    3 │   constructor() {}
    4 │   set name(value) { this._name = value; }
  
  ℹ Move this setter after the getter.
  
    2 │   get name() { return this._name; }
    3 │   constructor() {}
  > 4 │   set name(value) { this._name = value; }
      │       ^^^^
    5 │ }
    6 │

Getter should go before the setter.

1
const user = {
2
  set name(value) { this._name = value; },
3
  get name() { return this._name; }
4
};

code-block.js:3:7 lint/nursery/useAdjacentGetterSetter ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Getter should be defined right before the setter.
  
    1 │ const user = {
    2 │   set name(value) { this._name = value; },
  > 3 │   get name() { return this._name; }
      │       ^^^^
    4 │ };
    5 │ 
  
  ℹ Move this setter after the getter.
  
    1 │ const user = {
  > 2 │   set name(value) { this._name = value; },
      │       ^^^^
    3 │   get name() { return this._name; }
    4 │ };

Valid

1
class User {
2
  get name() { return this._name; }
3
  set name(value) { this._name = value; }
4
  get age() { return this._age; }
5
  set age(age) { this._age = age; }
6
}

This rule does not enforce the existence of both getter and setter for a property. Single getters without setters and setters without getters are ignored.

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useAdjacentGetterSetter": "error"
6
      }
7
    }
8
  }
9
}