no-deprecated-context-methods.md

Disallows usage of deprecated methods on rule context objects (no-deprecated-context-methods)

(fixable) The --fix option on the command line 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, e.g. context.getSourceCode().getText() instead of context.getSource().

Rule Details

Examples of incorrect code for this rule:

module.exports = {
  create(context) {
    return {
      Program(node) {
        const firstToken = context.getFirstToken(node);
      }
    }
  }
}

Examples of correct code for this rule:

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