Use getPhysicalFilename() instead of getFilename() if available (ESLint 7.28+) #2160

pmcelhaney · 2021-07-21T14:02:19Z

Starting with 7.28.0, ESLint has a new feature distinguishing the physical filename from the virtual filename.

context.getPhysicalFilename()

Rules can now use the new method getPhysicalFilename() on the context object to get the full path of the file on disk without any code block information.

The difference between getPhysicalFilename and getFilename is observable when ESLint is used with processors:
context.getPhysicalFilename() // "/project/example.md"        - original file
context.getFilename()         // "/project/example.md/0_0.js" - virtual filename assigned to a code block

When there's a difference, this plugin needs the real, physical filename. (See
eslint/eslint#11989)

I ran into the problem when I noticed no-unresolved was yielding false positives inside of code blocks in Storybook / Markdown files and helped push the necessary change through in ESLint.

To maintain backwards compatibility, this change uses context.getPhysicalFilename() if available and otherwise falls back to getFilename().

pmcelhaney · 2021-07-21T14:13:54Z

tests/src/core/resolve.js

+  it('falls back to getFilename() when getPhysicalFileName() is not available (ESLint < 7.28)', function () {
+    const testContext = utils.testContext({ 'import/resolver': './foo-bar-resolver-v1' });
+
+    expect(resolve( '../files/foo'
+      , Object.assign({}, testContext, { getFilename: function () { return utils.getFilename('foo.js'); } }),
+    )).to.equal(utils.testFilePath('./bar.jsx'));
+
+    expect(resolve( '../files/foo'
+      , Object.assign({}, testContext, { getFilename: function () { throw new Error('Should call getPhysicalFilename() instead of getFilename()'); }, getPhysicalFilename: function () { return utils.getFilename('foo.js'); } }),
+    )).to.equal(utils.testFilePath('./bar.jsx'));
+
+
+  });


Added this test to make sure the fallback behavior is working. Otherwise the tests have been updated to use getPhysicalFilename() instead of getFilename().

ljharb

Thanks!

please swap all the a && a() || b() for a ? a() : b(); plus the tests comment

ljharb · 2021-07-22T06:00:16Z

src/core/packagePath.js

@@ -4,7 +4,7 @@ import readPkgUp from 'read-pkg-up';


 export function getContextPackagePath(context) {
-  return getFilePackagePath(context.getFilename());
+  return getFilePackagePath((context.getPhysicalFilename && context.getPhysicalFilename()) || context.getFilename());


Suggested change

return getFilePackagePath((context.getPhysicalFilename && context.getPhysicalFilename()) || context.getFilename());

return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());

ljharb · 2021-07-22T06:00:34Z

src/rules/named.js

@@ -43,7 +43,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((context.getPhysicalFilename && context.getPhysicalFilename()) || context.getFilename()), i.path))


Suggested change

.map(i => path.relative(path.dirname((context.getPhysicalFilename && context.getPhysicalFilename()) || context.getFilename()), i.path))

.map(i => path.relative(path.dirname(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename()), i.path))

Yes, that's better. Let me know how you want to proceed on the tests and I'll make both changes at the same time. Thanks for the feedback!

ljharb · 2021-07-22T06:01:27Z

tests/src/core/resolve.js

-      , Object.assign({}, testContext, { getFilename: function () { return utils.getFilename('foo.js'); } }),
+      , Object.assign({}, testContext, { getPhysicalFilename: function () { return utils.getFilename('foo.js'); } }),


rather than modifying the existing tests, please leave these alone, so that the new getPhysicalFilename duplicated tests are clearly additions

Okay, which do you prefer?

Duplicate all of the existing tests so that the only difference is getFilename() vs. getPhysicalFilename()

Revert the changes so that we're testing all of the use cases for getFilename() and not exercising getPhysicalFilename() except for the couple of tests demonstrating that getPhysicalFilename() is the preferred API and getFIlename() is a fallback.

Same as 1, but add getFilename() { throw new Error(...) } to the mock context on all the new tests rather than have a separate test for the fallback.

I was originally thinking option 1, but i really do like option 3.

@ljharb These changes are done.

ljharb · 2021-08-03T15:54:21Z

(Had to update the tests so the getPhysicalFilename stuff only applies in eslint v7.28+)

[Fix] Use context.getPhysicalFilename() when available (ESLint 7.28+)

bfab4cc

pmcelhaney commented Jul 21, 2021

View reviewed changes

ljharb requested changes Jul 22, 2021

View reviewed changes

ljharb force-pushed the physical-filename branch from 8c3aafa to 2f0243f Compare August 3, 2021 03:43

ljharb added the package: utils eslint-module-utils package label Aug 3, 2021

ljharb approved these changes Aug 3, 2021

View reviewed changes

ljharb force-pushed the physical-filename branch 2 times, most recently from a4c0ab4 to bfab4cc Compare August 3, 2021 15:40

ljharb merged commit bfab4cc into import-js:master Aug 3, 2021

Conduitry mentioned this pull request Sep 8, 2021

Named code blocks confuse relative import paths #1415

Closed

FuckingUsername mentioned this pull request Apr 16, 2022

fix: get the real filename to avoid rule invalidation vuejs/eslint-plugin-vue#1852

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use getPhysicalFilename() instead of getFilename() if available (ESLint 7.28+) #2160

Use getPhysicalFilename() instead of getFilename() if available (ESLint 7.28+) #2160

pmcelhaney commented Jul 21, 2021

pmcelhaney Jul 21, 2021

ljharb left a comment

ljharb Jul 22, 2021

ljharb Jul 22, 2021

pmcelhaney Jul 22, 2021

ljharb Jul 22, 2021

pmcelhaney Jul 22, 2021

ljharb Jul 22, 2021

pmcelhaney Jul 26, 2021

ljharb commented Aug 3, 2021

	return getFilePackagePath((context.getPhysicalFilename && context.getPhysicalFilename()) \|\| context.getFilename());
	return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());

	.map(i => path.relative(path.dirname((context.getPhysicalFilename && context.getPhysicalFilename()) \|\| context.getFilename()), i.path))
	.map(i => path.relative(path.dirname(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename()), i.path))

		, Object.assign({}, testContext, { getFilename: function () { return utils.getFilename('foo.js'); } }),
		, Object.assign({}, testContext, { getPhysicalFilename: function () { return utils.getFilename('foo.js'); } }),

Use getPhysicalFilename() instead of getFilename() if available (ESLint 7.28+) #2160

Use getPhysicalFilename() instead of getFilename() if available (ESLint 7.28+) #2160

Conversation

pmcelhaney commented Jul 21, 2021

context.getPhysicalFilename()

Choose a reason for hiding this comment

ljharb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ljharb commented Aug 3, 2021