Skip to content

[eslint-patch] Add support for ESLint 8.x #2965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 13, 2021
Merged

[eslint-patch] Add support for ESLint 8.x #2965

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cba107
Add support for ESLint 8.x to modern-module-resolution
lukashass Oct 13, 2021
e4cb470
rush change
lukashass Oct 13, 2021
ad39fde
Update phrasing in logging message.
iclanton Oct 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions common/changes/@rushstack/eslint-patch/eslint-8x_2021-10-13-00-21.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/eslint-patch",
"comment": "Add support for ESLint 8.0.0",
"type": "patch"
}
],
"packageName": "@rushstack/eslint-patch"
}
66 changes: 52 additions & 14 deletions stack/eslint-patch/src/modern-module-resolution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
const path = require('path');
const fs = require('fs');

// Module path for eslintrc.cjs
// Example: ".../@eslint/eslintrc/dist/eslintrc.cjs"
let eslintrcBundlePath: string | undefined = undefined;

// Module path for config-array-factory.js
// Example: ".../@eslint/eslintrc/lib/config-array-factory"
let configArrayFactoryPath: string | undefined = undefined;
Expand All @@ -22,15 +26,14 @@ let moduleResolverPath: string | undefined = undefined;
// Example: ".../node_modules/eslint"
let eslintFolder: string | undefined = undefined;

// Probe for the ESLint >=7.8.0 layout:
// Probe for the ESLint >=8.0.0 layout:
for (let currentModule = module; ; ) {
if (!configArrayFactoryPath) {
// For ESLint >=7.8.0, config-array-factory.js is at this path:
// .../@eslint/eslintrc/lib/config-array-factory.js
if (/[\\/]@eslint[\\/]eslintrc[\\/]lib[\\/]config-array-factory\.js$/i.test(currentModule.filename)) {
if (!eslintrcBundlePath) {
// For ESLint >=8.0.0, all @eslint/eslintrc code is bundled at this path:
// .../@eslint/eslintrc/dist/eslintrc.cjs
if (/[\\/]@eslint[\\/]eslintrc[\\/]dist[\\/]eslintrc\.cjs$/i.test(currentModule.filename)) {
const eslintrcFolder: string = path.join(path.dirname(currentModule.filename), '..');
configArrayFactoryPath = path.join(eslintrcFolder, 'lib/config-array-factory');
moduleResolverPath = path.join(eslintrcFolder, 'lib/shared/relative-module-resolver');
eslintrcBundlePath = path.join(eslintrcFolder, 'dist/eslintrc.cjs');
}
} else {
// Next look for a file in ESLint's folder
Expand All @@ -47,6 +50,33 @@ for (let currentModule = module; ; ) {
currentModule = currentModule.parent;
}

if (!eslintFolder) {
// Probe for the ESLint >=7.8.0 layout:
for (let currentModule = module; ; ) {
if (!configArrayFactoryPath) {
// For ESLint >=7.8.0, config-array-factory.js is at this path:
// .../@eslint/eslintrc/lib/config-array-factory.js
if (/[\\/]@eslint[\\/]eslintrc[\\/]lib[\\/]config-array-factory\.js$/i.test(currentModule.filename)) {
const eslintrcFolder: string = path.join(path.dirname(currentModule.filename), '..');
configArrayFactoryPath = path.join(eslintrcFolder, 'lib/config-array-factory');
moduleResolverPath = path.join(eslintrcFolder, 'lib/shared/relative-module-resolver');
}
} else {
// Next look for a file in ESLint's folder
// .../eslint/lib/cli-engine/cli-engine.js
if (/[\\/]eslint[\\/]lib[\\/]cli-engine[\\/]cli-engine\.js$/i.test(currentModule.filename)) {
eslintFolder = path.join(path.dirname(currentModule.filename), '../..');
break;
}
}

if (!currentModule.parent) {
break;
}
currentModule = currentModule.parent;
}
}

if (!eslintFolder) {
// Probe for the <7.8.0 layout:
for (let currentModule = module; ; ) {
Expand Down Expand Up @@ -80,22 +110,30 @@ if (!versionMatch) {
throw new Error('Unable to parse ESLint version: ' + eslintPackageVersion);
}
const eslintMajorVersion = Number(versionMatch[1]);
if (!(eslintMajorVersion >= 6 && eslintMajorVersion <= 7)) {
if (!(eslintMajorVersion >= 6 && eslintMajorVersion <= 8)) {
throw new Error(
'The patch-eslint.js script has only been tested with ESLint version 6.x or 7.x.' +
'The patch-eslint.js script has only been tested with ESLint version 6.x, 7.x or 8.x.' +
` (Your version: ${eslintPackageVersion})\n` +
'Consider reporting a GitHub issue:\n' +
'https://github.com/microsoft/rushstack/issues'
);
}

const ConfigArrayFactory = require(configArrayFactoryPath!).ConfigArrayFactory;

let ConfigArrayFactory;
if (eslintMajorVersion === 8) {
ConfigArrayFactory = require(eslintrcBundlePath!).Legacy.ConfigArrayFactory;
} else {
ConfigArrayFactory = require(configArrayFactoryPath!).ConfigArrayFactory;
}
if (!ConfigArrayFactory.__patched) {
ConfigArrayFactory.__patched = true;

const ModuleResolver = require(moduleResolverPath!);

let ModuleResolver: { resolve: any };
if (eslintMajorVersion === 8) {
ModuleResolver = require(eslintrcBundlePath!).Legacy.ModuleResolver;
} else {
ModuleResolver = require(moduleResolverPath!);
}
const originalLoadPlugin = ConfigArrayFactory.prototype._loadPlugin;

if (eslintMajorVersion === 6) {
Expand All @@ -117,7 +155,7 @@ if (!ConfigArrayFactory.__patched) {
}
};
} else {
// ESLint 7.x
// ESLint 7.x || 8.x
ConfigArrayFactory.prototype._loadPlugin = function (name: string, ctx: Record<string, unknown>) {
const originalResolve = ModuleResolver.resolve;
try {
Expand Down