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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
|
# Disallows usage of deprecated methods on rule context objects (no-deprecated-context-methods)
(fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) automatically fixes problems reported by this rule.
This rule disallows the use of deprecated methods on rule `context` objects.
The deprecated methods are:
* `getSource`
* `getSourceLines`
* `getAllComments`
* `getNodeByRangeIndex`
* `getComments`
* `getCommentsBefore`
* `getCommentsAfter`
* `getCommentsInside`
* `getJSDocComment`
* `getFirstToken`
* `getFirstTokens`
* `getLastToken`
* `getLastTokens`
* `getTokenAfter`
* `getTokenBefore`
* `getTokenByRangeStart`
* `getTokens`
* `getTokensAfter`
* `getTokensBefore`
* `getTokensBetween`
Instead of using these methods, you should use the equivalent methods on [`SourceCode`](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode), e.g. `context.getSourceCode().getText()` instead of `context.getSource()`.
## Rule Details
Examples of **incorrect** code for this rule:
```js
module.exports = {
create(context) {
return {
Program(node) {
const firstToken = context.getFirstToken(node);
}
}
}
}
```
Examples of **correct** code for this rule:
```js
module.exports = {
create(context) {
const sourceCode = context.getSourceCode();
return {
Program(node) {
const firstToken = sourceCode.getFirstToken(node);
}
}
}
};
```
## When Not To Use It
If you need to support very old versions of ESLint where `SourceCode` doesn't exist, you should not enable this rule.
## Further Reading
* [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
|