feat: support ESLint v9

.github/workflows/node-4+.yml

@@ -36,6 +36,7 @@ jobs:
  - macos-latest
  node-version: ${{ fromJson(needs.matrix.outputs.latest) }}
  eslint:
+ - 9
  - 8
  - 7
  - 6
@@ -63,6 +64,18 @@ jobs:
  env:
  TS_PARSER: 2
  exclude:
+ - node-version: 16
+ eslint: 9
+ - node-version: 15
+ eslint: 9
+ - node-version: 13
+ eslint: 9
+ - node-version: 11
+ eslint: 9
+ - node-version: 10
+ eslint: 9
+ - node-version: 9
+ eslint: 9
  - node-version: 15
  eslint: 8
  - node-version: 13

src/context.js

@@ -0,0 +1,62 @@
+function getFilename(context) {
+ if ('filename' in context) {
+ return context.filename;
+ }
+
+ return context.getFilename();
+}
+
+function getPhysicalFilename(context) {
+ if (context.getPhysicalFilename) {
+ return context.getPhysicalFilename();
+ }
+
+ return getFilename(context);
+}
+
+function getSourceCode(context) {
+ if ('sourceCode' in context) {
+ return context.sourceCode;
+ }
+
+ return context.getSourceCode();
+}
+
+function getScope(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getScope) {
+ return sourceCode.getScope(node);
+ }
+
+ return context.getScope();
+}
+
+function getAncestors(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getAncestors) {
+ return sourceCode.getAncestors(node);
+ }
+
+ return context.getAncestors();
+}
+
+function getDeclaredVariables(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getDeclaredVariables) {
+ return sourceCode.getDeclaredVariables(node);
+ }
+
+ return context.getDeclaredVariables(node);
+}
+
+module.exports = {
+ getFilename,
+ getPhysicalFilename,
+ getSourceCode,
+ getScope,
+ getAncestors,
+ getDeclaredVariables,
+};

src/core/packagePath.js

@@ -1,14 +1,15 @@
 import { dirname } from 'path';
 import pkgUp from 'eslint-module-utils/pkgUp';
 import readPkgUp from 'eslint-module-utils/readPkgUp';
