Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,15 @@
"package-manager-detector": "^1.3.0",
"picocolors": "^1.1.1",
"publint": "^0.3.12",
"semver": "^7.7.2",
"tinyglobby": "^0.2.14"
},
"devDependencies": {
"@eslint/js": "^9.33.0",
"@types/debug": "^4.1.12",
"@types/node": "^24.2.1",
"@types/picomatch": "^4.0.2",
"@types/semver": "^7.7.0",
"@vitest/coverage-v8": "^3.2.3",
"eslint": "^9.33.0",
"pkg-pr-new": "^0.0.54",
Expand Down
47 changes: 44 additions & 3 deletions src/analyze/replacements.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import * as replacements from 'module-replacements';
import {ReportPluginResult} from '../types.js';
import type {FileSystem} from '../file-system.js';
import {getPackageJson} from '../file-system-utils.js';
import semverSatisfies from 'semver/functions/satisfies.js';
import semverLessThan from 'semver/ranges/ltr.js';
import {minVersion, validRange} from 'semver';

/**
* Generates a standard URL to the docs of a given rule
Expand All @@ -21,6 +24,28 @@ export function getMdnUrl(path: string): string {
return `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/${path}`;
}

function isNodeEngineCompatible(
requiredNode: string,
enginesNode: string
): boolean {
const requiredRange = validRange(requiredNode);
const engineRange = validRange(enginesNode);

if (!requiredRange || !engineRange) {
return true;
}

const requiredMin = minVersion(requiredRange);
if (!requiredMin) {
return true;
}

return (
semverLessThan(requiredMin.version, engineRange) ||
semverSatisfies(requiredMin.version, engineRange)
);
}

export async function runReplacements(
fileSystem: FileSystem
): Promise<ReportPluginResult> {
Expand Down Expand Up @@ -57,13 +82,29 @@ export async function runReplacements(
message: `Module "${name}" can be replaced. ${replacement.replacement}.`
});
} else if (replacement.type === 'native') {
const enginesNode = packageJson.engines?.node;
let supported = true;

if (replacement.nodeVersion && enginesNode) {
supported = isNodeEngineCompatible(
replacement.nodeVersion,
enginesNode
);
}

if (!supported) {
continue;
}

const mdnPath = getMdnUrl(replacement.mdnPath);
// TODO (43081j): support `nodeVersion` here, check it against the
// packageJson.engines field, if there is one.
const requires =
replacement.nodeVersion && !enginesNode
? ` Required Node >= ${replacement.nodeVersion}.`
: '';
result.messages.push({
severity: 'warning',
score: 0,
message: `Module "${name}" can be replaced with native functionality. Use "${replacement.replacement}" instead. You can read more at ${mdnPath}.`
message: `Module "${name}" can be replaced with native functionality. Use "${replacement.replacement}" instead. You can read more at ${mdnPath}.${requires}`
});
} else if (replacement.type === 'documented') {
const docUrl = getDocsUrl(replacement.docPath);
Expand Down
4 changes: 4 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ export interface PackageJsonLike {
version: string;
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
engines?: {
node?: string;
[engineName: string]: string | undefined;
};
}

export interface Replacement {
Expand Down