File: prefer-replace-text.md

package info (click to toggle)
node-eslint-plugin-eslint-plugin 2.3.0%2B~0.3.0-6
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 652 kB
  • sloc: javascript: 5,372; makefile: 34; sh: 1
file content (52 lines) | stat: -rw-r--r-- 1,209 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# prefer using replaceText instead of replaceTextRange. (prefer-replace-text)

## Rule Details

The rule reports an error if `replaceTextRange`'s first argument is an array of identical array elements. It can be easily replaced by `replaceText` to improve readability.

Examples of **incorrect** code for this rule:

```js
/* eslint eslint-plugin/prefer-replace-text: error */
module.exports = {
  create(context) {
    context.report({
      fix(fixer) {
        // error, can be written: return fixer.replaceText([node, '']);
        return fixer.replaceTextRange([node.range[0], node.range[1]], '');
      }
    });
  }
};
```

Examples of **correct** code for this rule:

```js
/* eslint eslint-plugin/prefer-replace-text: error */
module.exports = {
  create(context) {
    context.report({
      fix(fixer) {
        return fixer.replaceText(node, '');
      }
    });
  }
};

module.exports = {
  create(context) {
    context.report({
      fix(fixer) {
        // start = ...
        // end = ...
        return fixer.replaceTextRange([start, end], '');
      }
    });
  }
};
```

## Further Reading

* [Applying Fixes](https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes)