[New]: add rule `default-import-match-filename` #1476

golopot · 2019-09-15T16:10:54Z

Closes #325 .

Import name is considered to matche filename if they are equal after toLowercase, and striping extensions, and striping characters "._-".
CommonJs is also checked.
Cases like "./", "../", are ~~not~~ now checked.

Co-Authored-By: Chiawen Chen <[email protected]> Co-Authored-By: Armano <[email protected]> Co-Authored-By: Sharmila <[email protected]>

coveralls · 2019-09-15T16:33:12Z

Coverage increased (+0.003%) to 97.841% when pulling 678fc02 on golopot:default-import-match-filename into 47f912e on benmosher:master.

ljharb

I think this rule should also support a list of exceptions/aliases; ie, "fooBar" is allowed anywhere "foo" would otherwise be required.

docs/rules/default-import-match-filename.md

src/rules/default-import-match-filename.js

golopot · 2019-09-17T22:18:40Z

What does the "exception" option looks like?

// When "name" and "path" both globly match an item in whitelist, the error is ignored.
{
  whitelist: [
    {
      name: '*', // any name is allowed
      path: '*/models/*',
    },
    {
      name: 'reactDomSever',
      path: 'react-dom/sever',
    },
  ];
}

ljharb · 2019-10-09T03:24:35Z

docs/rules/default-import-match-filename.md

+
+#### `ignorePaths`
+
+Set this option to `['some-dir/', 'bb']` to ignore import statements whose path contains either `some-dir/` or `bb` as a substring.


should this support globs, and that should be in the example?

It seems that globs is not a good tool against relative paths.

can you elaborate? it seems like a good tool to me.

To perform a glob matching a cwd is required, for example:

// Using a hypothetical glob library glob.match({ pattern: 'tests/**/*.js' target: '/home/john/project-a/tests/a.js' cwd: '/home/john/project-a' }) // true

What should the cwd be in this rule? The first thought is to use the location of eslintrc as cwd, but it is problematic when there is another eslintrc in a subdirectory, or when overrides is used.

the cwd for any eslint rule is always process.cwd(), since you can't be sure where the config file is located.

Using process.cwd() taken as the cwd means that the rule will give different result depending on the cwd of the shell, is that fine?

// option for this rule { ignoredPaths: ['tests/**/*.js'] } project-root$ npx eslint . # will ignore files in tests/ project-root/tests$ npx eslint . # will **not** ignore files in tests/

yes, that seems fine to me.

ljharb · 2019-10-09T03:26:13Z

src/rules/default-import-match-filename.js

