Skip to content
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

[New] give resolvers access to parserServices #2238

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −12
Open

[New] give resolvers access to parserServices #2238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f50fea9
[New] give resolvers access to parserServices
jablko Sep 24, 2021
dc0553d
Add backward compatibility
jablko Sep 24, 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
2 changes: 1 addition & 1 deletion src/ExportMap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ ExportMap.parse = function (path, content, context) {
const namespaces = new Map();

function remotePath(value) {
return resolve.relative(value, path, context.settings);
return resolve.relative(value, path, context);
}

function resolveImport(value) {
Expand Down
38 changes: 27 additions & 11 deletions utils/resolve.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,25 @@ exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cache
return result;
};

function relative(modulePath, sourceFile, settings) {
return fullResolve(modulePath, sourceFile, settings).path;
function relative(modulePath, sourceFile, context) {
Copy link
Member

@ljharb ljharb Sep 24, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is actually a breaking change for the utils package, so that seems quite suboptimal

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I resolve that by accepting either the new value (context) or the old (settings), as in the latest commit?

return fullResolve(
modulePath,
sourceFile,
// Accept context or settings, for backward compatibility
!('settings' in context) ? { settings: context } : context,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m pretty skeptical there’s always a “settings” in context, consistently from eslint 2 - 7.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, we pass context.settings -> it today, so we already rely on that, don't we?

eslint-plugin-import/utils/resolve.js

Line 220 in dd81424

return relative(p, context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(), context.settings);

eslint-plugin-import/src/ExportMap.js

Line 434 in dd81424

return resolve.relative(value, path, context.settings);

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i guess that's true; if it wasn't an object it'd throw since it's not checked for truthiness. Still, is there a more robust way to check? perhaps eslint provides a Context constructor or something we could use to compare it to?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question ... Here's where it's constructed today, I think: https://github.com/eslint/eslint/blob/cf34e5cf5ed5d09eb53c16cca06821c4e34b7b70/lib/linter/linter.js#L910-L954

Looking at that, I'm not sure what would be more robust, and consistent between ESLint versions?

Copy link
Member

@ljharb ljharb Sep 24, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another alternative is to always pass settings, and just also pass context? We could also throw if settings !== context.settings when context is provided

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally -- I propose overloading the argument because I think it's functionally equivalent, and slightly tidier than calling relative(modulePath, sourceFile, context.settings, context), but no strong feelings either way ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's definitely tidier - we could also allow relative(modulePath, sourceFile, null, context), and adapt it later whenever we do a semver-major

).path;
}

function fullResolve(modulePath, sourceFile, settings) {
function fullResolve(modulePath, sourceFile, context) {
// check if this is a bonus core module
const coreSet = new Set(settings['import/core-modules']);
const coreSet = new Set(context.settings['import/core-modules']);
if (coreSet.has(modulePath)) return { found: true, path: null };

const sourceDir = path.dirname(sourceFile);
const cacheKey = sourceDir + hashObject(settings).digest('hex') + modulePath;
const cacheKey =
sourceDir + hashObject(context.settings).digest('hex') + modulePath;

const cacheSettings = ModuleCache.getSettings(settings);
const cacheSettings = ModuleCache.getSettings(context.settings);

const cachedPath = fileExistsCache.get(cacheKey, cacheSettings);
if (cachedPath !== undefined) return { found: true, path: cachedPath };
Expand All @@ -105,7 +111,12 @@ function fullResolve(modulePath, sourceFile, settings) {

function v1() {
try {
const resolved = resolver.resolveImport(modulePath, sourceFile, config);
const resolved = resolver.resolveImport(
modulePath,
sourceFile,
config,
context.parserServices,
);
if (resolved === undefined) return { found: false };
return { found: true, path: resolved };
} catch (err) {
Expand All @@ -114,7 +125,12 @@ function fullResolve(modulePath, sourceFile, settings) {
}

function v2() {
return resolver.resolve(modulePath, sourceFile, config);
return resolver.resolve(
modulePath,
sourceFile,
config,
context.parserServices,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pass context.parserServices -> resolver.resolve().

);
}

switch (resolver.interfaceVersion) {
Expand All @@ -127,8 +143,8 @@ function fullResolve(modulePath, sourceFile, settings) {
}
}

const configResolvers = (settings['import/resolver']
|| { 'node': settings['import/resolve'] }); // backward compatibility
const configResolvers = (context.settings['import/resolver']
|| { 'node': context.settings['import/resolve'] }); // backward compatibility

const resolvers = resolverReducer(configResolvers, new Map());

Expand Down Expand Up @@ -217,7 +233,7 @@ const erroredContexts = new Set();
*/
function resolve(p, context) {
try {
return relative(p, context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(), context.settings);
return relative(p, context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(), context);
} catch (err) {
if (!erroredContexts.has(context)) {
// The `err.stack` string starts with `err.name` followed by colon and `err.message`.
Expand Down