+import { getPhysicalFilename } from '../context';
 
 export function getFilePackagePath(filePath) {
  const fp = pkgUp({ cwd: filePath });
  return dirname(fp);
 }
 
 export function getContextPackagePath(context) {
- return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
+ return getFilePackagePath(getPhysicalFilename(context));
 }
 
 export function getFilePackageName(filePath) {

src/importDeclaration.js

@@ -1,4 +1,6 @@
-export default function importDeclaration(context) {
- const ancestors = context.getAncestors();
+import { getAncestors } from './context';
+
+export default function importDeclaration(context, node) {
+ const ancestors = getAncestors(context, node);
  return ancestors[ancestors.length - 1];
 }

src/rules/consistent-type-specifier-style.js

@@ -1,4 +1,5 @@
 import docsUrl from '../docsUrl';
+import { getSourceCode } from '../context';
 
 function isComma(token) {
  return token.type === 'Punctuator' && token.value === ',';
@@ -55,7 +56,7 @@ module.exports = {
  },
 
  create(context) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
 
  if (context.options[0] === 'prefer-inline') {
  return {

src/rules/dynamic-import-chunkname.js

@@ -1,5 +1,6 @@
 import vm from 'vm';
 import docsUrl from '../docsUrl';
+import { getSourceCode } from '../context';
 
 module.exports = {
  meta: {
@@ -40,7 +41,7 @@ module.exports = {
  const chunkSubstrRegex = new RegExp(chunkSubstrFormat);
 
  function run(node, arg) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
  const leadingComments = sourceCode.getCommentsBefore
  ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
  : sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.

src/rules/first.js

@@ -1,4 +1,5 @@
 import docsUrl from '../docsUrl';
+import { getDeclaredVariables, getSourceCode } from '../context';
 
 function getImportValue(node) {
  return node.type === 'ImportDeclaration'
@@ -38,7 +39,7 @@ module.exports = {
  }
  const absoluteFirst = context.options[0] === 'absolute-first';
  const message = 'Import in body of module; reorder to top.';
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
  const originSourceCode = sourceCode.getText();
  let nonImportCount = 0;
  let anyExpressions = false;
@@ -66,7 +67,7 @@ module.exports = {
  }
  }
  if (nonImportCount > 0) {
- for (const variable of context.getDeclaredVariables(node)) {
+ for (const variable of getDeclaredVariables(context, node)) {
  if (!shouldSort) { break; }
  const references = variable.references;
  if (references.length) {

src/rules/named.js

@@ -1,6 +1,7 @@
 import * as path from 'path';
 import ExportMapBuilder from '../exportMap/builder';
 import docsUrl from '../docsUrl';
+import { getFilename, getPhysicalFilename } from '../context';
 
 module.exports = {
  meta: {
@@ -67,7 +68,7 @@ module.exports = {
  if (!deepLookup.found) {
  if (deepLookup.path.length > 1) {
  const deepPath = deepLookup.path
- .map((i) => path.relative(path.dirname(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename()), i.path))
+ .map((i) => path.relative(path.dirname(getPhysicalFilename(context)), i.path))
  .join(' -> ');
 
  context.report(im[key], `${name} not found via ${deepPath}`);
@@ -121,7 +122,7 @@ module.exports = {
  if (!deepLookup.found) {
  if (deepLookup.path.length > 1) {
  const deepPath = deepLookup.path
- .map((i) => path.relative(path.dirname(context.getFilename()), i.path))
+ .map((i) => path.relative(path.dirname(getFilename(context)), i.path))
  .join(' -> ');
 
  context.report(im.key, `${im.key.name} not found via ${deepPath}`);

src/rules/namespace.js

@@ -87,7 +87,7 @@ module.exports = {
 
  // same as above, but does not add names to local map
  ExportNamespaceSpecifier(namespace) {
- const declaration = importDeclaration(context);
+ const declaration = importDeclaration(context, namespace);
 
  const imports = ExportMapBuilder.get(declaration.source.value, context);
  if (imports == null) { return null; }

src/rules/newline-after-import.js

@@ -7,6 +7,8 @@ import isStaticRequire from '../core/staticRequire';
 import docsUrl from '../docsUrl';
 
 import debug from 'debug';
+import { getPhysicalFilename, getScope } from '../context';
+
 const log = debug('eslint-plugin-import:rules:newline-after-import');
 
 //------------------------------------------------------------------------------
@@ -193,11 +195,13 @@ module.exports = {
  }
  },
  'Program:exit'() {
- log('exit processing for', context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
- const scopeBody = getScopeBody(context.getScope());
- log('got scope:', scopeBody);
+ log('exit processing for', getPhysicalFilename(context));
 
  requireCalls.forEach((node, index) => {
+ // todo: this probably isn't correct...
+ const scopeBody = getScopeBody(getScope(context, node));
+ log('got scope:', scopeBody);
+
  const nodePosition = findNodeIndexInScopeBody(scopeBody, node);
  log('node position in scope:', nodePosition);
 

src/rules/no-absolute-path.js

@@ -2,6 +2,7 @@ import path from 'path';
 import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
 import { isAbsolute } from '../core/importType';
 import docsUrl from '../docsUrl';
+import { getPhysicalFilename } from '../context';
 
 module.exports = {
  meta: {
@@ -22,7 +23,7 @@ module.exports = {
  node: source,
  message: 'Do not import modules using an absolute path',
  fix(fixer) {
- const resolvedContext = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const resolvedContext = getPhysicalFilename(context);
  // node.js and web imports work with posix style paths ("/")
  let relativePath = path.posix.relative(path.dirname(resolvedContext), source.value);
  if (!relativePath.startsWith('.')) {

src/rules/no-amd.js

@@ -4,6 +4,7 @@
  */
 
 import docsUrl from '../docsUrl';
+import { getScope } from '../context';
 
 //------------------------------------------------------------------------------
 // Rule Definition
@@ -23,7 +24,7 @@ module.exports = {
  create(context) {
  return {
  CallExpression(node) {
- if (context.getScope().type !== 'module') { return; }
+ if (getScope(context, node).type !== 'module') { return; }
 
  if (node.callee.type !== 'Identifier') { return; }
  if (node.callee.name !== 'require' && node.callee.name !== 'define') { return; }

src/rules/no-commonjs.js

@@ -4,6 +4,7 @@
  */
 
 import docsUrl from '../docsUrl';
+import { getScope } from '../context';
 
 const EXPORT_MESSAGE = 'Expected "export" or "export default"';
 const IMPORT_MESSAGE = 'Expected "import" instead of "require()"';
@@ -107,7 +108,7 @@ module.exports = {
 
  // exports.
  if (node.object.name === 'exports') {
- const isInScope = context.getScope()
+ const isInScope = getScope(context, node)
  .variables
  .some((variable) => variable.name === 'exports');
  if (!isInScope) {
@@ -117,7 +118,7 @@ module.exports = {
 
  },
  CallExpression(call) {
- if (!validateScope(context.getScope())) { return; }
+ if (!validateScope(getScope(context, call))) { return; }
 
  if (call.callee.type !== 'Identifier') { return; }
  if (call.callee.name !== 'require') { return; }

src/rules/no-cycle.js

@@ -8,6 +8,7 @@ import ExportMapBuilder from '../exportMap/builder';
 import { isExternalModule } from '../core/importType';
 import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
 import docsUrl from '../docsUrl';
+import { getPhysicalFilename } from '../context';
 
 const traversed = new Set();
 
@@ -51,7 +52,7 @@ module.exports = {
  },
 
  create(context) {
- const myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const myPath = getPhysicalFilename(context);
  if (myPath === '<text>') { return {}; } // can't cycle-check a non-file
 
  const options = context.options[0] || {};

src/rules/no-default-export.js

@@ -1,4 +1,5 @@
 import docsUrl from '../docsUrl';
+import { getSourceCode } from '../context';
 
 module.exports = {
  meta: {
@@ -22,15 +23,15 @@ module.exports = {
 
  return {
  ExportDefaultDeclaration(node) {
- const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
+ const { loc } = getSourceCode(context).getFirstTokens(node)[1] || {};
  context.report({ node, message: preferNamed, loc });
  },
 
  ExportNamedDeclaration(node) {
  node.specifiers
  .filter((specifier) => (specifier.exported.name || specifier.exported.value) === 'default')
  .forEach((specifier) => {
- const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
+ const { loc } = getSourceCode(context).getFirstTokens(node)[1] || {};
  if (specifier.type === 'ExportDefaultSpecifier') {
  context.report({ node, message: preferNamed, loc });
  } else if (specifier.type === 'ExportSpecifier') {

src/rules/no-duplicates.js

@@ -3,6 +3,7 @@ import semver from 'semver';
 import flatMap from 'array.prototype.flatmap';
 
 import docsUrl from '../docsUrl';
+import { getSourceCode } from '../context';
 
 let typescriptPkg;
 try {
@@ -248,7 +249,7 @@ function checkImports(imported, context) {
  if (nodes.length > 1) {
  const message = `'${module}' imported multiple times.`;
  const [first, ...rest] = nodes;
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
  const fix = getFix(first, rest, sourceCode, context);
 
  context.report({

src/rules/no-empty-named-blocks.js

@@ -1,4 +1,5 @@
 import docsUrl from '../docsUrl';
+import { getSourceCode } from '../context';
 
 function getEmptyBlockRange(tokens, index) {
  const token = tokens[index];
@@ -72,7 +73,7 @@ module.exports = {
  fix(fixer) {
  // Remove the empty block and the 'from' token, leaving the import only for its side
  // effects, e.g. `import 'mod'`
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
  const fromToken = program.tokens.find((t) => t.value === 'from');
  const importToken = program.tokens.find((t) => t.value === 'import');
  const hasSpaceAfterFrom = sourceCode.isSpaceBetween(fromToken, sourceCode.getTokenAfter(fromToken));

src/rules/no-extraneous-dependencies.js

@@ -7,6 +7,7 @@ import moduleVisitor from 'eslint-module-utils/moduleVisitor';
 import importType from '../core/importType';
 import { getFilePackageName } from '../core/packagePath';
 import docsUrl from '../docsUrl';
+import { getPhysicalFilename } from '../context';
 
 const depFieldCache = new Map();
 
@@ -79,7 +80,7 @@ function getDependencies(context, packageDir) {
  });
  } else {
  const packageJsonPath = pkgUp({
- cwd: context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(),
+ cwd: getPhysicalFilename(context),
  normalize: false,
  });
 
@@ -278,7 +279,7 @@ module.exports = {
 
  create(context) {
  const options = context.options[0] || {};
- const filename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const filename = getPhysicalFilename(context);
  const deps = getDependencies(context, options.packageDir) || extractDepFields({});
 
  const depsOptions = {