+function isAncestorRelativePath(path) {
+  return (
+    path.length > 0 &&
+    path[0] !== '/' &&


Suggested change

path[0] !== '/' &&

!path.startsWith('/') &&

Suggested change

path[0] !== '/' &&

(path[0] !== '/' || path[0] !== '\\') &&

On a windows machine, an absolute path would start with c://, no?

yes, you can use C:\ or C:/ and all duplicated slashes and backslashes are reduced than C:// or C://////////// is working,

you can also mix them up: C:/\/\/\/\ but who would do that

V:\> cd C:/\/\/\/\/\/\ C:\>

Since the test cases for absolute paths passes, I will leave the implementation as is.
https://github.com/benmosher/eslint-plugin-import/blob/64c6999a4627d2ea70fbb174194d66fc8b6af699/tests/src/rules/default-import-match-filename.js#L55-L57

src/rules/default-import-match-filename.js

ljharb · 2020-02-14T01:07:35Z

ping @golopot, it'd be great to get this in :-)

src/rules/default-import-match-filename.js

ljharb

It might be helpful for users to be able to specify that the binding should be in camelCase, or snake_case, so it won't conflict with the camelCase rule?

Let's add test cases that import from foo_bar as well as fooBar, for both cases.

golopot · 2020-02-15T07:25:36Z

Currently the rule is case-insesative, and underscores are ignored. Variable name foo_BarBAeZ is allowed for file foo_bar_baz.

https://github.com/benmosher/eslint-plugin-import/blob/dfdd7d43a06c1f449788a9921b2973c7f13e0eab/tests/src/rules/default-import-match-filename.js#L50-L53

docs/rules/default-import-match-filename.md

golopot · 2020-02-29T07:37:02Z

I am having trouble in designing the option ignorePatterns. This option is meant to ignore import statements when the import source matches a configured pattern. There are three choices:

(Current implementation) Use the resolved absolute path to match against the patterns. For example, in import a from './foo', the source resolves to absolute path /home/me/my-project/src/foo.js, and that path is used to match against a pattern, say **/foo.js. In this case the pattern **/foo.js matches. This approach has the drawback that only patterns starting with **/ can ever match, and "relative" patterns like src/foo.js or foo.js will never match in general.
Use the directory containing the closest package.json as the "cwd" for glob matching, With this approach, patterns src/foo.js or foo.js are considered to be relative to /home/me/my-project, which is the location of the closest package.json.
Use process.cwd as the "cwd" for glob matching. This approach has the drawback that the lint result depends on the cwd used for running the linter.

ljharb · 2020-03-10T06:38:36Z

Typically, process.cwd() is the current dir - because a rule can't know if its config came from a file (or which one), or from command line config, or an inline comment.

With option 1, however - could that resolved path have process.cwd() stripped off it, and all patterns applied relative to that?

golopot · 2020-03-10T12:33:42Z

With option 1, however - could that resolved path have process.cwd() stripped off it, and all patterns applied relative to that?

It should be doable using the function path.relative(). That sounds like option 3 in #1476 (comment)?

ljharb · 2020-03-13T06:22:41Z

Yes, option 3 sounds right to me.

stropho · 2020-03-18T17:12:25Z

Looking forward to this rule. Is there any autofix provided? Or not for now ?

Pearce-Ropion · 2020-05-09T01:24:05Z

It would be great to see a little bit more control over how this rule operates in the parserOptions. For example, the ability to make this case sensitive or the ability to whitelist which characters are ignored.

// These would be the defaults
{
    caseSensitive: false,
    allowedChars: [".", "_", "-"],
}

For example:
My repo uses absolute imports and I would like to ensure that the component is imported exactly as the filename is styled. Lets say I have a component called GridColumn:

parserOptions: {
    caseSensitive: true,
    allowedChars: [],
}

pass - import GridColumn from "components/GridColumn";
fail - import gridColumn from "components/GridColumn";
fail - import Gridcolumn from "components/GridColumn";
fail - import gridcolumn from "components/GridColumn";
fail - import Grid-Column from "components/GridColumn";
fail - import Grid_Column from "components/GridColumn";
fail - import GRIDCOLUMN from "components/GridColumn";
etc...

edit: typo

ljharb · 2020-06-01T17:07:22Z

@Pearce-Ropion while the casing should ideally match, remember that not all filesystems are case-sensitive.

Pearce-Ropion · 2020-06-01T17:33:57Z

@Pearce-Ropion while the casing should ideally match, remember that not all filesystems are case-sensitive.

Of course, thats why I suggested it as an optional setting. My reasoning here that some people have the luxury of knowing what systems their code is being developed on (for example, every engineer at my company is required to use a linux machine). Also, after having a glance at the code, it looks like the isCompatible() fn is doing a string equality check which would make it relatively easy to add these options.

Suggested changes snippet

/**
 * @param {string} filename
 * @param {object} options
 * @returns {string}
 */
function normalizeFilename(filename, options) {
  const allowedCharsRegex = new RegExp(`[${options.allowedChars.map(c => `\${c}`)}]`, 'g');

  if (options.caseSensitive) {
    return filename.replace(allowedCharsRegex, '');
  }

  return filename.replace(allowedCharsRegex, '').toLowerCase()
}

/**
 * Test if local name matches filename.
 * @param {string} localName
 * @param {string} filename
 * @param {object} options
 * @returns {boolean}
 */
function isCompatible(localName, filename, options) {
  const allowedCharsRegex = new RegExp(`[${options.allowedChars.map(c => `\${c}`)}]`, 'g');

  let normalizedLocalName = localName.replace(allowedCharsRegex, '');
  if (!options.caseSensitive) {
    normalizedLocalName = normalizedLocalName.toLowerCase();
  }

  return (
    normalizedLocalName === normalizeFilename(filename, options) ||
    normalizedLocalName === normalizeFilename(removeExtension(filename), options)
  )
}

granmoe · 2020-08-11T20:27:26Z

It will be awesome to have this rule 👍 Let's merge this thing 🚀

epiqueras · 2020-08-11T22:57:40Z

#325 (comment)

I think that should be part of this. When would you ever want to enforce this for an import name and not the export name, granted it's an internal module.

fregante · 2021-07-20T03:27:35Z

Does this need further work or is it done?

ljharb · 2021-07-20T05:46:20Z

It needs further work, as far as I'm aware. I'll mark it as a draft.

dword-design · 2021-07-20T08:11:25Z

I'm also working on an NPM package. But is quite some work because you need lots of options for customization. Will write when it's published.

giladgd · 2023-04-24T17:20:06Z

Is there any update on this? It would be great to have this as part of eslint-plugin-import IMO

[New]: add rule default-import-match-filename

830a76b

Co-Authored-By: Chiawen Chen <[email protected]> Co-Authored-By: Armano <[email protected]> Co-Authored-By: Sharmila <[email protected]>

golopot force-pushed the default-import-match-filename branch from 86d60cf to dcb5956 Compare September 15, 2019 16:42

ljharb requested changes Sep 15, 2019

View reviewed changes

ljharb added the semver-minor label Sep 15, 2019

ljharb mentioned this pull request Sep 17, 2019

Rule proposal: no-export-named-after-filename #1478

Open

golopot force-pushed the default-import-match-filename branch from dcb5956 to 4800988 Compare September 17, 2019 22:19

golopot force-pushed the default-import-match-filename branch from 4800988 to 217ec29 Compare October 1, 2019 06:05

ljharb reviewed Oct 9, 2019

View reviewed changes

amannn mentioned this pull request Dec 10, 2019

Default export should match filename molindo/eslint-config-molindo#45

Closed

alexilyaev approved these changes Feb 13, 2020

View reviewed changes

armano2 reviewed Feb 13, 2020

View reviewed changes

src/rules/default-import-match-filename.js Outdated Show resolved Hide resolved

golopot force-pushed the default-import-match-filename branch from 4c48012 to b32abff Compare February 14, 2020 04:43

ljharb reviewed Feb 14, 2020

View reviewed changes

src/rules/default-import-match-filename.js Outdated Show resolved Hide resolved

ljharb requested changes Feb 14, 2020

View reviewed changes

ljharb force-pushed the default-import-match-filename branch 2 times, most recently from d60737d to 830a76b Compare February 17, 2020 08:18

Rework option ignorePaths to accept glob patterns

5527eff

golopot commented Feb 19, 2020

View reviewed changes

docs/rules/default-import-match-filename.md Outdated Show resolved Hide resolved

golopot added 2 commits February 19, 2020 19:03

Add test cases for absolute paths

0a914db

Fix cases with scoped packages

64c6999

Make ignorePaths glob patterns relative to prcoess.cwd

d1f0632

golopot added 3 commits March 20, 2020 10:46

Make option ignorePaths a Set

d5701d8

docs add valid example

029340a

add a test

678fc02

golopot requested a review from ljharb March 20, 2020 03:05

ash-r1 mentioned this pull request Sep 13, 2020

Naming Consistency ash-r1/VN.js#15

Closed

CarinaChenot mentioned this pull request Dec 13, 2020

Proposal: default-import-match-filename #325

Open

ljharb marked this pull request as draft July 20, 2021 05:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[New]: add rule `default-import-match-filename` #1476

[New]: add rule `default-import-match-filename` #1476

golopot commented Sep 15, 2019 •

edited

Loading

coveralls commented Sep 15, 2019 •

edited

Loading

ljharb left a comment

golopot commented Sep 17, 2019

ljharb Oct 9, 2019

golopot Feb 14, 2020

ljharb Feb 14, 2020

golopot Feb 15, 2020

ljharb Feb 15, 2020

golopot Feb 16, 2020

ljharb Jun 2, 2020

ljharb Oct 9, 2019

armano2 Feb 13, 2020

ljharb Feb 14, 2020

armano2 Feb 17, 2020 •

edited

Loading

golopot Feb 19, 2020

ljharb commented Feb 14, 2020

ljharb left a comment

golopot commented Feb 15, 2020

golopot commented Feb 29, 2020

ljharb commented Mar 10, 2020

golopot commented Mar 10, 2020

ljharb commented Mar 13, 2020

stropho commented Mar 18, 2020

Pearce-Ropion commented May 9, 2020 •

edited

Loading

ljharb commented Jun 1, 2020

Pearce-Ropion commented Jun 1, 2020

granmoe commented Aug 11, 2020

epiqueras commented Aug 11, 2020

fregante commented Jul 20, 2021

ljharb commented Jul 20, 2021

dword-design commented Jul 20, 2021

giladgd commented Apr 24, 2023


		#### `ignorePaths`

		Set this option to `['some-dir/', 'bb']` to ignore import statements whose path contains either `some-dir/` or `bb` as a substring.

[New]: add rule default-import-match-filename #1476

Are you sure you want to change the base?

[New]: add rule default-import-match-filename #1476

Conversation

golopot commented Sep 15, 2019 • edited Loading

coveralls commented Sep 15, 2019 • edited Loading

ljharb left a comment

Choose a reason for hiding this comment

golopot commented Sep 17, 2019

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armano2 Feb 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ljharb commented Feb 14, 2020

ljharb left a comment

Choose a reason for hiding this comment

golopot commented Feb 15, 2020

golopot commented Feb 29, 2020

ljharb commented Mar 10, 2020

golopot commented Mar 10, 2020

ljharb commented Mar 13, 2020

stropho commented Mar 18, 2020

Pearce-Ropion commented May 9, 2020 • edited Loading

ljharb commented Jun 1, 2020

Pearce-Ropion commented Jun 1, 2020

granmoe commented Aug 11, 2020

epiqueras commented Aug 11, 2020

fregante commented Jul 20, 2021

ljharb commented Jul 20, 2021

dword-design commented Jul 20, 2021

giladgd commented Apr 24, 2023

[New]: add rule `default-import-match-filename` #1476

[New]: add rule `default-import-match-filename` #1476

golopot commented Sep 15, 2019 •

edited

Loading

coveralls commented Sep 15, 2019 •

edited

Loading

armano2 Feb 17, 2020 •

edited

Loading

Pearce-Ropion commented May 9, 2020 •

edited

Loading