From 8f05399f3b13ea224b0dd5b6f137dc3ba5928574 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 12 Feb 2023 14:17:53 -0800
Subject: [PATCH 001/199] [Dev Deps] update `@angular-eslint/template-parser`,
`chai`, `eslint-doc-generator`, `glob`
---
package.json | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/package.json b/package.json
index 299cf52b0c..d543ec5a83 100644
--- a/package.json
+++ b/package.json
@@ -55,7 +55,7 @@
},
"homepage": "https://github.com/import-js/eslint-plugin-import",
"devDependencies": {
- "@angular-eslint/template-parser": "^13.2.1",
+ "@angular-eslint/template-parser": "^13.5.0",
"@eslint/import-test-order-redirect-scoped": "file:./tests/files/order-redirect-scoped",
"@test-scope/some-module": "file:./tests/files/symlinked-module",
"@typescript-eslint/parser": "^2.23.0 || ^3.3.0 || ^4.29.3 || ^5.10.0",
@@ -68,11 +68,11 @@
"babel-preset-flow": "^6.23.0",
"babel-register": "^6.26.0",
"babylon": "^6.18.0",
- "chai": "^4.3.6",
+ "chai": "^4.3.7",
"cross-env": "^4.0.0",
"escope": "^3.6.0",
"eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8",
- "eslint-doc-generator": "^1.0.0",
+ "eslint-doc-generator": "^1.4.3",
"eslint-import-resolver-node": "file:./resolvers/node",
"eslint-import-resolver-typescript": "^1.0.2 || ^1.1.1",
"eslint-import-resolver-webpack": "file:./resolvers/webpack",
@@ -82,7 +82,7 @@
"eslint-plugin-import": "2.x",
"eslint-plugin-json": "^2.1.2",
"fs-copy-file-sync": "^1.1.1",
- "glob": "^7.2.0",
+ "glob": "^7.2.3",
"in-publish": "^2.0.1",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
From 5680a1f8d41cd19f9c60d999a6fadf10994a0a64 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 25 Feb 2023 10:57:20 -0800
Subject: [PATCH 002/199] [Deps] update `tsconfig-paths`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index d543ec5a83..3733e2d76f 100644
--- a/package.json
+++ b/package.json
@@ -114,6 +114,6 @@
"object.values": "^1.1.6",
"resolve": "^1.22.1",
"semver": "^6.3.0",
- "tsconfig-paths": "^3.14.1"
+ "tsconfig-paths": "^3.14.2"
}
}
From 6f12316ee7faa879fb046e04c8be8352f013a6f2 Mon Sep 17 00:00:00 2001
From: Brad Zacher <brad.zacher@gmail.com>
Date: Thu, 6 Apr 2023 16:31:23 +0930
Subject: [PATCH 003/199] [Fix] `consistent-type-specifier-style`: fix
accidental removal of comma in certain cases
---
CHANGELOG.md | 2 ++
src/rules/consistent-type-specifier-style.js | 6 ++---
.../rules/consistent-type-specifier-style.js | 27 +++++++++++++++++++
3 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c16d2c9ffa..1866819b09 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
- TypeScript config: fix resolver extension settings (thanks [@gajus])
+- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1065,6 +1066,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
[#2699]: https://github.com/import-js/eslint-plugin-import/pull/2699
[#2664]: https://github.com/import-js/eslint-plugin-import/pull/2664
[#2613]: https://github.com/import-js/eslint-plugin-import/pull/2613
diff --git a/src/rules/consistent-type-specifier-style.js b/src/rules/consistent-type-specifier-style.js
index 869eea91ff..bb8fdf8498 100644
--- a/src/rules/consistent-type-specifier-style.js
+++ b/src/rules/consistent-type-specifier-style.js
@@ -7,9 +7,9 @@ function isComma(token) {
function removeSpecifiers(fixes, fixer, sourceCode, specifiers) {
for (const specifier of specifiers) {
// remove the trailing comma
- const comma = sourceCode.getTokenAfter(specifier, isComma);
- if (comma) {
- fixes.push(fixer.remove(comma));
+ const token = sourceCode.getTokenAfter(specifier);
+ if (token && isComma(token)) {
+ fixes.push(fixer.remove(token));
}
fixes.push(fixer.remove(specifier));
}
diff --git a/tests/src/rules/consistent-type-specifier-style.js b/tests/src/rules/consistent-type-specifier-style.js
index 440ef3aff5..7799238c32 100644
--- a/tests/src/rules/consistent-type-specifier-style.js
+++ b/tests/src/rules/consistent-type-specifier-style.js
@@ -168,6 +168,33 @@ const COMMON_TESTS = {
type: 'ImportSpecifier',
}],
},
+ // https://github.com/import-js/eslint-plugin-import/issues/2753
+ {
+ code: `\
+import { Component, type ComponentProps } from "package-1";
+import {
+ Component1,
+ Component2,
+ Component3,
+ Component4,
+ Component5,
+} from "package-2";`,
+ output: `\
+import { Component } from "package-1";
+import type {ComponentProps} from "package-1";
+import {
+ Component1,
+ Component2,
+ Component3,
+ Component4,
+ Component5,
+} from "package-2";`,
+ options: ['prefer-top-level'],
+ errors: [{
+ message: 'Prefer using a top-level type-only import instead of inline type specifiers.',
+ type: 'ImportSpecifier',
+ }],
+ },
//
// prefer-inline
From 6be042b559aecc50f3a5313f20023a2cc4879541 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 7 Apr 2023 22:22:40 -0700
Subject: [PATCH 004/199] [Tests] `no-extraneous-dependencies`: add passing
test
Closes #2718
---
tests/src/rules/no-extraneous-dependencies.js | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index c1018a9149..8815f63cd8 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -475,5 +475,14 @@ typescriptRuleTester.run('no-extraneous-dependencies typescript type imports', r
message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
}],
}),
+ test({
+ code: `import type { Foo } from 'not-a-dependency'`,
+ options: [{ includeTypes: true }],
+ filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
+ parser: parsers.BABEL_OLD,
+ errors: [{
+ message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
+ }],
+ }),
],
});
From d2b10aec006d04680c8b36fbd4e4e325376a73c0 Mon Sep 17 00:00:00 2001
From: xM8WVqaG <44505331+xM8WVqaG@users.noreply.github.com>
Date: Sat, 25 Mar 2023 14:49:48 +0000
Subject: [PATCH 005/199] [Docs] `extensions`: reference node ESM behavior
This behavior largely didn't change despite the functionality becoming more widely adopted. Even though the document assumes CJS, It's probably worth including at least a footnote about the resolver behaving differently for ESM.
See: https://github.com/import-js/eslint-plugin-import/issues/2043
---
CHANGELOG.md | 3 +++
docs/rules/extensions.md | 4 +++-
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1866819b09..d10ceef814 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
- [Docs] [`group-exports`]: fix syntax highlighting ([#2699], thanks [@devinrhode2])
+- [Docs] [`extensions`]: reference node ESM behavior ([#2748], thanks [@xM8WVqaG])
## [2.27.5] - 2023-01-16
@@ -1067,6 +1068,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
+[#2748]: https://github.com/import-js/eslint-plugin-import/pull/2748
[#2699]: https://github.com/import-js/eslint-plugin-import/pull/2699
[#2664]: https://github.com/import-js/eslint-plugin-import/pull/2664
[#2613]: https://github.com/import-js/eslint-plugin-import/pull/2613
@@ -1853,6 +1855,7 @@ for info on changes for earlier releases.
[@wKich]: https://github.com/wKich
[@wschurman]: https://github.com/wschurman
[@wtgtybhertgeghgtwtg]: https://github.com/wtgtybhertgeghgtwtg
+[@xM8WVqaG]: https://github.com/xM8WVqaG
[@xpl]: https://github.com/xpl
[@yordis]: https://github.com/yordis
[@zloirock]: https://github.com/zloirock
diff --git a/docs/rules/extensions.md b/docs/rules/extensions.md
index 9e78b8c70f..df4f341287 100644
--- a/docs/rules/extensions.md
+++ b/docs/rules/extensions.md
@@ -2,7 +2,7 @@
<!-- end auto-generated rule header -->
-Some file resolve algorithms allow you to omit the file extension within the import source path. For example the `node` resolver can resolve `./foo/bar` to the absolute path `/User/someone/foo/bar.js` because the `.js` extension is resolved automatically by default. Depending on the resolver you can configure more extensions to get resolved automatically.
+Some file resolve algorithms allow you to omit the file extension within the import source path. For example the `node` resolver (which does not yet support ESM/`import`) can resolve `./foo/bar` to the absolute path `/User/someone/foo/bar.js` because the `.js` extension is resolved automatically by default in CJS. Depending on the resolver you can configure more extensions to get resolved automatically.
In order to provide a consistent use of file extensions across your code base, this rule can enforce or disallow the use of certain file extensions.
@@ -170,3 +170,5 @@ import foo from '@/foo';
## When Not To Use It
If you are not concerned about a consistent usage of file extension.
+
+In the future, when this rule supports native node ESM resolution, and the plugin is configured to use native rather than transpiled ESM (a config option that is not yet available) - setting this to `always` will have no effect.
From 6cb9616d3fcc07b98b9efe3256b457f9d44a11cf Mon Sep 17 00:00:00 2001
From: Lukas Eipert <git@leipert.io>
Date: Sat, 8 Apr 2023 15:18:37 +0200
Subject: [PATCH 006/199] [utils] [perf] Performance of fullResolve
While looking at a larger code base https://gitlab.com/gitlab-org/gitlab,
I've came to realize that `fullResolve` takes a lot of CPU cycles,
particularly the `hashObject` calls inside it.
I applied the following patch locally to see how often this is called and
how many unique hashes were produced:
```diff
diff --git a/utils/resolve.js b/utils/resolve.js
index 4a35c6a..3c28324 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -83,13 +83,28 @@ function relative(modulePath, sourceFile, settings) {
return fullResolve(modulePath, sourceFile, settings).path;
}
+let prevSettings = null;
+let nonEqualSettings = 0;
+let totalCalls = 0;
+let uniqueHashes = new Set();
function fullResolve(modulePath, sourceFile, settings) {
// check if this is a bonus core module
const coreSet = new Set(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;
+
+ totalCalls+=1;
+ const hash = hashObject(settings).digest('hex');
+
+ if(prevSettings !== settings){
+ uniqueHashes.add(hash);
+ prevSettings = settings;
+ nonEqualSettings+=1;
+ console.log(`fullResolve | Total calls:${totalCalls} | Non-Equal settings:${nonEqualSettings} | Unique hashes:${uniqueHashes.size} | dir:${sourceDir}`)
+ }
+
+ const cacheKey = sourceDir + hash + modulePath;
const cacheSettings = ModuleCache.getSettings(settings);
```
For our code base, `fullResolve` is called more than 570 thousand times.
The simple in-equality `!==` code path is taken 1090 times.
Actually only _four_ unique hashes are produced, meaning we only have
four unique settings across our code base.
I assume that a full object equality comparison might not be needed,
and a simple object comparison with `!==` already would reduce the amount
of `hashObject` calls by 570x. This is what is implemented in this commit.
Time spend in `fullResolve` was reduced by ~38%:
- Before: 17% (19.10s) of our total execution time
- After: 11% (11.86s) of our total execution time
The effect might even be more pronounced on machines that are slower when
calculating `sha256` hashes or that have less memory, as the `hashObject`
method tends to create loads of small strings which need to be garbage
collected.
---
utils/CHANGELOG.md | 5 +++++
utils/resolve.js | 10 +++++++++-
2 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 72fa611a14..7d2057dec2 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Fixed
+- Improve performance of `fullResolve` for large projects ([#2755], thanks [@leipert])
+
## v2.7.4 - 2022-08-11
### Fixed
@@ -123,6 +126,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#2755]: https://github.com/import-js/eslint-plugin-import/pull/2755
[#2523]: https://github.com/import-js/eslint-plugin-import/pull/2523
[#2431]: https://github.com/import-js/eslint-plugin-import/pull/2431
[#2350]: https://github.com/import-js/eslint-plugin-import/issues/2350
@@ -160,6 +164,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@iamnapo]: https://github.com/iamnapo
[@JounQin]: https://github.com/JounQin
[@kaiyoma]: https://github.com/kaiyoma
+[@leipert]: https://github.com/leipert
[@manuth]: https://github.com/manuth
[@maxkomarychev]: https://github.com/maxkomarychev
[@mgwalker]: https://github.com/mgwalker
diff --git a/utils/resolve.js b/utils/resolve.js
index 4a35c6a472..9d9dfa8439 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -83,13 +83,21 @@ function relative(modulePath, sourceFile, settings) {
return fullResolve(modulePath, sourceFile, settings).path;
}
+let prevSettings = null;
+let memoizedHash = '';
function fullResolve(modulePath, sourceFile, settings) {
// check if this is a bonus core module
const coreSet = new Set(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;
+
+ if (prevSettings !== settings) {
+ memoizedHash = hashObject(settings).digest('hex');
+ prevSettings = settings;
+ }
+
+ const cacheKey = sourceDir + memoizedHash + modulePath;
const cacheSettings = ModuleCache.getSettings(settings);
From 3a22c3b05fa22c5c0e9db639007d79ff730678e8 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 11 Apr 2023 16:00:25 -0700
Subject: [PATCH 007/199] Revert "[Fix] TypeScript config: fix resolver
extension settings"
This reverts commit 808d504bffe29286a885475a424562969e9d4879, per https://github.com/import-js/eslint-plugin-import/commit/808d504bffe29286a885475a424562969e9d4879#commitcomment-107093802
---
CHANGELOG.md | 1 -
config/typescript.js | 2 +-
2 files changed, 1 insertion(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d10ceef814..01ab3f0819 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,7 +8,6 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
-- TypeScript config: fix resolver extension settings (thanks [@gajus])
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
### Changed
diff --git a/config/typescript.js b/config/typescript.js
index 59c3c42dae..ed03fb3f6c 100644
--- a/config/typescript.js
+++ b/config/typescript.js
@@ -16,7 +16,7 @@ module.exports = {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
'import/resolver': {
- 'typescript': {
+ 'node': {
'extensions': allExtensions,
},
},
From dc596a29bb3fe705396acc64f38d891b2ce52669 Mon Sep 17 00:00:00 2001
From: Daniel Martens <danielmartens@protonmail.ch>
Date: Fri, 10 Feb 2023 20:57:33 +0100
Subject: [PATCH 008/199] [utils] [new] `parse`: support flat config
---
tests/src/core/parse.js | 59 ++++++++++++++++++++++++++++
tests/src/rules/no-unused-modules.js | 22 +++++++++++
utils/parse.js | 38 ++++++++++++------
3 files changed, 108 insertions(+), 11 deletions(-)
diff --git a/tests/src/core/parse.js b/tests/src/core/parse.js
index 407070aa2f..4ab8370ed2 100644
--- a/tests/src/core/parse.js
+++ b/tests/src/core/parse.js
@@ -69,4 +69,63 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: [ '.js' ] } }, parserPath: null, parserOptions })).not.to.throw(Error);
expect(parseSpy.callCount, 'custom parser to be called once').to.equal(1);
});
+
+ it('throws on invalid languageOptions', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: null })).to.throw(Error);
+ });
+
+ it('throws on non-object languageOptions.parser', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: 'espree' } })).to.throw(Error);
+ });
+
+ it('throws on null languageOptions.parser', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: null } })).to.throw(Error);
+ });
+
+ it('throws on empty languageOptions.parser', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: {} } })).to.throw(Error);
+ });
+
+ it('throws on non-function languageOptions.parser.parse', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: { parse: 'espree' } } })).to.throw(Error);
+ });
+
+ it('throws on non-function languageOptions.parser.parse', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: { parseForESLint: 'espree' } } })).to.throw(Error);
+ });
+
+ it('requires only one of the parse methods', function () {
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: null, languageOptions: { parser: { parseForESLint: () => ({ ast: {} }) } } })).not.to.throw(Error);
+ });
+
+ it('uses parse from languageOptions.parser', function () {
+ const parseSpy = sinon.spy();
+ expect(parse.bind(null, path, content, { settings: {}, languageOptions: { parser: { parse: parseSpy } } })).not.to.throw(Error);
+ expect(parseSpy.callCount, 'passed parser to be called once').to.equal(1);
+ });
+
+ it('uses parseForESLint from languageOptions.parser', function () {
+ const parseSpy = sinon.spy(() => ({ ast: {} }));
+ expect(parse.bind(null, path, content, { settings: {}, languageOptions: { parser: { parseForESLint: parseSpy } } })).not.to.throw(Error);
+ expect(parseSpy.callCount, 'passed parser to be called once').to.equal(1);
+ });
+
+ it('prefers parsers specified in the settings over languageOptions.parser', () => {
+ const parseSpy = sinon.spy();
+ parseStubParser.parse = parseSpy;
+ expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: [ '.js' ] } }, parserPath: null, languageOptions: { parser: { parse() {} } } })).not.to.throw(Error);
+ expect(parseSpy.callCount, 'custom parser to be called once').to.equal(1);
+ });
+
+ it('ignores parser options from language options set to null', () => {
+ const parseSpy = sinon.spy();
+ parseStubParser.parse = parseSpy;
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: 'espree', languageOptions: { parserOptions: null }, parserOptions: { sourceType: 'module', ecmaVersion: 2015, ecmaFeatures: { jsx: true } } })).not.to.throw(Error);
+ });
+
+ it('prefers languageOptions.parserOptions over parserOptions', () => {
+ const parseSpy = sinon.spy();
+ parseStubParser.parse = parseSpy;
+ expect(parse.bind(null, path, content, { settings: {}, parserPath: 'espree', languageOptions: { parserOptions: { sourceType: 'module', ecmaVersion: 2015, ecmaFeatures: { jsx: true } } }, parserOptions: { sourceType: 'script' } })).not.to.throw(Error);
+ });
});
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index de169c65da..87714b599b 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -7,6 +7,11 @@ import fs from 'fs';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
+let FlatRuleTester;
+try {
+ ({ FlatRuleTester } = require('eslint/use-at-your-own-risk'));
+} catch (e) { /**/ }
+
// TODO: figure out why these tests fail in eslint 4 and 5
const isESLint4TODO = semver.satisfies(eslintPkg.version, '^4 || ^5');
@@ -1371,3 +1376,20 @@ describe('parser ignores prefixes like BOM and hashbang', () => {
invalid: [],
});
});
+
+describe('supports flat eslint', { skip: !FlatRuleTester }, () => {
+ const flatRuleTester = new FlatRuleTester();
+ flatRuleTester.run('no-unused-modules', rule, {
+ valid: [{
+ options: unusedExportsOptions,
+ code: 'import { o2 } from "./file-o";export default () => 12',
+ filename: testFilePath('./no-unused-modules/file-a.js'),
+ }],
+ invalid: [{
+ options: unusedExportsOptions,
+ code: 'export default () => 13',
+ filename: testFilePath('./no-unused-modules/file-f.js'),
+ errors: [error(`exported declaration 'default' not used within other modules`)],
+ }],
+ });
+});
diff --git a/utils/parse.js b/utils/parse.js
index ac728ec5b2..dd0746aaa7 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -23,10 +23,10 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
if (parsedResult && parsedResult.visitorKeys) {
return parsedResult.visitorKeys;
}
- if (/.*espree.*/.test(parserPath)) {
+ if (typeof parserPath === 'string' && /.*espree.*/.test(parserPath)) {
return parserInstance.VisitorKeys;
}
- if (/.*babel-eslint.*/.test(parserPath)) {
+ if (typeof parserPath === 'string' && /.*babel-eslint.*/.test(parserPath)) {
return getBabelEslintVisitorKeys(parserPath);
}
return null;
@@ -51,13 +51,13 @@ function transformHashbang(text) {
}
exports.default = function parse(path, content, context) {
-
if (context == null) throw new Error('need context to parse properly');
- let parserOptions = context.parserOptions;
- const parserPath = getParserPath(path, context);
+ // ESLint in "flat" mode only sets context.languageOptions.parserOptions
+ let parserOptions = (context.languageOptions && context.languageOptions.parserOptions) || context.parserOptions;
+ const parserOrPath = getParser(path, context);
- if (!parserPath) throw new Error('parserPath is required!');
+ if (!parserOrPath) throw new Error('parserPath or languageOptions.parser is required!');
// hack: espree blows up with frozen options
parserOptions = Object.assign({}, parserOptions);
@@ -84,7 +84,7 @@ exports.default = function parse(path, content, context) {
delete parserOptions.projects;
// require the parser relative to the main module (i.e., ESLint)
- const parser = moduleRequire(parserPath);
+ const parser = typeof parserOrPath === 'string' ? moduleRequire(parserOrPath) : parserOrPath;
// replicate bom strip and hashbang transform of ESLint
// https://github.com/eslint/eslint/blob/b93af98b3c417225a027cabc964c38e779adb945/lib/linter/linter.js#L779
@@ -95,7 +95,7 @@ exports.default = function parse(path, content, context) {
try {
const parserRaw = parser.parseForESLint(content, parserOptions);
ast = parserRaw.ast;
- return makeParseReturn(ast, keysFromParser(parserPath, parser, parserRaw));
+ return makeParseReturn(ast, keysFromParser(parserOrPath, parser, parserRaw));
} catch (e) {
console.warn();
console.warn('Error while parsing ' + parserOptions.filePath);
@@ -104,18 +104,34 @@ exports.default = function parse(path, content, context) {
if (!ast || typeof ast !== 'object') {
console.warn(
'`parseForESLint` from parser `' +
- parserPath +
+ (typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`') + // Can only be invalid for custom parser per imports/parser
'` is invalid and will just be ignored'
);
} else {
- return makeParseReturn(ast, keysFromParser(parserPath, parser, undefined));
+ return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
}
}
const ast = parser.parse(content, parserOptions);
- return makeParseReturn(ast, keysFromParser(parserPath, parser, undefined));
+ return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
};
+function getParser(path, context) {
+ const parserPath = getParserPath(path, context);
+ if (parserPath) {
+ return parserPath;
+ }
+ const isFlat = context.languageOptions
+ && context.languageOptions.parser
+ && typeof context.languageOptions.parser !== 'string'
+ && (
+ typeof context.languageOptions.parser.parse === 'function'
+ || typeof context.languageOptions.parser.parseForESLint === 'function'
+ );
+
+ return isFlat ? context.languageOptions.parser : null;
+}
+
function getParserPath(path, context) {
const parsers = context.settings['import/parsers'];
if (parsers != null) {
From 0ae35c0efc02422f577bc0336ce9cef14b8339a0 Mon Sep 17 00:00:00 2001
From: Lukas Eipert <git@leipert.io>
Date: Wed, 12 Apr 2023 14:33:48 +0200
Subject: [PATCH 009/199] [perf] `ExportMap`: Improve ExportMap.for performance
on larger codebases
While looking at a larger code base https://gitlab.com/gitlab-org/gitlab,
`ExportMap.for` seems to take a significant amount of time. More than
half of it is spend on calculating hashes with `hashObject`.
Digging a little deeper, it seems like we are calling it around 500
thousand times. Each iteration calculates the hash of a context object.
This context object is created inside of the `childContext` function and
consists of four parts:
- `settings` -> an Object itself
- `parserOptions` -> an Object itself
- `parserPath` -> a String
- `path` -> a String.
Interestingly `settings`, `parserOptions` and `parserPath` rarely do
change for us, so calculating their hashes on every iteration seems
unnecessary. `hashObject` recursively calculates the hashes of each
key / value pair.
So instead of doing:
```js
cacheKey = hashObject({settings, parserOptions, parserPath, path})
```
We could also do:
```js
cacheKey = parserPath +
hashObject(parserOptions) +
hashObject(settings) +
path
```
This would be just as stable as before, although resulting in longer
cache keys. `parserPath` and `path` would not need to be hashed,
because they are strings and a single character change in them would
result in a different cache key.
Furthermore we can memoize the hashes of `parserOptions` and
`settings`, in case they didn't change compared. The equality is
checked with a simple `JSON.stringify`.
We move this `cacheKey` calculation to `childContext`, adding the
cache key to the `context` object. This way, we can fall back to the
old calculation inside of `ExportMap.for`, as it is a public
interface which consumers might be using.
In our code base the results speak for itself:
- 51.59s spent in `ExportMap.for`, 0ms spent in `childContext`.
- 16.89s is spent in node:crypto/hash `update` (overall)
- 41.02s spent in `ExportMap.for, 1.91s spent in `childContext`.
- Almost no time spent in `hashObject`, actually all calls in
our flame graph come from other code paths
- 7.86s is spent in node:crypto/hash `update` (overall)
So on this machine, and project, we are cutting the execution time
of `ExportMap.for` in half. On machines, which are hashing slower,
the effect might be more pronounced. Similarly machines with less
memory, as the `hashObject` function creates a lot of tiny strings.
One side-effect here could be, that the memoization is in-efficient
if the `settings` or `parserOptions` change often. (I cannot think
of such a scenario, but I am not that versed in the use cases of
this plugin.) But even then, the overhead should mainly be the
`JSON.stringify`.
---
CHANGELOG.md | 3 +++
src/ExportMap.js | 21 +++++++++++++++++++--
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 01ab3f0819..bbfaa0fb98 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
+- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1066,6 +1067,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
[#2748]: https://github.com/import-js/eslint-plugin-import/pull/2748
[#2699]: https://github.com/import-js/eslint-plugin-import/pull/2699
@@ -1737,6 +1739,7 @@ for info on changes for earlier releases.
[@kylemh]: https://github.com/kylemh
[@laysent]: https://github.com/laysent
[@le0nik]: https://github.com/le0nik
+[@leipert]: https://github.com/leipert
[@lemonmade]: https://github.com/lemonmade
[@lencioni]: https://github.com/lencioni
[@leonardodino]: https://github.com/leonardodino
diff --git a/src/ExportMap.js b/src/ExportMap.js
index 7b8c883143..d31375c83d 100644
--- a/src/ExportMap.js
+++ b/src/ExportMap.js
@@ -305,7 +305,7 @@ ExportMap.get = function (source, context) {
ExportMap.for = function (context) {
const { path } = context;
- const cacheKey = hashObject(context).digest('hex');
+ const cacheKey = context.cacheKey || hashObject(context).digest('hex');
let exportMap = exportCache.get(cacheKey);
// return cached ignore
@@ -559,7 +559,7 @@ ExportMap.parse = function (path, content, context) {
if (tsConfigInfo.tsConfigPath !== undefined) {
// Projects not using TypeScript won't have `typescript` installed.
if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
-
+
const configFile = ts.readConfigFile(tsConfigInfo.tsConfigPath, ts.sys.readFile);
return ts.parseJsonConfigFileContent(
configFile.config,
@@ -781,12 +781,29 @@ export function recursivePatternCapture(pattern, callback) {
}
}
+let parserOptionsHash = '';
+let prevParserOptions = '';
+let settingsHash = '';
+let prevSettings = '';
/**
* don't hold full context object in memory, just grab what we need.
+ * also calculate a cacheKey, where parts of the cacheKey hash are memoized
*/
function childContext(path, context) {
const { settings, parserOptions, parserPath } = context;
+
+ if (JSON.stringify(settings) !== prevSettings) {
+ settingsHash = hashObject({ settings }).digest('hex');
+ prevSettings = JSON.stringify(settings);
+ }
+
+ if (JSON.stringify(parserOptions) !== prevParserOptions) {
+ parserOptionsHash = hashObject({ parserOptions }).digest('hex');
+ prevParserOptions = JSON.stringify(parserOptions);
+ }
+
return {
+ cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
settings,
parserOptions,
parserPath,
From 97995673e02c3523559a4ae0792e1792d23064ec Mon Sep 17 00:00:00 2001
From: Andreas Deuschlinger <andreas.deuschlinger@gmail.com>
Date: Tue, 14 Mar 2023 22:50:50 +0100
Subject: [PATCH 010/199] [Fix] `no-extraneous-dependencies`/TypeScript: do not
error when importing inline type from dev dependencies
---
CHANGELOG.md | 3 ++
docs/rules/no-extraneous-dependencies.md | 1 +
src/rules/no-extraneous-dependencies.js | 7 ++++-
tests/src/rules/no-extraneous-dependencies.js | 30 +++++++++++++++++--
4 files changed, 38 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bbfaa0fb98..fe7f6771b8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
+- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1070,6 +1071,7 @@ for info on changes for earlier releases.
[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
[#2748]: https://github.com/import-js/eslint-plugin-import/pull/2748
+[#2735]: https://github.com/import-js/eslint-plugin-import/pull/2735
[#2699]: https://github.com/import-js/eslint-plugin-import/pull/2699
[#2664]: https://github.com/import-js/eslint-plugin-import/pull/2664
[#2613]: https://github.com/import-js/eslint-plugin-import/pull/2613
@@ -1625,6 +1627,7 @@ for info on changes for earlier releases.
[@alexgorbatchev]: https://github.com/alexgorbatchev
[@andreubotella]: https://github.com/andreubotella
[@AndrewLeedham]: https://github.com/AndrewLeedham
+[@andyogo]: https://github.com/andyogo
[@aravindet]: https://github.com/aravindet
[@arvigeus]: https://github.com/arvigeus
[@asapach]: https://github.com/asapach
diff --git a/docs/rules/no-extraneous-dependencies.md b/docs/rules/no-extraneous-dependencies.md
index 68cd4b154f..660875d1da 100644
--- a/docs/rules/no-extraneous-dependencies.md
+++ b/docs/rules/no-extraneous-dependencies.md
@@ -12,6 +12,7 @@ Modules have to be installed for this rule to work.
This rule supports the following options:
`devDependencies`: If set to `false`, then the rule will show an error when `devDependencies` are imported. Defaults to `true`.
+Type imports are ignored by default.
`optionalDependencies`: If set to `false`, then the rule will show an error when `optionalDependencies` are imported. Defaults to `true`.
diff --git a/src/rules/no-extraneous-dependencies.js b/src/rules/no-extraneous-dependencies.js
index d6437c2fd1..a149ca6599 100644
--- a/src/rules/no-extraneous-dependencies.js
+++ b/src/rules/no-extraneous-dependencies.js
@@ -178,7 +178,12 @@ function reportIfMissing(context, deps, depsOptions, node, name) {
// Do not report when importing types unless option is enabled
if (
!depsOptions.verifyTypeImports &&
- (node.importKind === 'type' || node.importKind === 'typeof')
+ (node.importKind === 'type' || node.importKind === 'typeof' ||
+ (
+ Array.isArray(node.specifiers) &&
+ node.specifiers.length &&
+ node.specifiers.every((specifier) => specifier.importKind === 'type' || specifier.importKind === 'typeof'))
+ )
) {
return;
}
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index 8815f63cd8..84aa8bb35d 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -438,7 +438,7 @@ describe('TypeScript', () => {
test(Object.assign({
code: 'import type T from "a";',
- options: [{
+ options: [{
packageDir: packageDirWithTypescriptDevDependencies,
devDependencies: false,
includeTypes: true,
@@ -464,6 +464,16 @@ typescriptRuleTester.run('no-extraneous-dependencies typescript type imports', r
filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
parser: parsers.BABEL_OLD,
}),
+ test({
+ code: 'import { type MyType } from "not-a-dependency";',
+ filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
+ parser: parsers.BABEL_OLD,
+ }),
+ test({
+ code: 'import { type MyType, type OtherType } from "not-a-dependency";',
+ filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
+ parser: parsers.BABEL_OLD,
+ }),
],
invalid: [
test({
@@ -476,7 +486,7 @@ typescriptRuleTester.run('no-extraneous-dependencies typescript type imports', r
}],
}),
test({
- code: `import type { Foo } from 'not-a-dependency'`,
+ code: `import type { Foo } from 'not-a-dependency';`,
options: [{ includeTypes: true }],
filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
parser: parsers.BABEL_OLD,
@@ -484,5 +494,21 @@ typescriptRuleTester.run('no-extraneous-dependencies typescript type imports', r
message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
}],
}),
+ test({
+ code: 'import Foo, { type MyType } from "not-a-dependency";',
+ filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
+ parser: parsers.BABEL_OLD,
+ errors: [{
+ message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
+ }],
+ }),
+ test({
+ code: 'import { type MyType, Foo } from "not-a-dependency";',
+ filename: testFilePath('./no-unused-modules/typescript/file-ts-a.ts'),
+ parser: parsers.BABEL_OLD,
+ errors: [{
+ message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
+ }],
+ }),
],
});
From 8c155baaca39dc78c5a3a63ff1bdd53b58f343e0 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 13 Apr 2023 16:20:26 -0700
Subject: [PATCH 011/199] [eslint] tighten up rules
---
.eslintrc | 95 ++++++-
config/typescript.js | 4 +-
memo-parser/index.js | 4 +-
resolvers/node/index.js | 9 +-
resolvers/node/test/packageMains.js | 1 -
resolvers/node/test/paths.js | 2 -
resolvers/webpack/index.js | 20 +-
.../config-extensions/webpack.config.babel.js | 4 +-
resolvers/webpack/test/extensions.js | 1 -
resolvers/webpack/test/fallback.js | 1 -
resolvers/webpack/test/loaders.js | 1 -
resolvers/webpack/test/packageMains.js | 1 -
resolvers/webpack/test/root.js | 1 -
scripts/testAll.js | 4 +-
src/ExportMap.js | 254 +++++++++---------
src/core/importType.js | 18 +-
src/core/packagePath.js | 1 -
src/core/staticRequire.js | 14 +-
src/index.js | 28 +-
src/rules/consistent-type-specifier-style.js | 36 +--
src/rules/default.js | 10 +-
src/rules/dynamic-import-chunkname.js | 3 +-
src/rules/export.js | 40 +--
src/rules/exports-last.js | 6 +-
src/rules/extensions.js | 18 +-
src/rules/first.js | 35 +--
src/rules/group-exports.js | 10 +-
src/rules/imports-first.js | 7 +-
src/rules/max-dependencies.js | 32 ++-
src/rules/named.js | 8 +-
src/rules/namespace.js | 68 ++---
src/rules/newline-after-import.js | 35 +--
src/rules/no-absolute-path.js | 6 +-
src/rules/no-amd.js | 13 +-
src/rules/no-anonymous-default-export.js | 6 +-
src/rules/no-commonjs.js | 46 ++--
src/rules/no-cycle.js | 44 +--
src/rules/no-default-export.js | 2 +-
src/rules/no-deprecated.js | 75 +++---
src/rules/no-duplicates.js | 65 +++--
src/rules/no-dynamic-require.js | 20 +-
src/rules/no-empty-named-blocks.js | 21 +-
src/rules/no-extraneous-dependencies.js | 94 +++----
src/rules/no-import-module-exports.js | 21 +-
src/rules/no-internal-modules.js | 34 +--
src/rules/no-mutable-exports.js | 4 +-
src/rules/no-named-as-default-member.js | 105 ++++----
src/rules/no-named-as-default.js | 18 +-
src/rules/no-named-default.js | 2 +-
src/rules/no-named-export.js | 2 +-
src/rules/no-namespace.js | 23 +-
src/rules/no-nodejs-modules.js | 2 +-
src/rules/no-relative-packages.js | 2 +-
src/rules/no-relative-parent-imports.js | 7 +-
src/rules/no-restricted-paths.js | 20 +-
src/rules/no-unassigned-import.js | 37 +--
src/rules/no-unused-modules.js | 117 ++++----
src/rules/no-useless-path-segments.js | 4 +-
src/rules/no-webpack-loader-syntax.js | 4 +-
src/rules/order.js | 101 ++++---
src/rules/prefer-default-export.js | 24 +-
tests/src/cli.js | 14 +-
tests/src/core/getExports.js | 55 ++--
tests/src/core/hash.js | 2 +-
tests/src/core/parse.js | 16 +-
tests/src/core/resolve.js | 207 ++++++++------
tests/src/package.js | 6 +-
tests/src/rules/dynamic-import-chunkname.js | 2 +-
tests/src/rules/export.js | 2 -
tests/src/rules/exports-last.js | 2 +-
tests/src/rules/extensions.js | 25 +-
tests/src/rules/first.js | 2 +-
tests/src/rules/named.js | 16 +-
tests/src/rules/namespace.js | 69 ++---
tests/src/rules/newline-after-import.js | 50 ++--
tests/src/rules/no-commonjs.js | 16 +-
tests/src/rules/no-cycle.js | 4 +-
tests/src/rules/no-deprecated.js | 13 +-
tests/src/rules/no-duplicates.js | 24 +-
tests/src/rules/no-dynamic-require.js | 14 +-
tests/src/rules/no-empty-named-blocks.js | 3 +-
tests/src/rules/no-extraneous-dependencies.js | 26 +-
tests/src/rules/no-import-module-exports.js | 3 +-
tests/src/rules/no-named-as-default-member.js | 25 +-
tests/src/rules/no-nodejs-modules.js | 4 +-
tests/src/rules/no-relative-parent-imports.js | 2 +-
tests/src/rules/no-restricted-paths.js | 5 +-
tests/src/rules/no-unassigned-import.js | 30 +--
tests/src/rules/no-unresolved.js | 23 +-
tests/src/rules/no-unused-modules.js | 7 +-
tests/src/rules/no-webpack-loader-syntax.js | 8 +-
tests/src/rules/order.js | 182 ++++++-------
tests/src/rules/prefer-default-export.js | 6 +-
tests/src/utils.js | 12 +-
utils/ModuleCache.js | 7 +-
utils/declaredScope.js | 5 +-
utils/hash.js | 11 +-
utils/ignore.js | 7 +-
utils/module-require.js | 1 +
utils/moduleVisitor.js | 88 +++---
utils/parse.js | 16 +-
utils/pkgUp.js | 9 +-
utils/readPkgUp.js | 9 +-
utils/resolve.js | 53 ++--
utils/unambiguous.js | 3 +-
utils/visit.js | 1 +
106 files changed, 1405 insertions(+), 1370 deletions(-)
diff --git a/.eslintrc b/.eslintrc
index 1c41cb71bd..709a474484 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -12,12 +12,18 @@
"env": {
"node": true,
"es6": true,
+ "es2017": true,
},
"parserOptions": {
"sourceType": "module",
"ecmaVersion": 2020,
},
"rules": {
+ "arrow-body-style": [2, "as-needed"],
+ "arrow-parens": [2, "always"],
+ "arrow-spacing": [2, { "before": true, "after": true }],
+ "block-spacing": [2, "always"],
+ "brace-style": [2, "1tbs", { "allowSingleLine": true }],
"comma-dangle": ["error", {
"arrays": "always-multiline",
"objects": "always-multiline",
@@ -25,12 +31,47 @@
"exports": "always-multiline",
"functions": "always-multiline",
}],
+ "comma-spacing": [2, { "before": false, "after": true }],
"comma-style": [2, "last"],
- "curly": [2, "multi-line"],
+ "computed-property-spacing": [2, "never"],
+ "curly": [2, "all"],
+ "default-case": [2, { "commentPattern": "(?:)" }],
+ "default-case-last": [2],
+ "default-param-last": [2],
+ "dot-location": [2, "property"],
+ "dot-notation": [2, { "allowKeywords": true, "allowPattern": "throws" }],
"eol-last": [2, "always"],
"eqeqeq": [2, "allow-null"],
- "func-call-spacing": 2,
- "indent": [2, 2],
+ "for-direction": [2],
+ "function-call-argument-newline": [2, "consistent"],
+ "func-call-spacing": [2, "never"],
+ "implicit-arrow-linebreak": [2, "beside"],
+ "indent": [2, 2, {
+ "SwitchCase": 1,
+ "VariableDeclarator": 1,
+ "outerIIFEBody": 1,
+ "FunctionDeclaration": {
+ "parameters": 1,
+ "body": 1
+ },
+ "FunctionExpression": {
+ "parameters": 1,
+ "body": 1
+ },
+ "CallExpression": {
+ "arguments": 1
+ },
+ "ArrayExpression": 1,
+ "ObjectExpression": 1,
+ "ImportDeclaration": 1,
+ "flatTernaryExpressions": false,
+ }],
+ "jsx-quotes": [2, "prefer-double"],
+ "key-spacing": [2, {
+ "beforeColon": false,
+ "afterColon": true,
+ "mode": "strict",
+ }],
"keyword-spacing": ["error", {
"before": true,
"after": true,
@@ -40,27 +81,68 @@
"case": { "after": true }
}
}],
+ "linebreak-style": [2, "unix"],
+ "lines-around-directive": [2, {
+ "before": "always",
+ "after": "always",
+ }],
"max-len": 0,
+ "new-parens": 2,
+ "no-array-constructor": 2,
+ "no-compare-neg-zero": 2,
"no-cond-assign": [2, "always"],
+ "no-extra-parens": 2,
+ "no-multiple-empty-lines": [2, { "max": 1, "maxEOF": 1, "maxBOF": 0 }],
"no-return-assign": [2, "always"],
+ "no-trailing-spaces": 2,
"no-var": 2,
"object-curly-spacing": [2, "always"],
"object-shorthand": ["error", "always", {
"ignoreConstructors": false,
- "avoidQuotes": true,
+ "avoidQuotes": false,
+ "avoidExplicitReturnArrows": true,
}],
"one-var": [2, "never"],
+ "operator-linebreak": [2, "none", {
+ "overrides": {
+ "?": "before",
+ ":": "before",
+ "&&": "before",
+ "||": "before",
+ },
+ }],
"prefer-const": 2,
+ "prefer-object-spread": 2,
+ "prefer-rest-params": 2,
+ "prefer-template": 2,
+ "quote-props": [2, "as-needed", { "keywords": false }],
"quotes": [2, "single", {
"allowTemplateLiterals": true,
"avoidEscape": true,
}],
+ "rest-spread-spacing": [2, "never"],
"semi": [2, "always"],
+ "semi-spacing": [2, { "before": false, "after": true }],
+ "semi-style": [2, "last"],
+ "space-before-blocks": [2, { "functions": "always", "keywords": "always", "classes": "always" }],
"space-before-function-paren": ["error", {
"anonymous": "always",
"named": "never",
"asyncArrow": "always",
}],
+ "space-in-parens": [2, "never"],
+ "space-infix-ops": [2],
+ "space-unary-ops": [2, { "words": true, "nonwords": false }],
+ "switch-colon-spacing": [2, { "after": true, "before": false }],
+ "template-curly-spacing": [2, "never"],
+ "template-tag-spacing": [2, "never"],
+ "unicode-bom": [2, "never"],
+ "use-isnan": [2, { "enforceForSwitchCase": true }],
+ "valid-typeof": [2],
+ "wrap-iife": [2, "outside", { "functionPrototypeMethods": true }],
+ "wrap-regex": [2],
+ "yield-star-spacing": [2, { "before": false, "after": true }],
+ "yoda": [2, "never", { "exceptRange": true, "onlyEquality": false }],
"eslint-plugin/consistent-output": [
"error",
@@ -116,6 +198,9 @@
"files": "resolvers/webpack/**",
"rules": {
"no-console": 1,
+ "prefer-template": 0,
+ "prefer-object-spread": 0,
+ "prefer-rest-params": 0,
},
"env": {
"es6": true,
@@ -143,6 +228,8 @@
"exports": "always-multiline",
"functions": "never"
}],
+ "prefer-object-spread": "off",
+ "prefer-template": "off",
"no-console": 1,
},
},
diff --git a/config/typescript.js b/config/typescript.js
index ed03fb3f6c..9fd789dbf7 100644
--- a/config/typescript.js
+++ b/config/typescript.js
@@ -16,8 +16,8 @@ module.exports = {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
'import/resolver': {
- 'node': {
- 'extensions': allExtensions,
+ node: {
+ extensions: allExtensions,
},
},
},
diff --git a/memo-parser/index.js b/memo-parser/index.js
index de558ffa3e..7868b7e953 100644
--- a/memo-parser/index.js
+++ b/memo-parser/index.js
@@ -17,7 +17,7 @@ const parserOptions = {
};
exports.parse = function parse(content, options) {
- options = Object.assign({}, options, parserOptions);
+ options = { ...options, ...parserOptions };
if (!options.filePath) {
throw new Error('no file path provided!');
@@ -30,7 +30,7 @@ exports.parse = function parse(content, options) {
const key = keyHash.digest('hex');
let ast = cache.get(key);
- if (ast != null) return ast;
+ if (ast != null) { return ast; }
const realParser = moduleRequire(options.parser);
diff --git a/resolvers/node/index.js b/resolvers/node/index.js
index ac478ef029..d382bca43d 100644
--- a/resolvers/node/index.js
+++ b/resolvers/node/index.js
@@ -29,17 +29,14 @@ exports.resolve = function (source, file, config) {
};
function opts(file, config, packageFilter) {
- return Object.assign({
- // more closely matches Node (#333)
+ return { // more closely matches Node (#333)
// plus 'mjs' for native modules! (#939)
extensions: ['.mjs', '.js', '.json', '.node'],
- },
- config,
- {
+ ...config,
// path.resolve will handle paths relative to CWD
basedir: path.dirname(path.resolve(file)),
packageFilter,
- });
+ };
}
function identity(x) { return x; }
diff --git a/resolvers/node/test/packageMains.js b/resolvers/node/test/packageMains.js
index caac6221ca..170b10e1a1 100644
--- a/resolvers/node/test/packageMains.js
+++ b/resolvers/node/test/packageMains.js
@@ -8,7 +8,6 @@ const resolver = require('../');
const file = path.join(__dirname, 'package-mains', 'dummy.js');
-
describe('packageMains', function () {
it('captures module', function () {
expect(resolver.resolve('./module', file)).property('path')
diff --git a/resolvers/node/test/paths.js b/resolvers/node/test/paths.js
index 1c42b46167..e6ffdafcd9 100644
--- a/resolvers/node/test/paths.js
+++ b/resolvers/node/test/paths.js
@@ -11,7 +11,6 @@ describe('paths', function () {
});
});
-
describe('core', function () {
it('returns found, but null path, for core Node modules', function () {
const resolved = node.resolve('fs', './test/file.js');
@@ -20,7 +19,6 @@ describe('core', function () {
});
});
-
describe('default options', function () {
it('finds .json files', function () {
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index b569d53224..8eb2db5ad6 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -75,7 +75,7 @@ exports.resolve = function (source, file, settings) {
if (!configPath || !path.isAbsolute(configPath)) {
// if not, find ancestral package.json and use its directory as base for the path
packageDir = findRoot(path.resolve(file));
- if (!packageDir) throw new Error('package not found above ' + file);
+ if (!packageDir) { throw new Error('package not found above ' + file); }
}
configPath = findConfigPath(configPath, packageDir);
@@ -108,7 +108,7 @@ exports.resolve = function (source, file, settings) {
}
if (Array.isArray(webpackConfig)) {
- webpackConfig = webpackConfig.map(cfg => {
+ webpackConfig = webpackConfig.map((cfg) => {
if (typeof cfg === 'function') {
return cfg(env, argv);
}
@@ -284,16 +284,15 @@ function createWebpack1ResolveSync(webpackRequire, resolveConfig, plugins) {
new ResultSymlinkPlugin(),
);
-
const resolvePlugins = [];
// support webpack.ResolverPlugin
if (plugins) {
plugins.forEach(function (plugin) {
if (
- plugin.constructor &&
- plugin.constructor.name === 'ResolverPlugin' &&
- Array.isArray(plugin.plugins)
+ plugin.constructor
+ && plugin.constructor.name === 'ResolverPlugin'
+ && Array.isArray(plugin.plugins)
) {
resolvePlugins.push.apply(resolvePlugins, plugin.plugins);
}
@@ -324,10 +323,10 @@ function makeRootPlugin(ModulesInRootPlugin, name, root) {
/* eslint-enable */
function findExternal(source, externals, context, resolveSync) {
- if (!externals) return false;
+ if (!externals) { return false; }
// string match
- if (typeof externals === 'string') return (source === externals);
+ if (typeof externals === 'string') { return source === externals; }
// array: recurse
if (Array.isArray(externals)) {
@@ -384,8 +383,8 @@ function findExternal(source, externals, context, resolveSync) {
// else, vanilla object
for (const key in externals) {
- if (!has(externals, key)) continue;
- if (source === key) return true;
+ if (!has(externals, key)) { continue; }
+ if (source === key) { return true; }
}
return false;
}
@@ -396,7 +395,6 @@ function findConfigPath(configPath, packageDir) {
});
let extension;
-
if (configPath) {
// extensions is not reused below, so safe to mutate it here.
extensions.reverse();
diff --git a/resolvers/webpack/test/config-extensions/webpack.config.babel.js b/resolvers/webpack/test/config-extensions/webpack.config.babel.js
index a63434f9bb..c8b3cd5780 100644
--- a/resolvers/webpack/test/config-extensions/webpack.config.babel.js
+++ b/resolvers/webpack/test/config-extensions/webpack.config.babel.js
@@ -3,7 +3,7 @@ import path from 'path';
export default {
resolve: {
alias: {
- 'foo': path.join(__dirname, 'some', 'goofy', 'path', 'foo.js'),
+ foo: path.join(__dirname, 'some', 'goofy', 'path', 'foo.js'),
},
modules: [
path.join(__dirname, 'src'),
@@ -17,7 +17,7 @@ export default {
},
externals: [
- { 'jquery': 'jQuery' },
+ { jquery: 'jQuery' },
'bootstrap',
],
};
diff --git a/resolvers/webpack/test/extensions.js b/resolvers/webpack/test/extensions.js
index c028f5c913..096df77281 100644
--- a/resolvers/webpack/test/extensions.js
+++ b/resolvers/webpack/test/extensions.js
@@ -6,7 +6,6 @@ const path = require('path');
const resolve = require('../index').resolve;
-
const file = path.join(__dirname, 'files', 'dummy.js');
const extensions = path.join(__dirname, 'custom-extensions', 'dummy.js');
diff --git a/resolvers/webpack/test/fallback.js b/resolvers/webpack/test/fallback.js
index 87c15eecd7..b164209e14 100644
--- a/resolvers/webpack/test/fallback.js
+++ b/resolvers/webpack/test/fallback.js
@@ -6,7 +6,6 @@ const path = require('path');
const resolve = require('../index').resolve;
-
const file = path.join(__dirname, 'files', 'src', 'dummy.js');
describe('fallback', function () {
diff --git a/resolvers/webpack/test/loaders.js b/resolvers/webpack/test/loaders.js
index 6b5604592d..e250894a54 100644
--- a/resolvers/webpack/test/loaders.js
+++ b/resolvers/webpack/test/loaders.js
@@ -6,7 +6,6 @@ const path = require('path');
const resolve = require('../index').resolve;
-
const file = path.join(__dirname, 'files', 'dummy.js');
describe('inline loader syntax', function () {
diff --git a/resolvers/webpack/test/packageMains.js b/resolvers/webpack/test/packageMains.js
index fef3dde073..d3ddad9dab 100644
--- a/resolvers/webpack/test/packageMains.js
+++ b/resolvers/webpack/test/packageMains.js
@@ -8,7 +8,6 @@ const resolver = require('../');
const file = path.join(__dirname, 'package-mains', 'dummy.js');
-
describe('packageMains', function () {
it('captures module', function () {
diff --git a/resolvers/webpack/test/root.js b/resolvers/webpack/test/root.js
index 154dbeef95..194bb8fc88 100644
--- a/resolvers/webpack/test/root.js
+++ b/resolvers/webpack/test/root.js
@@ -6,7 +6,6 @@ const path = require('path');
const resolve = require('../index').resolve;
-
const file = path.join(__dirname, 'files', 'src', 'dummy.js');
const webpackDir = path.join(__dirname, 'different-package-location');
diff --git a/scripts/testAll.js b/scripts/testAll.js
index fc30b1ac7d..0e4a12c68a 100644
--- a/scripts/testAll.js
+++ b/scripts/testAll.js
@@ -10,11 +10,11 @@ const spawnOptions = {
spawnSync(
npmPath,
['test'],
- Object.assign({ cwd: __dirname }, spawnOptions));
+ { cwd: __dirname, ...spawnOptions });
for (const resolverDir of resolverDirectories) {
spawnSync(
npmPath,
['test'],
- Object.assign({ cwd: resolverDir }, spawnOptions));
+ { cwd: resolverDir, ...spawnOptions });
}
diff --git a/src/ExportMap.js b/src/ExportMap.js
index d31375c83d..cd5bad56c3 100644
--- a/src/ExportMap.js
+++ b/src/ExportMap.js
@@ -53,10 +53,10 @@ export default class ExportMap {
get size() {
let size = this.namespace.size + this.reexports.size;
- this.dependencies.forEach(dep => {
+ this.dependencies.forEach((dep) => {
const d = dep();
// CJS / ignored dependencies won't exist (#717)
- if (d == null) return;
+ if (d == null) { return; }
size += d.size;
});
return size;
@@ -70,8 +70,8 @@ export default class ExportMap {
* @return {Boolean} true if `name` is exported by this module.
*/
has(name) {
- if (this.namespace.has(name)) return true;
- if (this.reexports.has(name)) return true;
+ if (this.namespace.has(name)) { return true; }
+ if (this.reexports.has(name)) { return true; }
// default exports must be explicitly re-exported (#328)
if (name !== 'default') {
@@ -79,9 +79,9 @@ export default class ExportMap {
const innerMap = dep();
// todo: report as unresolved?
- if (!innerMap) continue;
+ if (!innerMap) { continue; }
- if (innerMap.has(name)) return true;
+ if (innerMap.has(name)) { return true; }
}
}
@@ -94,14 +94,14 @@ export default class ExportMap {
* @return {{ found: boolean, path: ExportMap[] }}
*/
hasDeep(name) {
- if (this.namespace.has(name)) return { found: true, path: [this] };
+ if (this.namespace.has(name)) { return { found: true, path: [this] }; }
if (this.reexports.has(name)) {
const reexports = this.reexports.get(name);
const imported = reexports.getImport();
// if import is ignored, return explicit 'null'
- if (imported == null) return { found: true, path: [this] };
+ if (imported == null) { return { found: true, path: [this] }; }
// safeguard against cycles, only if name matches
if (imported.path === this.path && reexports.local === name) {
@@ -114,17 +114,16 @@ export default class ExportMap {
return deep;
}
-
// default exports must be explicitly re-exported (#328)
if (name !== 'default') {
for (const dep of this.dependencies) {
const innerMap = dep();
- if (innerMap == null) return { found: true, path: [this] };
+ if (innerMap == null) { return { found: true, path: [this] }; }
// todo: report as unresolved?
- if (!innerMap) continue;
+ if (!innerMap) { continue; }
// safeguard against cycles
- if (innerMap.path === this.path) continue;
+ if (innerMap.path === this.path) { continue; }
const innerValue = innerMap.hasDeep(name);
if (innerValue.found) {
@@ -138,17 +137,17 @@ export default class ExportMap {
}
get(name) {
- if (this.namespace.has(name)) return this.namespace.get(name);
+ if (this.namespace.has(name)) { return this.namespace.get(name); }
if (this.reexports.has(name)) {
const reexports = this.reexports.get(name);
const imported = reexports.getImport();
// if import is ignored, return explicit 'null'
- if (imported == null) return null;
+ if (imported == null) { return null; }
// safeguard against cycles, only if name matches
- if (imported.path === this.path && reexports.local === name) return undefined;
+ if (imported.path === this.path && reexports.local === name) { return undefined; }
return imported.get(reexports.local);
}
@@ -158,13 +157,13 @@ export default class ExportMap {
for (const dep of this.dependencies) {
const innerMap = dep();
// todo: report as unresolved?
- if (!innerMap) continue;
+ if (!innerMap) { continue; }
// safeguard against cycles
- if (innerMap.path === this.path) continue;
+ if (innerMap.path === this.path) { continue; }
const innerValue = innerMap.get(name);
- if (innerValue !== undefined) return innerValue;
+ if (innerValue !== undefined) { return innerValue; }
}
}
@@ -172,8 +171,7 @@ export default class ExportMap {
}
forEach(callback, thisArg) {
- this.namespace.forEach((v, n) =>
- callback.call(thisArg, v, n, this));
+ this.namespace.forEach((v, n) => { callback.call(thisArg, v, n, this); });
this.reexports.forEach((reexports, name) => {
const reexported = reexports.getImport();
@@ -181,25 +179,28 @@ export default class ExportMap {
callback.call(thisArg, reexported && reexported.get(reexports.local), name, this);
});
- this.dependencies.forEach(dep => {
+ this.dependencies.forEach((dep) => {
const d = dep();
// CJS / ignored dependencies won't exist (#717)
- if (d == null) return;
+ if (d == null) { return; }
- d.forEach((v, n) =>
- n !== 'default' && callback.call(thisArg, v, n, this));
+ d.forEach((v, n) => {
+ if (n !== 'default') {
+ callback.call(thisArg, v, n, this);
+ }
+ });
});
}
// todo: keys, values, entries?
reportErrors(context, declaration) {
+ const msg = this.errors
+ .map((e) => `${e.message} (${e.lineNumber}:${e.column})`)
+ .join(', ');
context.report({
node: declaration.source,
- message: `Parse errors in imported module '${declaration.source.value}': ` +
- `${this.errors
- .map(e => `${e.message} (${e.lineNumber}:${e.column})`)
- .join(', ')}`,
+ message: `Parse errors in imported module '${declaration.source.value}': ${msg}`,
});
}
}
@@ -211,7 +212,7 @@ function captureDoc(source, docStyleParsers, ...nodes) {
const metadata = {};
// 'some' short-circuits on first 'true'
- nodes.some(n => {
+ nodes.some((n) => {
try {
let leadingComments;
@@ -223,7 +224,7 @@ function captureDoc(source, docStyleParsers, ...nodes) {
leadingComments = source.getCommentsBefore(n);
}
- if (!leadingComments || leadingComments.length === 0) return false;
+ if (!leadingComments || leadingComments.length === 0) { return false; }
for (const name in docStyleParsers) {
const doc = docStyleParsers[name](leadingComments);
@@ -255,9 +256,9 @@ function captureJsDoc(comments) {
let doc;
// capture XSDoc
- comments.forEach(comment => {
+ comments.forEach((comment) => {
// skip non-block comments
- if (comment.type !== 'Block') return;
+ if (comment.type !== 'Block') { return; }
try {
doc = doctrine.parse(comment.value, { unwrap: true });
} catch (err) {
@@ -276,7 +277,7 @@ function captureTomDoc(comments) {
const lines = [];
for (let i = 0; i < comments.length; i++) {
const comment = comments[i];
- if (comment.value.match(/^\s*$/)) break;
+ if (comment.value.match(/^\s*$/)) { break; }
lines.push(comment.value.trim());
}
@@ -297,7 +298,7 @@ const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespace
ExportMap.get = function (source, context) {
const path = resolve(source, context);
- if (path == null) return null;
+ if (path == null) { return null; }
return ExportMap.for(childContext(path, context));
};
@@ -309,7 +310,7 @@ ExportMap.for = function (context) {
let exportMap = exportCache.get(cacheKey);
// return cached ignore
- if (exportMap === null) return null;
+ if (exportMap === null) { return null; }
const stats = fs.statSync(path);
if (exportMap != null) {
@@ -358,7 +359,6 @@ ExportMap.for = function (context) {
return exportMap;
};
-
ExportMap.parse = function (path, content, context) {
const m = new ExportMap(path);
const isEsModuleInteropTrue = isEsModuleInterop();
@@ -416,21 +416,21 @@ ExportMap.parse = function (path, content, context) {
});
const unambiguouslyESM = unambiguous.isModule(ast);
- if (!unambiguouslyESM && !hasDynamicImports) return null;
+ if (!unambiguouslyESM && !hasDynamicImports) { return null; }
- const docstyle = (context.settings && context.settings['import/docstyle']) || ['jsdoc'];
+ const docstyle = context.settings && context.settings['import/docstyle'] || ['jsdoc'];
const docStyleParsers = {};
- docstyle.forEach(style => {
+ docstyle.forEach((style) => {
docStyleParsers[style] = availableDocStyleParsers[style];
});
// attempt to collect module doc
if (ast.comments) {
- ast.comments.some(c => {
- if (c.type !== 'Block') return false;
+ ast.comments.some((c) => {
+ if (c.type !== 'Block') { return false; }
try {
const doc = doctrine.parse(c.value, { unwrap: true });
- if (doc.tags.some(t => t.title === 'module')) {
+ if (doc.tags.some((t) => t.title === 'module')) {
m.doc = doc;
return true;
}
@@ -447,12 +447,12 @@ ExportMap.parse = function (path, content, context) {
function resolveImport(value) {
const rp = remotePath(value);
- if (rp == null) return null;
+ if (rp == null) { return null; }
return ExportMap.for(childContext(rp, context));
}
function getNamespace(identifier) {
- if (!namespaces.has(identifier.name)) return;
+ if (!namespaces.has(identifier.name)) { return; }
return function () {
return resolveImport(namespaces.get(identifier.name));
@@ -474,27 +474,27 @@ ExportMap.parse = function (path, content, context) {
let local;
switch (s.type) {
- case 'ExportDefaultSpecifier':
- if (!nsource) return;
- local = 'default';
- break;
- case 'ExportNamespaceSpecifier':
- m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
- get() { return resolveImport(nsource); },
- }));
- return;
- case 'ExportAllDeclaration':
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.source.value));
- return;
- case 'ExportSpecifier':
- if (!n.source) {
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.local));
+ case 'ExportDefaultSpecifier':
+ if (!nsource) { return; }
+ local = 'default';
+ break;
+ case 'ExportNamespaceSpecifier':
+ m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
+ get() { return resolveImport(nsource); },
+ }));
return;
- }
+ case 'ExportAllDeclaration':
+ m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.source.value));
+ return;
+ case 'ExportSpecifier':
+ if (!n.source) {
+ m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.local));
+ return;
+ }
// else falls through
- default:
- local = s.local.name;
- break;
+ default:
+ local = s.local.name;
+ break;
}
// todo: JSDoc
@@ -508,7 +508,7 @@ ExportMap.parse = function (path, content, context) {
// shouldn't be considered to be just importing types
let specifiersOnlyImportingTypes = n.specifiers.length > 0;
const importedSpecifiers = new Set();
- n.specifiers.forEach(specifier => {
+ n.specifiers.forEach((specifier) => {
if (specifier.type === 'ImportSpecifier') {
importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
} else if (supportedImportTypes.has(specifier.type)) {
@@ -523,10 +523,10 @@ ExportMap.parse = function (path, content, context) {
}
function captureDependency({ source }, isOnlyImportingTypes, importedSpecifiers = new Set()) {
- if (source == null) return null;
+ if (source == null) { return null; }
const p = remotePath(source.value);
- if (p == null) return null;
+ if (p == null) { return null; }
const declarationMetadata = {
// capturing actual node reference holds full AST in memory!
@@ -550,9 +550,7 @@ ExportMap.parse = function (path, content, context) {
function readTsConfig(context) {
const tsConfigInfo = tsConfigLoader({
- cwd:
- (context.parserOptions && context.parserOptions.tsconfigRootDir) ||
- process.cwd(),
+ cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
getEnv: (key) => process.env[key],
});
try {
@@ -599,7 +597,7 @@ ExportMap.parse = function (path, content, context) {
if (n.type === 'ExportAllDeclaration') {
const getter = captureDependency(n, n.exportKind === 'type');
- if (getter) m.dependencies.add(getter);
+ if (getter) { m.dependencies.add(getter); }
if (n.exported) {
processSpecifier(n, n.exported, m);
}
@@ -610,7 +608,7 @@ ExportMap.parse = function (path, content, context) {
if (n.type === 'ImportDeclaration') {
captureDependencyWithSpecifiers(n);
- const ns = n.specifiers.find(s => s.type === 'ImportNamespaceSpecifier');
+ const ns = n.specifiers.find((s) => s.type === 'ImportNamespaceSpecifier');
if (ns) {
namespaces.set(ns.local.name, n.source.value);
}
@@ -623,24 +621,28 @@ ExportMap.parse = function (path, content, context) {
// capture declaration
if (n.declaration != null) {
switch (n.declaration.type) {
- case 'FunctionDeclaration':
- case 'ClassDeclaration':
- case 'TypeAlias': // flowtype with babel-eslint parser
- case 'InterfaceDeclaration':
- case 'DeclareFunction':
- case 'TSDeclareFunction':
- case 'TSEnumDeclaration':
- case 'TSTypeAliasDeclaration':
- case 'TSInterfaceDeclaration':
- case 'TSAbstractClassDeclaration':
- case 'TSModuleDeclaration':
- m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n));
- break;
- case 'VariableDeclaration':
- n.declaration.declarations.forEach((d) =>
- recursivePatternCapture(d.id,
- id => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n))));
- break;
+ case 'FunctionDeclaration':
+ case 'ClassDeclaration':
+ case 'TypeAlias': // flowtype with babel-eslint parser
+ case 'InterfaceDeclaration':
+ case 'DeclareFunction':
+ case 'TSDeclareFunction':
+ case 'TSEnumDeclaration':
+ case 'TSTypeAliasDeclaration':
+ case 'TSInterfaceDeclaration':
+ case 'TSAbstractClassDeclaration':
+ case 'TSModuleDeclaration':
+ m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n));
+ break;
+ case 'VariableDeclaration':
+ n.declaration.declarations.forEach((d) => {
+ recursivePatternCapture(
+ d.id,
+ (id) => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n)),
+ );
+ });
+ break;
+ default:
}
}
@@ -656,7 +658,7 @@ ExportMap.parse = function (path, content, context) {
if (includes(exports, n.type)) {
const exportedName = n.type === 'TSNamespaceExportDeclaration'
? (n.id || n.name).name
- : (n.expression && n.expression.name || (n.expression.id && n.expression.id.name) || null);
+ : n.expression && n.expression.name || n.expression.id && n.expression.id.name || null;
const declTypes = [
'VariableDeclaration',
'ClassDeclaration',
@@ -668,7 +670,7 @@ ExportMap.parse = function (path, content, context) {
'TSModuleDeclaration',
];
const exportedDecls = ast.body.filter(({ type, id, declarations }) => includes(declTypes, type) && (
- (id && id.name === exportedName) || (declarations && declarations.find((d) => d.id.name === exportedName))
+ id && id.name === exportedName || declarations && declarations.find((d) => d.id.name === exportedName)
));
if (exportedDecls.length === 0) {
// Export is not referencing any local declaration, must be re-exporting
@@ -689,18 +691,17 @@ ExportMap.parse = function (path, content, context) {
decl.body.body.forEach((moduleBlockNode) => {
// Export-assignment exports all members in the namespace,
// explicitly exported or not.
- const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration' ?
- moduleBlockNode.declaration :
- moduleBlockNode;
+ const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration'
+ ? moduleBlockNode.declaration
+ : moduleBlockNode;
if (!namespaceDecl) {
// TypeScript can check this for us; we needn't
} else if (namespaceDecl.type === 'VariableDeclaration') {
- namespaceDecl.declarations.forEach((d) =>
- recursivePatternCapture(d.id, (id) => m.namespace.set(
- id.name,
- captureDoc(source, docStyleParsers, decl, namespaceDecl, moduleBlockNode),
- )),
+ namespaceDecl.declarations.forEach((d) => recursivePatternCapture(d.id, (id) => m.namespace.set(
+ id.name,
+ captureDoc(source, docStyleParsers, decl, namespaceDecl, moduleBlockNode),
+ )),
);
} else {
m.namespace.set(
@@ -740,7 +741,6 @@ function thunkFor(p, context) {
return () => ExportMap.for(childContext(p, context));
}
-
/**
* Traverse a pattern/identifier node, calling 'callback'
* for each leaf identifier.
@@ -750,34 +750,35 @@ function thunkFor(p, context) {
*/
export function recursivePatternCapture(pattern, callback) {
switch (pattern.type) {
- case 'Identifier': // base case
- callback(pattern);
- break;
-
- case 'ObjectPattern':
- pattern.properties.forEach(p => {
- if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
- callback(p.argument);
- return;
- }
- recursivePatternCapture(p.value, callback);
- });
- break;
+ case 'Identifier': // base case
+ callback(pattern);
+ break;
- case 'ArrayPattern':
- pattern.elements.forEach((element) => {
- if (element == null) return;
- if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
- callback(element.argument);
- return;
- }
- recursivePatternCapture(element, callback);
- });
- break;
+ case 'ObjectPattern':
+ pattern.properties.forEach((p) => {
+ if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
+ callback(p.argument);
+ return;
+ }
+ recursivePatternCapture(p.value, callback);
+ });
+ break;
- case 'AssignmentPattern':
- callback(pattern.left);
- break;
+ case 'ArrayPattern':
+ pattern.elements.forEach((element) => {
+ if (element == null) { return; }
+ if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
+ callback(element.argument);
+ return;
+ }
+ recursivePatternCapture(element, callback);
+ });
+ break;
+
+ case 'AssignmentPattern':
+ callback(pattern.left);
+ break;
+ default:
}
}
@@ -811,7 +812,6 @@ function childContext(path, context) {
};
}
-
/**
* sometimes legacy support isn't _that_ hard... right?
*/
diff --git a/src/core/importType.js b/src/core/importType.js
index ebdb306bc9..6a37d1bb14 100644
--- a/src/core/importType.js
+++ b/src/core/importType.js
@@ -14,7 +14,7 @@ function baseModule(name) {
}
function isInternalRegexMatch(name, settings) {
- const internalScope = (settings && settings['import/internal-regex']);
+ const internalScope = settings && settings['import/internal-regex'];
return internalScope && new RegExp(internalScope).test(name);
}
@@ -24,21 +24,21 @@ export function isAbsolute(name) {
// path is defined only when a resolver resolves to a non-standard path
export function isBuiltIn(name, settings, path) {
- if (path || !name) return false;
+ if (path || !name) { return false; }
const base = baseModule(name);
- const extras = (settings && settings['import/core-modules']) || [];
+ const extras = settings && settings['import/core-modules'] || [];
return isCoreModule(base) || extras.indexOf(base) > -1;
}
export function isExternalModule(name, path, context) {
- if (arguments.length < 3) {
+ if (arguments.length < 3) {
throw new TypeError('isExternalModule: name, path, and context are all required');
}
return (isModule(name) || isScoped(name)) && typeTest(name, context, path) === 'external';
}
export function isExternalModuleMain(name, path, context) {
- if (arguments.length < 3) {
+ if (arguments.length < 3) {
throw new TypeError('isExternalModule: name, path, and context are all required');
}
return isModuleMain(name) && typeTest(name, context, path) === 'external';
@@ -65,7 +65,7 @@ export function isScopedMain(name) {
}
function isRelativeToParent(name) {
- return /^\.\.$|^\.\.[\\/]/.test(name);
+ return (/^\.\.$|^\.\.[\\/]/).test(name);
}
const indexFiles = ['.', './', './index', './index.js'];
@@ -74,7 +74,7 @@ function isIndex(name) {
}
function isRelativeToSibling(name) {
- return /^\.[\\/]/.test(name);
+ return (/^\.[\\/]/).test(name);
}
function isExternalPath(path, context) {
@@ -89,7 +89,7 @@ function isExternalPath(path, context) {
return true;
}
- const folders = (settings && settings['import/external-module-folders']) || ['node_modules'];
+ const folders = settings && settings['import/external-module-folders'] || ['node_modules'];
return folders.some((folder) => {
const folderPath = nodeResolve(packagePath, folder);
const relativePath = relative(folderPath, path);
@@ -109,7 +109,7 @@ function isExternalLookingName(name) {
return isModule(name) || isScoped(name);
}
-function typeTest(name, context, path ) {
+function typeTest(name, context, path) {
const { settings } = context;
if (isInternalRegexMatch(name, settings)) { return 'internal'; }
if (isAbsolute(name, settings, path)) { return 'absolute'; }
diff --git a/src/core/packagePath.js b/src/core/packagePath.js
index 2b5a2d41ef..1a7a28f4b4 100644
--- a/src/core/packagePath.js
+++ b/src/core/packagePath.js
@@ -2,7 +2,6 @@ import { dirname } from 'path';
import pkgUp from 'eslint-module-utils/pkgUp';
import readPkgUp from 'eslint-module-utils/readPkgUp';
-
export function getContextPackagePath(context) {
return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
}
diff --git a/src/core/staticRequire.js b/src/core/staticRequire.js
index 502d39317d..88b5000c89 100644
--- a/src/core/staticRequire.js
+++ b/src/core/staticRequire.js
@@ -1,10 +1,10 @@
// todo: merge with module visitor
export default function isStaticRequire(node) {
- return node &&
- node.callee &&
- node.callee.type === 'Identifier' &&
- node.callee.name === 'require' &&
- node.arguments.length === 1 &&
- node.arguments[0].type === 'Literal' &&
- typeof node.arguments[0].value === 'string';
+ return node
+ && node.callee
+ && node.callee.type === 'Identifier'
+ && node.callee.name === 'require'
+ && node.arguments.length === 1
+ && node.arguments[0].type === 'Literal'
+ && typeof node.arguments[0].value === 'string';
}
diff --git a/src/index.js b/src/index.js
index 15f98d96f2..feafba9003 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,12 +1,12 @@
export const rules = {
'no-unresolved': require('./rules/no-unresolved'),
- 'named': require('./rules/named'),
- 'default': require('./rules/default'),
- 'namespace': require('./rules/namespace'),
+ named: require('./rules/named'),
+ default: require('./rules/default'),
+ namespace: require('./rules/namespace'),
'no-namespace': require('./rules/no-namespace'),
- 'export': require('./rules/export'),
+ export: require('./rules/export'),
'no-mutable-exports': require('./rules/no-mutable-exports'),
- 'extensions': require('./rules/extensions'),
+ extensions: require('./rules/extensions'),
'no-restricted-paths': require('./rules/no-restricted-paths'),
'no-internal-modules': require('./rules/no-internal-modules'),
'group-exports': require('./rules/group-exports'),
@@ -25,19 +25,19 @@ export const rules = {
'no-commonjs': require('./rules/no-commonjs'),
'no-amd': require('./rules/no-amd'),
'no-duplicates': require('./rules/no-duplicates'),
- 'first': require('./rules/first'),
+ first: require('./rules/first'),
'max-dependencies': require('./rules/max-dependencies'),
'no-extraneous-dependencies': require('./rules/no-extraneous-dependencies'),
'no-absolute-path': require('./rules/no-absolute-path'),
'no-nodejs-modules': require('./rules/no-nodejs-modules'),
'no-webpack-loader-syntax': require('./rules/no-webpack-loader-syntax'),
- 'order': require('./rules/order'),
+ order: require('./rules/order'),
'newline-after-import': require('./rules/newline-after-import'),
'prefer-default-export': require('./rules/prefer-default-export'),
'no-default-export': require('./rules/no-default-export'),
'no-named-export': require('./rules/no-named-export'),
'no-dynamic-require': require('./rules/no-dynamic-require'),
- 'unambiguous': require('./rules/unambiguous'),
+ unambiguous: require('./rules/unambiguous'),
'no-unassigned-import': require('./rules/no-unassigned-import'),
'no-useless-path-segments': require('./rules/no-useless-path-segments'),
'dynamic-import-chunkname': require('./rules/dynamic-import-chunkname'),
@@ -55,17 +55,17 @@ export const rules = {
};
export const configs = {
- 'recommended': require('../config/recommended'),
+ recommended: require('../config/recommended'),
- 'errors': require('../config/errors'),
- 'warnings': require('../config/warnings'),
+ errors: require('../config/errors'),
+ warnings: require('../config/warnings'),
// shhhh... work in progress "secret" rules
'stage-0': require('../config/stage-0'),
// useful stuff for folks using various environments
- 'react': require('../config/react'),
+ react: require('../config/react'),
'react-native': require('../config/react-native'),
- 'electron': require('../config/electron'),
- 'typescript': require('../config/typescript'),
+ electron: require('../config/electron'),
+ typescript: require('../config/typescript'),
};
diff --git a/src/rules/consistent-type-specifier-style.js b/src/rules/consistent-type-specifier-style.js
index bb8fdf8498..9119976b19 100644
--- a/src/rules/consistent-type-specifier-style.js
+++ b/src/rules/consistent-type-specifier-style.js
@@ -26,7 +26,7 @@ function getImportText(
return '';
}
- const names = specifiers.map(s => {
+ const names = specifiers.map((s) => {
if (s.imported.name === s.local.name) {
return s.imported.name;
}
@@ -67,12 +67,14 @@ module.exports = {
if (
// no specifiers (import type {} from '') have no specifiers to mark as inline
- node.specifiers.length === 0 ||
- (node.specifiers.length === 1 &&
- // default imports are both "inline" and "top-level"
- (node.specifiers[0].type === 'ImportDefaultSpecifier' ||
- // namespace imports are both "inline" and "top-level"
- node.specifiers[0].type === 'ImportNamespaceSpecifier'))
+ node.specifiers.length === 0
+ || node.specifiers.length === 1
+ // default imports are both "inline" and "top-level"
+ && (
+ node.specifiers[0].type === 'ImportDefaultSpecifier'
+ // namespace imports are both "inline" and "top-level"
+ || node.specifiers[0].type === 'ImportNamespaceSpecifier'
+ )
) {
return;
}
@@ -101,15 +103,17 @@ module.exports = {
ImportDeclaration(node) {
if (
// already top-level is valid
- node.importKind === 'type' ||
- node.importKind === 'typeof' ||
+ node.importKind === 'type'
+ || node.importKind === 'typeof'
// no specifiers (import {} from '') cannot have inline - so is valid
- node.specifiers.length === 0 ||
- (node.specifiers.length === 1 &&
- // default imports are both "inline" and "top-level"
- (node.specifiers[0].type === 'ImportDefaultSpecifier' ||
- // namespace imports are both "inline" and "top-level"
- node.specifiers[0].type === 'ImportNamespaceSpecifier'))
+ || node.specifiers.length === 0
+ || node.specifiers.length === 1
+ // default imports are both "inline" and "top-level"
+ && (
+ node.specifiers[0].type === 'ImportDefaultSpecifier'
+ // namespace imports are both "inline" and "top-level"
+ || node.specifiers[0].type === 'ImportNamespaceSpecifier'
+ )
) {
return;
}
@@ -195,7 +199,7 @@ module.exports = {
const comma = sourceCode.getTokenAfter(defaultSpecifier, isComma);
const closingBrace = sourceCode.getTokenAfter(
node.specifiers[node.specifiers.length - 1],
- token => token.type === 'Punctuator' && token.value === '}',
+ (token) => token.type === 'Punctuator' && token.value === '}',
);
fixes.push(fixer.removeRange([
comma.range[0],
diff --git a/src/rules/default.js b/src/rules/default.js
index 6ca918ef66..f6b786020d 100644
--- a/src/rules/default.js
+++ b/src/rules/default.js
@@ -17,12 +17,12 @@ module.exports = {
function checkDefault(specifierType, node) {
const defaultSpecifier = node.specifiers.find(
- specifier => specifier.type === specifierType,
+ (specifier) => specifier.type === specifierType,
);
- if (!defaultSpecifier) return;
+ if (!defaultSpecifier) { return; }
const imports = Exports.get(node.source.value, context);
- if (imports == null) return;
+ if (imports == null) { return; }
if (imports.errors.length) {
imports.reportErrors(context, node);
@@ -35,8 +35,8 @@ module.exports = {
}
return {
- 'ImportDeclaration': checkDefault.bind(null, 'ImportDefaultSpecifier'),
- 'ExportNamedDeclaration': checkDefault.bind(null, 'ExportDefaultSpecifier'),
+ ImportDeclaration: checkDefault.bind(null, 'ImportDefaultSpecifier'),
+ ExportNamedDeclaration: checkDefault.bind(null, 'ExportDefaultSpecifier'),
};
},
};
diff --git a/src/rules/dynamic-import-chunkname.js b/src/rules/dynamic-import-chunkname.js
index 87a8523dad..96ceff2e16 100644
--- a/src/rules/dynamic-import-chunkname.js
+++ b/src/rules/dynamic-import-chunkname.js
@@ -72,8 +72,7 @@ module.exports = {
try {
// just like webpack itself does
vm.runInNewContext(`(function() {return {${comment.value}}})()`);
- }
- catch (error) {
+ } catch (error) {
context.report({
node,
message: `dynamic imports require a "webpack" comment with valid syntax`,
diff --git a/src/rules/export.js b/src/rules/export.js
index 92583bdd8f..c540f1e3c9 100644
--- a/src/rules/export.js
+++ b/src/rules/export.js
@@ -38,19 +38,20 @@ const tsTypePrefix = 'type:';
function isTypescriptFunctionOverloads(nodes) {
const nodesArr = Array.from(nodes);
- const idents = flatMap(nodesArr, (node) => (
- node.declaration && (
+ const idents = flatMap(
+ nodesArr,
+ (node) => node.declaration && (
node.declaration.type === 'TSDeclareFunction' // eslint 6+
|| node.declaration.type === 'TSEmptyBodyFunctionDeclaration' // eslint 4-5
)
? node.declaration.id.name
- : []
- ));
+ : [],
+ );
if (new Set(idents).size !== idents.length) {
return true;
}
- const types = new Set(nodesArr.map(node => node.parent.type));
+ const types = new Set(nodesArr.map((node) => node.parent.type));
if (!types.has('TSDeclareFunction')) {
return false;
}
@@ -73,17 +74,17 @@ function isTypescriptFunctionOverloads(nodes) {
* @returns {boolean}
*/
function isTypescriptNamespaceMerging(nodes) {
- const types = new Set(Array.from(nodes, node => node.parent.type));
+ const types = new Set(Array.from(nodes, (node) => node.parent.type));
const noNamespaceNodes = Array.from(nodes).filter((node) => node.parent.type !== 'TSModuleDeclaration');
return types.has('TSModuleDeclaration')
&& (
types.size === 1
// Merging with functions
- || (types.size === 2 && (types.has('FunctionDeclaration') || types.has('TSDeclareFunction')))
- || (types.size === 3 && types.has('FunctionDeclaration') && types.has('TSDeclareFunction'))
+ || types.size === 2 && (types.has('FunctionDeclaration') || types.has('TSDeclareFunction'))
+ || types.size === 3 && types.has('FunctionDeclaration') && types.has('TSDeclareFunction')
// Merging with classes or enums
- || (types.size === 2 && (types.has('ClassDeclaration') || types.has('TSEnumDeclaration')) && noNamespaceNodes.length === 1)
+ || types.size === 2 && (types.has('ClassDeclaration') || types.has('TSEnumDeclaration')) && noNamespaceNodes.length === 1
);
}
@@ -99,7 +100,7 @@ function isTypescriptNamespaceMerging(nodes) {
* @returns {boolean}
*/
function shouldSkipTypescriptNamespace(node, nodes) {
- const types = new Set(Array.from(nodes, node => node.parent.type));
+ const types = new Set(Array.from(nodes, (node) => node.parent.type));
return !isTypescriptNamespaceMerging(nodes)
&& node.parent.type === 'TSModuleDeclaration'
@@ -166,7 +167,7 @@ module.exports = {
},
ExportNamedDeclaration(node) {
- if (node.declaration == null) return;
+ if (node.declaration == null) { return; }
const parent = getParent(node);
// support for old TypeScript versions
@@ -185,20 +186,19 @@ module.exports = {
if (node.declaration.declarations != null) {
for (const declaration of node.declaration.declarations) {
- recursivePatternCapture(declaration.id, v =>
- addNamed(v.name, v, parent, isTypeVariableDecl));
+ recursivePatternCapture(declaration.id, (v) => { addNamed(v.name, v, parent, isTypeVariableDecl); });
}
}
},
ExportAllDeclaration(node) {
- if (node.source == null) return; // not sure if this is ever true
+ if (node.source == null) { return; } // not sure if this is ever true
// `export * as X from 'path'` does not conflict
- if (node.exported && node.exported.name) return;
+ if (node.exported && node.exported.name) { return; }
const remoteExports = ExportMap.get(node.source.value, context);
- if (remoteExports == null) return;
+ if (remoteExports == null) { return; }
if (remoteExports.errors.length) {
remoteExports.reportErrors(context, node);
@@ -223,15 +223,15 @@ module.exports = {
}
},
- 'Program:exit': function () {
+ 'Program:exit'() {
for (const [, named] of namespace) {
for (const [name, nodes] of named) {
- if (nodes.size <= 1) continue;
+ if (nodes.size <= 1) { continue; }
- if (isTypescriptFunctionOverloads(nodes) || isTypescriptNamespaceMerging(nodes)) continue;
+ if (isTypescriptFunctionOverloads(nodes) || isTypescriptNamespaceMerging(nodes)) { continue; }
for (const node of nodes) {
- if (shouldSkipTypescriptNamespace(node, nodes)) continue;
+ if (shouldSkipTypescriptNamespace(node, nodes)) { continue; }
if (name === 'default') {
context.report(node, 'Multiple default exports.');
diff --git a/src/rules/exports-last.js b/src/rules/exports-last.js
index ed77758d20..c4ed97e22f 100644
--- a/src/rules/exports-last.js
+++ b/src/rules/exports-last.js
@@ -1,9 +1,9 @@
import docsUrl from '../docsUrl';
function isNonExportStatement({ type }) {
- return type !== 'ExportDefaultDeclaration' &&
- type !== 'ExportNamedDeclaration' &&
- type !== 'ExportAllDeclaration';
+ return type !== 'ExportDefaultDeclaration'
+ && type !== 'ExportNamedDeclaration'
+ && type !== 'ExportAllDeclaration';
}
module.exports = {
diff --git a/src/rules/extensions.js b/src/rules/extensions.js
index 7d026c787f..50debc6c8c 100644
--- a/src/rules/extensions.js
+++ b/src/rules/extensions.js
@@ -13,8 +13,8 @@ const patternProperties = {
const properties = {
type: 'object',
properties: {
- 'pattern': patternProperties,
- 'ignorePackages': { type: 'boolean' },
+ pattern: patternProperties,
+ ignorePackages: { type: 'boolean' },
},
};
@@ -26,7 +26,7 @@ function buildProperties(context) {
ignorePackages: false,
};
- context.options.forEach(obj => {
+ context.options.forEach((obj) => {
// If this is a string, set defaultConfig to its value
if (typeof obj === 'string') {
@@ -132,25 +132,25 @@ module.exports = {
function isExternalRootModule(file) {
const slashCount = file.split('/').length - 1;
- if (slashCount === 0) return true;
- if (isScoped(file) && slashCount <= 1) return true;
+ if (slashCount === 0) { return true; }
+ if (isScoped(file) && slashCount <= 1) { return true; }
return false;
}
function checkFileExtension(source, node) {
// bail if the declaration doesn't have a source, e.g. "export { foo };", or if it's only partially typed like in an editor
- if (!source || !source.value) return;
+ if (!source || !source.value) { return; }
const importPathWithQueryString = source.value;
// don't enforce anything on builtins
- if (isBuiltIn(importPathWithQueryString, context.settings)) return;
+ if (isBuiltIn(importPathWithQueryString, context.settings)) { return; }
const importPath = importPathWithQueryString.replace(/\?(.*)$/, '');
// don't enforce in root external packages as they may have names with `.js`.
// Like `import Decimal from decimal.js`)
- if (isExternalRootModule(importPath)) return;
+ if (isExternalRootModule(importPath)) { return; }
const resolvedPath = resolve(importPath, context);
@@ -167,7 +167,7 @@ module.exports = {
if (!extension || !importPath.endsWith(`.${extension}`)) {
// ignore type-only imports and exports
- if (node.importKind === 'type' || node.exportKind === 'type') return;
+ if (node.importKind === 'type' || node.exportKind === 'type') { return; }
const extensionRequired = isUseOfExtensionRequired(extension, isPackage);
const extensionForbidden = isUseOfExtensionForbidden(extension);
if (extensionRequired && !extensionForbidden) {
diff --git a/src/rules/first.js b/src/rules/first.js
index ebead6cf27..f8cc273a31 100644
--- a/src/rules/first.js
+++ b/src/rules/first.js
@@ -25,13 +25,13 @@ module.exports = {
create(context) {
function isPossibleDirective(node) {
- return node.type === 'ExpressionStatement' &&
- node.expression.type === 'Literal' &&
- typeof node.expression.value === 'string';
+ return node.type === 'ExpressionStatement'
+ && node.expression.type === 'Literal'
+ && typeof node.expression.value === 'string';
}
return {
- 'Program': function (n) {
+ Program(n) {
const body = n.body;
if (!body) {
return;
@@ -56,7 +56,7 @@ module.exports = {
if (node.type === 'ImportDeclaration' || node.type === 'TSImportEqualsDeclaration') {
if (absoluteFirst) {
- if (/^\./.test(getImportValue(node))) {
+ if ((/^\./).test(getImportValue(node))) {
anyRelative = true;
} else if (anyRelative) {
context.report({
@@ -67,7 +67,7 @@ module.exports = {
}
if (nonImportCount > 0) {
for (const variable of context.getDeclaredVariables(node)) {
- if (!shouldSort) break;
+ if (!shouldSort) { break; }
const references = variable.references;
if (references.length) {
for (const reference of references) {
@@ -90,7 +90,7 @@ module.exports = {
nonImportCount++;
}
});
- if (!errorInfos.length) return;
+ if (!errorInfos.length) { return; }
errorInfos.forEach(function (errorInfo, index) {
const node = errorInfo.node;
const infos = {
@@ -112,26 +112,27 @@ module.exports = {
const nodeSourceCode = String.prototype.slice.apply(
originSourceCode, _errorInfo.range,
);
- if (/\S/.test(nodeSourceCode[0])) {
- return '\n' + nodeSourceCode;
+ if ((/\S/).test(nodeSourceCode[0])) {
+ return `\n${nodeSourceCode}`;
}
return nodeSourceCode;
}).join('');
let insertFixer = null;
let replaceSourceCode = '';
if (!lastLegalImp) {
- insertSourceCode =
- insertSourceCode.trim() + insertSourceCode.match(/^(\s+)/)[0];
+ insertSourceCode = insertSourceCode.trim() + insertSourceCode.match(/^(\s+)/)[0];
}
- insertFixer = lastLegalImp ?
- fixer.insertTextAfter(lastLegalImp, insertSourceCode) :
- fixer.insertTextBefore(body[0], insertSourceCode);
+ insertFixer = lastLegalImp
+ ? fixer.insertTextAfter(lastLegalImp, insertSourceCode)
+ : fixer.insertTextBefore(body[0], insertSourceCode);
+
const fixers = [insertFixer].concat(removeFixers);
- fixers.forEach(function (computedFixer, i) {
- replaceSourceCode += (originSourceCode.slice(
+ fixers.forEach((computedFixer, i) => {
+ replaceSourceCode += originSourceCode.slice(
fixers[i - 1] ? fixers[i - 1].range[1] : 0, computedFixer.range[0],
- ) + computedFixer.text);
+ ) + computedFixer.text;
});
+
return fixer.replaceTextRange(range, replaceSourceCode);
};
}
diff --git a/src/rules/group-exports.js b/src/rules/group-exports.js
index 63af9d9141..7978130d34 100644
--- a/src/rules/group-exports.js
+++ b/src/rules/group-exports.js
@@ -98,7 +98,7 @@ function create(context) {
'Program:exit': function onExit() {
// Report multiple `export` declarations (ES2015 modules)
if (nodes.modules.set.size > 1) {
- nodes.modules.set.forEach(node => {
+ nodes.modules.set.forEach((node) => {
context.report({
node,
message: errors[node.type],
@@ -108,7 +108,7 @@ function create(context) {
// Report multiple `aggregated exports` from the same module (ES2015 modules)
flat(values(nodes.modules.sources)
- .filter(nodesWithSource => Array.isArray(nodesWithSource) && nodesWithSource.length > 1))
+ .filter((nodesWithSource) => Array.isArray(nodesWithSource) && nodesWithSource.length > 1))
.forEach((node) => {
context.report({
node,
@@ -118,7 +118,7 @@ function create(context) {
// Report multiple `export type` declarations (FLOW ES2015 modules)
if (nodes.types.set.size > 1) {
- nodes.types.set.forEach(node => {
+ nodes.types.set.forEach((node) => {
context.report({
node,
message: errors[node.type],
@@ -128,7 +128,7 @@ function create(context) {
// Report multiple `aggregated type exports` from the same module (FLOW ES2015 modules)
flat(values(nodes.types.sources)
- .filter(nodesWithSource => Array.isArray(nodesWithSource) && nodesWithSource.length > 1))
+ .filter((nodesWithSource) => Array.isArray(nodesWithSource) && nodesWithSource.length > 1))
.forEach((node) => {
context.report({
node,
@@ -138,7 +138,7 @@ function create(context) {
// Report multiple `module.exports` assignments (CommonJS)
if (nodes.commonjs.set.size > 1) {
- nodes.commonjs.set.forEach(node => {
+ nodes.commonjs.set.forEach((node) => {
context.report({
node,
message: errors[node.type],
diff --git a/src/rules/imports-first.js b/src/rules/imports-first.js
index 07bb4633de..966367e99f 100644
--- a/src/rules/imports-first.js
+++ b/src/rules/imports-first.js
@@ -2,13 +2,14 @@ import docsUrl from '../docsUrl';
const first = require('./first');
-const newMeta = Object.assign({}, first.meta, {
+const newMeta = {
+ ...first.meta,
deprecated: true,
docs: {
category: 'Style guide',
description: 'Replaced by `import/first`.',
url: docsUrl('imports-first', '7b25c1cb95ee18acc1531002fd343e1e6031f9ed'),
},
-});
+};
-module.exports = Object.assign({}, first, { meta: newMeta });
+module.exports = { ...first, meta: newMeta };
diff --git a/src/rules/max-dependencies.js b/src/rules/max-dependencies.js
index 95f34176f5..488e906182 100644
--- a/src/rules/max-dependencies.js
+++ b/src/rules/max-dependencies.js
@@ -24,17 +24,17 @@ module.exports = {
schema: [
{
- 'type': 'object',
- 'properties': {
- 'max': { 'type': 'number' },
- 'ignoreTypeImports': { 'type': 'boolean' },
+ type: 'object',
+ properties: {
+ max: { type: 'number' },
+ ignoreTypeImports: { type: 'boolean' },
},
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
- create: context => {
+ create(context) {
const {
ignoreTypeImports = DEFAULT_IGNORE_TYPE_IMPORTS,
} = context.options[0] || {};
@@ -42,15 +42,19 @@ module.exports = {
const dependencies = new Set(); // keep track of dependencies
let lastNode; // keep track of the last node to report on
- return Object.assign({
- 'Program:exit': function () {
+ return {
+ 'Program:exit'() {
countDependencies(dependencies, lastNode, context);
},
- }, moduleVisitor((source, { importKind }) => {
- if (importKind !== TYPE_IMPORT || !ignoreTypeImports) {
- dependencies.add(source.value);
- }
- lastNode = source;
- }, { commonjs: true }));
+ ...moduleVisitor(
+ (source, { importKind }) => {
+ if (importKind !== TYPE_IMPORT || !ignoreTypeImports) {
+ dependencies.add(source.value);
+ }
+ lastNode = source;
+ },
+ { commonjs: true },
+ ),
+ };
},
};
diff --git a/src/rules/named.js b/src/rules/named.js
index 050f835056..e7fe4e4dce 100644
--- a/src/rules/named.js
+++ b/src/rules/named.js
@@ -67,12 +67,12 @@ module.exports = {
if (!deepLookup.found) {
if (deepLookup.path.length > 1) {
const deepPath = deepLookup.path
- .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))
.join(' -> ');
context.report(im[key], `${name} not found via ${deepPath}`);
} else {
- context.report(im[key], name + ' not found in \'' + node.source.value + '\'');
+ context.report(im[key], `${name} not found in '${node.source.value}'`);
}
}
});
@@ -121,12 +121,12 @@ 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.getFilename()), i.path))
.join(' -> ');
context.report(im.key, `${im.key.name} not found via ${deepPath}`);
} else {
- context.report(im.key, im.key.name + ' not found in \'' + source.value + '\'');
+ context.report(im.key, `${im.key.name} not found in '${source.value}'`);
}
}
});
diff --git a/src/rules/namespace.js b/src/rules/namespace.js
index 3b6019da8d..77a3ea9077 100644
--- a/src/rules/namespace.js
+++ b/src/rules/namespace.js
@@ -4,12 +4,12 @@ import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
function processBodyStatement(context, namespaces, declaration) {
- if (declaration.type !== 'ImportDeclaration') return;
+ if (declaration.type !== 'ImportDeclaration') { return; }
- if (declaration.specifiers.length === 0) return;
+ if (declaration.specifiers.length === 0) { return; }
const imports = Exports.get(declaration.source.value, context);
- if (imports == null) return null;
+ if (imports == null) { return null; }
if (imports.errors.length > 0) {
imports.reportErrors(context, declaration);
@@ -18,25 +18,26 @@ function processBodyStatement(context, namespaces, declaration) {
declaration.specifiers.forEach((specifier) => {
switch (specifier.type) {
- case 'ImportNamespaceSpecifier':
- if (!imports.size) {
- context.report(
- specifier,
- `No exported names found in module '${declaration.source.value}'.`,
+ case 'ImportNamespaceSpecifier':
+ if (!imports.size) {
+ context.report(
+ specifier,
+ `No exported names found in module '${declaration.source.value}'.`,
+ );
+ }
+ namespaces.set(specifier.local.name, imports);
+ break;
+ case 'ImportDefaultSpecifier':
+ case 'ImportSpecifier': {
+ const meta = imports.get(
+ // default to 'default' for default https://i.imgur.com/nj6qAWy.jpg
+ specifier.imported ? specifier.imported.name || specifier.imported.value : 'default',
);
+ if (!meta || !meta.namespace) { break; }
+ namespaces.set(specifier.local.name, meta.namespace);
+ break;
}
- namespaces.set(specifier.local.name, imports);
- break;
- case 'ImportDefaultSpecifier':
- case 'ImportSpecifier': {
- const meta = imports.get(
- // default to 'default' for default https://i.imgur.com/nj6qAWy.jpg
- specifier.imported ? (specifier.imported.name || specifier.imported.value) : 'default',
- );
- if (!meta || !meta.namespace) { break; }
- namespaces.set(specifier.local.name, meta.namespace);
- break;
- }
+ default:
}
});
}
@@ -66,7 +67,6 @@ module.exports = {
},
create: function namespaceRule(context) {
-
// read options
const {
allowComputed = false,
@@ -81,7 +81,7 @@ module.exports = {
return {
// pick up all imports at body entry time, to properly respect hoisting
Program({ body }) {
- body.forEach(x => processBodyStatement(context, namespaces, x));
+ body.forEach((x) => { processBodyStatement(context, namespaces, x); });
},
// same as above, but does not add names to local map
@@ -89,7 +89,7 @@ module.exports = {
const declaration = importDeclaration(context);
const imports = Exports.get(declaration.source.value, context);
- if (imports == null) return null;
+ if (imports == null) { return null; }
if (imports.errors.length) {
imports.reportErrors(context, declaration);
@@ -107,9 +107,9 @@ module.exports = {
// todo: check for possible redefinition
MemberExpression(dereference) {
- if (dereference.object.type !== 'Identifier') return;
- if (!namespaces.has(dereference.object.name)) return;
- if (declaredScope(context, dereference.object.name) !== 'module') return;
+ if (dereference.object.type !== 'Identifier') { return; }
+ if (!namespaces.has(dereference.object.name)) { return; }
+ if (declaredScope(context, dereference.object.name) !== 'module') { return; }
if (dereference.parent.type === 'AssignmentExpression' && dereference.parent.left === dereference) {
context.report(
@@ -142,7 +142,7 @@ module.exports = {
}
const exported = namespace.get(dereference.property.name);
- if (exported == null) return;
+ if (exported == null) { return; }
// stash and pop
namepath.push(dereference.property.name);
@@ -152,18 +152,18 @@ module.exports = {
},
VariableDeclarator({ id, init }) {
- if (init == null) return;
- if (init.type !== 'Identifier') return;
- if (!namespaces.has(init.name)) return;
+ if (init == null) { return; }
+ if (init.type !== 'Identifier') { return; }
+ if (!namespaces.has(init.name)) { return; }
// check for redefinition in intermediate scopes
- if (declaredScope(context, init.name) !== 'module') return;
+ if (declaredScope(context, init.name) !== 'module') { return; }
// DFS traverse child namespaces
function testKey(pattern, namespace, path = [init.name]) {
- if (!(namespace instanceof Exports)) return;
+ if (!(namespace instanceof Exports)) { return; }
- if (pattern.type !== 'ObjectPattern') return;
+ if (pattern.type !== 'ObjectPattern') { return; }
for (const property of pattern.properties) {
if (
@@ -204,7 +204,7 @@ module.exports = {
},
JSXMemberExpression({ object, property }) {
- if (!namespaces.has(object.name)) return;
+ if (!namespaces.has(object.name)) { return; }
const namespace = namespaces.get(object.name);
if (!namespace.has(property.name)) {
context.report({
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index 36678bfc4e..c63bb21b24 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -63,22 +63,22 @@ module.exports = {
fixable: 'whitespace',
schema: [
{
- 'type': 'object',
- 'properties': {
- 'count': {
- 'type': 'integer',
- 'minimum': 1,
+ type: 'object',
+ properties: {
+ count: {
+ type: 'integer',
+ minimum: 1,
},
- 'considerComments': { 'type': 'boolean' },
+ considerComments: { type: 'boolean' },
},
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
create(context) {
let level = 0;
const requireCalls = [];
- const options = Object.assign({ count: 1, considerComments: false }, context.options[0]);
+ const options = { count: 1, considerComments: false, ...context.options[0] };
function checkForNewLine(node, nextNode, type) {
if (isExportDefaultClass(nextNode) || isExportNameClass(nextNode)) {
@@ -107,7 +107,7 @@ module.exports = {
column,
},
message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after ${type} statement not followed by another ${type}.`,
- fix: fixer => fixer.insertTextAfter(
+ fix: (fixer) => fixer.insertTextAfter(
node,
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference),
),
@@ -132,7 +132,7 @@ module.exports = {
column,
},
message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after import statement not followed by another import.`,
- fix: fixer => fixer.insertTextAfter(
+ fix: (fixer) => fixer.insertTextAfter(
node,
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference),
),
@@ -155,10 +155,9 @@ module.exports = {
let nextComment;
if (typeof parent.comments !== 'undefined' && options.considerComments) {
- nextComment = parent.comments.find(o => o.loc.start.line === endLine + 1);
+ nextComment = parent.comments.find((o) => o.loc.start.line === endLine + 1);
}
-
// skip "export import"s
if (node.type === 'TSImportEqualsDeclaration' && node.isExport) {
return;
@@ -179,12 +178,12 @@ module.exports = {
requireCalls.push(node);
}
},
- 'Program:exit': function () {
+ 'Program:exit'() {
log('exit processing for', context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
const scopeBody = getScopeBody(context.getScope());
log('got scope:', scopeBody);
- requireCalls.forEach(function (node, index) {
+ requireCalls.forEach((node, index) => {
const nodePosition = findNodeIndexInScopeBody(scopeBody, node);
log('node position in scope:', nodePosition);
@@ -196,8 +195,12 @@ module.exports = {
return;
}
- if (nextStatement &&
- (!nextRequireCall || !containsNodeOrEqual(nextStatement, nextRequireCall))) {
+ if (
+ nextStatement && (
+ !nextRequireCall
+ || !containsNodeOrEqual(nextStatement, nextRequireCall)
+ )
+ ) {
checkForNewLine(statementWithRequireCall, nextStatement, 'require');
}
diff --git a/src/rules/no-absolute-path.js b/src/rules/no-absolute-path.js
index 19dae6b6fb..a5498ec765 100644
--- a/src/rules/no-absolute-path.js
+++ b/src/rules/no-absolute-path.js
@@ -21,12 +21,12 @@ module.exports = {
context.report({
node: source,
message: 'Do not import modules using an absolute path',
- fix: fixer => {
+ fix(fixer) {
const resolvedContext = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
// node.js and web imports work with posix style paths ("/")
let relativePath = path.posix.relative(path.dirname(resolvedContext), source.value);
if (!relativePath.startsWith('.')) {
- relativePath = './' + relativePath;
+ relativePath = `./${relativePath}`;
}
return fixer.replaceText(source, JSON.stringify(relativePath));
},
@@ -34,7 +34,7 @@ module.exports = {
}
}
- const options = Object.assign({ esmodule: true, commonjs: true }, context.options[0]);
+ const options = { esmodule: true, commonjs: true, ...context.options[0] };
return moduleVisitor(reportIfAbsolute, options);
},
};
diff --git a/src/rules/no-amd.js b/src/rules/no-amd.js
index 90359cd5fd..5edfe3e698 100644
--- a/src/rules/no-amd.js
+++ b/src/rules/no-amd.js
@@ -22,18 +22,17 @@ module.exports = {
create(context) {
return {
- 'CallExpression': function (node) {
- if (context.getScope().type !== 'module') return;
+ CallExpression(node) {
+ if (context.getScope().type !== 'module') { return; }
- if (node.callee.type !== 'Identifier') return;
- if (node.callee.name !== 'require' &&
- node.callee.name !== 'define') return;
+ if (node.callee.type !== 'Identifier') { return; }
+ if (node.callee.name !== 'require' && node.callee.name !== 'define') { return; }
// todo: capture define((require, module, exports) => {}) form?
- if (node.arguments.length !== 2) return;
+ if (node.arguments.length !== 2) { return; }
const modules = node.arguments[0];
- if (modules.type !== 'ArrayExpression') return;
+ if (modules.type !== 'ArrayExpression') { return; }
// todo: check second arg type? (identifier or callback)
diff --git a/src/rules/no-anonymous-default-export.js b/src/rules/no-anonymous-default-export.js
index d9edcc2b36..80950d550e 100644
--- a/src/rules/no-anonymous-default-export.js
+++ b/src/rules/no-anonymous-default-export.js
@@ -88,16 +88,16 @@ module.exports = {
{
type: 'object',
properties: schemaProperties,
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
create(context) {
- const options = Object.assign({}, defaults, context.options[0]);
+ const options = { ...defaults, ...context.options[0] };
return {
- 'ExportDefaultDeclaration': (node) => {
+ ExportDefaultDeclaration(node) {
const def = defs[node.declaration.type];
// Recognized node type and allowed by configuration,
diff --git a/src/rules/no-commonjs.js b/src/rules/no-commonjs.js
index 7a35fc8a08..dde509222b 100644
--- a/src/rules/no-commonjs.js
+++ b/src/rules/no-commonjs.js
@@ -16,9 +16,9 @@ function normalizeLegacyOptions(options) {
}
function allowPrimitive(node, options) {
- if (!options.allowPrimitiveModules) return false;
- if (node.parent.type !== 'AssignmentExpression') return false;
- return (node.parent.right.type !== 'ObjectExpression');
+ if (!options.allowPrimitiveModules) { return false; }
+ if (node.parent.type !== 'AssignmentExpression') { return false; }
+ return node.parent.right.type !== 'ObjectExpression';
}
function allowRequire(node, options) {
@@ -40,14 +40,16 @@ function isConditional(node) {
|| node.type === 'TryStatement'
|| node.type === 'LogicalExpression'
|| node.type === 'ConditionalExpression'
- ) return true;
- if (node.parent) return isConditional(node.parent);
+ ) {
+ return true;
+ }
+ if (node.parent) { return isConditional(node.parent); }
return false;
}
function isLiteralString(node) {
- return (node.type === 'Literal' && typeof node.value === 'string') ||
- (node.type === 'TemplateLiteral' && node.expressions.length === 0);
+ return node.type === 'Literal' && typeof node.value === 'string'
+ || node.type === 'TemplateLiteral' && node.expressions.length === 0;
}
//------------------------------------------------------------------------------
@@ -58,9 +60,9 @@ const schemaString = { enum: ['allow-primitive-modules'] };
const schemaObject = {
type: 'object',
properties: {
- allowPrimitiveModules: { 'type': 'boolean' },
- allowRequire: { 'type': 'boolean' },
- allowConditionalRequire: { 'type': 'boolean' },
+ allowPrimitiveModules: { type: 'boolean' },
+ allowRequire: { type: 'boolean' },
+ allowConditionalRequire: { type: 'boolean' },
},
additionalProperties: false,
};
@@ -95,11 +97,11 @@ module.exports = {
return {
- 'MemberExpression': function (node) {
+ MemberExpression(node) {
// module.exports
if (node.object.name === 'module' && node.property.name === 'exports') {
- if (allowPrimitive(node, options)) return;
+ if (allowPrimitive(node, options)) { return; }
context.report({ node, message: EXPORT_MESSAGE });
}
@@ -107,25 +109,25 @@ module.exports = {
if (node.object.name === 'exports') {
const isInScope = context.getScope()
.variables
- .some(variable => variable.name === 'exports');
- if (! isInScope) {
+ .some((variable) => variable.name === 'exports');
+ if (!isInScope) {
context.report({ node, message: EXPORT_MESSAGE });
}
}
},
- 'CallExpression': function (call) {
- if (!validateScope(context.getScope())) return;
+ CallExpression(call) {
+ if (!validateScope(context.getScope())) { return; }
- if (call.callee.type !== 'Identifier') return;
- if (call.callee.name !== 'require') return;
+ if (call.callee.type !== 'Identifier') { return; }
+ if (call.callee.name !== 'require') { return; }
- if (call.arguments.length !== 1) return;
- if (!isLiteralString(call.arguments[0])) return;
+ if (call.arguments.length !== 1) { return; }
+ if (!isLiteralString(call.arguments[0])) { return; }
- if (allowRequire(call, options)) return;
+ if (allowRequire(call, options)) { return; }
- if (allowConditionalRequire(call, options) && isConditional(call.parent)) return;
+ if (allowConditionalRequire(call, options) && isConditional(call.parent)) { return; }
// keeping it simple: all 1-string-arg `require` calls are reported
context.report({
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index e12a81cea6..5b9d8c0709 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -48,7 +48,7 @@ module.exports = {
create(context) {
const myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- if (myPath === '<text>') return {}; // can't cycle-check a non-file
+ if (myPath === '<text>') { return {}; } // can't cycle-check a non-file
const options = context.options[0] || {};
const maxDepth = typeof options.maxDepth === 'number' ? options.maxDepth : Infinity;
@@ -62,20 +62,23 @@ module.exports = {
if (ignoreModule(sourceNode.value)) {
return; // ignore external modules
}
- if (options.allowUnsafeDynamicCyclicDependency && (
- // Ignore `import()`
- importer.type === 'ImportExpression' ||
- // `require()` calls are always checked (if possible)
- (importer.type === 'CallExpression' && importer.callee.name !== 'require'))) {
+ if (
+ options.allowUnsafeDynamicCyclicDependency && (
+ // Ignore `import()`
+ importer.type === 'ImportExpression'
+ // `require()` calls are always checked (if possible)
+ || importer.type === 'CallExpression' && importer.callee.name !== 'require'
+ )
+ ) {
return; // cycle via dynamic import allowed by config
}
if (
importer.type === 'ImportDeclaration' && (
// import type { Foo } (TS and Flow)
- importer.importKind === 'type' ||
+ importer.importKind === 'type'
// import { type Foo } (Flow)
- importer.specifiers.every(({ importKind }) => importKind === 'type')
+ || importer.specifiers.every(({ importKind }) => importKind === 'type')
)
) {
return; // ignore type imports
@@ -91,25 +94,24 @@ module.exports = {
return; // no-self-import territory
}
- const untraversed = [{ mget: () => imported, route:[] }];
+ const untraversed = [{ mget: () => imported, route: [] }];
function detectCycle({ mget, route }) {
const m = mget();
- if (m == null) return;
- if (traversed.has(m.path)) return;
+ if (m == null) { return; }
+ if (traversed.has(m.path)) { return; }
traversed.add(m.path);
for (const [path, { getter, declarations }] of m.imports) {
- if (traversed.has(path)) continue;
- const toTraverse = [...declarations].filter(({ source, isOnlyImportingTypes }) =>
- !ignoreModule(source.value) &&
+ if (traversed.has(path)) { continue; }
+ const toTraverse = [...declarations].filter(({ source, isOnlyImportingTypes }) => !ignoreModule(source.value)
// Ignore only type imports
- !isOnlyImportingTypes,
+ && !isOnlyImportingTypes,
);
/*
If cyclic dependency is allowed via dynamic import, skip checking if any module is imported dynamically
*/
- if (options.allowUnsafeDynamicCyclicDependency && toTraverse.some(d => d.dynamic)) return;
+ if (options.allowUnsafeDynamicCyclicDependency && toTraverse.some((d) => d.dynamic)) { return; }
/*
Only report as a cycle if there are any import declarations that are considered by
@@ -121,7 +123,7 @@ module.exports = {
b.ts:
import type { Bar } from './a'
*/
- if (path === myPath && toTraverse.length > 0) return true;
+ if (path === myPath && toTraverse.length > 0) { return true; }
if (route.length + 1 < maxDepth) {
for (const { source } of toTraverse) {
untraversed.push({ mget: getter, route: route.concat(source) });
@@ -133,9 +135,9 @@ module.exports = {
while (untraversed.length > 0) {
const next = untraversed.shift(); // bfs!
if (detectCycle(next)) {
- const message = (next.route.length > 0
+ const message = next.route.length > 0
? `Dependency cycle via ${routeString(next.route)}`
- : 'Dependency cycle detected.');
+ : 'Dependency cycle detected.';
context.report(importer, message);
return;
}
@@ -143,7 +145,7 @@ module.exports = {
}
return Object.assign(moduleVisitor(checkSourceValue, context.options[0]), {
- 'Program:exit': () => {
+ 'Program:exit'() {
traversed.clear();
},
});
@@ -151,5 +153,5 @@ module.exports = {
};
function routeString(route) {
- return route.map(s => `${s.value}:${s.loc.start.line}`).join('=>');
+ return route.map((s) => `${s.value}:${s.loc.start.line}`).join('=>');
}
diff --git a/src/rules/no-default-export.js b/src/rules/no-default-export.js
index 5fc8c40e4c..6e5a537485 100644
--- a/src/rules/no-default-export.js
+++ b/src/rules/no-default-export.js
@@ -27,7 +27,7 @@ module.exports = {
},
ExportNamedDeclaration(node) {
- node.specifiers.filter(specifier => (specifier.exported.name || specifier.exported.value) === 'default').forEach(specifier => {
+ node.specifiers.filter((specifier) => (specifier.exported.name || specifier.exported.value) === 'default').forEach((specifier) => {
const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
if (specifier.type === 'ExportDefaultSpecifier') {
context.report({ node, message: preferNamed, loc });
diff --git a/src/rules/no-deprecated.js b/src/rules/no-deprecated.js
index 7a35a8e673..06eeff8ea7 100644
--- a/src/rules/no-deprecated.js
+++ b/src/rules/no-deprecated.js
@@ -3,13 +3,13 @@ import Exports from '../ExportMap';
import docsUrl from '../docsUrl';
function message(deprecation) {
- return 'Deprecated' + (deprecation.description ? ': ' + deprecation.description : '.');
+ return `Deprecated${deprecation.description ? `: ${deprecation.description}` : '.'}`;
}
function getDeprecation(metadata) {
- if (!metadata || !metadata.doc) return;
+ if (!metadata || !metadata.doc) { return; }
- return metadata.doc.tags.find(t => t.title === 'deprecated');
+ return metadata.doc.tags.find((t) => t.title === 'deprecated');
}
module.exports = {
@@ -28,13 +28,13 @@ module.exports = {
const namespaces = new Map();
function checkSpecifiers(node) {
- if (node.type !== 'ImportDeclaration') return;
- if (node.source == null) return; // local export, ignore
+ if (node.type !== 'ImportDeclaration') { return; }
+ if (node.source == null) { return; } // local export, ignore
const imports = Exports.get(node.source.value, context);
- if (imports == null) return;
+ if (imports == null) { return; }
- const moduleDeprecation = imports.doc && imports.doc.tags.find(t => t.title === 'deprecated');
+ const moduleDeprecation = imports.doc && imports.doc.tags.find((t) => t.title === 'deprecated');
if (moduleDeprecation) {
context.report({ node, message: message(moduleDeprecation) });
}
@@ -48,35 +48,34 @@ module.exports = {
let imported; let local;
switch (im.type) {
+ case 'ImportNamespaceSpecifier': {
+ if (!imports.size) { return; }
+ namespaces.set(im.local.name, imports);
+ return;
+ }
- case 'ImportNamespaceSpecifier':{
- if (!imports.size) return;
- namespaces.set(im.local.name, imports);
- return;
- }
-
- case 'ImportDefaultSpecifier':
- imported = 'default';
- local = im.local.name;
- break;
+ case 'ImportDefaultSpecifier':
+ imported = 'default';
+ local = im.local.name;
+ break;
- case 'ImportSpecifier':
- imported = im.imported.name;
- local = im.local.name;
- break;
+ case 'ImportSpecifier':
+ imported = im.imported.name;
+ local = im.local.name;
+ break;
- default: return; // can't handle this one
+ default: return; // can't handle this one
}
// unknown thing can't be deprecated
const exported = imports.get(imported);
- if (exported == null) return;
+ if (exported == null) { return; }
// capture import of deep namespace
- if (exported.namespace) namespaces.set(local, exported.namespace);
+ if (exported.namespace) { namespaces.set(local, exported.namespace); }
const deprecation = getDeprecation(imports.get(imported));
- if (!deprecation) return;
+ if (!deprecation) { return; }
context.report({ node: im, message: message(deprecation) });
@@ -86,44 +85,42 @@ module.exports = {
}
return {
- 'Program': ({ body }) => body.forEach(checkSpecifiers),
+ Program: ({ body }) => body.forEach(checkSpecifiers),
- 'Identifier': function (node) {
+ Identifier(node) {
if (node.parent.type === 'MemberExpression' && node.parent.property === node) {
return; // handled by MemberExpression
}
// ignore specifier identifiers
- if (node.parent.type.slice(0, 6) === 'Import') return;
+ if (node.parent.type.slice(0, 6) === 'Import') { return; }
- if (!deprecated.has(node.name)) return;
+ if (!deprecated.has(node.name)) { return; }
- if (declaredScope(context, node.name) !== 'module') return;
+ if (declaredScope(context, node.name) !== 'module') { return; }
context.report({
node,
message: message(deprecated.get(node.name)),
});
},
- 'MemberExpression': function (dereference) {
- if (dereference.object.type !== 'Identifier') return;
- if (!namespaces.has(dereference.object.name)) return;
+ MemberExpression(dereference) {
+ if (dereference.object.type !== 'Identifier') { return; }
+ if (!namespaces.has(dereference.object.name)) { return; }
- if (declaredScope(context, dereference.object.name) !== 'module') return;
+ if (declaredScope(context, dereference.object.name) !== 'module') { return; }
// go deep
let namespace = namespaces.get(dereference.object.name);
const namepath = [dereference.object.name];
// while property is namespace and parent is member expression, keep validating
- while (namespace instanceof Exports &&
- dereference.type === 'MemberExpression') {
-
+ while (namespace instanceof Exports && dereference.type === 'MemberExpression') {
// ignore computed parts for now
- if (dereference.computed) return;
+ if (dereference.computed) { return; }
const metadata = namespace.get(dereference.property.name);
- if (!metadata) break;
+ if (!metadata) { break; }
const deprecation = getDeprecation(metadata);
if (deprecation) {
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 15515e6757..76bf187b2e 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -62,16 +62,16 @@ function getFix(first, rest, sourceCode, context) {
// Leave it to the user to handle comments. Also skip `import * as ns from
// './foo'` imports, since they cannot be merged into another import.
- const restWithoutComments = rest.filter(node => !(
- hasProblematicComments(node, sourceCode) ||
- hasNamespace(node)
+ const restWithoutComments = rest.filter((node) => !(
+ hasProblematicComments(node, sourceCode)
+ || hasNamespace(node)
));
const specifiers = restWithoutComments
- .map(node => {
+ .map((node) => {
const tokens = sourceCode.getTokens(node);
- const openBrace = tokens.find(token => isPunctuator(token, '{'));
- const closeBrace = tokens.find(token => isPunctuator(token, '}'));
+ const openBrace = tokens.find((token) => isPunctuator(token, '{'));
+ const closeBrace = tokens.find((token) => isPunctuator(token, '}'));
if (openBrace == null || closeBrace == null) {
return undefined;
@@ -85,10 +85,9 @@ function getFix(first, rest, sourceCode, context) {
})
.filter(Boolean);
- const unnecessaryImports = restWithoutComments.filter(node =>
- !hasSpecifiers(node) &&
- !hasNamespace(node) &&
- !specifiers.some(specifier => specifier.importNode === node),
+ const unnecessaryImports = restWithoutComments.filter((node) => !hasSpecifiers(node)
+ && !hasNamespace(node)
+ && !specifiers.some((specifier) => specifier.importNode === node),
);
const shouldAddDefault = getDefaultImportName(first) == null && defaultImportNames.size === 1;
@@ -99,16 +98,14 @@ function getFix(first, rest, sourceCode, context) {
return undefined;
}
- return fixer => {
+ return (fixer) => {
const tokens = sourceCode.getTokens(first);
- const openBrace = tokens.find(token => isPunctuator(token, '{'));
- const closeBrace = tokens.find(token => isPunctuator(token, '}'));
+ const openBrace = tokens.find((token) => isPunctuator(token, '{'));
+ const closeBrace = tokens.find((token) => isPunctuator(token, '}'));
const firstToken = sourceCode.getFirstToken(first);
const [defaultImportName] = defaultImportNames;
- const firstHasTrailingComma =
- closeBrace != null &&
- isPunctuator(sourceCode.getTokenBefore(closeBrace), ',');
+ const firstHasTrailingComma = closeBrace != null && isPunctuator(sourceCode.getTokenBefore(closeBrace), ',');
const firstIsEmpty = !hasSpecifiers(first);
const firstExistingIdentifiers = firstIsEmpty
? new Set()
@@ -214,21 +211,21 @@ function isPunctuator(node, value) {
// Get the name of the default import of `node`, if any.
function getDefaultImportName(node) {
const defaultSpecifier = node.specifiers
- .find(specifier => specifier.type === 'ImportDefaultSpecifier');
+ .find((specifier) => specifier.type === 'ImportDefaultSpecifier');
return defaultSpecifier != null ? defaultSpecifier.local.name : undefined;
}
// Checks whether `node` has a namespace import.
function hasNamespace(node) {
const specifiers = node.specifiers
- .filter(specifier => specifier.type === 'ImportNamespaceSpecifier');
+ .filter((specifier) => specifier.type === 'ImportNamespaceSpecifier');
return specifiers.length > 0;
}
// Checks whether `node` has any non-default specifiers.
function hasSpecifiers(node) {
const specifiers = node.specifiers
- .filter(specifier => specifier.type === 'ImportSpecifier');
+ .filter((specifier) => specifier.type === 'ImportSpecifier');
return specifiers.length > 0;
}
@@ -236,9 +233,9 @@ function hasSpecifiers(node) {
// duplicate imports, so skip imports with comments when autofixing.
function hasProblematicComments(node, sourceCode) {
return (
- hasCommentBefore(node, sourceCode) ||
- hasCommentAfter(node, sourceCode) ||
- hasCommentInsideNonSpecifiers(node, sourceCode)
+ hasCommentBefore(node, sourceCode)
+ || hasCommentAfter(node, sourceCode)
+ || hasCommentInsideNonSpecifiers(node, sourceCode)
);
}
@@ -246,29 +243,29 @@ function hasProblematicComments(node, sourceCode) {
// the same line as `node` (starts).
function hasCommentBefore(node, sourceCode) {
return sourceCode.getCommentsBefore(node)
- .some(comment => comment.loc.end.line >= node.loc.start.line - 1);
+ .some((comment) => comment.loc.end.line >= node.loc.start.line - 1);
}
// Checks whether `node` has a comment (that starts) on the same line as `node`
// (ends).
function hasCommentAfter(node, sourceCode) {
return sourceCode.getCommentsAfter(node)
- .some(comment => comment.loc.start.line === node.loc.end.line);
+ .some((comment) => comment.loc.start.line === node.loc.end.line);
}
// Checks whether `node` has any comments _inside,_ except inside the `{...}`
// part (if any).
function hasCommentInsideNonSpecifiers(node, sourceCode) {
const tokens = sourceCode.getTokens(node);
- const openBraceIndex = tokens.findIndex(token => isPunctuator(token, '{'));
- const closeBraceIndex = tokens.findIndex(token => isPunctuator(token, '}'));
+ const openBraceIndex = tokens.findIndex((token) => isPunctuator(token, '{'));
+ const closeBraceIndex = tokens.findIndex((token) => isPunctuator(token, '}'));
// Slice away the first token, since we're no looking for comments _before_
// `node` (only inside). If there's a `{...}` part, look for comments before
// the `{`, but not before the `}` (hence the `+1`s).
const someTokens = openBraceIndex >= 0 && closeBraceIndex >= 0
? tokens.slice(1, openBraceIndex + 1).concat(tokens.slice(closeBraceIndex + 1))
: tokens.slice(1);
- return someTokens.some(token => sourceCode.getCommentsBefore(token).length > 0);
+ return someTokens.some((token) => sourceCode.getCommentsBefore(token).length > 0);
}
module.exports = {
@@ -298,16 +295,16 @@ module.exports = {
create(context) {
// Prepare the resolver from options.
- const considerQueryStringOption = context.options[0] &&
- context.options[0]['considerQueryString'];
- const defaultResolver = sourcePath => resolve(sourcePath, context) || sourcePath;
- const resolver = considerQueryStringOption ? (sourcePath => {
+ const considerQueryStringOption = context.options[0]
+ && context.options[0].considerQueryString;
+ const defaultResolver = (sourcePath) => resolve(sourcePath, context) || sourcePath;
+ const resolver = considerQueryStringOption ? (sourcePath) => {
const parts = sourcePath.match(/^([^?]*)\?(.*)$/);
if (!parts) {
return defaultResolver(sourcePath);
}
- return defaultResolver(parts[1]) + '?' + parts[2];
- }) : defaultResolver;
+ return `${defaultResolver(parts[1])}?${parts[2]}`;
+ } : defaultResolver;
const moduleMaps = new Map();
@@ -344,7 +341,7 @@ module.exports = {
}
},
- 'Program:exit': function () {
+ 'Program:exit'() {
for (const map of moduleMaps.values()) {
checkImports(map.imported, context);
checkImports(map.nsImported, context);
diff --git a/src/rules/no-dynamic-require.js b/src/rules/no-dynamic-require.js
index f334adec67..f8b369a70f 100644
--- a/src/rules/no-dynamic-require.js
+++ b/src/rules/no-dynamic-require.js
@@ -1,22 +1,22 @@
import docsUrl from '../docsUrl';
function isRequire(node) {
- return node &&
- node.callee &&
- node.callee.type === 'Identifier' &&
- node.callee.name === 'require' &&
- node.arguments.length >= 1;
+ return node
+ && node.callee
+ && node.callee.type === 'Identifier'
+ && node.callee.name === 'require'
+ && node.arguments.length >= 1;
}
function isDynamicImport(node) {
- return node &&
- node.callee &&
- node.callee.type === 'Import';
+ return node
+ && node.callee
+ && node.callee.type === 'Import';
}
function isStaticValue(arg) {
- return arg.type === 'Literal' ||
- (arg.type === 'TemplateLiteral' && arg.expressions.length === 0);
+ return arg.type === 'Literal'
+ || arg.type === 'TemplateLiteral' && arg.expressions.length === 0;
}
const dynamicImportErrorMessage = 'Calls to import() should use string literals';
diff --git a/src/rules/no-empty-named-blocks.js b/src/rules/no-empty-named-blocks.js
index 25567b08f8..3ec1501b8f 100644
--- a/src/rules/no-empty-named-blocks.js
+++ b/src/rules/no-empty-named-blocks.js
@@ -8,7 +8,7 @@ function getEmptyBlockRange(tokens, index) {
const end = nextToken.range[1];
// Remove block tokens and the previous comma
- if (prevToken.value === ','|| prevToken.value === 'type' || prevToken.value === 'typeof') {
+ if (prevToken.value === ',' || prevToken.value === 'type' || prevToken.value === 'typeof') {
start = prevToken.range[0];
}
@@ -33,15 +33,13 @@ module.exports = {
return {
ImportDeclaration(node) {
- if (!node.specifiers.some(x => x.type === 'ImportSpecifier')) {
+ if (!node.specifiers.some((x) => x.type === 'ImportSpecifier')) {
importsWithoutNameds.push(node);
}
},
- 'Program:exit': function (program) {
- const importsTokens = importsWithoutNameds.map((node) => {
- return [node, program.tokens.filter(x => x.range[0] >= node.range[0] && x.range[1] <= node.range[1])];
- });
+ 'Program:exit'(program) {
+ const importsTokens = importsWithoutNameds.map((node) => [node, program.tokens.filter((x) => x.range[0] >= node.range[0] && x.range[1] <= node.range[1])]);
importsTokens.forEach(([node, tokens]) => {
tokens.forEach((token) => {
@@ -49,12 +47,11 @@ module.exports = {
const nextToken = program.tokens[idx + 1];
if (nextToken && token.value === '{' && nextToken.value === '}') {
- const hasOtherIdentifiers = tokens.some((token) => (
- token.type === 'Identifier'
+ const hasOtherIdentifiers = tokens.some((token) => token.type === 'Identifier'
&& token.value !== 'from'
&& token.value !== 'type'
- && token.value !== 'typeof'
- ));
+ && token.value !== 'typeof',
+ );
// If it has no other identifiers it's the only thing in the import, so we can either remove the import
// completely or transform it in a side-effects only import
@@ -76,8 +73,8 @@ module.exports = {
// Remove the empty block and the 'from' token, leaving the import only for its side
// effects, e.g. `import 'mod'`
const sourceCode = context.getSourceCode();
- const fromToken = program.tokens.find(t => t.value === 'from');
- const importToken = program.tokens.find(t => t.value === 'import');
+ const fromToken = program.tokens.find((t) => t.value === 'from');
+ const importToken = program.tokens.find((t) => t.value === 'import');
const hasSpaceAfterFrom = sourceCode.isSpaceBetween(fromToken, sourceCode.getTokenAfter(fromToken));
const hasSpaceAfterImport = sourceCode.isSpaceBetween(importToken, sourceCode.getTokenAfter(fromToken));
diff --git a/src/rules/no-extraneous-dependencies.js b/src/rules/no-extraneous-dependencies.js
index a149ca6599..0408e0866d 100644
--- a/src/rules/no-extraneous-dependencies.js
+++ b/src/rules/no-extraneous-dependencies.js
@@ -64,18 +64,18 @@ function getDependencies(context, packageDir) {
if (!Array.isArray(packageDir)) {
paths = [path.resolve(packageDir)];
} else {
- paths = packageDir.map(dir => path.resolve(dir));
+ paths = packageDir.map((dir) => path.resolve(dir));
}
}
if (paths.length > 0) {
// use rule config to find package.json
- paths.forEach(dir => {
+ paths.forEach((dir) => {
const packageJsonPath = path.join(dir, 'package.json');
const _packageContent = getPackageDepFields(packageJsonPath, true);
- Object.keys(packageContent).forEach(depsKey =>
- Object.assign(packageContent[depsKey], _packageContent[depsKey]),
- );
+ Object.keys(packageContent).forEach((depsKey) => {
+ Object.assign(packageContent[depsKey], _packageContent[depsKey]);
+ });
});
} else {
const packageJsonPath = pkgUp({
@@ -110,7 +110,7 @@ function getDependencies(context, packageDir) {
}
if (e.name === 'JSONError' || e instanceof SyntaxError) {
context.report({
- message: 'The package.json file could not be parsed: ' + e.message,
+ message: `The package.json file could not be parsed: ${e.message}`,
loc: { line: 0, column: 0 },
});
}
@@ -120,8 +120,7 @@ function getDependencies(context, packageDir) {
}
function missingErrorMessage(packageName) {
- return `'${packageName}' should be listed in the project's dependencies. ` +
- `Run 'npm i -S ${packageName}' to add it`;
+ return `'${packageName}' should be listed in the project's dependencies. Run 'npm i -S ${packageName}' to add it`;
}
function devDepErrorMessage(packageName) {
@@ -129,8 +128,7 @@ function devDepErrorMessage(packageName) {
}
function optDepErrorMessage(packageName) {
- return `'${packageName}' should be listed in the project's dependencies, ` +
- `not optionalDependencies.`;
+ return `'${packageName}' should be listed in the project's dependencies, not optionalDependencies.`;
}
function getModuleOriginalName(name) {
@@ -162,27 +160,24 @@ function checkDependencyDeclaration(deps, packageName, declarationStatus) {
}
});
- return packageHierarchy.reduce((result, ancestorName) => {
- return {
- isInDeps: result.isInDeps || deps.dependencies[ancestorName] !== undefined,
- isInDevDeps: result.isInDevDeps || deps.devDependencies[ancestorName] !== undefined,
- isInOptDeps: result.isInOptDeps || deps.optionalDependencies[ancestorName] !== undefined,
- isInPeerDeps: result.isInPeerDeps || deps.peerDependencies[ancestorName] !== undefined,
- isInBundledDeps:
+ return packageHierarchy.reduce((result, ancestorName) => ({
+ isInDeps: result.isInDeps || deps.dependencies[ancestorName] !== undefined,
+ isInDevDeps: result.isInDevDeps || deps.devDependencies[ancestorName] !== undefined,
+ isInOptDeps: result.isInOptDeps || deps.optionalDependencies[ancestorName] !== undefined,
+ isInPeerDeps: result.isInPeerDeps || deps.peerDependencies[ancestorName] !== undefined,
+ isInBundledDeps:
result.isInBundledDeps || deps.bundledDependencies.indexOf(ancestorName) !== -1,
- };
- }, newDeclarationStatus);
+ }), newDeclarationStatus);
}
function reportIfMissing(context, deps, depsOptions, node, name) {
// Do not report when importing types unless option is enabled
if (
- !depsOptions.verifyTypeImports &&
- (node.importKind === 'type' || node.importKind === 'typeof' ||
- (
- Array.isArray(node.specifiers) &&
- node.specifiers.length &&
- node.specifiers.every((specifier) => specifier.importKind === 'type' || specifier.importKind === 'typeof'))
+ !depsOptions.verifyTypeImports
+ && (
+ node.importKind === 'type'
+ || node.importKind === 'typeof'
+ || Array.isArray(node.specifiers) && node.specifiers.length && node.specifiers.every((specifier) => specifier.importKind === 'type' || specifier.importKind === 'typeof')
)
) {
return;
@@ -204,11 +199,11 @@ function reportIfMissing(context, deps, depsOptions, node, name) {
let declarationStatus = checkDependencyDeclaration(deps, importPackageName);
if (
- declarationStatus.isInDeps ||
- (depsOptions.allowDevDeps && declarationStatus.isInDevDeps) ||
- (depsOptions.allowPeerDeps && declarationStatus.isInPeerDeps) ||
- (depsOptions.allowOptDeps && declarationStatus.isInOptDeps) ||
- (depsOptions.allowBundledDeps && declarationStatus.isInBundledDeps)
+ declarationStatus.isInDeps
+ || depsOptions.allowDevDeps && declarationStatus.isInDevDeps
+ || depsOptions.allowPeerDeps && declarationStatus.isInPeerDeps
+ || depsOptions.allowOptDeps && declarationStatus.isInOptDeps
+ || depsOptions.allowBundledDeps && declarationStatus.isInBundledDeps
) {
return;
}
@@ -220,11 +215,11 @@ function reportIfMissing(context, deps, depsOptions, node, name) {
declarationStatus = checkDependencyDeclaration(deps, realPackageName, declarationStatus);
if (
- declarationStatus.isInDeps ||
- (depsOptions.allowDevDeps && declarationStatus.isInDevDeps) ||
- (depsOptions.allowPeerDeps && declarationStatus.isInPeerDeps) ||
- (depsOptions.allowOptDeps && declarationStatus.isInOptDeps) ||
- (depsOptions.allowBundledDeps && declarationStatus.isInBundledDeps)
+ declarationStatus.isInDeps
+ || depsOptions.allowDevDeps && declarationStatus.isInDevDeps
+ || depsOptions.allowPeerDeps && declarationStatus.isInPeerDeps
+ || depsOptions.allowOptDeps && declarationStatus.isInOptDeps
+ || depsOptions.allowBundledDeps && declarationStatus.isInBundledDeps
) {
return;
}
@@ -249,10 +244,9 @@ function testConfig(config, filename) {
return config;
}
// Array of globs.
- return config.some(c => (
- minimatch(filename, c) ||
- minimatch(filename, path.join(process.cwd(), c))
- ));
+ return config.some((c) => minimatch(filename, c)
+ || minimatch(filename, path.join(process.cwd(), c)),
+ );
}
module.exports = {
@@ -266,17 +260,17 @@ module.exports = {
schema: [
{
- 'type': 'object',
- 'properties': {
- 'devDependencies': { 'type': ['boolean', 'array'] },
- 'optionalDependencies': { 'type': ['boolean', 'array'] },
- 'peerDependencies': { 'type': ['boolean', 'array'] },
- 'bundledDependencies': { 'type': ['boolean', 'array'] },
- 'packageDir': { 'type': ['string', 'array'] },
- 'includeInternal': { 'type': ['boolean'] },
- 'includeTypes': { 'type': ['boolean'] },
+ type: 'object',
+ properties: {
+ devDependencies: { type: ['boolean', 'array'] },
+ optionalDependencies: { type: ['boolean', 'array'] },
+ peerDependencies: { type: ['boolean', 'array'] },
+ bundledDependencies: { type: ['boolean', 'array'] },
+ packageDir: { type: ['string', 'array'] },
+ includeInternal: { type: ['boolean'] },
+ includeTypes: { type: ['boolean'] },
},
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
@@ -300,7 +294,7 @@ module.exports = {
}, { commonjs: true });
},
- 'Program:exit': () => {
+ 'Program:exit'() {
depFieldCache.clear();
},
};
diff --git a/src/rules/no-import-module-exports.js b/src/rules/no-import-module-exports.js
index 5a91acd07d..bc4605c39d 100644
--- a/src/rules/no-import-module-exports.js
+++ b/src/rules/no-import-module-exports.js
@@ -16,12 +16,12 @@ function getEntryPoint(context) {
function findScope(context, identifier) {
const { scopeManager } = context.getSourceCode();
- return scopeManager && scopeManager.scopes.slice().reverse().find((scope) => scope.variables.some(variable => variable.identifiers.some((node) => node.name === identifier)));
+ return scopeManager && scopeManager.scopes.slice().reverse().find((scope) => scope.variables.some((variable) => variable.identifiers.some((node) => node.name === identifier)));
}
function findDefinition(objectScope, identifier) {
- const variable = objectScope.variables.find(variable => variable.name === identifier);
- return variable.defs.find(def => def.name.name === identifier);
+ const variable = objectScope.variables.find((variable) => variable.name === identifier);
+ return variable.defs.find((def) => def.name.name === identifier);
}
module.exports = {
@@ -35,11 +35,11 @@ module.exports = {
fixable: 'code',
schema: [
{
- 'type': 'object',
- 'properties': {
- 'exceptions': { 'type': 'array' },
+ type: 'object',
+ properties: {
+ exceptions: { type: 'array' },
},
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
@@ -58,14 +58,13 @@ module.exports = {
const variableDefinition = objectScope && findDefinition(objectScope, node.object.name);
const isImportBinding = variableDefinition && variableDefinition.type === 'ImportBinding';
const hasCJSExportReference = hasKeywords && (!objectScope || objectScope.type === 'module');
- const isException = !!options.exceptions && options.exceptions.some(glob => minimatch(fileName, glob));
+ const isException = !!options.exceptions && options.exceptions.some((glob) => minimatch(fileName, glob));
if (isIdentifier && hasCJSExportReference && !isEntryPoint && !isException && !isImportBinding) {
- importDeclarations.forEach(importDeclaration => {
+ importDeclarations.forEach((importDeclaration) => {
context.report({
node: importDeclaration,
- message: `Cannot use import declarations in modules that export using ` +
- `CommonJS (module.exports = 'foo' or exports.bar = 'hi')`,
+ message: `Cannot use import declarations in modules that export using CommonJS (module.exports = 'foo' or exports.bar = 'hi')`,
});
});
alreadyReported = true;
diff --git a/src/rules/no-internal-modules.js b/src/rules/no-internal-modules.js
index 2416c1ce3f..687193f5c5 100644
--- a/src/rules/no-internal-modules.js
+++ b/src/rules/no-internal-modules.js
@@ -48,8 +48,8 @@ module.exports = {
create: function noReachingInside(context) {
const options = context.options[0] || {};
- const allowRegexps = (options.allow || []).map(p => minimatch.makeRe(p));
- const forbidRegexps = (options.forbid || []).map(p => minimatch.makeRe(p));
+ const allowRegexps = (options.allow || []).map((p) => minimatch.makeRe(p));
+ const forbidRegexps = (options.forbid || []).map((p) => minimatch.makeRe(p));
// minimatch patterns are expected to use / path separators, like import
// statements, so normalize paths to use the same
@@ -73,29 +73,29 @@ module.exports = {
// test if reaching to this destination is allowed
function reachingAllowed(importPath) {
- return allowRegexps.some(re => re.test(importPath));
+ return allowRegexps.some((re) => re.test(importPath));
}
// test if reaching to this destination is forbidden
function reachingForbidden(importPath) {
- return forbidRegexps.some(re => re.test(importPath));
+ return forbidRegexps.some((re) => re.test(importPath));
}
function isAllowViolation(importPath) {
const steps = toSteps(importPath);
- const nonScopeSteps = steps.filter(step => step.indexOf('@') !== 0);
- if (nonScopeSteps.length <= 1) return false;
+ const nonScopeSteps = steps.filter((step) => step.indexOf('@') !== 0);
+ if (nonScopeSteps.length <= 1) { return false; }
// before trying to resolve, see if the raw import (with relative
// segments resolved) matches an allowed pattern
const justSteps = steps.join('/');
- if (reachingAllowed(justSteps) || reachingAllowed(`/${justSteps}`)) return false;
+ if (reachingAllowed(justSteps) || reachingAllowed(`/${justSteps}`)) { return false; }
// if the import statement doesn't match directly, try to match the
// resolved path if the import is resolvable
const resolved = resolve(importPath, context);
- if (!resolved || reachingAllowed(normalizeSep(resolved))) return false;
+ if (!resolved || reachingAllowed(normalizeSep(resolved))) { return false; }
// this import was not allowed by the allowed paths, and reaches
// so it is a violation
@@ -109,12 +109,12 @@ module.exports = {
// segments resolved) matches a forbidden pattern
const justSteps = steps.join('/');
- if (reachingForbidden(justSteps) || reachingForbidden(`/${justSteps}`)) return true;
+ if (reachingForbidden(justSteps) || reachingForbidden(`/${justSteps}`)) { return true; }
// if the import statement doesn't match directly, try to match the
// resolved path if the import is resolvable
const resolved = resolve(importPath, context);
- if (resolved && reachingForbidden(normalizeSep(resolved))) return true;
+ if (resolved && reachingForbidden(normalizeSep(resolved))) { return true; }
// this import was not forbidden by the forbidden paths so it is not a violation
return false;
@@ -125,8 +125,9 @@ module.exports = {
function checkImportForReaching(importPath, node) {
const potentialViolationTypes = ['parent', 'index', 'sibling', 'external', 'internal'];
- if (potentialViolationTypes.indexOf(importType(importPath, context)) !== -1 &&
- isReachViolation(importPath)
+ if (
+ potentialViolationTypes.indexOf(importType(importPath, context)) !== -1
+ && isReachViolation(importPath)
) {
context.report({
node,
@@ -135,8 +136,11 @@ module.exports = {
}
}
- return moduleVisitor((source) => {
- checkImportForReaching(source.value, source);
- }, { commonjs: true });
+ return moduleVisitor(
+ (source) => {
+ checkImportForReaching(source.value, source);
+ },
+ { commonjs: true },
+ );
},
};
diff --git a/src/rules/no-mutable-exports.js b/src/rules/no-mutable-exports.js
index 75a321b62a..433d64e167 100644
--- a/src/rules/no-mutable-exports.js
+++ b/src/rules/no-mutable-exports.js
@@ -52,8 +52,8 @@ module.exports = {
}
return {
- 'ExportDefaultDeclaration': handleExportDefault,
- 'ExportNamedDeclaration': handleExportNamed,
+ ExportDefaultDeclaration: handleExportDefault,
+ ExportNamedDeclaration: handleExportNamed,
};
},
};
diff --git a/src/rules/no-named-as-default-member.js b/src/rules/no-named-as-default-member.js
index 0fb0927249..e00a4cbc87 100644
--- a/src/rules/no-named-as-default-member.js
+++ b/src/rules/no-named-as-default-member.js
@@ -24,81 +24,68 @@ module.exports = {
},
create(context) {
-
const fileImports = new Map();
const allPropertyLookups = new Map();
- function handleImportDefault(node) {
- const declaration = importDeclaration(context);
- const exportMap = Exports.get(declaration.source.value, context);
- if (exportMap == null) return;
-
- if (exportMap.errors.length) {
- exportMap.reportErrors(context, declaration);
- return;
- }
-
- fileImports.set(node.local.name, {
- exportMap,
- sourcePath: declaration.source.value,
- });
- }
-
function storePropertyLookup(objectName, propName, node) {
const lookups = allPropertyLookups.get(objectName) || [];
lookups.push({ node, propName });
allPropertyLookups.set(objectName, lookups);
}
- function handlePropLookup(node) {
- const objectName = node.object.name;
- const propName = node.property.name;
- storePropertyLookup(objectName, propName, node);
- }
+ return {
+ ImportDefaultSpecifier(node) {
+ const declaration = importDeclaration(context);
+ const exportMap = Exports.get(declaration.source.value, context);
+ if (exportMap == null) { return; }
- function handleDestructuringAssignment(node) {
- const isDestructure = (
- node.id.type === 'ObjectPattern' &&
- node.init != null &&
- node.init.type === 'Identifier'
- );
- if (!isDestructure) return;
+ if (exportMap.errors.length) {
+ exportMap.reportErrors(context, declaration);
+ return;
+ }
- const objectName = node.init.name;
- for (const { key } of node.id.properties) {
- if (key == null) continue; // true for rest properties
- storePropertyLookup(objectName, key.name, key);
- }
- }
+ fileImports.set(node.local.name, {
+ exportMap,
+ sourcePath: declaration.source.value,
+ });
+ },
- function handleProgramExit() {
- allPropertyLookups.forEach((lookups, objectName) => {
- const fileImport = fileImports.get(objectName);
- if (fileImport == null) return;
+ MemberExpression(node) {
+ const objectName = node.object.name;
+ const propName = node.property.name;
+ storePropertyLookup(objectName, propName, node);
+ },
- for (const { propName, node } of lookups) {
- // the default import can have a "default" property
- if (propName === 'default') continue;
- if (!fileImport.exportMap.namespace.has(propName)) continue;
+ VariableDeclarator(node) {
+ const isDestructure = node.id.type === 'ObjectPattern'
+ && node.init != null
+ && node.init.type === 'Identifier';
+ if (!isDestructure) { return; }
- context.report({
- node,
- message: (
- `Caution: \`${objectName}\` also has a named export ` +
- `\`${propName}\`. Check if you meant to write ` +
- `\`import {${propName}} from '${fileImport.sourcePath}'\` ` +
- 'instead.'
- ),
- });
+ const objectName = node.init.name;
+ for (const { key } of node.id.properties) {
+ if (key == null) { continue; } // true for rest properties
+ storePropertyLookup(objectName, key.name, key);
}
- });
- }
+ },
- return {
- 'ImportDefaultSpecifier': handleImportDefault,
- 'MemberExpression': handlePropLookup,
- 'VariableDeclarator': handleDestructuringAssignment,
- 'Program:exit': handleProgramExit,
+ 'Program:exit'() {
+ allPropertyLookups.forEach((lookups, objectName) => {
+ const fileImport = fileImports.get(objectName);
+ if (fileImport == null) { return; }
+
+ for (const { propName, node } of lookups) {
+ // the default import can have a "default" property
+ if (propName === 'default') { continue; }
+ if (!fileImport.exportMap.namespace.has(propName)) { continue; }
+
+ context.report({
+ node,
+ message: `Caution: \`${objectName}\` also has a named export \`${propName}\`. Check if you meant to write \`import {${propName}} from '${fileImport.sourcePath}'\` instead.`,
+ });
+ }
+ });
+ },
};
},
};
diff --git a/src/rules/no-named-as-default.js b/src/rules/no-named-as-default.js
index c3a35ff64a..40b1e175b2 100644
--- a/src/rules/no-named-as-default.js
+++ b/src/rules/no-named-as-default.js
@@ -16,30 +16,30 @@ module.exports = {
create(context) {
function checkDefault(nameKey, defaultSpecifier) {
// #566: default is a valid specifier
- if (defaultSpecifier[nameKey].name === 'default') return;
+ if (defaultSpecifier[nameKey].name === 'default') { return; }
const declaration = importDeclaration(context);
const imports = Exports.get(declaration.source.value, context);
- if (imports == null) return;
+ if (imports == null) { return; }
if (imports.errors.length) {
imports.reportErrors(context, declaration);
return;
}
- if (imports.has('default') &&
- imports.has(defaultSpecifier[nameKey].name)) {
+ if (imports.has('default') && imports.has(defaultSpecifier[nameKey].name)) {
- context.report(defaultSpecifier,
- 'Using exported name \'' + defaultSpecifier[nameKey].name +
- '\' as identifier for default export.');
+ context.report(
+ defaultSpecifier,
+ `Using exported name '${defaultSpecifier[nameKey].name}' as identifier for default export.`,
+ );
}
}
return {
- 'ImportDefaultSpecifier': checkDefault.bind(null, 'local'),
- 'ExportDefaultSpecifier': checkDefault.bind(null, 'exported'),
+ ImportDefaultSpecifier: checkDefault.bind(null, 'local'),
+ ExportDefaultSpecifier: checkDefault.bind(null, 'exported'),
};
},
};
diff --git a/src/rules/no-named-default.js b/src/rules/no-named-default.js
index 8745ce3890..1ed0e31df5 100644
--- a/src/rules/no-named-default.js
+++ b/src/rules/no-named-default.js
@@ -13,7 +13,7 @@ module.exports = {
create(context) {
return {
- 'ImportDeclaration': function (node) {
+ ImportDeclaration(node) {
node.specifiers.forEach(function (im) {
if (im.importKind === 'type' || im.importKind === 'typeof') {
return;
diff --git a/src/rules/no-named-export.js b/src/rules/no-named-export.js
index b0722f3596..efaf9dc4c8 100644
--- a/src/rules/no-named-export.js
+++ b/src/rules/no-named-export.js
@@ -29,7 +29,7 @@ module.exports = {
return context.report({ node, message });
}
- const someNamed = node.specifiers.some(specifier => (specifier.exported.name || specifier.exported.value) !== 'default');
+ const someNamed = node.specifiers.some((specifier) => (specifier.exported.name || specifier.exported.value) !== 'default');
if (someNamed) {
context.report({ node, message });
}
diff --git a/src/rules/no-namespace.js b/src/rules/no-namespace.js
index a078137e65..d3e591876f 100644
--- a/src/rules/no-namespace.js
+++ b/src/rules/no-namespace.js
@@ -10,7 +10,6 @@ import docsUrl from '../docsUrl';
// Rule Definition
//------------------------------------------------------------------------------
-
module.exports = {
meta: {
type: 'suggestion',
@@ -40,20 +39,20 @@ module.exports = {
return {
ImportNamespaceSpecifier(node) {
- if (ignoreGlobs && ignoreGlobs.find(glob => minimatch(node.parent.source.value, glob, { matchBase: true }))) {
+ if (ignoreGlobs && ignoreGlobs.find((glob) => minimatch(node.parent.source.value, glob, { matchBase: true }))) {
return;
}
const scopeVariables = context.getScope().variables;
const namespaceVariable = scopeVariables.find((variable) => variable.defs[0].node === node);
const namespaceReferences = namespaceVariable.references;
- const namespaceIdentifiers = namespaceReferences.map(reference => reference.identifier);
+ const namespaceIdentifiers = namespaceReferences.map((reference) => reference.identifier);
const canFix = namespaceIdentifiers.length > 0 && !usesNamespaceAsObject(namespaceIdentifiers);
context.report({
node,
message: `Unexpected namespace import.`,
- fix: canFix && (fixer => {
+ fix: canFix && ((fixer) => {
const scopeManager = context.getSourceCode().scopeManager;
const fixes = [];
@@ -82,11 +81,10 @@ module.exports = {
);
// Replace the ImportNamespaceSpecifier with a list of ImportSpecifiers
- const namedImportSpecifiers = importNames.map((importName) => (
- importName === importLocalNames[importName]
- ? importName
- : `${importName} as ${importLocalNames[importName]}`
- ));
+ const namedImportSpecifiers = importNames.map((importName) => importName === importLocalNames[importName]
+ ? importName
+ : `${importName} as ${importLocalNames[importName]}`,
+ );
fixes.push(fixer.replaceText(node, `{ ${namedImportSpecifiers.join(', ')} }`));
// Pass 2: Replace references to the namespace with references to the named imports
@@ -116,8 +114,9 @@ function usesNamespaceAsObject(namespaceIdentifiers) {
// `namespace.x` or `namespace['x']`
return (
- parent && parent.type === 'MemberExpression' &&
- (parent.property.type === 'Identifier' || parent.property.type === 'Literal')
+ parent
+ && parent.type === 'MemberExpression'
+ && (parent.property.type === 'Identifier' || parent.property.type === 'Literal')
);
});
}
@@ -144,7 +143,7 @@ function getVariableNamesInScope(scopeManager, node) {
currentNode = currentNode.parent;
scope = scopeManager.acquire(currentNode, true);
}
- return new Set(scope.variables.concat(scope.upper.variables).map(variable => variable.name));
+ return new Set(scope.variables.concat(scope.upper.variables).map((variable) => variable.name));
}
/**
diff --git a/src/rules/no-nodejs-modules.js b/src/rules/no-nodejs-modules.js
index a87bff796f..82594bb603 100644
--- a/src/rules/no-nodejs-modules.js
+++ b/src/rules/no-nodejs-modules.js
@@ -4,7 +4,7 @@ import docsUrl from '../docsUrl';
function reportIfMissing(context, node, allowed, name) {
if (allowed.indexOf(name) === -1 && importType(name, context) === 'builtin') {
- context.report(node, 'Do not import Node.js builtin module "' + name + '"');
+ context.report(node, `Do not import Node.js builtin module "${name}"`);
}
}
diff --git a/src/rules/no-relative-packages.js b/src/rules/no-relative-packages.js
index 6b0a627670..1d215519fd 100644
--- a/src/rules/no-relative-packages.js
+++ b/src/rules/no-relative-packages.js
@@ -47,7 +47,7 @@ function checkImportForRelativePackage(context, importPath, node) {
context.report({
node,
message: `Relative import from another package is not allowed. Use \`${properImport}\` instead of \`${importPath}\``,
- fix: fixer => fixer.replaceText(node, JSON.stringify(toPosixPath(properImport)))
+ fix: (fixer) => fixer.replaceText(node, JSON.stringify(toPosixPath(properImport)))
,
});
}
diff --git a/src/rules/no-relative-parent-imports.js b/src/rules/no-relative-parent-imports.js
index fd8dcb302f..decd2ef7d2 100644
--- a/src/rules/no-relative-parent-imports.js
+++ b/src/rules/no-relative-parent-imports.js
@@ -18,7 +18,7 @@ module.exports = {
create: function noRelativePackages(context) {
const myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- if (myPath === '<text>') return {}; // can't check a non-file
+ if (myPath === '<text>') { return {}; } // can't check a non-file
function checkSourceValue(sourceNode) {
const depPath = sourceNode.value;
@@ -38,10 +38,7 @@ module.exports = {
if (importType(relDepPath, context) === 'parent') {
context.report({
node: sourceNode,
- message: 'Relative imports from parent directories are not allowed. ' +
- `Please either pass what you're importing through at runtime ` +
- `(dependency injection), move \`${basename(myPath)}\` to same ` +
- `directory as \`${depPath}\` or consider making \`${depPath}\` a package.`,
+ message: `Relative imports from parent directories are not allowed. Please either pass what you're importing through at runtime (dependency injection), move \`${basename(myPath)}\` to same directory as \`${depPath}\` or consider making \`${depPath}\` a package.`,
});
}
}
diff --git a/src/rules/no-restricted-paths.js b/src/rules/no-restricted-paths.js
index 2293119592..bce9fd1a03 100644
--- a/src/rules/no-restricted-paths.js
+++ b/src/rules/no-restricted-paths.js
@@ -77,11 +77,9 @@ module.exports = {
const restrictedPaths = options.zones || [];
const basePath = options.basePath || process.cwd();
const currentFilename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- const matchingZones = restrictedPaths.filter((zone) => {
- return [].concat(zone.target)
- .map(target => path.resolve(basePath, target))
- .some(targetPath => isMatchingTargetPath(currentFilename, targetPath));
- });
+ const matchingZones = restrictedPaths.filter((zone) => [].concat(zone.target)
+ .map((target) => path.resolve(basePath, target))
+ .some((targetPath) => isMatchingTargetPath(currentFilename, targetPath)));
function isMatchingTargetPath(filename, targetPath) {
if (isGlob(targetPath)) {
@@ -180,7 +178,7 @@ module.exports = {
}
function reportInvalidExceptions(validators, node) {
- validators.forEach(validator => validator.reportInvalidException(node));
+ validators.forEach((validator) => validator.reportInvalidException(node));
}
function reportImportsInRestrictedZone(validators, node, importPath, customMessage) {
@@ -203,7 +201,7 @@ module.exports = {
const isGlobPattern = areGlobPatterns.every((isGlob) => isGlob);
- return allZoneFrom.map(singleZoneFrom => {
+ return allZoneFrom.map((singleZoneFrom) => {
const absoluteFrom = path.resolve(basePath, singleZoneFrom);
if (isGlobPattern) {
@@ -227,14 +225,14 @@ module.exports = {
validators[index] = makePathValidators(zone.from, zone.except);
}
- const applicableValidatorsForImportPath = validators[index].filter(validator => validator.isPathRestricted(absoluteImportPath));
+ const applicableValidatorsForImportPath = validators[index].filter((validator) => validator.isPathRestricted(absoluteImportPath));
- const validatorsWithInvalidExceptions = applicableValidatorsForImportPath.filter(validator => !validator.hasValidExceptions);
+ const validatorsWithInvalidExceptions = applicableValidatorsForImportPath.filter((validator) => !validator.hasValidExceptions);
reportInvalidExceptions(validatorsWithInvalidExceptions, node);
const applicableValidatorsForImportPathExcludingExceptions = applicableValidatorsForImportPath
- .filter(validator => validator.hasValidExceptions)
- .filter(validator => !validator.isPathException(absoluteImportPath));
+ .filter((validator) => validator.hasValidExceptions)
+ .filter((validator) => !validator.isPathException(absoluteImportPath));
reportImportsInRestrictedZone(applicableValidatorsForImportPathExcludingExceptions, node, importPath, zone.message);
});
}
diff --git a/src/rules/no-unassigned-import.js b/src/rules/no-unassigned-import.js
index b790141927..0af9f2e9f3 100644
--- a/src/rules/no-unassigned-import.js
+++ b/src/rules/no-unassigned-import.js
@@ -24,16 +24,15 @@ function testIsAllow(globs, filename, source) {
filePath = path.resolve(path.dirname(filename), source); // get source absolute path
}
- return globs.find(glob => (
- minimatch(filePath, glob) ||
- minimatch(filePath, path.join(process.cwd(), glob))
- )) !== undefined;
+ return globs.find((glob) => minimatch(filePath, glob)
+ || minimatch(filePath, path.join(process.cwd(), glob)),
+ ) !== undefined;
}
function create(context) {
const options = context.options[0] || {};
const filename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- const isAllow = source => testIsAllow(options.allow, filename, source);
+ const isAllow = (source) => testIsAllow(options.allow, filename, source);
return {
ImportDeclaration(node) {
@@ -42,9 +41,11 @@ function create(context) {
}
},
ExpressionStatement(node) {
- if (node.expression.type === 'CallExpression' &&
- isStaticRequire(node.expression) &&
- !isAllow(node.expression.arguments[0].value)) {
+ if (
+ node.expression.type === 'CallExpression'
+ && isStaticRequire(node.expression)
+ && !isAllow(node.expression.arguments[0].value)
+ ) {
report(context, node.expression);
}
},
@@ -62,19 +63,19 @@ module.exports = {
},
schema: [
{
- 'type': 'object',
- 'properties': {
- 'devDependencies': { 'type': ['boolean', 'array'] },
- 'optionalDependencies': { 'type': ['boolean', 'array'] },
- 'peerDependencies': { 'type': ['boolean', 'array'] },
- 'allow': {
- 'type': 'array',
- 'items': {
- 'type': 'string',
+ type: 'object',
+ properties: {
+ devDependencies: { type: ['boolean', 'array'] },
+ optionalDependencies: { type: ['boolean', 'array'] },
+ peerDependencies: { type: ['boolean', 'array'] },
+ allow: {
+ type: 'array',
+ items: {
+ type: 'string',
},
},
},
- 'additionalProperties': false,
+ additionalProperties: false,
},
],
},
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index bd8c524abb..4b09128a10 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -40,11 +40,12 @@ try {
const { listFilesToProcess: originalListFilesToProcess } = require('eslint/lib/util/glob-util');
listFilesToProcess = function (src, extensions) {
- const patterns = src.reduce((carry, pattern) => {
- return carry.concat(extensions.map((extension) => {
- return /\*\*|\*\./.test(pattern) ? pattern : `${pattern}/**/*${extension}`;
- }));
- }, src.slice());
+ const patterns = src.reduce(
+ (carry, pattern) => carry.concat(
+ extensions.map((extension) => (/\*\*|\*\./).test(pattern) ? pattern : `${pattern}/**/*${extension}`),
+ ),
+ src,
+ );
return originalListFilesToProcess(patterns);
};
@@ -84,11 +85,11 @@ const DEFAULT = 'default';
function forEachDeclarationIdentifier(declaration, cb) {
if (declaration) {
if (
- declaration.type === FUNCTION_DECLARATION ||
- declaration.type === CLASS_DECLARATION ||
- declaration.type === TS_INTERFACE_DECLARATION ||
- declaration.type === TS_TYPE_ALIAS_DECLARATION ||
- declaration.type === TS_ENUM_DECLARATION
+ declaration.type === FUNCTION_DECLARATION
+ || declaration.type === CLASS_DECLARATION
+ || declaration.type === TS_INTERFACE_DECLARATION
+ || declaration.type === TS_TYPE_ALIAS_DECLARATION
+ || declaration.type === TS_ENUM_DECLARATION
) {
cb(declaration.id.name);
} else if (declaration.type === VARIABLE_DECLARATION) {
@@ -160,9 +161,7 @@ const visitorKeyMap = new Map();
const ignoredFiles = new Set();
const filesOutsideSrc = new Set();
-const isNodeModule = path => {
- return /\/(node_modules)\//.test(path);
-};
+const isNodeModule = (path) => (/\/(node_modules)\//).test(path);
/**
* read all files matching the patterns in src and ignoreExports
@@ -191,7 +190,7 @@ const resolveFiles = (src, ignoreExports, context) => {
*/
const prepareImportsAndExports = (srcFiles, context) => {
const exportAll = new Map();
- srcFiles.forEach(file => {
+ srcFiles.forEach((file) => {
const exports = new Map();
const imports = new Map();
const currentExports = Exports.get(file, context);
@@ -207,7 +206,7 @@ const prepareImportsAndExports = (srcFiles, context) => {
visitorKeyMap.set(file, visitorKeys);
// dependencies === export * from
const currentExportAll = new Set();
- dependencies.forEach(getDependency => {
+ dependencies.forEach((getDependency) => {
const dependency = getDependency();
if (dependency === null) {
return;
@@ -247,9 +246,11 @@ const prepareImportsAndExports = (srcFiles, context) => {
return;
}
const localImport = imports.get(key) || new Set();
- value.declarations.forEach(({ importedSpecifiers }) =>
- importedSpecifiers.forEach(specifier => localImport.add(specifier)),
- );
+ value.declarations.forEach(({ importedSpecifiers }) => {
+ importedSpecifiers.forEach((specifier) => {
+ localImport.add(specifier);
+ });
+ });
imports.set(key, localImport);
});
importList.set(file, imports);
@@ -271,7 +272,7 @@ const prepareImportsAndExports = (srcFiles, context) => {
exportList.set(file, exports);
});
exportAll.forEach((value, key) => {
- value.forEach(val => {
+ value.forEach((val) => {
const currentExports = exportList.get(val);
if (currentExports) {
const currentExport = currentExports.get(EXPORT_ALL_DECLARATION);
@@ -290,7 +291,7 @@ const determineUsage = () => {
listValue.forEach((value, key) => {
const exports = exportList.get(key);
if (typeof exports !== 'undefined') {
- value.forEach(currentImport => {
+ value.forEach((currentImport) => {
let specifier;
if (currentImport === IMPORT_NAMESPACE_SPECIFIER) {
specifier = IMPORT_NAMESPACE_SPECIFIER;
@@ -313,7 +314,7 @@ const determineUsage = () => {
});
};
-const getSrc = src => {
+const getSrc = (src) => {
if (src) {
return src;
}
@@ -347,33 +348,31 @@ const doPreparation = (src, ignoreExports, context) => {
lastPrepareKey = prepareKey;
};
-const newNamespaceImportExists = specifiers =>
- specifiers.some(({ type }) => type === IMPORT_NAMESPACE_SPECIFIER);
+const newNamespaceImportExists = (specifiers) => specifiers.some(({ type }) => type === IMPORT_NAMESPACE_SPECIFIER);
-const newDefaultImportExists = specifiers =>
- specifiers.some(({ type }) => type === IMPORT_DEFAULT_SPECIFIER);
+const newDefaultImportExists = (specifiers) => specifiers.some(({ type }) => type === IMPORT_DEFAULT_SPECIFIER);
-const fileIsInPkg = file => {
+const fileIsInPkg = (file) => {
const { path, pkg } = readPkgUp({ cwd: file });
const basePath = dirname(path);
- const checkPkgFieldString = pkgField => {
+ const checkPkgFieldString = (pkgField) => {
if (join(basePath, pkgField) === file) {
return true;
}
};
- const checkPkgFieldObject = pkgField => {
+ const checkPkgFieldObject = (pkgField) => {
const pkgFieldFiles = values(pkgField)
.filter((value) => typeof value !== 'boolean')
- .map(value => join(basePath, value));
+ .map((value) => join(basePath, value));
if (includes(pkgFieldFiles, file)) {
return true;
}
};
- const checkPkgField = pkgField => {
+ const checkPkgField = (pkgField) => {
if (typeof pkgField === 'string') {
return checkPkgFieldString(pkgField);
}
@@ -452,7 +451,7 @@ module.exports = {
missingExports: { enum: [false] },
},
},
- anyOf:[{
+ anyOf: [{
not: {
properties: {
unusedExports: { enum: [true] },
@@ -480,7 +479,7 @@ module.exports = {
}],
},
- create: context => {
+ create(context) {
const {
src,
ignoreExports = [],
@@ -494,7 +493,7 @@ module.exports = {
const file = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- const checkExportPresence = node => {
+ const checkExportPresence = (node) => {
if (!missingExports) {
return;
}
@@ -589,7 +588,7 @@ module.exports = {
*
* update lists of existing exports during runtime
*/
- const updateExportUsage = node => {
+ const updateExportUsage = (node) => {
if (ignoredFiles.has(file)) {
return;
}
@@ -611,7 +610,7 @@ module.exports = {
}
if (type === EXPORT_NAMED_DECLARATION) {
if (specifiers.length > 0) {
- specifiers.forEach(specifier => {
+ specifiers.forEach((specifier) => {
if (specifier.exported) {
newExportIdentifiers.add(specifier.exported.name || specifier.exported.value);
}
@@ -631,7 +630,7 @@ module.exports = {
});
// new export identifiers added: add to map of new exports
- newExportIdentifiers.forEach(key => {
+ newExportIdentifiers.forEach((key) => {
if (!exports.has(key)) {
newExports.set(key, { whereUsed: new Set() });
}
@@ -655,7 +654,7 @@ module.exports = {
*
* update lists of existing imports during runtime
*/
- const updateImportUsage = node => {
+ const updateImportUsage = (node) => {
if (!unusedExports) {
return;
}
@@ -686,9 +685,11 @@ module.exports = {
if (value.has(IMPORT_DEFAULT_SPECIFIER)) {
oldDefaultImports.add(key);
}
- value.forEach(val => {
- if (val !== IMPORT_NAMESPACE_SPECIFIER &&
- val !== IMPORT_DEFAULT_SPECIFIER) {
+ value.forEach((val) => {
+ if (
+ val !== IMPORT_NAMESPACE_SPECIFIER
+ && val !== IMPORT_DEFAULT_SPECIFIER
+ ) {
oldImports.set(val, key);
}
});
@@ -716,14 +717,14 @@ module.exports = {
},
});
- node.body.forEach(astNode => {
+ node.body.forEach((astNode) => {
let resolvedPath;
// support for export { value } from 'module'
if (astNode.type === EXPORT_NAMED_DECLARATION) {
if (astNode.source) {
resolvedPath = resolve(astNode.source.raw.replace(/('|")/g, ''), context);
- astNode.specifiers.forEach(specifier => {
+ astNode.specifiers.forEach((specifier) => {
const name = specifier.local.name || specifier.local.value;
if (name === DEFAULT) {
newDefaultImports.add(resolvedPath);
@@ -757,17 +758,15 @@ module.exports = {
newDefaultImports.add(resolvedPath);
}
- astNode.specifiers.forEach(specifier => {
- if (specifier.type === IMPORT_DEFAULT_SPECIFIER ||
- specifier.type === IMPORT_NAMESPACE_SPECIFIER) {
- return;
- }
- newImports.set(specifier.imported.name || specifier.imported.value, resolvedPath);
- });
+ astNode.specifiers
+ .filter((specifier) => specifier.type !== IMPORT_DEFAULT_SPECIFIER && specifier.type !== IMPORT_NAMESPACE_SPECIFIER)
+ .forEach((specifier) => {
+ newImports.set(specifier.imported.name || specifier.imported.value, resolvedPath);
+ });
}
});
- newExportAll.forEach(value => {
+ newExportAll.forEach((value) => {
if (!oldExportAll.has(value)) {
let imports = oldImportPaths.get(value);
if (typeof imports === 'undefined') {
@@ -795,7 +794,7 @@ module.exports = {
}
});
- oldExportAll.forEach(value => {
+ oldExportAll.forEach((value) => {
if (!newExportAll.has(value)) {
const imports = oldImportPaths.get(value);
imports.delete(EXPORT_ALL_DECLARATION);
@@ -810,7 +809,7 @@ module.exports = {
}
});
- newDefaultImports.forEach(value => {
+ newDefaultImports.forEach((value) => {
if (!oldDefaultImports.has(value)) {
let imports = oldImportPaths.get(value);
if (typeof imports === 'undefined') {
@@ -838,7 +837,7 @@ module.exports = {
}
});
- oldDefaultImports.forEach(value => {
+ oldDefaultImports.forEach((value) => {
if (!newDefaultImports.has(value)) {
const imports = oldImportPaths.get(value);
imports.delete(IMPORT_DEFAULT_SPECIFIER);
@@ -853,7 +852,7 @@ module.exports = {
}
});
- newNamespaceImports.forEach(value => {
+ newNamespaceImports.forEach((value) => {
if (!oldNamespaceImports.has(value)) {
let imports = oldImportPaths.get(value);
if (typeof imports === 'undefined') {
@@ -881,7 +880,7 @@ module.exports = {
}
});
- oldNamespaceImports.forEach(value => {
+ oldNamespaceImports.forEach((value) => {
if (!newNamespaceImports.has(value)) {
const imports = oldImportPaths.get(value);
imports.delete(IMPORT_NAMESPACE_SPECIFIER);
@@ -941,16 +940,16 @@ module.exports = {
};
return {
- 'Program:exit': node => {
+ 'Program:exit'(node) {
updateExportUsage(node);
updateImportUsage(node);
checkExportPresence(node);
},
- 'ExportDefaultDeclaration': node => {
+ ExportDefaultDeclaration(node) {
checkUsage(node, IMPORT_DEFAULT_SPECIFIER);
},
- 'ExportNamedDeclaration': node => {
- node.specifiers.forEach(specifier => {
+ ExportNamedDeclaration(node) {
+ node.specifiers.forEach((specifier) => {
checkUsage(node, specifier.exported.name || specifier.exported.value);
});
forEachDeclarationIdentifier(node.declaration, (name) => {
diff --git a/src/rules/no-useless-path-segments.js b/src/rules/no-useless-path-segments.js
index a328be2465..343a4f6230 100644
--- a/src/rules/no-useless-path-segments.js
+++ b/src/rules/no-useless-path-segments.js
@@ -25,7 +25,7 @@ import docsUrl from '../docsUrl';
function toRelativePath(relativePath) {
const stripped = relativePath.replace(/\/$/g, ''); // Remove trailing /
- return /^((\.\.)|(\.))($|\/)/.test(stripped) ? stripped : `./${stripped}`;
+ return (/^((\.\.)|(\.))($|\/)/).test(stripped) ? stripped : `./${stripped}`;
}
function normalize(fn) {
@@ -71,7 +71,7 @@ module.exports = {
node: source,
// Note: Using messageIds is not possible due to the support for ESLint 2 and 3
message: `Useless path segments for "${importPath}", should be "${proposedPath}"`,
- fix: fixer => proposedPath && fixer.replaceText(source, JSON.stringify(proposedPath)),
+ fix: (fixer) => proposedPath && fixer.replaceText(source, JSON.stringify(proposedPath)),
});
}
diff --git a/src/rules/no-webpack-loader-syntax.js b/src/rules/no-webpack-loader-syntax.js
index faedeb4373..6ca7d603d6 100644
--- a/src/rules/no-webpack-loader-syntax.js
+++ b/src/rules/no-webpack-loader-syntax.js
@@ -3,9 +3,7 @@ import docsUrl from '../docsUrl';
function reportIfNonStandard(context, node, name) {
if (name && name.indexOf('!') !== -1) {
- context.report(node, `Unexpected '!' in '${name}'. ` +
- 'Do not use import syntax to configure webpack loaders.',
- );
+ context.report(node, `Unexpected '!' in '${name}'. Do not use import syntax to configure webpack loaders.`);
}
}
diff --git a/src/rules/order.js b/src/rules/order.js
index bdead9d40c..5921989d2b 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -13,7 +13,7 @@ const defaultGroups = ['builtin', 'external', 'parent', 'sibling', 'index'];
function reverse(array) {
return array.map(function (v) {
- return Object.assign({}, v, { rank: -v.rank });
+ return { ...v, rank: -v.rank };
}).reverse();
}
@@ -111,9 +111,9 @@ function findEndOfLineWithComments(sourceCode, node) {
}
function commentOnSameLineAs(node) {
- return token => (token.type === 'Block' || token.type === 'Line') &&
- token.loc.start.line === token.loc.end.line &&
- token.loc.end.line === node.loc.end.line;
+ return (token) => (token.type === 'Block' || token.type === 'Line')
+ && token.loc.start.line === token.loc.end.line
+ && token.loc.end.line === node.loc.end.line;
}
function findStartOfLineWithComments(sourceCode, node) {
@@ -130,13 +130,13 @@ function findStartOfLineWithComments(sourceCode, node) {
}
function isRequireExpression(expr) {
- return expr != null &&
- expr.type === 'CallExpression' &&
- expr.callee != null &&
- expr.callee.name === 'require' &&
- expr.arguments != null &&
- expr.arguments.length === 1 &&
- expr.arguments[0].type === 'Literal';
+ return expr != null
+ && expr.type === 'CallExpression'
+ && expr.callee != null
+ && expr.callee.name === 'require'
+ && expr.arguments != null
+ && expr.arguments.length === 1
+ && expr.arguments[0].type === 'Literal';
}
function isSupportedRequireModule(node) {
@@ -147,16 +147,16 @@ function isSupportedRequireModule(node) {
return false;
}
const decl = node.declarations[0];
- const isPlainRequire = decl.id &&
- (decl.id.type === 'Identifier' || decl.id.type === 'ObjectPattern') &&
- isRequireExpression(decl.init);
- const isRequireWithMemberExpression = decl.id &&
- (decl.id.type === 'Identifier' || decl.id.type === 'ObjectPattern') &&
- decl.init != null &&
- decl.init.type === 'CallExpression' &&
- decl.init.callee != null &&
- decl.init.callee.type === 'MemberExpression' &&
- isRequireExpression(decl.init.callee.object);
+ const isPlainRequire = decl.id
+ && (decl.id.type === 'Identifier' || decl.id.type === 'ObjectPattern')
+ && isRequireExpression(decl.init);
+ const isRequireWithMemberExpression = decl.id
+ && (decl.id.type === 'Identifier' || decl.id.type === 'ObjectPattern')
+ && decl.init != null
+ && decl.init.type === 'CallExpression'
+ && decl.init.callee != null
+ && decl.init.callee.type === 'MemberExpression'
+ && isRequireExpression(decl.init.callee.object);
return isPlainRequire || isRequireWithMemberExpression;
}
@@ -211,7 +211,7 @@ function fixOutOfOrder(context, firstNode, secondNode, order) {
let newCode = sourceCode.text.substring(secondRootStart, secondRootEnd);
if (newCode[newCode.length - 1] !== '\n') {
- newCode = newCode + '\n';
+ newCode = `${newCode}\n`;
}
const firstImport = `${makeImportDescription(firstNode)} of \`${firstNode.displayName}\``;
@@ -222,21 +222,19 @@ function fixOutOfOrder(context, firstNode, secondNode, order) {
context.report({
node: secondNode.node,
message,
- fix: canFix && (fixer =>
- fixer.replaceTextRange(
- [firstRootStart, secondRootEnd],
- newCode + sourceCode.text.substring(firstRootStart, secondRootStart),
- )),
+ fix: canFix && ((fixer) => fixer.replaceTextRange(
+ [firstRootStart, secondRootEnd],
+ newCode + sourceCode.text.substring(firstRootStart, secondRootStart),
+ )),
});
} else if (order === 'after') {
context.report({
node: secondNode.node,
message,
- fix: canFix && (fixer =>
- fixer.replaceTextRange(
- [secondRootStart, firstRootEnd],
- sourceCode.text.substring(secondRootEnd, firstRootEnd) + newCode,
- )),
+ fix: canFix && ((fixer) => fixer.replaceTextRange(
+ [secondRootStart, firstRootEnd],
+ sourceCode.text.substring(secondRootEnd, firstRootEnd) + newCode,
+ )),
});
}
}
@@ -285,8 +283,8 @@ const getNormalizedValue = (node, toLowerCase) => {
function getSorter(alphabetizeOptions) {
const multiplier = alphabetizeOptions.order === 'asc' ? 1 : -1;
const orderImportKind = alphabetizeOptions.orderImportKind;
- const multiplierImportKind = orderImportKind !== 'ignore' &&
- (alphabetizeOptions.orderImportKind === 'asc' ? 1 : -1);
+ const multiplierImportKind = orderImportKind !== 'ignore'
+ && (alphabetizeOptions.orderImportKind === 'asc' ? 1 : -1);
return function importsSorter(nodeA, nodeB) {
const importA = getNormalizedValue(nodeA, alphabetizeOptions.caseInsensitive);
@@ -303,7 +301,7 @@ function getSorter(alphabetizeOptions) {
for (let i = 0; i < Math.min(a, b); i++) {
result = compareString(A[i], B[i]);
- if (result) break;
+ if (result) { break; }
}
if (!result && a !== b) {
@@ -368,7 +366,7 @@ function computePathRank(ranks, pathGroups, path, maxPosition) {
for (let i = 0, l = pathGroups.length; i < l; i++) {
const { pattern, patternOptions, group, position = 1 } = pathGroups[i];
if (minimatch(path, pattern, patternOptions || { nocomment: true })) {
- return ranks[group] + (position / maxPosition);
+ return ranks[group] + position / maxPosition;
}
}
}
@@ -399,7 +397,7 @@ function computeRank(context, ranks, importEntry, excludedImportTypes) {
function registerNode(context, importEntry, ranks, imported, excludedImportTypes) {
const rank = computeRank(context, ranks, importEntry, excludedImportTypes);
if (rank !== -1) {
- imported.push(Object.assign({}, importEntry, { rank }));
+ imported.push({ ...importEntry, rank });
}
}
@@ -408,15 +406,15 @@ function getRequireBlock(node) {
// Handle cases like `const baz = require('foo').bar.baz`
// and `const foo = require('foo')()`
while (
- (n.parent.type === 'MemberExpression' && n.parent.object === n) ||
- (n.parent.type === 'CallExpression' && n.parent.callee === n)
+ n.parent.type === 'MemberExpression' && n.parent.object === n
+ || n.parent.type === 'CallExpression' && n.parent.callee === n
) {
n = n.parent;
}
if (
- n.parent.type === 'VariableDeclarator' &&
- n.parent.parent.type === 'VariableDeclaration' &&
- n.parent.parent.parent.type === 'Program'
+ n.parent.type === 'VariableDeclarator'
+ && n.parent.parent.type === 'VariableDeclaration'
+ && n.parent.parent.parent.type === 'Program'
) {
return n.parent.parent.parent;
}
@@ -434,11 +432,10 @@ function convertGroupsToRanks(groups) {
}
group.forEach(function (groupItem) {
if (types.indexOf(groupItem) === -1) {
- throw new Error('Incorrect configuration of the rule: Unknown type `' +
- JSON.stringify(groupItem) + '`');
+ throw new Error(`Incorrect configuration of the rule: Unknown type \`${JSON.stringify(groupItem)}\``);
}
if (res[groupItem] !== undefined) {
- throw new Error('Incorrect configuration of the rule: `' + groupItem + '` is duplicated');
+ throw new Error(`Incorrect configuration of the rule: \`${groupItem}\` is duplicated`);
}
res[groupItem] = index * 2;
});
@@ -476,7 +473,7 @@ function convertPathGroupsForRanks(pathGroups) {
before[group].push(index);
}
- return Object.assign({}, pathGroup, { position });
+ return { ...pathGroup, position };
});
let maxPosition = 1;
@@ -520,7 +517,7 @@ function removeNewLineAfterImport(context, currentImport, previousImport) {
findEndOfLineWithComments(sourceCode, prevRoot),
findStartOfLineWithComments(sourceCode, currRoot),
];
- if (/^\s*$/.test(sourceCode.text.substring(rangeToRemove[0], rangeToRemove[1]))) {
+ if ((/^\s*$/).test(sourceCode.text.substring(rangeToRemove[0], rangeToRemove[1]))) {
return (fixer) => fixer.removeRange(rangeToRemove);
}
return undefined;
@@ -535,9 +532,7 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, di
return linesBetweenImports.filter((line) => !line.trim().length).length;
};
- const getIsStartOfDistinctGroup = (currentImport, previousImport) => {
- return currentImport.rank - 1 >= previousImport.rank;
- };
+ const getIsStartOfDistinctGroup = (currentImport, previousImport) => currentImport.rank - 1 >= previousImport.rank;
let previousImport = imported[0];
imported.slice(1).forEach(function (currentImport) {
@@ -547,7 +542,7 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, di
if (newlinesBetweenImports === 'always'
|| newlinesBetweenImports === 'always-and-inside-groups') {
if (currentImport.rank !== previousImport.rank && emptyLinesBetween === 0) {
- if (distinctGroup || (!distinctGroup && isStartOfDistinctGroup)) {
+ if (distinctGroup || !distinctGroup && isStartOfDistinctGroup) {
context.report({
node: previousImport.node,
message: 'There should be at least one empty line between import groups',
@@ -556,7 +551,7 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, di
}
} else if (emptyLinesBetween > 0
&& newlinesBetweenImports !== 'always-and-inside-groups') {
- if ((distinctGroup && currentImport.rank === previousImport.rank) || (!distinctGroup && !isStartOfDistinctGroup)) {
+ if (distinctGroup && currentImport.rank === previousImport.rank || !distinctGroup && !isStartOfDistinctGroup) {
context.report({
node: previousImport.node,
message: 'There should be no empty line within import group',
@@ -675,7 +670,7 @@ module.exports = {
create: function importOrderRule(context) {
const options = context.options[0] || {};
const newlinesBetweenImports = options['newlines-between'] || 'ignore';
- const pathGroupsExcludedImportTypes = new Set(options['pathGroupsExcludedImportTypes'] || ['builtin', 'external', 'object']);
+ const pathGroupsExcludedImportTypes = new Set(options.pathGroupsExcludedImportTypes || ['builtin', 'external', 'object']);
const alphabetize = getAlphabetizeConfig(options);
const distinctGroup = options.distinctGroup == null ? defaultDistinctGroup : !!options.distinctGroup;
let ranks;
diff --git a/src/rules/prefer-default-export.js b/src/rules/prefer-default-export.js
index 32ef5004fa..581f02502e 100644
--- a/src/rules/prefer-default-export.js
+++ b/src/rules/prefer-default-export.js
@@ -15,7 +15,7 @@ module.exports = {
},
schema: [{
type: 'object',
- properties:{
+ properties: {
target: {
type: 'string',
enum: ['single', 'any'],
@@ -51,11 +51,11 @@ module.exports = {
}
return {
- 'ExportDefaultSpecifier': function () {
+ ExportDefaultSpecifier() {
hasDefaultExport = true;
},
- 'ExportSpecifier': function (node) {
+ ExportSpecifier(node) {
if ((node.exported.name || node.exported.value) === 'default') {
hasDefaultExport = true;
} else {
@@ -64,17 +64,17 @@ module.exports = {
}
},
- 'ExportNamedDeclaration': function (node) {
+ ExportNamedDeclaration(node) {
// if there are specifiers, node.declaration should be null
- if (!node.declaration) return;
+ if (!node.declaration) { return; }
const { type } = node.declaration;
if (
- type === 'TSTypeAliasDeclaration' ||
- type === 'TypeAlias' ||
- type === 'TSInterfaceDeclaration' ||
- type === 'InterfaceDeclaration'
+ type === 'TSTypeAliasDeclaration'
+ || type === 'TypeAlias'
+ || type === 'TSInterfaceDeclaration'
+ || type === 'InterfaceDeclaration'
) {
specifierExportCount++;
hasTypeExport = true;
@@ -93,15 +93,15 @@ module.exports = {
namedExportNode = node;
},
- 'ExportDefaultDeclaration': function () {
+ ExportDefaultDeclaration() {
hasDefaultExport = true;
},
- 'ExportAllDeclaration': function () {
+ ExportAllDeclaration() {
hasStarExport = true;
},
- 'Program:exit': function () {
+ 'Program:exit'() {
if (hasDefaultExport || hasStarExport || hasTypeExport) {
return;
}
diff --git a/tests/src/cli.js b/tests/src/cli.js
index e6afd8e441..8a73454878 100644
--- a/tests/src/cli.js
+++ b/tests/src/cli.js
@@ -21,7 +21,7 @@ describe('CLI regression tests', function () {
rulePaths: ['./src/rules'],
overrideConfig: {
rules: {
- 'named': 2,
+ named: 2,
},
},
plugins: { 'eslint-plugin-import': importPlugin },
@@ -32,7 +32,7 @@ describe('CLI regression tests', function () {
configFile: './tests/files/issue210.config.js',
rulePaths: ['./src/rules'],
rules: {
- 'named': 2,
+ named: 2,
},
});
cli.addPlugin('eslint-plugin-import', importPlugin);
@@ -78,7 +78,7 @@ describe('CLI regression tests', function () {
it('throws an error on invalid JSON', () => {
const invalidJSON = './tests/files/just-json-files/invalid.json';
if (eslint) {
- return eslint.lintFiles([invalidJSON]).then(results => {
+ return eslint.lintFiles([invalidJSON]).then((results) => {
expect(results).to.eql(
[
{
@@ -97,16 +97,16 @@ describe('CLI regression tests', function () {
},
],
errorCount: 1,
- ...(semver.satisfies(eslintPkg.version, '>= 7.32 || ^8.0.0') && {
+ ...semver.satisfies(eslintPkg.version, '>= 7.32 || ^8.0.0') && {
fatalErrorCount: 0,
- }),
+ },
warningCount: 0,
fixableErrorCount: 0,
fixableWarningCount: 0,
source: results[0].source, // NewLine-characters might differ depending on git-settings
- ...(semver.satisfies(eslintPkg.version, '>= 8.8') && {
+ ...semver.satisfies(eslintPkg.version, '>= 8.8') && {
suppressedMessages: [],
- }),
+ },
usedDeprecatedRules: results[0].usedDeprecatedRules, // we don't care about this one
},
],
diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
index 86c1915968..1dd6e88014 100644
--- a/tests/src/core/getExports.js
+++ b/tests/src/core/getExports.js
@@ -58,11 +58,10 @@ describe('ExportMap', function () {
const firstAccess = ExportMap.get('./named-exports', fakeContext);
expect(firstAccess).to.exist;
- const differentSettings = Object.assign(
- {},
- fakeContext,
- { parserPath: 'espree' },
- );
+ const differentSettings = {
+ ...fakeContext,
+ parserPath: 'espree',
+ };
expect(ExportMap.get('./named-exports', differentSettings))
.to.exist.and
@@ -320,17 +319,19 @@ describe('ExportMap', function () {
});
it(`'has' circular reference`, function () {
expect(ExportMap.get('./narcissist', fakeContext))
- .to.exist.and.satisfy(m => m.has('soGreat'));
+ .to.exist.and.satisfy((m) => m.has('soGreat'));
});
it(`can 'get' circular reference`, function () {
expect(ExportMap.get('./narcissist', fakeContext))
- .to.exist.and.satisfy(m => m.get('soGreat') != null);
+ .to.exist.and.satisfy((m) => m.get('soGreat') != null);
});
});
context('issue #478: never parse non-whitelist extensions', function () {
- const context = Object.assign({}, fakeContext,
- { settings: { 'import/extensions': ['.js'] } });
+ const context = {
+ ...fakeContext,
+ settings: { 'import/extensions': ['.js'] },
+ };
let imports;
before('load imports', function () {
@@ -359,11 +360,13 @@ describe('ExportMap', function () {
configs.forEach(([description, parserConfig]) => {
describe(description, function () {
- const context = Object.assign({}, fakeContext,
- { settings: {
+ const context = {
+ ...fakeContext,
+ settings: {
'import/extensions': ['.js'],
'import/parsers': parserConfig,
- } });
+ },
+ };
let imports;
before('load imports', function () {
@@ -404,30 +407,24 @@ describe('ExportMap', function () {
});
it('should cache tsconfig until tsconfigRootDir parser option changes', function () {
- const customContext = Object.assign(
- {},
- context,
- {
- parserOptions: {
- tsconfigRootDir: null,
- },
+ const customContext = {
+ ...context,
+ parserOptions: {
+ tsconfigRootDir: null,
},
- );
+ };
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(0);
ExportMap.parse('./baz.ts', 'export const baz = 5', customContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(1);
ExportMap.parse('./baz.ts', 'export const baz = 5', customContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(1);
- const differentContext = Object.assign(
- {},
- context,
- {
- parserOptions: {
- tsconfigRootDir: process.cwd(),
- },
+ const differentContext = {
+ ...context,
+ parserOptions: {
+ tsconfigRootDir: process.cwd(),
},
- );
+ };
ExportMap.parse('./baz.ts', 'export const baz = 5', differentContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(2);
@@ -460,7 +457,7 @@ describe('ExportMap', function () {
for (const [testFile, expectedRegexResult] of testFiles) {
it(`works for ${testFile} (${expectedRegexResult})`, function () {
- const content = fs.readFileSync('./tests/files/' + testFile, 'utf8');
+ const content = fs.readFileSync(`./tests/files/${testFile}`, 'utf8');
expect(testUnambiguous(content)).to.equal(expectedRegexResult);
});
}
diff --git a/tests/src/core/hash.js b/tests/src/core/hash.js
index e75783fb06..1d6a9eb85c 100644
--- a/tests/src/core/hash.js
+++ b/tests/src/core/hash.js
@@ -7,7 +7,7 @@ const createHash = require('crypto').createHash;
function expectHash(actualHash, expectedString) {
const expectedHash = createHash('sha256');
expectedHash.update(expectedString);
- expect(actualHash.digest('hex'), 'to be a hex digest of sha256 hash of string <' + expectedString + '>').to.equal(expectedHash.digest('hex'));
+ expect(actualHash.digest('hex'), `to be a hex digest of sha256 hash of string <${expectedString}>`).to.equal(expectedHash.digest('hex'));
}
describe('hash', function () {
diff --git a/tests/src/core/parse.js b/tests/src/core/parse.js
index 4ab8370ed2..9c59453602 100644
--- a/tests/src/core/parse.js
+++ b/tests/src/core/parse.js
@@ -13,9 +13,19 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
const eslintParserPath = require.resolve('./eslintParser');
let content;
- before((done) =>
- fs.readFile(path, { encoding: 'utf8' },
- (err, f) => { if (err) { done(err); } else { content = f; done(); }}));
+ before((done) => {
+ fs.readFile(
+ path,
+ { encoding: 'utf8' },
+ (err, f) => {
+ if (err) {
+ done(err);
+ } else {
+ content = f; done();
+ }
+ },
+ );
+ });
it('doesn\'t support JSX by default', function () {
expect(() => parse(path, content, { parserPath: 'espree' })).to.throw(Error);
diff --git a/tests/src/core/resolve.js b/tests/src/core/resolve.js
index 05a6aaeb68..6b69fb7f12 100644
--- a/tests/src/core/resolve.js
+++ b/tests/src/core/resolve.js
@@ -21,32 +21,38 @@ describe('resolve', function () {
it('resolves via a custom resolver with interface version 1', function () {
const testContext = utils.testContext({ 'import/resolver': './foo-bar-resolver-v1' });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
});
it('resolves via a custom resolver with interface version 1 assumed if not specified', function () {
const testContext = utils.testContext({ 'import/resolver': './foo-bar-resolver-no-version' });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
});
@@ -57,21 +63,24 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
testContextReports.length = 0;
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(replaceErrorStackForTest(testContextReports[0].message)).to.equal('Resolve error: foo-bar-resolver-v2 resolve test exception\n<stack-was-here>');
expect(testContextReports[0].loc).to.eql({ line: 1, column: 0 });
testContextReports.length = 0;
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
expect(testContextReports.length).to.equal(0);
});
@@ -79,32 +88,36 @@ describe('resolve', function () {
it('respects import/resolver as array of strings', function () {
const testContext = utils.testContext({ 'import/resolver': [ './foo-bar-resolver-v2', './foo-bar-resolver-v1' ] });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('respects import/resolver as object', function () {
const testContext = utils.testContext({ 'import/resolver': { './foo-bar-resolver-v2': {} } });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('respects import/resolver as array of objects', function () {
const testContext = utils.testContext({ 'import/resolver': [ { './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} } ] });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('finds resolvers from the source files rather than eslint-module-utils', function () {
- const testContext = utils.testContext({ 'import/resolver': { 'foo': {} } });
+ const testContext = utils.testContext({ 'import/resolver': { foo: {} } });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
@@ -116,8 +129,9 @@ describe('resolve', function () {
};
testContextReports.length = 0;
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(testContextReports[0].message).to.equal('Resolve error: invalid resolver config');
@@ -132,8 +146,9 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
testContextReports.length = 0;
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(testContextReports[0].message).to.equal(`Resolve error: ${resolverName} with invalid interface loaded as resolver`);
@@ -141,10 +156,11 @@ describe('resolve', function () {
});
it('respects import/resolve extensions', function () {
- const testContext = utils.testContext({ 'import/resolve': { 'extensions': ['.jsx'] } });
+ const testContext = utils.testContext({ 'import/resolve': { extensions: ['.jsx'] } });
- expect(resolve( './jsx/MyCoolComponent'
- , testContext,
+ expect(resolve(
+ './jsx/MyCoolComponent',
+ testContext,
)).to.equal(utils.testFilePath('./jsx/MyCoolComponent.jsx'));
});
@@ -155,8 +171,9 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(replaceErrorStackForTest(testContextReports[0].message)).to.equal('Resolve error: SyntaxError: TEST SYNTAX ERROR\n<stack-was-here>');
@@ -172,32 +189,38 @@ describe('resolve', function () {
it('resolves via a custom resolver with interface version 1', function () {
const testContext = utils.testContext({ 'import/resolver': './foo-bar-resolver-v1' });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
});
it('resolves via a custom resolver with interface version 1 assumed if not specified', function () {
const testContext = utils.testContext({ 'import/resolver': './foo-bar-resolver-no-version' });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
});
@@ -208,21 +231,24 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
testContextReports.length = 0;
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(replaceErrorStackForTest(testContextReports[0].message)).to.equal('Resolve error: foo-bar-resolver-v2 resolve test exception\n<stack-was-here>');
expect(testContextReports[0].loc).to.eql({ line: 1, column: 0 });
testContextReports.length = 0;
- expect(resolve( '../files/not-found'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } }),
+ expect(resolve(
+ '../files/not-found',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('not-found.js'); } },
)).to.equal(undefined);
expect(testContextReports.length).to.equal(0);
});
@@ -230,32 +256,36 @@ describe('resolve', function () {
it('respects import/resolver as array of strings', function () {
const testContext = utils.testContext({ 'import/resolver': [ './foo-bar-resolver-v2', './foo-bar-resolver-v1' ] });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('respects import/resolver as object', function () {
const testContext = utils.testContext({ 'import/resolver': { './foo-bar-resolver-v2': {} } });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('respects import/resolver as array of objects', function () {
const testContext = utils.testContext({ 'import/resolver': [ { './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} } ] });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
it('finds resolvers from the source files rather than eslint-module-utils', function () {
- const testContext = utils.testContext({ 'import/resolver': { 'foo': {} } });
+ const testContext = utils.testContext({ 'import/resolver': { foo: {} } });
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(utils.testFilePath('./bar.jsx'));
});
@@ -267,8 +297,9 @@ describe('resolve', function () {
};
testContextReports.length = 0;
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(testContextReports[0].message).to.equal('Resolve error: invalid resolver config');
@@ -283,8 +314,9 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
testContextReports.length = 0;
- expect(resolve( '../files/foo'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } }),
+ expect(resolve(
+ '../files/foo',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('foo.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(testContextReports[0].message).to.equal(`Resolve error: ${resolverName} with invalid interface loaded as resolver`);
@@ -292,10 +324,11 @@ describe('resolve', function () {
});
it('respects import/resolve extensions', function () {
- const testContext = utils.testContext({ 'import/resolve': { 'extensions': ['.jsx'] } });
+ const testContext = utils.testContext({ 'import/resolve': { extensions: ['.jsx'] } });
- expect(resolve( './jsx/MyCoolComponent'
- , testContext,
+ expect(resolve(
+ './jsx/MyCoolComponent',
+ testContext,
)).to.equal(utils.testFilePath('./jsx/MyCoolComponent.jsx'));
});
@@ -306,8 +339,9 @@ describe('resolve', function () {
testContextReports.push(reportInfo);
};
- expect(resolve( '../files/exception'
- , Object.assign({}, testContext, { getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } }),
+ expect(resolve(
+ '../files/exception',
+ { ...testContext, getFilename: unexpectedCallToGetFilename, getPhysicalFilename() { return utils.getFilename('exception.js'); } },
)).to.equal(undefined);
expect(testContextReports[0]).to.be.an('object');
expect(replaceErrorStackForTest(testContextReports[0].message)).to.equal('Resolve error: SyntaxError: TEST SYNTAX ERROR\n<stack-was-here>');
@@ -315,11 +349,11 @@ describe('resolve', function () {
});
});
- const caseDescribe = (!CASE_SENSITIVE_FS ? describe : describe.skip);
+ const caseDescribe = !CASE_SENSITIVE_FS ? describe : describe.skip;
caseDescribe('case sensitivity', function () {
let file;
const testContext = utils.testContext({
- 'import/resolve': { 'extensions': ['.jsx'] },
+ 'import/resolve': { extensions: ['.jsx'] },
'import/cache': { lifetime: 0 },
});
const testSettings = testContext.settings;
@@ -333,31 +367,30 @@ describe('resolve', function () {
});
it('detects case does not match FS', function () {
expect(fileExistsWithCaseSync(file, testSettings))
- .to.be.false;
+ .to.equal(false);
});
it('detecting case does not include parent folder path (issue #720)', function () {
const f = path.join(process.cwd().toUpperCase(), './tests/files/jsx/MyUnCoolComponent.jsx');
expect(fileExistsWithCaseSync(f, testSettings))
- .to.be.true;
+ .to.equal(true);
});
it('detecting case should include parent folder path', function () {
const f = path.join(process.cwd().toUpperCase(), './tests/files/jsx/MyUnCoolComponent.jsx');
expect(fileExistsWithCaseSync(f, testSettings, true))
- .to.be.false;
+ .to.equal(false);
});
});
describe('rename cache correctness', function () {
const context = utils.testContext({
- 'import/cache': { 'lifetime': 1 },
+ 'import/cache': { lifetime: 1 },
});
- const infiniteContexts = [ '∞', 'Infinity' ].map(inf => [inf,
+ const infiniteContexts = [ '∞', 'Infinity' ].map((inf) => [inf,
utils.testContext({
- 'import/cache': { 'lifetime': inf },
+ 'import/cache': { lifetime: inf },
})]);
-
const pairs = [
['./CaseyKasem.js', './CASEYKASEM2.js'],
];
@@ -372,7 +405,7 @@ describe('resolve', function () {
// settings are part of cache key
before('warm up infinite entries', function () {
- infiniteContexts.forEach(([,c]) => {
+ infiniteContexts.forEach(([, c]) => {
expect(resolve(original, c)).to.exist;
});
});
@@ -384,10 +417,9 @@ describe('resolve', function () {
done);
});
- before('verify rename', (done) =>
- fs.exists(
- utils.testFilePath(changed),
- exists => done(exists ? null : new Error('new file does not exist'))));
+ before('verify rename', (done) => fs.exists(
+ utils.testFilePath(changed),
+ (exists) => done(exists ? null : new Error('new file does not exist'))));
it('gets cached values within cache lifetime', function () {
// get cached values initially
@@ -426,7 +458,8 @@ describe('resolve', function () {
fs.rename(
utils.testFilePath(changed),
utils.testFilePath(original),
- done);
+ done,
+ );
});
});
});
diff --git a/tests/src/package.js b/tests/src/package.js
index f759819758..dd55e2740b 100644
--- a/tests/src/package.js
+++ b/tests/src/package.js
@@ -38,8 +38,8 @@ describe('package', function () {
it('exports all configs', function (done) {
fs.readdir(path.join(process.cwd(), 'config'), function (err, files) {
if (err) { done(err); return; }
- files.filter(isJSFile).forEach(file => {
- if (file[0] === '.') return;
+ files.filter(isJSFile).forEach((file) => {
+ if (file[0] === '.') { return; }
expect(module.configs).to.have.property(path.basename(file, '.js'));
});
done();
@@ -66,7 +66,7 @@ describe('package', function () {
it('marks deprecated rules in their metadata', function () {
expect(module.rules['imports-first'].meta.deprecated).to.be.true;
- expect(module.rules['first'].meta.deprecated).not.to.be.true;
+ expect(module.rules.first.meta.deprecated).not.to.be.true;
});
});
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index 46a1b97afe..73617a6f36 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -969,7 +969,7 @@ ruleTester.run('dynamic-import-chunkname', rule, {
context('TypeScript', () => {
getTSParsers().forEach((typescriptParser) => {
- const nodeType = typescriptParser === parsers.TS_OLD || (typescriptParser === parsers.TS_NEW && semver.satisfies(require('@typescript-eslint/parser/package.json').version, '^2'))
+ const nodeType = typescriptParser === parsers.TS_OLD || typescriptParser === parsers.TS_NEW && semver.satisfies(require('@typescript-eslint/parser/package.json').version, '^2')
? 'CallExpression'
: 'ImportExpression';
diff --git a/tests/src/rules/export.js b/tests/src/rules/export.js
index 95093bf4a8..a7f2bec122 100644
--- a/tests/src/rules/export.js
+++ b/tests/src/rules/export.js
@@ -137,7 +137,6 @@ ruleTester.run('export', rule, {
// errors: ['Parsing error: Duplicate export \'bar\''],
// }),
-
// #328: "export * from" does not export a default
test({
code: 'export * from "./default-export"',
@@ -158,7 +157,6 @@ ruleTester.run('export', rule, {
),
});
-
context('TypeScript', function () {
getTSParsers().forEach((parser) => {
const parserConfig = {
diff --git a/tests/src/rules/exports-last.js b/tests/src/rules/exports-last.js
index 9f01f27f42..d7122e9a00 100644
--- a/tests/src/rules/exports-last.js
+++ b/tests/src/rules/exports-last.js
@@ -5,7 +5,7 @@ import rule from 'rules/exports-last';
const ruleTester = new RuleTester();
-const error = type => ({
+const error = (type) => ({
message: 'Export statements should appear at the end of the file',
type,
});
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index 45b4498fe9..ede1a8d88a 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -31,7 +31,7 @@ ruleTester.run('extensions', rule, {
'import data from "./bar.json"',
].join('\n'),
options: [ 'never' ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
}),
test({
@@ -41,7 +41,7 @@ ruleTester.run('extensions', rule, {
'import barhbs from "./bar.hbs"',
].join('\n'),
options: [ 'always', { js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json', '.hbs' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json', '.hbs' ] } },
}),
test({
@@ -50,7 +50,7 @@ ruleTester.run('extensions', rule, {
'import pack from "./package"',
].join('\n'),
options: [ 'never', { js: 'always', json: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.json' ] } },
}),
// unresolved (#271/#295)
@@ -96,8 +96,8 @@ ruleTester.run('extensions', rule, {
filename: testFilePath('./internal-modules/plugins/plugin.js'),
settings: {
'import/resolver': {
- 'node': { 'extensions': [ '.js', '.jsx', '.json' ] },
- 'webpack': { 'config': 'webpack.empty.config.js' },
+ node: { extensions: [ '.js', '.jsx', '.json' ] },
+ webpack: { config: 'webpack.empty.config.js' },
},
},
}),
@@ -174,7 +174,7 @@ ruleTester.run('extensions', rule, {
'import packageConfig from "./package"',
].join('\n'),
options: [ { json: 'always', js: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.json' ] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "a/index.js"',
@@ -195,7 +195,7 @@ ruleTester.run('extensions', rule, {
'import data from "./bar.json"',
].join('\n'),
options: [ 'never' ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -211,7 +211,7 @@ ruleTester.run('extensions', rule, {
'import data from "./bar.json"',
].join('\n'),
options: [ { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -227,7 +227,7 @@ ruleTester.run('extensions', rule, {
'import data from "./bar.json"',
].join('\n'),
options: [ { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.jsx', '.json', '.js' ] } },
+ settings: { 'import/resolve': { extensions: [ '.jsx', '.json', '.js' ] } },
errors: [
{
message: 'Unexpected use of file extension "jsx" for "./bar.jsx"',
@@ -246,7 +246,7 @@ ruleTester.run('extensions', rule, {
},
],
options: ['never', { js: 'always', jsx: 'always' }],
- settings: { 'import/resolve': { 'extensions': ['.coffee', '.js'] } },
+ settings: { 'import/resolve': { extensions: ['.coffee', '.js'] } },
}),
test({
@@ -256,7 +256,7 @@ ruleTester.run('extensions', rule, {
'import barnone from "./bar"',
].join('\n'),
options: [ 'always', { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -273,7 +273,7 @@ ruleTester.run('extensions', rule, {
'import barnone from "./bar"',
].join('\n'),
options: [ 'never', { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { 'extensions': [ '.js', '.jsx', '.json' ] } },
+ settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -331,7 +331,6 @@ ruleTester.run('extensions', rule, {
],
}),
-
test({
code: `
import foo from './foo.js'
diff --git a/tests/src/rules/first.js b/tests/src/rules/first.js
index 8892ff3d62..f34f227b2d 100644
--- a/tests/src/rules/first.js
+++ b/tests/src/rules/first.js
@@ -81,7 +81,7 @@ ruleTester.run('first', rule, {
code: "if (true) { console.log(1) }import a from 'b'",
errors: 1,
output: "import a from 'b'\nif (true) { console.log(1) }",
- }),
+ }),
],
});
diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
index 227e242ef8..110cfff52a 100644
--- a/tests/src/rules/named.js
+++ b/tests/src/rules/named.js
@@ -4,12 +4,11 @@ import path from 'path';
import { CASE_SENSITIVE_FS } from 'eslint-module-utils/resolve';
-
const ruleTester = new RuleTester();
const rule = require('rules/named');
function error(name, module, type = 'Identifier') {
- return { message: name + ' not found in \'' + module + '\'', type };
+ return { message: `${name} not found in '${module}'`, type };
}
ruleTester.run('named', rule, {
@@ -30,11 +29,10 @@ ruleTester.run('named', rule, {
test({ code: 'import {RuleTester} from "./re-export-node_modules"' }),
test({ code: 'import { jsxFoo } from "./jsx/AnotherComponent"',
- settings: { 'import/resolve': { 'extensions': ['.js', '.jsx'] } } }),
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx'] } } }),
// validate that eslint-disable-line silences this properly
- test({ code: 'import {a, b, d} from "./common"; ' +
- '// eslint-disable-line named' }),
+ test({ code: 'import {a, b, d} from "./common"; // eslint-disable-line named' }),
test({ code: 'import { foo, bar } from "./re-export-names"' }),
@@ -192,7 +190,7 @@ ruleTester.run('named', rule, {
},
})),
- testVersion('>=7.8.0', () =>({ code: 'const { something } = require("./dynamic-import-in-commonjs")',
+ testVersion('>=7.8.0', () => ({ code: 'const { something } = require("./dynamic-import-in-commonjs")',
parserOptions: { ecmaVersion: 2021 },
options: [{ commonjs: true }],
})),
@@ -323,7 +321,6 @@ ruleTester.run('named', rule, {
errors: ["bap not found in './re-export-default'"],
}),
-
// #328: * exports do not include default
test({
code: 'import { default as barDefault } from "./re-export"',
@@ -381,7 +378,6 @@ ruleTester.run('named (export *)', rule, {
],
});
-
context('TypeScript', function () {
getTSParsers().forEach((parser) => {
const settings = {
@@ -459,7 +455,7 @@ context('TypeScript', function () {
parser,
settings,
}),
- (source === 'typescript-declare'
+ source === 'typescript-declare'
? testVersion('> 5', () => ({
code: `import { getFoo } from "./${source}"`,
parser,
@@ -470,7 +466,7 @@ context('TypeScript', function () {
parser,
settings,
})
- ),
+ ,
test({
code: `import { MyEnum } from "./${source}"`,
parser,
diff --git a/tests/src/rules/namespace.js b/tests/src/rules/namespace.js
index 163ff163ea..d368fd3fe9 100644
--- a/tests/src/rules/namespace.js
+++ b/tests/src/rules/namespace.js
@@ -5,7 +5,6 @@ import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester({ env: { es6: true } });
const rule = require('rules/namespace');
-
function error(name, namespace) {
return { message: `'${name}' not found in imported namespace '${namespace}'.` };
}
@@ -14,13 +13,10 @@ const valid = [
test({ code: 'import "./malformed.js"' }),
test({ code: "import * as foo from './empty-folder';" }),
- test({ code: 'import * as names from "./named-exports"; ' +
- 'console.log((names.b).c); ' }),
+ test({ code: 'import * as names from "./named-exports"; console.log((names.b).c); ' }),
- test({ code: 'import * as names from "./named-exports"; ' +
- 'console.log(names.a);' }),
- test({ code: 'import * as names from "./re-export-names"; ' +
- 'console.log(names.foo);' }),
+ test({ code: 'import * as names from "./named-exports"; console.log(names.a);' }),
+ test({ code: 'import * as names from "./re-export-names"; console.log(names.foo);' }),
test({
code: "import * as elements from './jsx';",
parserOptions: {
@@ -61,26 +57,23 @@ const valid = [
test({ code: "import * as foo from './common';" }),
// destructuring namespaces
- test({ code: 'import * as names from "./named-exports";' +
- 'const { a } = names' }),
- test({ code: 'import * as names from "./named-exports";' +
- 'const { d: c } = names' }),
- test({ code: 'import * as names from "./named-exports";' +
- 'const { c } = foo\n' +
- ' , { length } = "names"\n' +
- ' , alt = names' }),
+ test({ code: 'import * as names from "./named-exports"; const { a } = names' }),
+ test({ code: 'import * as names from "./named-exports"; const { d: c } = names' }),
+ test({
+ code: `
+ import * as names from "./named-exports";
+ const { c } = foo,
+ { length } = "names",
+ alt = names;
+ `,
+ }),
// deep destructuring only cares about top level
- test({ code: 'import * as names from "./named-exports";' +
- 'const { ExportedClass: { length } } = names' }),
+ test({ code: 'import * as names from "./named-exports"; const { ExportedClass: { length } } = names' }),
// detect scope redefinition
- test({ code: 'import * as names from "./named-exports";' +
- 'function b(names) { const { c } = names }' }),
- test({ code: 'import * as names from "./named-exports";' +
- 'function b() { let names = null; const { c } = names }' }),
- test({ code: 'import * as names from "./named-exports";' +
- 'const x = function names() { const { c } = names }' }),
-
+ test({ code: 'import * as names from "./named-exports"; function b(names) { const { c } = names }' }),
+ test({ code: 'import * as names from "./named-exports"; function b() { let names = null; const { c } = names }' }),
+ test({ code: 'import * as names from "./named-exports"; const x = function names() { const { c } = names }' }),
/////////
// es7 //
@@ -101,8 +94,7 @@ const valid = [
// respect hoisting
test({
code:
- 'function x() { console.log((names.b).c); } ' +
- 'import * as names from "./named-exports"; ',
+ 'function x() { console.log((names.b).c); } import * as names from "./named-exports"; ',
}),
// names.default is valid export
@@ -241,13 +233,11 @@ const valid = [
];
const invalid = [].concat(
- test({ code: "import * as names from './named-exports'; " +
- ' console.log(names.c);',
- errors: [error('c', 'names')] }),
+ test({ code: "import * as names from './named-exports'; console.log(names.c)",
+ errors: [error('c', 'names')] }),
- test({ code: "import * as names from './named-exports';" +
- " console.log(names['a']);",
- errors: ["Unable to validate computed reference to imported namespace 'names'."] }),
+ test({ code: "import * as names from './named-exports'; console.log(names['a']);",
+ errors: ["Unable to validate computed reference to imported namespace 'names'."] }),
// assignment warning (from no-reassign)
test({ code: 'import * as foo from \'./bar\'; foo.foo = \'y\';',
@@ -269,8 +259,7 @@ const invalid = [].concat(
errors: [{ type: 'Property', message: "'c' not found in imported namespace 'names'." }],
}),
test({
- code: 'import * as names from "./named-exports";' +
- 'const { c: { d } } = names',
+ code: 'import * as names from "./named-exports"; const { c: { d } } = names',
errors: [{ type: 'Property', message: "'c' not found in imported namespace 'names'." }],
}),
@@ -300,15 +289,11 @@ const invalid = [].concat(
// respect hoisting
test({
- code:
- 'console.log(names.c);' +
- "import * as names from './named-exports'; ",
+ code: `console.log(names.c); import * as names from './named-exports';`,
errors: [error('c', 'names')],
}),
test({
- code:
- 'function x() { console.log(names.c) } ' +
- "import * as names from './named-exports'; ",
+ code: `function x() { console.log(names.c) } import * as names from './named-exports';`,
errors: [error('c', 'names')],
}),
@@ -340,12 +325,12 @@ const invalid = [].concat(
errors: [ "'e' not found in deeply imported namespace 'b.c'." ],
parserOptions: { ecmaVersion: 2022 },
})),
-)
+);
///////////////////////
// deep dereferences //
//////////////////////
-;[['deep', require.resolve('espree')], ['deep-es7', parsers.BABEL_OLD]].forEach(function ([folder, parser]) { // close over params
+[['deep', require.resolve('espree')], ['deep-es7', parsers.BABEL_OLD]].forEach(function ([folder, parser]) { // close over params
valid.push(
test({ parser, code: `import * as a from "./${folder}/a"; console.log(a.b.c.d.e)` }),
test({ parser, code: `import { b } from "./${folder}/a"; console.log(b.c.d.e)` }),
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index bf91064f85..5e14b570ee 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -6,9 +6,7 @@ import { version as tsEslintVersion } from 'typescript-eslint-parser/package.jso
import { getTSParsers, parsers, testVersion } from '../utils';
const IMPORT_ERROR_MESSAGE = 'Expected 1 empty line after import statement not followed by another import.';
-const IMPORT_ERROR_MESSAGE_MULTIPLE = (count) => {
- return `Expected ${count} empty lines after import statement not followed by another import.`;
-};
+const IMPORT_ERROR_MESSAGE_MULTIPLE = (count) => `Expected ${count} empty lines after import statement not followed by another import.`;
const REQUIRE_ERROR_MESSAGE = 'Expected 1 empty line after require statement not followed by another require.';
const ruleTester = new RuleTester();
@@ -22,7 +20,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
code: `
const x = () => require('baz')
, y = () => require('bar')`,
- parserOptions: { ecmaVersion: 6 } ,
+ parserOptions: { ecmaVersion: 6 },
},
{
code: `
@@ -31,12 +29,12 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
// some comment here
`,
- parserOptions: { ecmaVersion: 6 } ,
+ parserOptions: { ecmaVersion: 6 },
options: [{ considerComments: true }],
},
{
code: `const x = () => require('baz') && require('bar')`,
- parserOptions: { ecmaVersion: 6 } ,
+ parserOptions: { ecmaVersion: 6 },
},
{
code: `
@@ -45,8 +43,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
// Some random single line comment
var bar = 42;
`,
- parserOptions: { ecmaVersion: 6 } ,
- options: [{ 'considerComments': true }],
+ parserOptions: { ecmaVersion: 6 },
+ options: [{ considerComments: true }],
},
{
code: `
@@ -57,7 +55,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
**/
var bar = 42;
`,
- parserOptions: { ecmaVersion: 6 } ,
+ parserOptions: { ecmaVersion: 6 },
},
`function x() { require('baz'); }`,
`a(require('b'), require('c'), require('d'));`,
@@ -122,12 +120,12 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `import foo from 'foo';\n\n\nvar bar = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- options: [{ 'count': 2 }],
+ options: [{ count: 2 }],
},
{
code: `import foo from 'foo';\n\n\n\n\nvar bar = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- options: [{ 'count': 4 }],
+ options: [{ count: 4 }],
},
{
code: `var foo = require('foo-module');\n\nvar foo = 'bar';`,
@@ -136,12 +134,12 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `var foo = require('foo-module');\n\n\nvar foo = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- options: [{ 'count': 2 }],
+ options: [{ count: 2 }],
},
{
code: `var foo = require('foo-module');\n\n\n\n\nvar foo = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- options: [{ 'count': 4 }],
+ options: [{ count: 4 }],
},
{
code: `require('foo-module');\n\nvar foo = 'bar';`,
@@ -202,12 +200,12 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parser: parsers.BABEL_OLD,
},
{
- code : `// issue 1004\nimport foo from 'foo';\n\n@SomeDecorator(foo)\nexport default class Test {}`,
+ code: `// issue 1004\nimport foo from 'foo';\n\n@SomeDecorator(foo)\nexport default class Test {}`,
parserOptions: { sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
{
- code : `// issue 1004\nconst foo = require('foo');\n\n@SomeDecorator(foo)\nexport default class Test {}`,
+ code: `// issue 1004\nconst foo = require('foo');\n\n@SomeDecorator(foo)\nexport default class Test {}`,
parserOptions: { sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
@@ -296,7 +294,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
**/
var bar = 42;
`,
- parserOptions: { ecmaVersion: 2015, sourceType: 'module' } ,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `
@@ -308,8 +306,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
**/
var bar = 42;
`,
- parserOptions: { ecmaVersion: 2015, sourceType: 'module' } ,
- options: [{ 'considerComments': true }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ considerComments: true }],
},
{
code: `
@@ -319,7 +317,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
// Some random single line comment
var bar = 42;
`,
- parserOptions: { ecmaVersion: 2015, sourceType: 'module' } ,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
),
@@ -344,7 +342,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE,
} ],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- options: [{ 'considerComments': true }],
+ options: [{ considerComments: true }],
},
{
code: `
@@ -370,8 +368,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
column: 9,
message: IMPORT_ERROR_MESSAGE,
} ],
- parserOptions: { ecmaVersion: 2015, sourceType: 'module' } ,
- options: [{ 'considerComments': true }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ considerComments: true }],
},
{
code: `
@@ -391,8 +389,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
column: 9,
message: IMPORT_ERROR_MESSAGE,
} ],
- parserOptions: { ecmaVersion: 2015, sourceType: 'module' } ,
- options: [{ 'considerComments': true, 'count': 1 }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ considerComments: true, count: 1 }],
},
{
code: `import foo from 'foo';\nexport default function() {};`,
@@ -407,7 +405,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `import foo from 'foo';\n\nexport default function() {};`,
output: `import foo from 'foo';\n\n\nexport default function() {};`,
- options: [{ 'count': 2 }],
+ options: [{ count: 2 }],
errors: [ {
line: 1,
column: 1,
@@ -428,7 +426,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `import foo from 'foo';\nexport default function() {};`,
output: `import foo from 'foo';\n\nexport default function() {};`,
- options: [{ 'count': 1 }],
+ options: [{ count: 1 }],
errors: [ {
line: 1,
column: 1,
diff --git a/tests/src/rules/no-commonjs.js b/tests/src/rules/no-commonjs.js
index a2e3464ca7..baa3b907f6 100644
--- a/tests/src/rules/no-commonjs.js
+++ b/tests/src/rules/no-commonjs.js
@@ -19,12 +19,12 @@ ruleTester.run('no-commonjs', require('rules/no-commonjs'), {
{ code: 'export default "x"', parserOptions: { ecmaVersion: 2015, sourceType: 'module' } },
{ code: 'export function house() {}', parserOptions: { ecmaVersion: 2015, sourceType: 'module' } },
{
- code:
- 'function someFunc() {\n'+
- ' const exports = someComputation();\n'+
- '\n'+
- ' expect(exports.someProp).toEqual({ a: \'value\' });\n'+
- '}',
+ code: `
+ function someFunc() {
+ const exports = someComputation();
+ expect(exports.someProp).toEqual({ a: 'value' });
+ }
+ `,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
@@ -68,7 +68,7 @@ ruleTester.run('no-commonjs', require('rules/no-commonjs'), {
invalid: [
// imports
- ...(semver.satisfies(eslintPkg.version, '< 4.0.0') ? [] : [
+ ...semver.satisfies(eslintPkg.version, '< 4.0.0') ? [] : [
{ code: 'var x = require("x")', output: 'var x = require("x")', errors: [ { message: IMPORT_MESSAGE }] },
{ code: 'x = require("x")', output: 'x = require("x")', errors: [ { message: IMPORT_MESSAGE }] },
{ code: 'require("x")', output: 'require("x")', errors: [ { message: IMPORT_MESSAGE }] },
@@ -93,7 +93,7 @@ ruleTester.run('no-commonjs', require('rules/no-commonjs'), {
output: 'try { require("x") } catch (error) {}',
errors: [ { message: IMPORT_MESSAGE }],
},
- ]),
+ ],
// exports
{ code: 'exports.face = "palm"', output: 'exports.face = "palm"', errors: [ { message: EXPORT_MESSAGE }] },
diff --git a/tests/src/rules/no-cycle.js b/tests/src/rules/no-cycle.js
index 155f257b71..d2adbf61f9 100644
--- a/tests/src/rules/no-cycle.js
+++ b/tests/src/rules/no-cycle.js
@@ -6,9 +6,9 @@ import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester();
const rule = require('rules/no-cycle');
-const error = message => ({ message });
+const error = (message) => ({ message });
-const test = def => _test(Object.assign(def, {
+const test = (def) => _test(Object.assign(def, {
filename: testFilePath('./cycles/depth-zero.js'),
}));
const testVersion = (specifier, t) => _testVersion(specifier, () => Object.assign(t(), {
diff --git a/tests/src/rules/no-deprecated.js b/tests/src/rules/no-deprecated.js
index 290946735f..318ea7c368 100644
--- a/tests/src/rules/no-deprecated.js
+++ b/tests/src/rules/no-deprecated.js
@@ -38,7 +38,6 @@ ruleTester.run('no-deprecated', rule, {
code: "import { deepDep } from './deep-deprecated'; function x(deepDep) { console.log(deepDep.MY_TERRIBLE_ACTION) }",
}),
-
...SYNTAX_CASES,
],
invalid: [
@@ -210,18 +209,20 @@ describe('TypeScript', function () {
ruleTester.run(parser, rule, {
valid: [
- test(Object.assign({
+ test({
code: 'import * as hasDeprecated from \'./ts-deprecated.ts\'',
- }, parserConfig)),
+ ...parserConfig,
+ }),
],
invalid: [
- test(Object.assign({
+ test({
code: 'import { foo } from \'./ts-deprecated.ts\'; console.log(foo())',
errors: [
{ type: 'ImportSpecifier', message: 'Deprecated: don\'t use this!' },
{ type: 'Identifier', message: 'Deprecated: don\'t use this!' },
- ] },
- parserConfig)),
+ ],
+ ...parserConfig,
+ }),
],
});
});
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index ac76c3070a..33e1e632e2 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -12,7 +12,7 @@ const rule = require('rules/no-duplicates');
// autofix only possible with eslint 4+
const test = semver.satisfies(eslintPkg.version, '< 4')
- ? t => testUtil(Object.assign({}, t, { output: t.code }))
+ ? (t) => testUtil({ ...t, output: t.code })
: testUtil;
ruleTester.run('no-duplicates', rule, {
@@ -22,8 +22,7 @@ ruleTester.run('no-duplicates', rule, {
test({ code: "import { x } from './foo'; import { y } from './bar'" }),
// #86: every unresolved module should not show up as 'null' and duplicate
- test({ code: 'import foo from "234artaf";' +
- 'import { shoop } from "234q25ad"' }),
+ test({ code: 'import foo from "234artaf"; import { shoop } from "234q25ad"' }),
// #225: ignore duplicate if is a flow type import
test({
@@ -34,12 +33,12 @@ ruleTester.run('no-duplicates', rule, {
// #1107: Using different query strings that trigger different webpack loaders.
test({
code: "import x from './bar?optionX'; import y from './bar?optionY';",
- options: [{ 'considerQueryString': true }],
+ options: [{ considerQueryString: true }],
settings: { 'import/resolver': 'webpack' },
}),
test({
code: "import x from './foo'; import y from './bar';",
- options: [{ 'considerQueryString': true }],
+ options: [{ considerQueryString: true }],
settings: { 'import/resolver': 'webpack' },
}),
@@ -68,10 +67,11 @@ ruleTester.run('no-duplicates', rule, {
test({
code: "import { x } from './bar'; import { y } from 'bar';",
output: "import { x , y } from './bar'; ",
- settings: { 'import/resolve': {
- paths: [path.join( process.cwd()
- , 'tests', 'files',
- )] } },
+ settings: {
+ 'import/resolve': {
+ paths: [path.join(process.cwd(), 'tests', 'files')],
+ },
+ },
errors: 2, // path ends up hardcoded
}),
@@ -90,7 +90,7 @@ ruleTester.run('no-duplicates', rule, {
// #1107: Using same query strings that trigger the same loader.
test({
code: "import x from './bar?optionX'; import y from './bar.js?optionX';",
- options: [{ 'considerQueryString': true }],
+ options: [{ considerQueryString: true }],
settings: { 'import/resolver': 'webpack' },
errors: 2, // path ends up hardcoded
}),
@@ -132,8 +132,8 @@ ruleTester.run('no-duplicates', rule, {
}),
// These test cases use duplicate import identifiers, which causes a fatal parsing error using ESPREE (default) and TS_OLD.
- ...flatMap([parsers.BABEL_OLD, parsers.TS_NEW], parser => {
- if (!parser) return []; // TS_NEW is not always available
+ ...flatMap([parsers.BABEL_OLD, parsers.TS_NEW], (parser) => {
+ if (!parser) { return []; } // TS_NEW is not always available
return [
// #2347: duplicate identifiers should be removed
test({
diff --git a/tests/src/rules/no-dynamic-require.js b/tests/src/rules/no-dynamic-require.js
index 0b141ccd76..e316470ec8 100644
--- a/tests/src/rules/no-dynamic-require.js
+++ b/tests/src/rules/no-dynamic-require.js
@@ -30,10 +30,9 @@ ruleTester.run('no-dynamic-require', rule, {
//dynamic import
...flatMap([parsers.ESPREE, parsers.BABEL_OLD], (parser) => {
- const _test =
- parser === parsers.ESPREE
- ? (testObj) => testVersion('>= 6.2.0', () => testObj)
- : (testObj) => test(testObj);
+ const _test = parser === parsers.ESPREE
+ ? (testObj) => testVersion('>= 6.2.0', () => testObj)
+ : (testObj) => test(testObj);
return [].concat(
_test({
code: 'import("foo")',
@@ -143,10 +142,9 @@ ruleTester.run('no-dynamic-require', rule, {
// dynamic import
...flatMap([parsers.ESPREE, parsers.BABEL_OLD], (parser) => {
- const _test =
- parser === parsers.ESPREE
- ? (testObj) => testVersion('>= 6.2.0', () => testObj)
- : (testObj) => test(testObj);
+ const _test = parser === parsers.ESPREE
+ ? (testObj) => testVersion('>= 6.2.0', () => testObj)
+ : (testObj) => test(testObj);
return [].concat(
_test({
code: 'import("../" + name)',
diff --git a/tests/src/rules/no-empty-named-blocks.js b/tests/src/rules/no-empty-named-blocks.js
index 87a0a3e7c9..f65e5a2045 100644
--- a/tests/src/rules/no-empty-named-blocks.js
+++ b/tests/src/rules/no-empty-named-blocks.js
@@ -5,9 +5,8 @@ import { RuleTester } from 'eslint';
const ruleTester = new RuleTester();
const rule = require('rules/no-empty-named-blocks');
-
function generateSuggestionsTestCases(cases, parser) {
- return cases.map(code => test({
+ return cases.map((code) => test({
code,
parser,
errors: [{
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index 84aa8bb35d..6f4e710f9d 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -308,7 +308,7 @@ ruleTester.run('no-extraneous-dependencies', rule, {
code: 'import foo from "foo"',
options: [{ packageDir: packageDirWithSyntaxError }],
errors: [{
- message: 'The package.json file could not be parsed: ' + packageFileWithSyntaxErrorMessage,
+ message: `The package.json file could not be parsed: ${packageFileWithSyntaxErrorMessage}`,
}],
}),
test({
@@ -422,31 +422,29 @@ describe('TypeScript', () => {
ruleTester.run('no-extraneous-dependencies', rule, {
valid: [
- test(Object.assign({
+ test({
code: 'import type T from "a";',
options: [{ packageDir: packageDirWithTypescriptDevDependencies, devDependencies: false }],
- }, parserConfig)),
+ ...parserConfig,
+ }),
],
invalid: [
- test(Object.assign({
+ test({
code: 'import T from "a";',
options: [{ packageDir: packageDirWithTypescriptDevDependencies, devDependencies: false }],
- errors: [{
- message: "'a' should be listed in the project's dependencies, not devDependencies.",
- }],
- }, parserConfig)),
+ errors: [{ message: "'a' should be listed in the project's dependencies, not devDependencies." }],
+ ...parserConfig,
+ }),
- test(Object.assign({
- code: 'import type T from "a";',
+ test({ code: 'import type T from "a";',
options: [{
packageDir: packageDirWithTypescriptDevDependencies,
devDependencies: false,
includeTypes: true,
}],
- errors: [{
- message: "'a' should be listed in the project's dependencies, not devDependencies.",
- }],
- }, parserConfig)),
+ errors: [{ message: "'a' should be listed in the project's dependencies, not devDependencies." }],
+ ...parserConfig,
+ }),
],
});
});
diff --git a/tests/src/rules/no-import-module-exports.js b/tests/src/rules/no-import-module-exports.js
index 81faceba98..c2bf7ed132 100644
--- a/tests/src/rules/no-import-module-exports.js
+++ b/tests/src/rules/no-import-module-exports.js
@@ -9,8 +9,7 @@ const ruleTester = new RuleTester({
const rule = require('rules/no-import-module-exports');
const error = {
- message: `Cannot use import declarations in modules that export using CommonJS ` +
- `(module.exports = 'foo' or exports.bar = 'hi')`,
+ message: `Cannot use import declarations in modules that export using CommonJS (module.exports = 'foo' or exports.bar = 'hi')`,
type: 'ImportDeclaration',
};
diff --git a/tests/src/rules/no-named-as-default-member.js b/tests/src/rules/no-named-as-default-member.js
index 53cba230ba..1773176f4f 100644
--- a/tests/src/rules/no-named-as-default-member.js
+++ b/tests/src/rules/no-named-as-default-member.js
@@ -25,40 +25,28 @@ ruleTester.run('no-named-as-default-member', rule, {
test({
code: 'import bar from "./bar"; const foo = bar.foo;',
errors: [{
- message: (
- 'Caution: `bar` also has a named export `foo`. ' +
- 'Check if you meant to write `import {foo} from \'./bar\'` instead.'
- ),
+ message: 'Caution: `bar` also has a named export `foo`. Check if you meant to write `import {foo} from \'./bar\'` instead.',
type: 'MemberExpression',
}],
}),
test({
code: 'import bar from "./bar"; bar.foo();',
errors: [{
- message: (
- 'Caution: `bar` also has a named export `foo`. ' +
- 'Check if you meant to write `import {foo} from \'./bar\'` instead.'
- ),
+ message: 'Caution: `bar` also has a named export `foo`. Check if you meant to write `import {foo} from \'./bar\'` instead.',
type: 'MemberExpression',
}],
}),
test({
code: 'import bar from "./bar"; const {foo} = bar;',
errors: [{
- message: (
- 'Caution: `bar` also has a named export `foo`. ' +
- 'Check if you meant to write `import {foo} from \'./bar\'` instead.'
- ),
+ message: 'Caution: `bar` also has a named export `foo`. Check if you meant to write `import {foo} from \'./bar\'` instead.',
type: 'Identifier',
}],
}),
test({
code: 'import bar from "./bar"; const {foo: foo2, baz} = bar;',
errors: [{
- message: (
- 'Caution: `bar` also has a named export `foo`. ' +
- 'Check if you meant to write `import {foo} from \'./bar\'` instead.'
- ),
+ message: 'Caution: `bar` also has a named export `foo`. Check if you meant to write `import {foo} from \'./bar\'` instead.',
type: 'Identifier',
}],
}),
@@ -66,10 +54,7 @@ ruleTester.run('no-named-as-default-member', rule, {
testVersion('>= 8.7', () => ({
code: 'import bar from "./export-default-string-and-named"; const foo = bar.foo;',
errors: [{
- message: (
- 'Caution: `bar` also has a named export `foo`. ' +
- 'Check if you meant to write `import {foo} from \'./export-default-string-and-named\'` instead.'
- ),
+ message: 'Caution: `bar` also has a named export `foo`. Check if you meant to write `import {foo} from \'./export-default-string-and-named\'` instead.',
type: 'MemberExpression',
}],
parserOptions: { ecmaVersion: 2022 },
diff --git a/tests/src/rules/no-nodejs-modules.js b/tests/src/rules/no-nodejs-modules.js
index 9be605709a..b25eb0ce85 100644
--- a/tests/src/rules/no-nodejs-modules.js
+++ b/tests/src/rules/no-nodejs-modules.js
@@ -6,7 +6,7 @@ const isCore = require('is-core-module');
const ruleTester = new RuleTester();
const rule = require('rules/no-nodejs-modules');
-const error = message => ({
+const error = (message) => ({
message,
});
@@ -69,7 +69,7 @@ ruleTester.run('no-nodejs-modules', rule, {
allow: ['node:events'],
}],
}),
- ]: [],
+ ] : [],
isCore('node:path') ? [
test({
code: 'import path from "node:path"',
diff --git a/tests/src/rules/no-relative-parent-imports.js b/tests/src/rules/no-relative-parent-imports.js
index 3050498026..bfd4e16bcd 100644
--- a/tests/src/rules/no-relative-parent-imports.js
+++ b/tests/src/rules/no-relative-parent-imports.js
@@ -2,7 +2,7 @@ import { RuleTester } from 'eslint';
import rule from 'rules/no-relative-parent-imports';
import { parsers, test as _test, testFilePath } from '../utils';
-const test = def => _test(Object.assign(def, {
+const test = (def) => _test(Object.assign(def, {
filename: testFilePath('./internal-modules/plugins/plugin2/index.js'),
parser: parsers.BABEL_OLD,
}));
diff --git a/tests/src/rules/no-restricted-paths.js b/tests/src/rules/no-restricted-paths.js
index 81182189f2..a83a804a0a 100644
--- a/tests/src/rules/no-restricted-paths.js
+++ b/tests/src/rules/no-restricted-paths.js
@@ -713,7 +713,7 @@ ruleTester.run('no-restricted-paths', rule, {
});
context('Typescript', function () {
- getTSParsers().forEach(parser => {
+ getTSParsers().forEach((parser) => {
const settings = {
'import/parsers': { [parser]: ['.ts'] },
'import/resolver': { 'eslint-import-resolver-typescript': true },
@@ -933,8 +933,7 @@ context('Typescript', function () {
}],
}],
errors: [{
- message: 'Restricted path exceptions must be descendants of the configured ' +
- '`from` path for that zone.',
+ message: 'Restricted path exceptions must be descendants of the configured `from` path for that zone.',
line: 1,
column: 20,
}],
diff --git a/tests/src/rules/no-unassigned-import.js b/tests/src/rules/no-unassigned-import.js
index 8724b80d30..f96808cbcc 100644
--- a/tests/src/rules/no-unassigned-import.js
+++ b/tests/src/rules/no-unassigned-import.js
@@ -29,48 +29,48 @@ ruleTester.run('no-unassigned-import', rule, {
test({ code: 'require("lodash")()' }),
test({
code: 'import "app.css"',
- options: [{ 'allow': ['**/*.css'] }],
+ options: [{ allow: ['**/*.css'] }],
}),
test({
code: 'import "app.css";',
- options: [{ 'allow': ['*.css'] }],
+ options: [{ allow: ['*.css'] }],
}),
test({
code: 'import "./app.css"',
- options: [{ 'allow': ['**/*.css'] }],
+ options: [{ allow: ['**/*.css'] }],
}),
test({
code: 'import "foo/bar"',
- options: [{ 'allow': ['foo/**'] }],
+ options: [{ allow: ['foo/**'] }],
}),
test({
code: 'import "foo/bar"',
- options: [{ 'allow': ['foo/bar'] }],
+ options: [{ allow: ['foo/bar'] }],
}),
test({
code: 'import "../dir/app.css"',
- options: [{ 'allow': ['**/*.css'] }],
+ options: [{ allow: ['**/*.css'] }],
}),
test({
code: 'import "../dir/app.js"',
- options: [{ 'allow': ['**/dir/**'] }],
+ options: [{ allow: ['**/dir/**'] }],
}),
test({
code: 'require("./app.css")',
- options: [{ 'allow': ['**/*.css'] }],
+ options: [{ allow: ['**/*.css'] }],
}),
test({
code: 'import "babel-register"',
- options: [{ 'allow': ['babel-register'] }],
+ options: [{ allow: ['babel-register'] }],
}),
test({
code: 'import "./styles/app.css"',
- options: [{ 'allow': ['src/styles/**'] }],
+ options: [{ allow: ['src/styles/**'] }],
filename: path.join(process.cwd(), 'src/app.js'),
}),
test({
code: 'import "../scripts/register.js"',
- options: [{ 'allow': ['src/styles/**', '**/scripts/*.js'] }],
+ options: [{ allow: ['src/styles/**', '**/scripts/*.js'] }],
filename: path.join(process.cwd(), 'src/app.js'),
}),
],
@@ -85,22 +85,22 @@ ruleTester.run('no-unassigned-import', rule, {
}),
test({
code: 'import "./app.css"',
- options: [{ 'allow': ['**/*.js'] }],
+ options: [{ allow: ['**/*.js'] }],
errors: [error],
}),
test({
code: 'import "./app.css"',
- options: [{ 'allow': ['**/dir/**'] }],
+ options: [{ allow: ['**/dir/**'] }],
errors: [error],
}),
test({
code: 'require("./app.css")',
- options: [{ 'allow': ['**/*.js'] }],
+ options: [{ allow: ['**/*.js'] }],
errors: [error],
}),
test({
code: 'import "./styles/app.css"',
- options: [{ 'allow': ['styles/*.css'] }],
+ options: [{ allow: ['styles/*.css'] }],
filename: path.join(process.cwd(), 'src/app.js'),
errors: [error],
}),
diff --git a/tests/src/rules/no-unresolved.js b/tests/src/rules/no-unresolved.js
index 024e8965ae..109099c389 100644
--- a/tests/src/rules/no-unresolved.js
+++ b/tests/src/rules/no-unresolved.js
@@ -17,7 +17,7 @@ function runResolverTests(resolver) {
...specs,
settings: {
...specs.settings,
- 'import/resolver': resolver,
+ 'import/resolver': resolver,
'import/cache': { lifetime: 0 },
},
});
@@ -161,7 +161,7 @@ function runResolverTests(resolver) {
message: "Unable to resolve path to module './empty-folder'.",
type: 'Literal',
},
- ],
+ ],
}),
// sanity check that this module is _not_ found without proper settings
@@ -185,7 +185,7 @@ function runResolverTests(resolver) {
parser: parsers.BABEL_OLD,
}),
- rest({
+ rest({
code: 'export { foo } from "./does-not-exist"',
errors: ["Unable to resolve path to module './does-not-exist'."],
}),
@@ -359,7 +359,7 @@ ruleTester.run('no-unresolved (import/resolve legacy)', rule, {
code: "import { DEEP } from 'in-alternate-root';",
settings: {
'import/resolve': {
- 'paths': [
+ paths: [
path.join(process.cwd(), 'tests', 'files', 'alternate-root'),
],
},
@@ -373,14 +373,14 @@ ruleTester.run('no-unresolved (import/resolve legacy)', rule, {
paths: [
path.join('tests', 'files', 'src-root'),
path.join('tests', 'files', 'alternate-root'),
- ],
+ ],
},
},
}),
test({
code: 'import * as foo from "jsx-module/foo"',
- settings: { 'import/resolve': { 'extensions': ['.jsx'] } },
+ settings: { 'import/resolve': { extensions: ['.jsx'] } },
}),
],
@@ -417,7 +417,6 @@ ruleTester.run('no-unresolved (webpack-specific)', rule, {
],
});
-
ruleTester.run('no-unresolved ignore list', rule, {
valid: [
test({
@@ -440,7 +439,7 @@ ruleTester.run('no-unresolved ignore list', rule, {
}),
],
- invalid:[
+ invalid: [
test({
code: 'import "./test.gif"',
options: [{ ignore: ['.png$'] }],
@@ -458,7 +457,7 @@ ruleTester.run('no-unresolved ignore list', rule, {
ruleTester.run('no-unresolved unknown resolver', rule, {
valid: [],
- invalid:[
+ invalid: [
// logs resolver load error
test({
@@ -490,7 +489,7 @@ ruleTester.run('no-unresolved electron', rule, {
settings: { 'import/core-modules': ['electron'] },
}),
],
- invalid:[
+ invalid: [
test({
code: 'import "electron"',
errors: [`Unable to resolve path to module 'electron'.`],
@@ -500,7 +499,7 @@ ruleTester.run('no-unresolved electron', rule, {
ruleTester.run('no-unresolved syntax verification', rule, {
valid: SYNTAX_CASES,
- invalid:[],
+ invalid: [],
});
// https://github.com/import-js/eslint-plugin-import/issues/2024
@@ -522,7 +521,7 @@ ruleTester.run('import() with built-in parser', rule, {
context('TypeScript', () => {
// Type-only imports were added in TypeScript ESTree 2.23.0
- getTSParsers().filter(x => x !== parsers.TS_OLD).forEach((parser) => {
+ getTSParsers().filter((x) => x !== parsers.TS_OLD).forEach((parser) => {
ruleTester.run(`${parser}: no-unresolved ignore type-only`, rule, {
valid: [
test({
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 87714b599b..936123ab71 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -20,7 +20,7 @@ const typescriptRuleTester = new RuleTester(typescriptConfig);
const jsxRuleTester = new RuleTester(jsxConfig);
const rule = require('rules/no-unused-modules');
-const error = message => ({ message });
+const error = (message) => ({ message });
const missingExportsOptions = [{
missingExports: true,
@@ -109,7 +109,6 @@ ruleTester.run('no-unused-modules', rule, {
],
});
-
// tests for exports
ruleTester.run('no-unused-modules', rule, {
valid: [
@@ -247,7 +246,6 @@ ruleTester.run('no-unused-modules', rule, {
],
});
-
describe('dynamic imports', function () {
if (semver.satisfies(eslintPkg.version, '< 6')) {
beforeEach(function () {
@@ -817,7 +815,6 @@ describe('test behavior for new file', () => {
],
});
-
describe('test behavior for new file', () => {
before(() => {
fs.writeFileSync(testFilePath('./no-unused-modules/file-added-1.js'), '', { encoding: 'utf8' });
@@ -1382,7 +1379,7 @@ describe('supports flat eslint', { skip: !FlatRuleTester }, () => {
flatRuleTester.run('no-unused-modules', rule, {
valid: [{
options: unusedExportsOptions,
- code: 'import { o2 } from "./file-o";export default () => 12',
+ code: 'import { o2 } from "./file-o"; export default () => 12',
filename: testFilePath('./no-unused-modules/file-a.js'),
}],
invalid: [{
diff --git a/tests/src/rules/no-webpack-loader-syntax.js b/tests/src/rules/no-webpack-loader-syntax.js
index 2b841e18a3..05ad242f50 100644
--- a/tests/src/rules/no-webpack-loader-syntax.js
+++ b/tests/src/rules/no-webpack-loader-syntax.js
@@ -88,12 +88,8 @@ context('TypeScript', function () {
if (!(parser === parsers.TS_NEW && semver.satisfies(require('@typescript-eslint/parser/package.json').version, '>= 5'))) {
ruleTester.run('no-webpack-loader-syntax', rule, {
valid: [
- test(Object.assign({
- code: 'import { foo } from\nalert()',
- }, parserConfig)),
- test(Object.assign({
- code: 'import foo from\nalert()',
- }, parserConfig)),
+ test({ code: 'import { foo } from\nalert()', ...parserConfig }),
+ test({ code: 'import foo from\nalert()', ...parserConfig }),
],
invalid: [],
});
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 291dae33b0..8d0b315e71 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -7,7 +7,6 @@ import flatMap from 'array.prototype.flatmap';
import { resolve } from 'path';
import { default as babelPresetFlow } from 'babel-preset-flow';
-
const ruleTester = new RuleTester();
const flowRuleTester = new RuleTester({
parser: resolve(__dirname, '../../../node_modules/babel-eslint'),
@@ -22,7 +21,7 @@ const flowRuleTester = new RuleTester({
const rule = require('rules/order');
function withoutAutofixOutput(test) {
- return Object.assign({}, test, { output: test.code });
+ return { ...test, output: test.code };
}
ruleTester.run('order', rule, {
@@ -193,7 +192,7 @@ ruleTester.run('order', rule, {
var index = require('./');
`,
}),
- ...flatMap(getTSParsers(), parser => [
+ ...flatMap(getTSParsers(), (parser) => [
// Export equals expressions should be on top alongside with ordinary import-statements.
test({
code: `
@@ -829,7 +828,7 @@ ruleTester.run('order', rule, {
pathGroupsExcludedImportTypes: [],
}],
}),
- ...flatMap(getTSParsers, parser => [
+ ...flatMap(getTSParsers, (parser) => [
// Order of the `import ... = require(...)` syntax
test({
code: `
@@ -950,18 +949,18 @@ ruleTester.run('order', rule, {
options: [
{
'newlines-between': 'always',
- 'distinctGroup': true,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
+ distinctGroup: true,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
{
- 'pattern': 'a',
- 'group': 'external',
- 'position': 'before',
+ pattern: 'a',
+ group: 'external',
+ position: 'before',
},
{
- 'pattern': 'b',
- 'group': 'external',
- 'position': 'after',
+ pattern: 'b',
+ group: 'external',
+ position: 'after',
},
],
},
@@ -977,18 +976,18 @@ ruleTester.run('order', rule, {
options: [
{
'newlines-between': 'always',
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
{
- 'pattern': 'a',
- 'group': 'external',
- 'position': 'before',
+ pattern: 'a',
+ group: 'external',
+ position: 'before',
},
{
- 'pattern': 'b',
- 'group': 'external',
- 'position': 'after',
+ pattern: 'b',
+ group: 'external',
+ position: 'after',
},
],
},
@@ -1005,17 +1004,17 @@ ruleTester.run('order', rule, {
options: [
{
'newlines-between': 'always',
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
{
- 'pattern': 'a',
- 'group': 'external',
+ pattern: 'a',
+ group: 'external',
},
{
- 'pattern': 'b',
- 'group': 'internal',
- 'position': 'before',
+ pattern: 'b',
+ group: 'internal',
+ position: 'before',
},
],
},
@@ -1041,53 +1040,53 @@ ruleTester.run('order', rule, {
`,
options: [
{
- 'alphabetize': {
- 'caseInsensitive': false,
- 'order': 'asc',
+ alphabetize: {
+ caseInsensitive: false,
+ order: 'asc',
},
'newlines-between': 'always',
- 'groups': [
+ groups: [
['builtin', 'external', 'internal', 'unknown', 'object', 'type'],
'parent',
['sibling', 'index'],
],
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
{
- 'pattern': './',
- 'group': 'sibling',
- 'position': 'before',
+ pattern: './',
+ group: 'sibling',
+ position: 'before',
},
{
- 'pattern': '.',
- 'group': 'sibling',
- 'position': 'before',
+ pattern: '.',
+ group: 'sibling',
+ position: 'before',
},
{
- 'pattern': '..',
- 'group': 'parent',
- 'position': 'before',
+ pattern: '..',
+ group: 'parent',
+ position: 'before',
},
{
- 'pattern': '../',
- 'group': 'parent',
- 'position': 'before',
+ pattern: '../',
+ group: 'parent',
+ position: 'before',
},
{
- 'pattern': '[a-z]*',
- 'group': 'external',
- 'position': 'before',
+ pattern: '[a-z]*',
+ group: 'external',
+ position: 'before',
},
{
- 'pattern': '../[a-z]*',
- 'group': 'parent',
- 'position': 'before',
+ pattern: '../[a-z]*',
+ group: 'parent',
+ position: 'before',
},
{
- 'pattern': './[a-z]*',
- 'group': 'sibling',
- 'position': 'before',
+ pattern: './[a-z]*',
+ group: 'sibling',
+ position: 'before',
},
],
},
@@ -1101,7 +1100,7 @@ ruleTester.run('order', rule, {
`,
options: [
{
- 'alphabetize': { order: 'asc', orderImportKind: 'asc', 'caseInsensitive': true },
+ alphabetize: { order: 'asc', orderImportKind: 'asc', caseInsensitive: true },
},
],
}),
@@ -1179,12 +1178,8 @@ ruleTester.run('order', rule, {
}),
// fix order with windows end of lines
test({
- code:
- `/* comment0 */ /* comment1 */ var async = require('async'); /* comment2 */` + `\r\n` +
- `/* comment3 */ var fs = require('fs'); /* comment4 */` + `\r\n`,
- output:
- `/* comment3 */ var fs = require('fs'); /* comment4 */` + `\r\n` +
- `/* comment0 */ /* comment1 */ var async = require('async'); /* comment2 */` + `\r\n`,
+ code: `/* comment0 */ /* comment1 */ var async = require('async'); /* comment2 */` + `\r\n` + `/* comment3 */ var fs = require('fs'); /* comment4 */` + `\r\n`,
+ output: `/* comment3 */ var fs = require('fs'); /* comment4 */` + `\r\n` + `/* comment0 */ /* comment1 */ var async = require('async'); /* comment2 */` + `\r\n`,
errors: [{
message: '`fs` import should occur before import of `async`',
}],
@@ -1558,7 +1553,7 @@ ruleTester.run('order', rule, {
message: '`fs` import should occur after import of `../foo/bar`',
}],
}),
- ...flatMap(getTSParsers(), parser => [
+ ...flatMap(getTSParsers(), (parser) => [
// Order of the `import ... = require(...)` syntax
test({
code: `
@@ -2676,8 +2671,8 @@ ruleTester.run('order', rule, {
options: [
{
'newlines-between': 'always',
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
},
],
errors: [{
@@ -2698,18 +2693,18 @@ ruleTester.run('order', rule, {
options: [
{
'newlines-between': 'always',
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
{
- 'pattern': 'a',
- 'group': 'external',
- 'position': 'before',
+ pattern: 'a',
+ group: 'external',
+ position: 'before',
},
{
- 'pattern': 'c',
- 'group': 'external',
- 'position': 'after',
+ pattern: 'c',
+ group: 'external',
+ position: 'after',
},
],
},
@@ -2743,7 +2738,6 @@ ruleTester.run('order', rule, {
].filter((t) => !!t),
});
-
context('TypeScript', function () {
getNonDefaultParsers()
// Type-only imports were added in TypeScript ESTree 2.23.0
@@ -3182,7 +3176,7 @@ context('TypeScript', function () {
`,
errors: [{
message: '`fs` type import should occur before type import of `path`',
- },{
+ }, {
message: '`fs` type import should occur before type import of `path`',
}],
...parserConfig,
@@ -3303,34 +3297,34 @@ flowRuleTester.run('order', rule, {
`,
options: [
{
- 'groups': [
+ groups: [
['builtin', 'external'],
'internal',
['sibling', 'parent'],
'object',
'type',
],
- 'pathGroups': [
+ pathGroups: [
{
- 'pattern': 'react',
- 'group': 'builtin',
- 'position': 'before',
- 'patternOptions': {
- 'matchBase': true,
+ pattern: 'react',
+ group: 'builtin',
+ position: 'before',
+ patternOptions: {
+ matchBase: true,
},
},
{
- 'pattern': '*.+(css|svg)',
- 'group': 'type',
- 'position': 'after',
- 'patternOptions': {
- 'matchBase': true,
+ pattern: '*.+(css|svg)',
+ group: 'type',
+ position: 'after',
+ patternOptions: {
+ matchBase: true,
},
},
],
- 'pathGroupsExcludedImportTypes': ['react'],
- 'alphabetize': {
- 'order': 'asc',
+ pathGroupsExcludedImportTypes: ['react'],
+ alphabetize: {
+ order: 'asc',
},
'newlines-between': 'always',
},
diff --git a/tests/src/rules/prefer-default-export.js b/tests/src/rules/prefer-default-export.js
index ae7c16a40e..a7310445b5 100644
--- a/tests/src/rules/prefer-default-export.js
+++ b/tests/src/rules/prefer-default-export.js
@@ -362,15 +362,15 @@ context('TypeScript', function () {
...parserConfig,
}),
semver.satisfies(tsEslintVersion, '>= 22') ? test({
- code: 'export type foo = string /* ' + parser.replace(process.cwd(), '$$PWD') + '*/',
+ code: `export type foo = string /* ${parser.replace(process.cwd(), '$$PWD')}*/`,
...parserConfig,
}) : [],
semver.satisfies(tsEslintVersion, '> 20') ? test({
- code: 'export interface foo { bar: string; } /* ' + parser.replace(process.cwd(), '$$PWD') + '*/',
+ code: `export interface foo { bar: string; } /* ${parser.replace(process.cwd(), '$$PWD')}*/`,
...parserConfig,
}) : [],
test({
- code: 'export interface foo { bar: string; }; export function goo() {} /* ' + parser.replace(process.cwd(), '$$PWD') + '*/',
+ code: `export interface foo { bar: string; }; export function goo() {} /* ${parser.replace(process.cwd(), '$$PWD')}*/`,
...parserConfig,
}),
),
diff --git a/tests/src/utils.js b/tests/src/utils.js
index b82883a6f4..d5215b02e3 100644
--- a/tests/src/utils.js
+++ b/tests/src/utils.js
@@ -50,14 +50,15 @@ export function test(t) {
if (arguments.length !== 1) {
throw new SyntaxError('`test` requires exactly one object argument');
}
- return Object.assign({
+ return {
filename: FILENAME,
- }, t, {
- parserOptions: Object.assign({
+ ...t,
+ parserOptions: {
sourceType: 'module',
ecmaVersion: 9,
- }, t.parserOptions),
- });
+ ...t.parserOptions,
+ },
+ };
}
export function testContext(settings) {
@@ -133,5 +134,4 @@ export const SYNTAX_CASES = [
test({
code: 'import { foo } from "./ignore.invalid.extension"',
}),
-
];
diff --git a/utils/ModuleCache.js b/utils/ModuleCache.js
index a06616de9b..4b1edc0eff 100644
--- a/utils/ModuleCache.js
+++ b/utils/ModuleCache.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const log = require('debug')('eslint-module-utils:ModuleCache');
@@ -23,8 +24,10 @@ class ModuleCache {
if (this.map.has(cacheKey)) {
const f = this.map.get(cacheKey);
// check freshness
- if (process.hrtime(f.lastSeen)[0] < settings.lifetime) return f.result;
- } else log('cache miss for', cacheKey);
+ if (process.hrtime(f.lastSeen)[0] < settings.lifetime) { return f.result; }
+ } else {
+ log('cache miss for', cacheKey);
+ }
// cache miss
return undefined;
}
diff --git a/utils/declaredScope.js b/utils/declaredScope.js
index ded2131e49..dd2a20149f 100644
--- a/utils/declaredScope.js
+++ b/utils/declaredScope.js
@@ -1,9 +1,10 @@
'use strict';
+
exports.__esModule = true;
exports.default = function declaredScope(context, name) {
const references = context.getScope().references;
- const reference = references.find(x => x.identifier.name === name);
- if (!reference) return undefined;
+ const reference = references.find((x) => x.identifier.name === name);
+ if (!reference) { return undefined; }
return reference.resolved.scope.type;
};
diff --git a/utils/hash.js b/utils/hash.js
index fcf00de38c..b9bff25bd9 100644
--- a/utils/hash.js
+++ b/utils/hash.js
@@ -2,7 +2,9 @@
* utilities for hashing config objects.
* basically iteratively updates hash with a JSON-like format
*/
+
'use strict';
+
exports.__esModule = true;
const createHash = require('crypto').createHash;
@@ -10,7 +12,7 @@ const createHash = require('crypto').createHash;
const stringify = JSON.stringify;
function hashify(value, hash) {
- if (!hash) hash = createHash('sha256');
+ if (!hash) { hash = createHash('sha256'); }
if (Array.isArray(value)) {
hashArray(value, hash);
@@ -25,7 +27,7 @@ function hashify(value, hash) {
exports.default = hashify;
function hashArray(array, hash) {
- if (!hash) hash = createHash('sha256');
+ if (!hash) { hash = createHash('sha256'); }
hash.update('[');
for (let i = 0; i < array.length; i++) {
@@ -40,10 +42,10 @@ hashify.array = hashArray;
exports.hashArray = hashArray;
function hashObject(object, hash) {
- if (!hash) hash = createHash('sha256');
+ if (!hash) { hash = createHash('sha256'); }
hash.update('{');
- Object.keys(object).sort().forEach(key => {
+ Object.keys(object).sort().forEach((key) => {
hash.update(stringify(key));
hash.update(':');
hashify(object[key], hash);
@@ -56,4 +58,3 @@ function hashObject(object, hash) {
hashify.object = hashObject;
exports.hashObject = hashObject;
-
diff --git a/utils/ignore.js b/utils/ignore.js
index 32bbbc6249..e41d1e5a50 100644
--- a/utils/ignore.js
+++ b/utils/ignore.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const extname = require('path').extname;
@@ -28,7 +29,7 @@ function makeValidExtensionSet(settings) {
if (!Array.isArray(parserSettings)) {
throw new TypeError('"settings" for ' + parser + ' must be an array');
}
- parserSettings.forEach(ext => exts.add(ext));
+ parserSettings.forEach((ext) => exts.add(ext));
}
}
@@ -38,9 +39,9 @@ exports.getFileExtensions = makeValidExtensionSet;
exports.default = function ignore(path, context) {
// check extension whitelist first (cheap)
- if (!hasValidExtension(path, context)) return true;
+ if (!hasValidExtension(path, context)) { return true; }
- if (!('import/ignore' in context.settings)) return false;
+ if (!('import/ignore' in context.settings)) { return false; }
const ignoreStrings = context.settings['import/ignore'];
for (let i = 0; i < ignoreStrings.length; i++) {
diff --git a/utils/module-require.js b/utils/module-require.js
index c03671ce5a..96ef82ba51 100644
--- a/utils/module-require.js
+++ b/utils/module-require.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const Module = require('module');
diff --git a/utils/moduleVisitor.js b/utils/moduleVisitor.js
index 4d93a0199b..c312ca2d45 100644
--- a/utils/moduleVisitor.js
+++ b/utils/moduleVisitor.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
/**
@@ -16,14 +17,14 @@ exports.default = function visitModules(visitor, options) {
let ignoreRegExps = [];
if (options.ignore != null) {
- ignoreRegExps = options.ignore.map(p => new RegExp(p));
+ ignoreRegExps = options.ignore.map((p) => new RegExp(p));
}
function checkSourceValue(source, importer) {
- if (source == null) return; //?
+ if (source == null) { return; } //?
// handle ignore
- if (ignoreRegExps.some(re => re.test(source.value))) return;
+ if (ignoreRegExps.some((re) => re.test(source.value))) { return; }
// fire visitor
visitor(source, importer);
@@ -41,14 +42,14 @@ exports.default = function visitModules(visitor, options) {
if (node.type === 'ImportExpression') {
modulePath = node.source;
} else if (node.type === 'CallExpression') {
- if (node.callee.type !== 'Import') return;
- if (node.arguments.length !== 1) return;
+ if (node.callee.type !== 'Import') { return; }
+ if (node.arguments.length !== 1) { return; }
modulePath = node.arguments[0];
}
- if (modulePath.type !== 'Literal') return;
- if (typeof modulePath.value !== 'string') return;
+ if (modulePath.type !== 'Literal') { return; }
+ if (typeof modulePath.value !== 'string') { return; }
checkSourceValue(modulePath, node);
}
@@ -56,32 +57,35 @@ exports.default = function visitModules(visitor, options) {
// for CommonJS `require` calls
// adapted from @mctep: https://git.io/v4rAu
function checkCommon(call) {
- if (call.callee.type !== 'Identifier') return;
- if (call.callee.name !== 'require') return;
- if (call.arguments.length !== 1) return;
+ if (call.callee.type !== 'Identifier') { return; }
+ if (call.callee.name !== 'require') { return; }
+ if (call.arguments.length !== 1) { return; }
const modulePath = call.arguments[0];
- if (modulePath.type !== 'Literal') return;
- if (typeof modulePath.value !== 'string') return;
+ if (modulePath.type !== 'Literal') { return; }
+ if (typeof modulePath.value !== 'string') { return; }
checkSourceValue(modulePath, call);
}
function checkAMD(call) {
- if (call.callee.type !== 'Identifier') return;
- if (call.callee.name !== 'require' &&
- call.callee.name !== 'define') return;
- if (call.arguments.length !== 2) return;
+ if (call.callee.type !== 'Identifier') { return; }
+ if (call.callee.name !== 'require' && call.callee.name !== 'define') { return; }
+ if (call.arguments.length !== 2) { return; }
const modules = call.arguments[0];
- if (modules.type !== 'ArrayExpression') return;
+ if (modules.type !== 'ArrayExpression') { return; }
for (const element of modules.elements) {
- if (element.type !== 'Literal') continue;
- if (typeof element.value !== 'string') continue;
+ if (element.type !== 'Literal') { continue; }
+ if (typeof element.value !== 'string') { continue; }
- if (element.value === 'require' ||
- element.value === 'exports') continue; // magic modules: https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#magic-modules
+ if (
+ element.value === 'require'
+ || element.value === 'exports'
+ ) {
+ continue; // magic modules: https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#magic-modules
+ }
checkSourceValue(element, element);
}
@@ -90,20 +94,20 @@ exports.default = function visitModules(visitor, options) {
const visitors = {};
if (options.esmodule) {
Object.assign(visitors, {
- 'ImportDeclaration': checkSource,
- 'ExportNamedDeclaration': checkSource,
- 'ExportAllDeclaration': checkSource,
- 'CallExpression': checkImportCall,
- 'ImportExpression': checkImportCall,
+ ImportDeclaration: checkSource,
+ ExportNamedDeclaration: checkSource,
+ ExportAllDeclaration: checkSource,
+ CallExpression: checkImportCall,
+ ImportExpression: checkImportCall,
});
}
if (options.commonjs || options.amd) {
- const currentCallExpression = visitors['CallExpression'];
- visitors['CallExpression'] = function (call) {
- if (currentCallExpression) currentCallExpression(call);
- if (options.commonjs) checkCommon(call);
- if (options.amd) checkAMD(call);
+ const currentCallExpression = visitors.CallExpression;
+ visitors.CallExpression = function (call) {
+ if (currentCallExpression) { currentCallExpression(call); }
+ if (options.commonjs) { checkCommon(call); }
+ if (options.amd) { checkAMD(call); }
};
}
@@ -116,19 +120,19 @@ exports.default = function visitModules(visitor, options) {
*/
function makeOptionsSchema(additionalProperties) {
const base = {
- 'type': 'object',
- 'properties': {
- 'commonjs': { 'type': 'boolean' },
- 'amd': { 'type': 'boolean' },
- 'esmodule': { 'type': 'boolean' },
- 'ignore': {
- 'type': 'array',
- 'minItems': 1,
- 'items': { 'type': 'string' },
- 'uniqueItems': true,
+ type: 'object',
+ properties: {
+ commonjs: { type: 'boolean' },
+ amd: { type: 'boolean' },
+ esmodule: { type: 'boolean' },
+ ignore: {
+ type: 'array',
+ minItems: 1,
+ items: { type: 'string' },
+ uniqueItems: true,
},
},
- 'additionalProperties': false,
+ additionalProperties: false,
};
if (additionalProperties) {
diff --git a/utils/parse.js b/utils/parse.js
index dd0746aaa7..7646b3177c 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const moduleRequire = require('./module-require').default;
@@ -23,10 +24,10 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
if (parsedResult && parsedResult.visitorKeys) {
return parsedResult.visitorKeys;
}
- if (typeof parserPath === 'string' && /.*espree.*/.test(parserPath)) {
+ if (typeof parserPath === 'string' && (/.*espree.*/).test(parserPath)) {
return parserInstance.VisitorKeys;
}
- if (typeof parserPath === 'string' && /.*babel-eslint.*/.test(parserPath)) {
+ if (typeof parserPath === 'string' && (/.*babel-eslint.*/).test(parserPath)) {
return getBabelEslintVisitorKeys(parserPath);
}
return null;
@@ -51,13 +52,13 @@ function transformHashbang(text) {
}
exports.default = function parse(path, content, context) {
- if (context == null) throw new Error('need context to parse properly');
+ if (context == null) { throw new Error('need context to parse properly'); }
// ESLint in "flat" mode only sets context.languageOptions.parserOptions
- let parserOptions = (context.languageOptions && context.languageOptions.parserOptions) || context.parserOptions;
+ let parserOptions = context.languageOptions && context.languageOptions.parserOptions || context.parserOptions;
const parserOrPath = getParser(path, context);
- if (!parserOrPath) throw new Error('parserPath or languageOptions.parser is required!');
+ if (!parserOrPath) { throw new Error('parserPath or languageOptions.parser is required!'); }
// hack: espree blows up with frozen options
parserOptions = Object.assign({}, parserOptions);
@@ -103,9 +104,8 @@ exports.default = function parse(path, content, context) {
}
if (!ast || typeof ast !== 'object') {
console.warn(
- '`parseForESLint` from parser `' +
- (typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`') + // Can only be invalid for custom parser per imports/parser
- '` is invalid and will just be ignored'
+ // Can only be invalid for custom parser per imports/parser
+ '`parseForESLint` from parser `' + (typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`') + '` is invalid and will just be ignored'
);
} else {
return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
diff --git a/utils/pkgUp.js b/utils/pkgUp.js
index 049869719b..889f62265f 100644
--- a/utils/pkgUp.js
+++ b/utils/pkgUp.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const fs = require('fs');
@@ -6,22 +7,22 @@ const path = require('path');
/**
* Derived significantly from package find-up@2.0.0. See license below.
- *
+ *
* @copyright Sindre Sorhus
* MIT License
*
* Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
- *
+ *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
- *
+ *
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
- *
+ *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
diff --git a/utils/readPkgUp.js b/utils/readPkgUp.js
index 6a6a1eea3e..d34fa6c818 100644
--- a/utils/readPkgUp.js
+++ b/utils/readPkgUp.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const fs = require('fs');
@@ -10,22 +11,22 @@ function stripBOM(str) {
/**
* Derived significantly from read-pkg-up@2.0.0. See license below.
- *
+ *
* @copyright Sindre Sorhus
* MIT License
*
* Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
- *
+ *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
- *
+ *
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
- *
+ *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
diff --git a/utils/resolve.js b/utils/resolve.js
index 9d9dfa8439..0ed5bdb0c9 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const fs = require('fs');
@@ -53,16 +54,16 @@ function tryRequire(target, sourceFile) {
// https://stackoverflow.com/a/27382838
exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cacheSettings, strict) {
// don't care if the FS is case-sensitive
- if (CASE_SENSITIVE_FS) return true;
+ if (CASE_SENSITIVE_FS) { return true; }
// null means it resolved to a builtin
- if (filepath === null) return true;
- if (filepath.toLowerCase() === process.cwd().toLowerCase() && !strict) return true;
+ if (filepath === null) { return true; }
+ if (filepath.toLowerCase() === process.cwd().toLowerCase() && !strict) { return true; }
const parsedPath = path.parse(filepath);
const dir = parsedPath.dir;
let result = fileExistsCache.get(filepath, cacheSettings);
- if (result != null) return result;
+ if (result != null) { return result; }
// base case
if (dir === '' || parsedPath.root === filepath) {
@@ -88,7 +89,7 @@ let memoizedHash = '';
function fullResolve(modulePath, sourceFile, settings) {
// check if this is a bonus core module
const coreSet = new Set(settings['import/core-modules']);
- if (coreSet.has(modulePath)) return { found: true, path: null };
+ if (coreSet.has(modulePath)) { return { found: true, path: null }; }
const sourceDir = path.dirname(sourceFile);
@@ -102,40 +103,28 @@ function fullResolve(modulePath, sourceFile, settings) {
const cacheSettings = ModuleCache.getSettings(settings);
const cachedPath = fileExistsCache.get(cacheKey, cacheSettings);
- if (cachedPath !== undefined) return { found: true, path: cachedPath };
+ if (cachedPath !== undefined) { return { found: true, path: cachedPath }; }
function cache(resolvedPath) {
fileExistsCache.set(cacheKey, resolvedPath);
}
function withResolver(resolver, config) {
-
- function v1() {
- try {
- const resolved = resolver.resolveImport(modulePath, sourceFile, config);
- if (resolved === undefined) return { found: false };
- return { found: true, path: resolved };
- } catch (err) {
- return { found: false };
- }
- }
-
- function v2() {
+ if (resolver.interfaceVersion === 2) {
return resolver.resolve(modulePath, sourceFile, config);
}
- switch (resolver.interfaceVersion) {
- case 2:
- return v2();
-
- default:
- case 1:
- return v1();
+ try {
+ const resolved = resolver.resolveImport(modulePath, sourceFile, config);
+ if (resolved === undefined) { return { found: false }; }
+ return { found: true, path: resolved };
+ } catch (err) {
+ return { found: false };
}
}
- const configResolvers = (settings['import/resolver']
- || { 'node': settings['import/resolve'] }); // backward compatibility
+ const configResolvers = settings['import/resolver']
+ || { node: settings['import/resolve'] }; // backward compatibility
const resolvers = resolverReducer(configResolvers, new Map());
@@ -145,7 +134,7 @@ function fullResolve(modulePath, sourceFile, settings) {
const resolver = requireResolver(name, sourceFile);
const resolved = withResolver(resolver, config);
- if (!resolved.found) continue;
+ if (!resolved.found) { continue; }
// else, counts
cache(resolved.path);
@@ -160,7 +149,7 @@ exports.relative = relative;
function resolverReducer(resolvers, map) {
if (Array.isArray(resolvers)) {
- resolvers.forEach(r => resolverReducer(r, map));
+ resolvers.forEach((r) => resolverReducer(r, map));
return map;
}
@@ -186,9 +175,9 @@ function getBaseDir(sourceFile) {
}
function requireResolver(name, sourceFile) {
// Try to resolve package with conventional name
- const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile) ||
- tryRequire(name, sourceFile) ||
- tryRequire(path.resolve(getBaseDir(sourceFile), name));
+ const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile)
+ || tryRequire(name, sourceFile)
+ || tryRequire(path.resolve(getBaseDir(sourceFile), name));
if (!resolver) {
const err = new Error(`unable to load resolver "${name}".`);
diff --git a/utils/unambiguous.js b/utils/unambiguous.js
index 75f21693b7..24cb123157 100644
--- a/utils/unambiguous.js
+++ b/utils/unambiguous.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
const pattern = /(^|;)\s*(export|import)((\s+\w)|(\s*[{*=]))|import\(/m;
@@ -25,5 +26,5 @@ const unambiguousNodeType = /^(?:(?:Exp|Imp)ort.*Declaration|TSExportAssignment)
* @return {Boolean}
*/
exports.isModule = function isUnambiguousModule(ast) {
- return ast.body && ast.body.some(node => unambiguousNodeType.test(node.type));
+ return ast.body && ast.body.some((node) => unambiguousNodeType.test(node.type));
};
diff --git a/utils/visit.js b/utils/visit.js
index 77b09850ae..6178faeaa0 100644
--- a/utils/visit.js
+++ b/utils/visit.js
@@ -1,4 +1,5 @@
'use strict';
+
exports.__esModule = true;
exports.default = function visit(node, keys, visitorSpec) {
From 7e9f651625ac6835ec73f21490ecd68eebac100b Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 13 Apr 2023 16:41:18 -0700
Subject: [PATCH 012/199] [resolvers] [*] [deps] update `is-core-module`,
`resolve`
---
resolvers/node/package.json | 4 ++--
resolvers/webpack/package.json | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
index d13b48635f..c63ee976b6 100644
--- a/resolvers/node/package.json
+++ b/resolvers/node/package.json
@@ -30,8 +30,8 @@
"homepage": "https://github.com/import-js/eslint-plugin-import",
"dependencies": {
"debug": "^3.2.7",
- "is-core-module": "^2.11.0",
- "resolve": "^1.22.1"
+ "is-core-module": "^2.12.0",
+ "resolve": "^1.22.2"
},
"devDependencies": {
"chai": "^3.5.0",
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 42d5e7470e..ba21801e61 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -36,10 +36,10 @@
"find-root": "^1.1.0",
"has": "^1.0.3",
"interpret": "^1.4.0",
- "is-core-module": "^2.11.0",
+ "is-core-module": "^2.12.0",
"is-regex": "^1.1.4",
"lodash": "^4.17.21",
- "resolve": "^1.22.1",
+ "resolve": "^1.22.2",
"semver": "^5.7.1"
},
"peerDependencies": {
From a89eadf3247af844da6b0f9e7bca7690777bf665 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 13 Apr 2023 16:44:24 -0700
Subject: [PATCH 013/199] [deps] update `is-core-module`, `resolve`
---
package.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/package.json b/package.json
index 3733e2d76f..013422c71e 100644
--- a/package.json
+++ b/package.json
@@ -108,11 +108,11 @@
"eslint-import-resolver-node": "^0.3.7",
"eslint-module-utils": "^2.7.4",
"has": "^1.0.3",
- "is-core-module": "^2.11.0",
+ "is-core-module": "^2.12.0",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.values": "^1.1.6",
- "resolve": "^1.22.1",
+ "resolve": "^1.22.2",
"semver": "^6.3.0",
"tsconfig-paths": "^3.14.2"
}
From 1fa29717518732e3143aaf8155713133c383bf3c Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 11:48:48 -0700
Subject: [PATCH 014/199] [Fix] `order`: partial fix for #2687
---
src/rules/order.js | 12 +++---
tests/src/core/importType.js | 4 ++
tests/src/rules/order.js | 73 +++++++++++++++++++++++++++++++++---
3 files changed, 79 insertions(+), 10 deletions(-)
diff --git a/src/rules/order.js b/src/rules/order.js
index 5921989d2b..27c3f4b0f9 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -253,6 +253,7 @@ function makeOutOfOrderReport(context, imported) {
if (!outOfOrder.length) {
return;
}
+
// There are things to report. Try to minimize the number of reported errors.
const reversedImported = reverse(imported);
const reversedOrder = findOutOfOrder(reversedImported);
@@ -426,11 +427,12 @@ const types = ['builtin', 'external', 'internal', 'unknown', 'parent', 'sibling'
// Example: { index: 0, sibling: 1, parent: 1, external: 1, builtin: 2, internal: 2 }
// Will throw an error if it contains a type that does not exist, or has a duplicate
function convertGroupsToRanks(groups) {
+ if (groups.length === 1) {
+ // TODO: remove this `if` and fix the bug
+ return convertGroupsToRanks(groups[0]);
+ }
const rankObject = groups.reduce(function (res, group, index) {
- if (typeof group === 'string') {
- group = [group];
- }
- group.forEach(function (groupItem) {
+ [].concat(group).forEach(function (groupItem) {
if (types.indexOf(groupItem) === -1) {
throw new Error(`Incorrect configuration of the rule: Unknown type \`${JSON.stringify(groupItem)}\``);
}
@@ -443,7 +445,7 @@ function convertGroupsToRanks(groups) {
}, {});
const omittedTypes = types.filter(function (type) {
- return rankObject[type] === undefined;
+ return typeof rankObject[type] === 'undefined';
});
const ranks = omittedTypes.reduce(function (res, type) {
diff --git a/tests/src/core/importType.js b/tests/src/core/importType.js
index 937f193033..bdc93d8a3e 100644
--- a/tests/src/core/importType.js
+++ b/tests/src/core/importType.js
@@ -17,7 +17,11 @@ describe('importType(name)', function () {
it("should return 'builtin' for node.js modules", function () {
expect(importType('fs', context)).to.equal('builtin');
+ expect(importType('node:fs', context)).to.equal('builtin');
+ expect(importType('fs/promises', context)).to.equal('builtin');
+ expect(importType('node:fs/promises', context)).to.equal('builtin');
expect(importType('path', context)).to.equal('builtin');
+ expect(importType('node:path', context)).to.equal('builtin');
});
it("should return 'external' for non-builtin modules without a relative path", function () {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 8d0b315e71..e7a9cb9c9b 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -3174,11 +3174,10 @@ context('TypeScript', function () {
import type { ParsedPath } from 'path';
}
`,
- errors: [{
- message: '`fs` type import should occur before type import of `path`',
- }, {
- message: '`fs` type import should occur before type import of `path`',
- }],
+ errors: [
+ { message: '`fs` type import should occur before type import of `path`' },
+ { message: '`fs` type import should occur before type import of `path`' },
+ ],
...parserConfig,
options: [
{
@@ -3186,6 +3185,70 @@ context('TypeScript', function () {
},
],
}),
+
+ test({
+ code: `
+ import express from 'express';
+ import log4js from 'log4js';
+ import chpro from 'node:child_process';
+ // import fsp from 'node:fs/promises';
+ `,
+ output: `
+ import chpro from 'node:child_process';
+ import express from 'express';
+ import log4js from 'log4js';
+ // import fsp from 'node:fs/promises';
+ `,
+ options: [{
+ groups: [
+ 'builtin',
+ 'external',
+ 'internal',
+ 'parent',
+ 'sibling',
+ 'index',
+ 'object',
+ 'type',
+ ],
+ }],
+ errors: [
+ { message: '`node:child_process` import should occur before import of `express`' },
+ // { message: '`node:fs/promises` import should occur before import of `express`' },
+ ],
+ }),
+
+ test({
+ code: `
+ import express from 'express';
+ import log4js from 'log4js';
+ import chpro from 'node:child_process';
+ // import fsp from 'node:fs/promises';
+ `,
+ output: `
+ import chpro from 'node:child_process';
+ import express from 'express';
+ import log4js from 'log4js';
+ // import fsp from 'node:fs/promises';
+ `,
+ options: [{
+ groups: [
+ [
+ 'builtin',
+ 'external',
+ 'internal',
+ 'parent',
+ 'sibling',
+ 'index',
+ 'object',
+ 'type',
+ ],
+ ],
+ }],
+ errors: [
+ { message: '`node:child_process` import should occur before import of `express`' },
+ // { message: '`node:fs/promises` import should occur before import of `express`' },
+ ],
+ }),
],
});
});
From ef094f2031dcb219e3aae1a9b508d8d49fd2489f Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 11:50:25 -0700
Subject: [PATCH 015/199] [meta] add missing CHANGELOG entry
---
CHANGELOG.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index fe7f6771b8..8a8ec36692 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
+* [`order`]: partial fix for [#2687] (thanks [@ljharb])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1397,6 +1398,7 @@ for info on changes for earlier releases.
[#211]: https://github.com/import-js/eslint-plugin-import/pull/211
[#164]: https://github.com/import-js/eslint-plugin-import/pull/164
[#157]: https://github.com/import-js/eslint-plugin-import/pull/157
+[#2687]: https://github.com/import-js/eslint-plugin-import/issues/2687
[#2684]: https://github.com/import-js/eslint-plugin-import/issues/2684
[#2674]: https://github.com/import-js/eslint-plugin-import/issues/2674
[#2668]: https://github.com/import-js/eslint-plugin-import/issues/2668
From 261ee3aa7666edb0131e08db3d3d3428b013df42 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 11:51:58 -0700
Subject: [PATCH 016/199] [Deps] update `resolve`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 013422c71e..a0fdc66100 100644
--- a/package.json
+++ b/package.json
@@ -112,7 +112,7 @@
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.values": "^1.1.6",
- "resolve": "^1.22.2",
+ "resolve": "^1.22.3",
"semver": "^6.3.0",
"tsconfig-paths": "^3.14.2"
}
From 4c6fa3e1e47198eb448690c1c5ef486c162e6c00 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 11:58:36 -0700
Subject: [PATCH 017/199] [Tests] fix tests for older nodes
---
tests/src/core/importType.js | 13 ++--
tests/src/rules/order.js | 113 ++++++++++++++++++-----------------
2 files changed, 65 insertions(+), 61 deletions(-)
diff --git a/tests/src/core/importType.js b/tests/src/core/importType.js
index bdc93d8a3e..c4dca866e2 100644
--- a/tests/src/core/importType.js
+++ b/tests/src/core/importType.js
@@ -1,5 +1,6 @@
import { expect } from 'chai';
import * as path from 'path';
+import isCoreModule from 'is-core-module';
import importType, { isExternalModule, isScoped, isAbsolute } from 'core/importType';
@@ -16,12 +17,12 @@ describe('importType(name)', function () {
});
it("should return 'builtin' for node.js modules", function () {
- expect(importType('fs', context)).to.equal('builtin');
- expect(importType('node:fs', context)).to.equal('builtin');
- expect(importType('fs/promises', context)).to.equal('builtin');
- expect(importType('node:fs/promises', context)).to.equal('builtin');
- expect(importType('path', context)).to.equal('builtin');
- expect(importType('node:path', context)).to.equal('builtin');
+ ['fs', 'fs/promises', 'path'].filter((x) => isCoreModule(x)).forEach((x) => {
+ expect(importType(x, context)).to.equal('builtin');
+ if (isCoreModule(`node:${x}`)) {
+ expect(importType(`node:${x}`, context)).to.equal('builtin');
+ }
+ });
});
it("should return 'external' for non-builtin modules without a relative path", function () {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index e7a9cb9c9b..84b341e1b0 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -5,6 +5,7 @@ import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
import { resolve } from 'path';
+import isCoreModule from 'is-core-module';
import { default as babelPresetFlow } from 'babel-preset-flow';
const ruleTester = new RuleTester();
@@ -2962,7 +2963,7 @@ context('TypeScript', function () {
],
}),
],
- invalid: [
+ invalid: [].concat(
// Option alphabetize: {order: 'asc'}
test({
code: `
@@ -3186,53 +3187,22 @@ context('TypeScript', function () {
],
}),
- test({
- code: `
- import express from 'express';
- import log4js from 'log4js';
- import chpro from 'node:child_process';
- // import fsp from 'node:fs/promises';
- `,
- output: `
- import chpro from 'node:child_process';
- import express from 'express';
- import log4js from 'log4js';
- // import fsp from 'node:fs/promises';
- `,
- options: [{
- groups: [
- 'builtin',
- 'external',
- 'internal',
- 'parent',
- 'sibling',
- 'index',
- 'object',
- 'type',
- ],
- }],
- errors: [
- { message: '`node:child_process` import should occur before import of `express`' },
- // { message: '`node:fs/promises` import should occur before import of `express`' },
- ],
- }),
-
- test({
- code: `
- import express from 'express';
- import log4js from 'log4js';
- import chpro from 'node:child_process';
- // import fsp from 'node:fs/promises';
- `,
- output: `
- import chpro from 'node:child_process';
- import express from 'express';
- import log4js from 'log4js';
- // import fsp from 'node:fs/promises';
- `,
- options: [{
- groups: [
- [
+ isCoreModule('node:child_process') && isCoreModule('node:fs/promises') ? [
+ test({
+ code: `
+ import express from 'express';
+ import log4js from 'log4js';
+ import chpro from 'node:child_process';
+ // import fsp from 'node:fs/promises';
+ `,
+ output: `
+ import chpro from 'node:child_process';
+ import express from 'express';
+ import log4js from 'log4js';
+ // import fsp from 'node:fs/promises';
+ `,
+ options: [{
+ groups: [
'builtin',
'external',
'internal',
@@ -3242,14 +3212,47 @@ context('TypeScript', function () {
'object',
'type',
],
+ }],
+ errors: [
+ { message: '`node:child_process` import should occur before import of `express`' },
+ // { message: '`node:fs/promises` import should occur before import of `express`' },
],
- }],
- errors: [
- { message: '`node:child_process` import should occur before import of `express`' },
- // { message: '`node:fs/promises` import should occur before import of `express`' },
- ],
- }),
- ],
+ }),
+
+ test({
+ code: `
+ import express from 'express';
+ import log4js from 'log4js';
+ import chpro from 'node:child_process';
+ // import fsp from 'node:fs/promises';
+ `,
+ output: `
+ import chpro from 'node:child_process';
+ import express from 'express';
+ import log4js from 'log4js';
+ // import fsp from 'node:fs/promises';
+ `,
+ options: [{
+ groups: [
+ [
+ 'builtin',
+ 'external',
+ 'internal',
+ 'parent',
+ 'sibling',
+ 'index',
+ 'object',
+ 'type',
+ ],
+ ],
+ }],
+ errors: [
+ { message: '`node:child_process` import should occur before import of `express`' },
+ // { message: '`node:fs/promises` import should occur before import of `express`' },
+ ],
+ }),
+ ] : [],
+ ),
});
});
});
From 463ce199da3002cbf49d56917085bed94b5a43de Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 12:03:43 -0700
Subject: [PATCH 018/199] [utils] v2.8.0
---
utils/CHANGELOG.md | 9 ++++++++-
utils/package.json | 2 +-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 7d2057dec2..ae3588a390 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,11 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.8.0 - 2023-04-14
+
+### New
+- `parse`: support flat config ([#2714], thanks [@DMartens])
+
### Fixed
- Improve performance of `fullResolve` for large projects ([#2755], thanks [@leipert])
@@ -19,7 +24,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## v2.7.3 - 2022-01-26
### Fixed
-- [Fix] `parse`: restore compatibility by making the return value `ast` again ([#2350], thanks [@ljharb])
+- `parse`: restore compatibility by making the return value `ast` again ([#2350], thanks [@ljharb])
## v2.7.2 - 2022-01-01
@@ -127,6 +132,7 @@ Yanked due to critical issue with cache key resulting from #839.
- `unambiguous.test()` regex is now properly in multiline mode
[#2755]: https://github.com/import-js/eslint-plugin-import/pull/2755
+[#2714]: https://github.com/import-js/eslint-plugin-import/pull/2714
[#2523]: https://github.com/import-js/eslint-plugin-import/pull/2523
[#2431]: https://github.com/import-js/eslint-plugin-import/pull/2431
[#2350]: https://github.com/import-js/eslint-plugin-import/issues/2350
@@ -159,6 +165,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@bradzacher]: https://github.com/bradzacher
[@brettz9]: https://github.com/brettz9
[@christophercurrie]: https://github.com/christophercurrie
+[@DMartens]: https://github.com/DMartens
[@hulkish]: https://github.com/hulkish
[@Hypnosphi]: https://github.com/Hypnosphi
[@iamnapo]: https://github.com/iamnapo
diff --git a/utils/package.json b/utils/package.json
index 0c0678a5ec..d56c442b1a 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.7.4",
+ "version": "2.8.0",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From 683d3a5927adf97a1654cfb4d9d3caf148e1eb8a Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 14 Apr 2023 13:02:33 -0700
Subject: [PATCH 019/199] [Deps] update `eslint-module-utils`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index a0fdc66100..59ab24c57b 100644
--- a/package.json
+++ b/package.json
@@ -106,7 +106,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.7",
- "eslint-module-utils": "^2.7.4",
+ "eslint-module-utils": "^2.8.0",
"has": "^1.0.3",
"is-core-module": "^2.12.0",
"is-glob": "^4.0.3",
From eaa1591c47679b3523696bca346d997b9598b508 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 17 Apr 2023 13:58:40 -0700
Subject: [PATCH 020/199] [Tests] switch some files to unix line endings
---
tests/files/foo-bar-resolver-no-version.js | 24 +++++++++----------
tests/files/foo-bar-resolver-v1.js | 28 +++++++++++-----------
tests/files/foo-bar-resolver-v2.js | 28 +++++++++++-----------
3 files changed, 40 insertions(+), 40 deletions(-)
diff --git a/tests/files/foo-bar-resolver-no-version.js b/tests/files/foo-bar-resolver-no-version.js
index f00198562e..2a2d451850 100644
--- a/tests/files/foo-bar-resolver-no-version.js
+++ b/tests/files/foo-bar-resolver-no-version.js
@@ -1,12 +1,12 @@
-var path = require('path')
-
-exports.resolveImport = function (modulePath, sourceFile, config) {
- var sourceFileName = path.basename(sourceFile)
- if (sourceFileName === 'foo.js') {
- return path.join(__dirname, 'bar.jsx')
- }
- if (sourceFileName === 'exception.js') {
- throw new Error('foo-bar-resolver-v1 resolveImport test exception')
- }
- return undefined;
-}
+var path = require('path')
+
+exports.resolveImport = function (modulePath, sourceFile, config) {
+ var sourceFileName = path.basename(sourceFile)
+ if (sourceFileName === 'foo.js') {
+ return path.join(__dirname, 'bar.jsx')
+ }
+ if (sourceFileName === 'exception.js') {
+ throw new Error('foo-bar-resolver-v1 resolveImport test exception')
+ }
+ return undefined;
+}
diff --git a/tests/files/foo-bar-resolver-v1.js b/tests/files/foo-bar-resolver-v1.js
index af9da1b7a6..7ba97cb55f 100644
--- a/tests/files/foo-bar-resolver-v1.js
+++ b/tests/files/foo-bar-resolver-v1.js
@@ -1,14 +1,14 @@
-var path = require('path')
-
-exports.resolveImport = function (modulePath, sourceFile, config) {
- var sourceFileName = path.basename(sourceFile)
- if (sourceFileName === 'foo.js') {
- return path.join(__dirname, 'bar.jsx');
- }
- if (sourceFileName === 'exception.js') {
- throw new Error('foo-bar-resolver-v1 resolveImport test exception');
- }
- return undefined;
-};
-
-exports.interfaceVersion = 1;
+var path = require('path')
+
+exports.resolveImport = function (modulePath, sourceFile, config) {
+ var sourceFileName = path.basename(sourceFile)
+ if (sourceFileName === 'foo.js') {
+ return path.join(__dirname, 'bar.jsx');
+ }
+ if (sourceFileName === 'exception.js') {
+ throw new Error('foo-bar-resolver-v1 resolveImport test exception');
+ }
+ return undefined;
+};
+
+exports.interfaceVersion = 1;
diff --git a/tests/files/foo-bar-resolver-v2.js b/tests/files/foo-bar-resolver-v2.js
index 7f8bcc0f86..13135e3925 100644
--- a/tests/files/foo-bar-resolver-v2.js
+++ b/tests/files/foo-bar-resolver-v2.js
@@ -1,14 +1,14 @@
-var path = require('path')
-
-exports.resolve = function (modulePath, sourceFile, config) {
- var sourceFileName = path.basename(sourceFile)
- if (sourceFileName === 'foo.js') {
- return { found: true, path: path.join(__dirname, 'bar.jsx') }
- }
- if (sourceFileName === 'exception.js') {
- throw new Error('foo-bar-resolver-v2 resolve test exception')
- }
- return { found: false };
-};
-
-exports.interfaceVersion = 2;
+var path = require('path')
+
+exports.resolve = function (modulePath, sourceFile, config) {
+ var sourceFileName = path.basename(sourceFile)
+ if (sourceFileName === 'foo.js') {
+ return { found: true, path: path.join(__dirname, 'bar.jsx') }
+ }
+ if (sourceFileName === 'exception.js') {
+ throw new Error('foo-bar-resolver-v2 resolve test exception')
+ }
+ return { found: false };
+};
+
+exports.interfaceVersion = 2;
From afaefbbda83ed7b637ed4a039be6ad19727ea244 Mon Sep 17 00:00:00 2001
From: JounQin <admin@1stg.me>
Date: Sun, 7 Aug 2022 12:29:33 +0800
Subject: [PATCH 021/199] [Refactor] `ExportMap`: rename `tsConfig` to
`tsconfig`
---
src/ExportMap.js | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/ExportMap.js b/src/ExportMap.js
index cd5bad56c3..f61d3c170a 100644
--- a/src/ExportMap.js
+++ b/src/ExportMap.js
@@ -24,7 +24,7 @@ let ts;
const log = debug('eslint-plugin-import:ExportMap');
const exportCache = new Map();
-const tsConfigCache = new Map();
+const tsconfigCache = new Map();
export default class ExportMap {
constructor(path) {
@@ -549,20 +549,20 @@ ExportMap.parse = function (path, content, context) {
const source = makeSourceCode(content, ast);
function readTsConfig(context) {
- const tsConfigInfo = tsConfigLoader({
+ const tsconfigInfo = tsConfigLoader({
cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
getEnv: (key) => process.env[key],
});
try {
- if (tsConfigInfo.tsConfigPath !== undefined) {
+ if (tsconfigInfo.tsConfigPath !== undefined) {
// Projects not using TypeScript won't have `typescript` installed.
if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
- const configFile = ts.readConfigFile(tsConfigInfo.tsConfigPath, ts.sys.readFile);
+ const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
return ts.parseJsonConfigFileContent(
configFile.config,
ts.sys,
- dirname(tsConfigInfo.tsConfigPath),
+ dirname(tsconfigInfo.tsConfigPath),
);
}
} catch (e) {
@@ -576,10 +576,10 @@ ExportMap.parse = function (path, content, context) {
const cacheKey = hashObject({
tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
}).digest('hex');
- let tsConfig = tsConfigCache.get(cacheKey);
+ let tsConfig = tsconfigCache.get(cacheKey);
if (typeof tsConfig === 'undefined') {
tsConfig = readTsConfig(context);
- tsConfigCache.set(cacheKey, tsConfig);
+ tsconfigCache.set(cacheKey, tsConfig);
}
return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
From 328064abc707d3289772a8a29da5783c6dc345f6 Mon Sep 17 00:00:00 2001
From: silverwind <me@silverwind.io>
Date: Tue, 18 Apr 2023 20:03:39 +0200
Subject: [PATCH 022/199] Fix invalid YAML in import/parsers example
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5c6f1a3211..ca99b8fafb 100644
--- a/README.md
+++ b/README.md
@@ -355,7 +355,7 @@ directly using webpack, for example:
# .eslintrc.yml
settings:
import/parsers:
- @typescript-eslint/parser: [ .ts, .tsx ]
+ "@typescript-eslint/parser": [ .ts, .tsx ]
```
In this case, [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
From 88dd8153571373151c3c7b508c5944cb2bba1588 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 28 May 2023 09:02:13 -0800
Subject: [PATCH 023/199] [Deps] update `is-core-module`
---
package.json | 2 +-
src/rules/default.js | 2 --
2 files changed, 1 insertion(+), 3 deletions(-)
diff --git a/package.json b/package.json
index 59ab24c57b..feee6e46de 100644
--- a/package.json
+++ b/package.json
@@ -108,7 +108,7 @@
"eslint-import-resolver-node": "^0.3.7",
"eslint-module-utils": "^2.8.0",
"has": "^1.0.3",
- "is-core-module": "^2.12.0",
+ "is-core-module": "^2.12.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.values": "^1.1.6",
diff --git a/src/rules/default.js b/src/rules/default.js
index f6b786020d..297a80c463 100644
--- a/src/rules/default.js
+++ b/src/rules/default.js
@@ -13,9 +13,7 @@ module.exports = {
},
create(context) {
-
function checkDefault(specifierType, node) {
-
const defaultSpecifier = node.specifiers.find(
(specifier) => specifier.type === specifierType,
);
From a24a03b5ab4a257c78e5e0742b08023a002645e0 Mon Sep 17 00:00:00 2001
From: Kirill Korolyov <kirill.korolyov@gmail.com>
Date: Mon, 3 Jul 2023 21:18:16 +0100
Subject: [PATCH 024/199] [meta] Add "eslint-plugin" to the list of keywords in
package.json
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index feee6e46de..37911c90d8 100644
--- a/package.json
+++ b/package.json
@@ -42,6 +42,7 @@
"keywords": [
"eslint",
"eslintplugin",
+ "eslint-plugin",
"es6",
"jsnext",
"modules",
From 66e755fb32d900517df97efcd7707561a53dfc99 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 3 Jul 2023 22:37:00 -0500
Subject: [PATCH 025/199] [Refactor] `exports-last`: use
`array.prototype.findlastindex`
---
CHANGELOG.md | 1 +
package.json | 1 +
src/rules/exports-last.js | 11 ++++-------
3 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8a8ec36692..2c0fe3fdf0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
- [Docs] [`group-exports`]: fix syntax highlighting ([#2699], thanks [@devinrhode2])
- [Docs] [`extensions`]: reference node ESM behavior ([#2748], thanks [@xM8WVqaG])
+- [Refactor] [`exports-last`]: use `array.prototype.findlastindex` (thanks [@ljharb])
## [2.27.5] - 2023-01-16
diff --git a/package.json b/package.json
index 37911c90d8..9127841b3d 100644
--- a/package.json
+++ b/package.json
@@ -102,6 +102,7 @@
},
"dependencies": {
"array-includes": "^3.1.6",
+ "array.prototype.findlastindex": "^1.2.2",
"array.prototype.flat": "^1.3.1",
"array.prototype.flatmap": "^1.3.1",
"debug": "^3.2.7",
diff --git a/src/rules/exports-last.js b/src/rules/exports-last.js
index c4ed97e22f..1e79f8339c 100644
--- a/src/rules/exports-last.js
+++ b/src/rules/exports-last.js
@@ -1,3 +1,5 @@
+import findLastIndex from 'array.prototype.findlastindex';
+
import docsUrl from '../docsUrl';
function isNonExportStatement({ type }) {
@@ -20,15 +22,10 @@ module.exports = {
create(context) {
return {
Program({ body }) {
- const lastNonExportStatementIndex = body.reduce(function findLastIndex(acc, item, index) {
- if (isNonExportStatement(item)) {
- return index;
- }
- return acc;
- }, -1);
+ const lastNonExportStatementIndex = findLastIndex(body, isNonExportStatement);
if (lastNonExportStatementIndex !== -1) {
- body.slice(0, lastNonExportStatementIndex).forEach(function checkNonExport(node) {
+ body.slice(0, lastNonExportStatementIndex).forEach((node) => {
if (!isNonExportStatement(node)) {
context.report({
node,
From 2c196b097f7812992c5987c45ce53e33a66a8021 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 3 Jul 2023 22:44:09 -0500
Subject: [PATCH 026/199] [Refactor] `no-anonymous-default-export`: use
`object.fromentries`
---
CHANGELOG.md | 1 +
package.json | 1 +
src/rules/no-anonymous-default-export.js | 12 +++++-------
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2c0fe3fdf0..fdc41210b4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] [`group-exports`]: fix syntax highlighting ([#2699], thanks [@devinrhode2])
- [Docs] [`extensions`]: reference node ESM behavior ([#2748], thanks [@xM8WVqaG])
- [Refactor] [`exports-last`]: use `array.prototype.findlastindex` (thanks [@ljharb])
+- [Refactor] [`no-anonymous-default-export`]: use `object.fromentries` (thanks [@ljharb])
## [2.27.5] - 2023-01-16
diff --git a/package.json b/package.json
index 9127841b3d..763b5efc0c 100644
--- a/package.json
+++ b/package.json
@@ -113,6 +113,7 @@
"is-core-module": "^2.12.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
+ "object.fromentries": "^2.0.6",
"object.values": "^1.1.6",
"resolve": "^1.22.3",
"semver": "^6.3.0",
diff --git a/src/rules/no-anonymous-default-export.js b/src/rules/no-anonymous-default-export.js
index 80950d550e..06ea854b33 100644
--- a/src/rules/no-anonymous-default-export.js
+++ b/src/rules/no-anonymous-default-export.js
@@ -3,8 +3,11 @@
* @author Duncan Beevers
*/
-import docsUrl from '../docsUrl';
import has from 'has';
+import values from 'object.values';
+import fromEntries from 'object.fromentries';
+
+import docsUrl from '../docsUrl';
const defs = {
ArrayExpression: {
@@ -68,12 +71,7 @@ const schemaProperties = Object.keys(defs)
return acc;
}, {});
-const defaults = Object.keys(defs)
- .map((key) => defs[key])
- .reduce((acc, def) => {
- acc[def.option] = has(def, 'default') ? def.default : false;
- return acc;
- }, {});
+const defaults = fromEntries(values(defs).map((def) => [def.option, has(def, 'default') ? def.default : false]));
module.exports = {
meta: {
From 3a5ad34ca69a5c3239fff56241eb7e353d87274c Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 3 Jul 2023 22:48:40 -0500
Subject: [PATCH 027/199] [Refactor] `no-unused-modules`: use
`array.prototype.flatmap`
---
CHANGELOG.md | 1 +
src/rules/no-unused-modules.js | 24 ++++++++++--------------
2 files changed, 11 insertions(+), 14 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index fdc41210b4..68d7156784 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] [`extensions`]: reference node ESM behavior ([#2748], thanks [@xM8WVqaG])
- [Refactor] [`exports-last`]: use `array.prototype.findlastindex` (thanks [@ljharb])
- [Refactor] [`no-anonymous-default-export`]: use `object.fromentries` (thanks [@ljharb])
+- [Refactor] [`no-unused-modules`]: use `array.prototype.flatmap` (thanks [@ljharb])
## [2.27.5] - 2023-01-16
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 4b09128a10..a2b6f4ea27 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -4,15 +4,17 @@
* @author René Fermann
*/
-import Exports, { recursivePatternCapture } from '../ExportMap';
import { getFileExtensions } from 'eslint-module-utils/ignore';
import resolve from 'eslint-module-utils/resolve';
import visit from 'eslint-module-utils/visit';
-import docsUrl from '../docsUrl';
import { dirname, join } from 'path';
import readPkgUp from 'eslint-module-utils/readPkgUp';
import values from 'object.values';
import includes from 'array-includes';
+import flatMap from 'array.prototype.flatmap';
+
+import Exports, { recursivePatternCapture } from '../ExportMap';
+import docsUrl from '../docsUrl';
let FileEnumerator;
let listFilesToProcess;
@@ -40,12 +42,7 @@ try {
const { listFilesToProcess: originalListFilesToProcess } = require('eslint/lib/util/glob-util');
listFilesToProcess = function (src, extensions) {
- const patterns = src.reduce(
- (carry, pattern) => carry.concat(
- extensions.map((extension) => (/\*\*|\*\./).test(pattern) ? pattern : `${pattern}/**/*${extension}`),
- ),
- src,
- );
+ const patterns = src.concat(flatMap(src, (pattern) => extensions.map((extension) => (/\*\*|\*\./).test(pattern) ? pattern : `${pattern}/**/*${extension}`)));
return originalListFilesToProcess(patterns);
};
@@ -171,18 +168,17 @@ const isNodeModule = (path) => (/\/(node_modules)\//).test(path);
const resolveFiles = (src, ignoreExports, context) => {
const extensions = Array.from(getFileExtensions(context.settings));
- const srcFiles = new Set();
const srcFileList = listFilesToProcess(src, extensions);
// prepare list of ignored files
- const ignoredFilesList = listFilesToProcess(ignoreExports, extensions);
+ const ignoredFilesList = listFilesToProcess(ignoreExports, extensions);
ignoredFilesList.forEach(({ filename }) => ignoredFiles.add(filename));
// prepare list of source files, don't consider files from node_modules
- srcFileList.filter(({ filename }) => !isNodeModule(filename)).forEach(({ filename }) => {
- srcFiles.add(filename);
- });
- return srcFiles;
+
+ return new Set(
+ srcFileList.filter(({ filename }) => !isNodeModule(filename)).map(({ filename }) => filename),
+ );
};
/**
From ee00a1cc702cdfccbb2f10cddcb2797827115974 Mon Sep 17 00:00:00 2001
From: laurens-dg <laurens.degraeve@outlook.com>
Date: Tue, 18 Jul 2023 15:35:15 +0200
Subject: [PATCH 028/199] [Fix] guard against empty parent
---
CHANGELOG.md | 3 +++
src/rules/newline-after-import.js | 5 +++++
tests/src/rules/newline-after-import.js | 16 +++++++++++++---
3 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 68d7156784..dcfb192d2a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
+- [`newline-after-import`]/TypeScript: do not error when re-exporting a namespaced import ([#2832], thanks [@laurens-dg])
* [`order`]: partial fix for [#2687] (thanks [@ljharb])
### Changed
@@ -1072,6 +1073,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
[#2748]: https://github.com/import-js/eslint-plugin-import/pull/2748
@@ -1746,6 +1748,7 @@ for info on changes for earlier releases.
[@KostyaZgara]: https://github.com/KostyaZgara
[@kylemh]: https://github.com/kylemh
[@laysent]: https://github.com/laysent
+[@laurens-dg]: https://github.com/laurens-dg
[@le0nik]: https://github.com/le0nik
[@leipert]: https://github.com/leipert
[@lemonmade]: https://github.com/lemonmade
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index c63bb21b24..8855e26e52 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -149,6 +149,11 @@ module.exports = {
function checkImport(node) {
const { parent } = node;
+
+ if (!parent || !parent.body) {
+ return;
+ }
+
const nodePosition = parent.body.indexOf(node);
const nextNode = parent.body[nodePosition + 1];
const endLine = node.loc.end.line;
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index 5e14b570ee..9ec6eb757b 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -26,7 +26,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
code: `
const x = () => require('baz')
, y = () => require('bar')
-
+
// some comment here
`,
parserOptions: { ecmaVersion: 6 },
@@ -273,6 +273,16 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parser,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
+ {
+ code: `
+ import { ns } from 'namespace';
+ import Bar = ns.baz.foo.Bar;
+
+ export import Foo = ns.baz.bar.Foo;
+ `,
+ parser,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
)),
{
code: `
@@ -299,7 +309,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `
import path from 'path';import foo from 'foo';
-
+
/**
* some multiline comment here
* another line of comment
@@ -313,7 +323,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
code: `
import path from 'path';
import foo from 'foo';
-
+
// Some random single line comment
var bar = 42;
`,
From e2cf99c21130404fbf68394434b8cfa6d88a1bd0 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 24 Jul 2023 11:34:22 -0700
Subject: [PATCH 029/199] [Deps] update `semver`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 763b5efc0c..e870082e34 100644
--- a/package.json
+++ b/package.json
@@ -116,7 +116,7 @@
"object.fromentries": "^2.0.6",
"object.values": "^1.1.6",
"resolve": "^1.22.3",
- "semver": "^6.3.0",
+ "semver": "^6.3.1",
"tsconfig-paths": "^3.14.2"
}
}
From f302f7d31d28c91bd483c5da14600ce6e26cd0e3 Mon Sep 17 00:00:00 2001
From: ben <benkrejci@gmail.com>
Date: Tue, 18 Jul 2023 21:46:55 -0400
Subject: [PATCH 030/199] [Fix] `no-duplicates`: Prefer combined type and
regular imports when using `prefer-inline`
---
CHANGELOG.md | 3 +++
docs/rules/no-duplicates.md | 5 +++++
src/rules/no-duplicates.js | 5 +++--
tests/src/rules/no-duplicates.js | 19 +++++++++++++++++++
4 files changed, 30 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index dcfb192d2a..a46b1b0326 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
- [`newline-after-import`]/TypeScript: do not error when re-exporting a namespaced import ([#2832], thanks [@laurens-dg])
* [`order`]: partial fix for [#2687] (thanks [@ljharb])
+- [`no-duplicates`]: Detect across type and regular imports ([#2835], thanks [@benkrejci])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1073,6 +1074,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
@@ -1647,6 +1649,7 @@ for info on changes for earlier releases.
[@BarryThePenguin]: https://github.com/BarryThePenguin
[@be5invis]: https://github.com/be5invis
[@beatrizrezener]: https://github.com/beatrizrezener
+[@benkrejci]: https://github.com/benkrejci
[@benmosher]: https://github.com/benmosher
[@benmunro]: https://github.com/benmunro
[@BenoitZugmeyer]: https://github.com/BenoitZugmeyer
diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md
index 5f3cfbd426..dd741c21a5 100644
--- a/docs/rules/no-duplicates.md
+++ b/docs/rules/no-duplicates.md
@@ -84,12 +84,17 @@ Config:
```js
import { AValue, type AType } from './mama-mia'
import type { BType } from './mama-mia'
+
+import { CValue } from './papa-mia'
+import type { CType } from './papa-mia'
```
✅ Valid with `["error", {"prefer-inline": true}]`
```js
import { AValue, type AType, type BType } from './mama-mia'
+
+import { CValue, type CType } from './papa-mia'
```
<!--tabs-->
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 76bf187b2e..2373202cb6 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -318,10 +318,11 @@ module.exports = {
});
}
const map = moduleMaps.get(n.parent);
- if (n.importKind === 'type') {
+ const preferInline = context.options[0] && context.options[0]['prefer-inline'];
+ if (!preferInline && n.importKind === 'type') {
return n.specifiers.length > 0 && n.specifiers[0].type === 'ImportDefaultSpecifier' ? map.defaultTypesImported : map.namedTypesImported;
}
- if (n.specifiers.some((spec) => spec.importKind === 'type')) {
+ if (!preferInline && n.specifiers.some((spec) => spec.importKind === 'type')) {
return map.namedTypesImported;
}
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index 33e1e632e2..d61fda86e1 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -711,6 +711,25 @@ context('TypeScript', function () {
},
],
}),
+ // #2834 Detect duplicates across type and regular imports
+ test({
+ code: "import {AValue} from './foo'; import type {AType} from './foo'",
+ ...parserConfig,
+ options: [{ 'prefer-inline': true }],
+ output: `import {AValue,type AType} from './foo'; `,
+ errors: [
+ {
+ line: 1,
+ column: 22,
+ message: "'./foo' imported multiple times.",
+ },
+ {
+ line: 1,
+ column: 56,
+ message: "'./foo' imported multiple times.",
+ },
+ ],
+ }),
]);
ruleTester.run('no-duplicates', rule, {
From d8002bee587dad9c574fb06a23b4bcb25e90bc39 Mon Sep 17 00:00:00 2001
From: Ben Asher <ben@ashbyhq.com>
Date: Sun, 7 May 2023 18:57:33 -0700
Subject: [PATCH 031/199] [Fix] `extensions`: handle `.` and `..` properly
---
CHANGELOG.md | 5 ++-
src/rules/extensions.js | 1 +
tests/files/internal-modules/test.js | 0
tests/index.js | 1 +
tests/src/rules/extensions.js | 49 ++++++++++++++++++++++++++++
5 files changed, 55 insertions(+), 1 deletion(-)
create mode 100644 tests/files/internal-modules/test.js
create mode 100644 tests/index.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a46b1b0326..7febb37111 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,8 +12,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
- [`newline-after-import`]/TypeScript: do not error when re-exporting a namespaced import ([#2832], thanks [@laurens-dg])
-* [`order`]: partial fix for [#2687] (thanks [@ljharb])
+- [`order`]: partial fix for [#2687] (thanks [@ljharb])
- [`no-duplicates`]: Detect across type and regular imports ([#2835], thanks [@benkrejci])
+- [`extensions`]: handle `.` and `..` properly ([#2778], thanks [@benasher44])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1076,6 +1077,7 @@ for info on changes for earlier releases.
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
+[#2778]: https://github.com/import-js/eslint-plugin-import/pull/2778
[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
[#2748]: https://github.com/import-js/eslint-plugin-import/pull/2748
@@ -1649,6 +1651,7 @@ for info on changes for earlier releases.
[@BarryThePenguin]: https://github.com/BarryThePenguin
[@be5invis]: https://github.com/be5invis
[@beatrizrezener]: https://github.com/beatrizrezener
+[@benasher44]: https://github.com/benasher44
[@benkrejci]: https://github.com/benkrejci
[@benmosher]: https://github.com/benmosher
[@benmunro]: https://github.com/benmunro
diff --git a/src/rules/extensions.js b/src/rules/extensions.js
index 50debc6c8c..3acefcd31b 100644
--- a/src/rules/extensions.js
+++ b/src/rules/extensions.js
@@ -130,6 +130,7 @@ module.exports = {
}
function isExternalRootModule(file) {
+ if (file === '.' || file === '..') { return false; }
const slashCount = file.split('/').length - 1;
if (slashCount === 0) { return true; }
diff --git a/tests/files/internal-modules/test.js b/tests/files/internal-modules/test.js
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/index.js b/tests/index.js
new file mode 100644
index 0000000000..abc02b839c
--- /dev/null
+++ b/tests/index.js
@@ -0,0 +1 @@
+export * from './files';
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index ede1a8d88a..22a5fc3023 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -266,6 +266,26 @@ ruleTester.run('extensions', rule, {
],
}),
+ test({
+ code: [
+ 'import barjs from "."',
+ 'import barjs2 from ".."',
+ ].join('\n'),
+ options: [ 'always' ],
+ errors: [
+ {
+ message: 'Missing file extension "js" for "."',
+ line: 1,
+ column: 19,
+ },
+ {
+ message: 'Missing file extension "js" for ".."',
+ line: 2,
+ column: 20,
+ },
+ ],
+ }),
+
test({
code: [
'import barjs from "./bar.js"',
@@ -594,6 +614,35 @@ ruleTester.run('extensions', rule, {
},
],
}),
+
+ // TODO: properly ignore packages resolved via relative imports
+ test({
+ code: [
+ 'import * as test from "."',
+ ].join('\n'),
+ filename: testFilePath('./internal-modules/test.js'),
+ options: [ 'ignorePackages' ],
+ errors: [
+ {
+ message: 'Missing file extension for "."',
+ line: 1,
+ },
+ ],
+ }),
+ // TODO: properly ignore packages resolved via relative imports
+ test({
+ code: [
+ 'import * as test from ".."',
+ ].join('\n'),
+ filename: testFilePath('./internal-modules/plugins/plugin.js'),
+ options: [ 'ignorePackages' ],
+ errors: [
+ {
+ message: 'Missing file extension for ".."',
+ line: 1,
+ },
+ ],
+ }),
],
});
From 68bf51019b0e9ee86c572393781a75b9dba2ea8b Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 25 Jul 2023 22:52:17 -0700
Subject: [PATCH 032/199] [eslint] enable `array-bracket-spacing`
---
.eslintrc | 1 +
src/rules/extensions.js | 2 +-
src/rules/no-absolute-path.js | 2 +-
tests/src/core/hash.js | 8 +-
tests/src/core/ignore.js | 4 +-
tests/src/core/parse.js | 4 +-
tests/src/core/resolve.js | 10 +-
tests/src/rules/extensions.js | 120 +++++------
tests/src/rules/named.js | 4 +-
tests/src/rules/namespace.js | 18 +-
tests/src/rules/newline-after-import.js | 60 +++---
tests/src/rules/no-amd.js | 8 +-
tests/src/rules/no-commonjs.js | 28 +--
tests/src/rules/no-extraneous-dependencies.js | 4 +-
tests/src/rules/no-internal-modules.js | 204 +++++++++---------
tests/src/rules/no-named-as-default.js | 16 +-
tests/src/rules/no-namespace.js | 18 +-
tests/src/rules/no-relative-packages.js | 16 +-
tests/src/rules/no-relative-parent-imports.js | 18 +-
tests/src/rules/no-unresolved.js | 6 +-
tests/src/rules/no-useless-path-segments.js | 38 ++--
tests/src/rules/order.js | 2 +-
utils/ignore.js | 2 +-
23 files changed, 297 insertions(+), 296 deletions(-)
diff --git a/.eslintrc b/.eslintrc
index 709a474484..932055e8d4 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -19,6 +19,7 @@
"ecmaVersion": 2020,
},
"rules": {
+ "array-bracket-spacing": [2, "never"],
"arrow-body-style": [2, "as-needed"],
"arrow-parens": [2, "always"],
"arrow-spacing": [2, { "before": true, "after": true }],
diff --git a/src/rules/extensions.js b/src/rules/extensions.js
index 3acefcd31b..b1e5c6d9f1 100644
--- a/src/rules/extensions.js
+++ b/src/rules/extensions.js
@@ -5,7 +5,7 @@ import { isBuiltIn, isExternalModule, isScoped } from '../core/importType';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
import docsUrl from '../docsUrl';
-const enumValues = { enum: [ 'always', 'ignorePackages', 'never' ] };
+const enumValues = { enum: ['always', 'ignorePackages', 'never'] };
const patternProperties = {
type: 'object',
patternProperties: { '.*': enumValues },
diff --git a/src/rules/no-absolute-path.js b/src/rules/no-absolute-path.js
index a5498ec765..04f67383f2 100644
--- a/src/rules/no-absolute-path.js
+++ b/src/rules/no-absolute-path.js
@@ -12,7 +12,7 @@ module.exports = {
url: docsUrl('no-absolute-path'),
},
fixable: 'code',
- schema: [ makeOptionsSchema() ],
+ schema: [makeOptionsSchema()],
},
create(context) {
diff --git a/tests/src/core/hash.js b/tests/src/core/hash.js
index 1d6a9eb85c..785b8abc34 100644
--- a/tests/src/core/hash.js
+++ b/tests/src/core/hash.js
@@ -29,7 +29,7 @@ describe('hash', function () {
});
it('handles Array instances', function () {
- expectHash(hashify([ 'a string' ]), '["a string",]');
+ expectHash(hashify(['a string']), '["a string",]');
});
it('handles empty Array instances', function () {
@@ -45,13 +45,13 @@ describe('hash', function () {
});
it('handles nested Object and Array instances', function () {
- expectHash(hashify({ foo: 123.456, 'a key': 'a value', obj: { arr: [ { def: 'ghi' } ] } }), '{"a key":"a value","foo":123.456,"obj":{"arr":[{"def":"ghi",},],},}');
+ expectHash(hashify({ foo: 123.456, 'a key': 'a value', obj: { arr: [{ def: 'ghi' }] } }), '{"a key":"a value","foo":123.456,"obj":{"arr":[{"def":"ghi",},],},}');
});
});
describe('hashArray', function () {
it('handles Array instances', function () {
- expectHash(hashArray([ 'a string' ]), '["a string",]');
+ expectHash(hashArray(['a string']), '["a string",]');
});
it('handles empty Array instances', function () {
@@ -69,7 +69,7 @@ describe('hash', function () {
});
it('handles nested Object and Array instances', function () {
- expectHash(hashObject({ foo: 123.456, 'a key': 'a value', obj: { arr: [ { def: 'ghi' } ] } }), '{"a key":"a value","foo":123.456,"obj":{"arr":[{"def":"ghi",},],},}');
+ expectHash(hashObject({ foo: 123.456, 'a key': 'a value', obj: { arr: [{ def: 'ghi' }] } }), '{"a key":"a value","foo":123.456,"obj":{"arr":[{"def":"ghi",},],},}');
});
});
diff --git a/tests/src/core/ignore.js b/tests/src/core/ignore.js
index 2b2126c8b5..3212781363 100644
--- a/tests/src/core/ignore.js
+++ b/tests/src/core/ignore.js
@@ -19,7 +19,7 @@ describe('ignore', function () {
});
it('ignores paths with invalid extensions when configured with import/extensions', function () {
- const testContext = utils.testContext({ 'import/extensions': [ '.js', '.jsx', '.ts' ] });
+ const testContext = utils.testContext({ 'import/extensions': ['.js', '.jsx', '.ts'] });
expect(isIgnored('../files/foo.js', testContext)).to.equal(false);
@@ -45,7 +45,7 @@ describe('ignore', function () {
});
it('can be configured with import/extensions', function () {
- const testContext = utils.testContext({ 'import/extensions': [ '.foo', '.bar' ] });
+ const testContext = utils.testContext({ 'import/extensions': ['.foo', '.bar'] });
expect(hasValidExtension('../files/foo.foo', testContext)).to.equal(true);
diff --git a/tests/src/core/parse.js b/tests/src/core/parse.js
index 9c59453602..275b93982b 100644
--- a/tests/src/core/parse.js
+++ b/tests/src/core/parse.js
@@ -76,7 +76,7 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
const parseSpy = sinon.spy();
const parserOptions = { ecmaFeatures: { jsx: true } };
parseStubParser.parse = parseSpy;
- expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: [ '.js' ] } }, parserPath: null, parserOptions })).not.to.throw(Error);
+ expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: ['.js'] } }, parserPath: null, parserOptions })).not.to.throw(Error);
expect(parseSpy.callCount, 'custom parser to be called once').to.equal(1);
});
@@ -123,7 +123,7 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
it('prefers parsers specified in the settings over languageOptions.parser', () => {
const parseSpy = sinon.spy();
parseStubParser.parse = parseSpy;
- expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: [ '.js' ] } }, parserPath: null, languageOptions: { parser: { parse() {} } } })).not.to.throw(Error);
+ expect(parse.bind(null, path, content, { settings: { 'import/parsers': { [parseStubParserPath]: ['.js'] } }, parserPath: null, languageOptions: { parser: { parse() {} } } })).not.to.throw(Error);
expect(parseSpy.callCount, 'custom parser to be called once').to.equal(1);
});
diff --git a/tests/src/core/resolve.js b/tests/src/core/resolve.js
index 6b69fb7f12..0db9b05f49 100644
--- a/tests/src/core/resolve.js
+++ b/tests/src/core/resolve.js
@@ -86,7 +86,7 @@ describe('resolve', function () {
});
it('respects import/resolver as array of strings', function () {
- const testContext = utils.testContext({ 'import/resolver': [ './foo-bar-resolver-v2', './foo-bar-resolver-v1' ] });
+ const testContext = utils.testContext({ 'import/resolver': ['./foo-bar-resolver-v2', './foo-bar-resolver-v1'] });
expect(resolve(
'../files/foo',
@@ -104,7 +104,7 @@ describe('resolve', function () {
});
it('respects import/resolver as array of objects', function () {
- const testContext = utils.testContext({ 'import/resolver': [ { './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} } ] });
+ const testContext = utils.testContext({ 'import/resolver': [{ './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} }] });
expect(resolve(
'../files/foo',
@@ -254,7 +254,7 @@ describe('resolve', function () {
});
it('respects import/resolver as array of strings', function () {
- const testContext = utils.testContext({ 'import/resolver': [ './foo-bar-resolver-v2', './foo-bar-resolver-v1' ] });
+ const testContext = utils.testContext({ 'import/resolver': ['./foo-bar-resolver-v2', './foo-bar-resolver-v1'] });
expect(resolve(
'../files/foo',
@@ -272,7 +272,7 @@ describe('resolve', function () {
});
it('respects import/resolver as array of objects', function () {
- const testContext = utils.testContext({ 'import/resolver': [ { './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} } ] });
+ const testContext = utils.testContext({ 'import/resolver': [{ './foo-bar-resolver-v2': {} }, { './foo-bar-resolver-v1': {} }] });
expect(resolve(
'../files/foo',
@@ -386,7 +386,7 @@ describe('resolve', function () {
'import/cache': { lifetime: 1 },
});
- const infiniteContexts = [ '∞', 'Infinity' ].map((inf) => [inf,
+ const infiniteContexts = ['∞', 'Infinity'].map((inf) => [inf,
utils.testContext({
'import/cache': { lifetime: inf },
})]);
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index 22a5fc3023..14d84eaa62 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -11,18 +11,18 @@ ruleTester.run('extensions', rule, {
test({ code: 'import dot from "./file.with.dot"' }),
test({
code: 'import a from "a/index.js"',
- options: [ 'always' ],
+ options: ['always'],
}),
test({
code: 'import dot from "./file.with.dot.js"',
- options: [ 'always' ],
+ options: ['always'],
}),
test({
code: [
'import a from "a"',
'import packageConfig from "./package.json"',
].join('\n'),
- options: [ { json: 'always', js: 'never' } ],
+ options: [{ json: 'always', js: 'never' }],
}),
test({
code: [
@@ -30,8 +30,8 @@ ruleTester.run('extensions', rule, {
'import component from "./bar.jsx"',
'import data from "./bar.json"',
].join('\n'),
- options: [ 'never' ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
+ options: ['never'],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json'] } },
}),
test({
@@ -40,8 +40,8 @@ ruleTester.run('extensions', rule, {
'import barjson from "./bar.json"',
'import barhbs from "./bar.hbs"',
].join('\n'),
- options: [ 'always', { js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json', '.hbs' ] } },
+ options: ['always', { js: 'never', jsx: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json', '.hbs'] } },
}),
test({
@@ -49,16 +49,16 @@ ruleTester.run('extensions', rule, {
'import bar from "./bar.js"',
'import pack from "./package"',
].join('\n'),
- options: [ 'never', { js: 'always', json: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.json' ] } },
+ options: ['never', { js: 'always', json: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.json'] } },
}),
// unresolved (#271/#295)
test({ code: 'import path from "path"' }),
- test({ code: 'import path from "path"', options: [ 'never' ] }),
- test({ code: 'import path from "path"', options: [ 'always' ] }),
- test({ code: 'import thing from "./fake-file.js"', options: [ 'always' ] }),
- test({ code: 'import thing from "non-package"', options: [ 'never' ] }),
+ test({ code: 'import path from "path"', options: ['never'] }),
+ test({ code: 'import path from "path"', options: ['always'] }),
+ test({ code: 'import thing from "./fake-file.js"', options: ['always'] }),
+ test({ code: 'import thing from "non-package"', options: ['never'] }),
test({
code: `
@@ -67,7 +67,7 @@ ruleTester.run('extensions', rule, {
import Component from './Component.jsx'
import express from 'express'
`,
- options: [ 'ignorePackages' ],
+ options: ['ignorePackages'],
}),
test({
@@ -77,7 +77,7 @@ ruleTester.run('extensions', rule, {
import Component from './Component.jsx'
import express from 'express'
`,
- options: [ 'always', { ignorePackages: true } ],
+ options: ['always', { ignorePackages: true }],
}),
test({
@@ -87,16 +87,16 @@ ruleTester.run('extensions', rule, {
import Component from './Component'
import express from 'express'
`,
- options: [ 'never', { ignorePackages: true } ],
+ options: ['never', { ignorePackages: true }],
}),
test({
code: 'import exceljs from "exceljs"',
- options: [ 'always', { js: 'never', jsx: 'never' } ],
+ options: ['always', { js: 'never', jsx: 'never' }],
filename: testFilePath('./internal-modules/plugins/plugin.js'),
settings: {
'import/resolver': {
- node: { extensions: [ '.js', '.jsx', '.json' ] },
+ node: { extensions: ['.js', '.jsx', '.json'] },
webpack: { config: 'webpack.empty.config.js' },
},
},
@@ -108,14 +108,14 @@ ruleTester.run('extensions', rule, {
'export { foo } from "./foo.js"',
'let bar; export { bar }',
].join('\n'),
- options: [ 'always' ],
+ options: ['always'],
}),
test({
code: [
'export { foo } from "./foo"',
'let bar; export { bar }',
].join('\n'),
- options: [ 'never' ],
+ options: ['never'],
}),
// Root packages should be ignored and they are names not files
@@ -125,17 +125,17 @@ ruleTester.run('extensions', rule, {
'import lib2 from "pgk/package"',
'import lib3 from "@name/pkg.js"',
].join('\n'),
- options: [ 'never' ],
+ options: ['never'],
}),
// Query strings.
test({
code: 'import bare from "./foo?a=True.ext"',
- options: [ 'never' ],
+ options: ['never'],
}),
test({
code: 'import bare from "./foo.js?a=True"',
- options: [ 'always' ],
+ options: ['always'],
}),
test({
@@ -144,22 +144,22 @@ ruleTester.run('extensions', rule, {
'import lib2 from "pgk/package.js"',
'import lib3 from "@name/pkg"',
].join('\n'),
- options: [ 'always' ],
+ options: ['always'],
}),
],
invalid: [
test({
code: 'import a from "a/index.js"',
- errors: [ {
+ errors: [{
message: 'Unexpected use of file extension "js" for "a/index.js"',
line: 1,
column: 15,
- } ],
+ }],
}),
test({
code: 'import dot from "./file.with.dot"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension "js" for "./file.with.dot"',
@@ -173,8 +173,8 @@ ruleTester.run('extensions', rule, {
'import a from "a/index.js"',
'import packageConfig from "./package"',
].join('\n'),
- options: [ { json: 'always', js: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.json' ] } },
+ options: [{ json: 'always', js: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.json'] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "a/index.js"',
@@ -194,8 +194,8 @@ ruleTester.run('extensions', rule, {
'import component from "./bar.jsx"',
'import data from "./bar.json"',
].join('\n'),
- options: [ 'never' ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
+ options: ['never'],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json'] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -210,8 +210,8 @@ ruleTester.run('extensions', rule, {
'import component from "./bar.jsx"',
'import data from "./bar.json"',
].join('\n'),
- options: [ { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
+ options: [{ json: 'always', js: 'never', jsx: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json'] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -226,8 +226,8 @@ ruleTester.run('extensions', rule, {
'import component from "./bar.jsx"',
'import data from "./bar.json"',
].join('\n'),
- options: [ { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.jsx', '.json', '.js' ] } },
+ options: [{ json: 'always', js: 'never', jsx: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.jsx', '.json', '.js'] } },
errors: [
{
message: 'Unexpected use of file extension "jsx" for "./bar.jsx"',
@@ -255,8 +255,8 @@ ruleTester.run('extensions', rule, {
'import barjson from "./bar.json"',
'import barnone from "./bar"',
].join('\n'),
- options: [ 'always', { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
+ options: ['always', { json: 'always', js: 'never', jsx: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json'] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -271,7 +271,7 @@ ruleTester.run('extensions', rule, {
'import barjs from "."',
'import barjs2 from ".."',
].join('\n'),
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension "js" for "."',
@@ -292,8 +292,8 @@ ruleTester.run('extensions', rule, {
'import barjson from "./bar.json"',
'import barnone from "./bar"',
].join('\n'),
- options: [ 'never', { json: 'always', js: 'never', jsx: 'never' } ],
- settings: { 'import/resolve': { extensions: [ '.js', '.jsx', '.json' ] } },
+ options: ['never', { json: 'always', js: 'never', jsx: 'never' }],
+ settings: { 'import/resolve': { extensions: ['.js', '.jsx', '.json'] } },
errors: [
{
message: 'Unexpected use of file extension "js" for "./bar.js"',
@@ -306,7 +306,7 @@ ruleTester.run('extensions', rule, {
// unresolved (#271/#295)
test({
code: 'import thing from "./fake-file.js"',
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./fake-file.js"',
@@ -317,7 +317,7 @@ ruleTester.run('extensions', rule, {
}),
test({
code: 'import thing from "non-package/test"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "non-package/test"',
@@ -329,7 +329,7 @@ ruleTester.run('extensions', rule, {
test({
code: 'import thing from "@name/pkg/test"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "@name/pkg/test"',
@@ -341,7 +341,7 @@ ruleTester.run('extensions', rule, {
test({
code: 'import thing from "@name/pkg/test.js"',
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "@name/pkg/test.js"',
@@ -361,7 +361,7 @@ ruleTester.run('extensions', rule, {
import chart from '@/configs/chart'
import express from 'express'
`,
- options: [ 'always', { ignorePackages: true } ],
+ options: ['always', { ignorePackages: true }],
errors: [
{
message: 'Missing file extension for "./Component"',
@@ -386,7 +386,7 @@ ruleTester.run('extensions', rule, {
import chart from '@/configs/chart'
import express from 'express'
`,
- options: [ 'ignorePackages' ],
+ options: ['ignorePackages'],
errors: [
{
message: 'Missing file extension for "./Component"',
@@ -419,7 +419,7 @@ ruleTester.run('extensions', rule, {
column: 31,
},
],
- options: [ 'never', { ignorePackages: true } ],
+ options: ['never', { ignorePackages: true }],
}),
test({
@@ -435,7 +435,7 @@ ruleTester.run('extensions', rule, {
column: 31,
},
],
- options: [ 'always', { pattern: { jsx: 'never' } } ],
+ options: ['always', { pattern: { jsx: 'never' } }],
}),
// export (#964)
@@ -444,7 +444,7 @@ ruleTester.run('extensions', rule, {
'export { foo } from "./foo"',
'let bar; export { bar }',
].join('\n'),
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "./foo"',
@@ -458,7 +458,7 @@ ruleTester.run('extensions', rule, {
'export { foo } from "./foo.js"',
'let bar; export { bar }',
].join('\n'),
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./foo.js"',
@@ -471,7 +471,7 @@ ruleTester.run('extensions', rule, {
// Query strings.
test({
code: 'import withExtension from "./foo.js?a=True"',
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./foo.js?a=True"',
@@ -482,7 +482,7 @@ ruleTester.run('extensions', rule, {
}),
test({
code: 'import withoutExtension from "./foo?a=True.ext"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "./foo?a=True.ext"',
@@ -497,7 +497,7 @@ ruleTester.run('extensions', rule, {
'const { foo } = require("./foo")',
'export { foo }',
].join('\n'),
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "./foo"',
@@ -511,7 +511,7 @@ ruleTester.run('extensions', rule, {
'const { foo } = require("./foo.js")',
'export { foo }',
].join('\n'),
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./foo.js"',
@@ -524,7 +524,7 @@ ruleTester.run('extensions', rule, {
// export { } from
test({
code: 'export { foo } from "./foo"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "./foo"',
@@ -552,7 +552,7 @@ ruleTester.run('extensions', rule, {
}),
test({
code: 'export { foo } from "./foo.js"',
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./foo.js"',
@@ -565,7 +565,7 @@ ruleTester.run('extensions', rule, {
// export * from
test({
code: 'export * from "./foo"',
- options: [ 'always' ],
+ options: ['always'],
errors: [
{
message: 'Missing file extension for "./foo"',
@@ -576,7 +576,7 @@ ruleTester.run('extensions', rule, {
}),
test({
code: 'export * from "./foo.js"',
- options: [ 'never' ],
+ options: ['never'],
errors: [
{
message: 'Unexpected use of file extension "js" for "./foo.js"',
@@ -621,7 +621,7 @@ ruleTester.run('extensions', rule, {
'import * as test from "."',
].join('\n'),
filename: testFilePath('./internal-modules/test.js'),
- options: [ 'ignorePackages' ],
+ options: ['ignorePackages'],
errors: [
{
message: 'Missing file extension for "."',
@@ -635,7 +635,7 @@ ruleTester.run('extensions', rule, {
'import * as test from ".."',
].join('\n'),
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ 'ignorePackages' ],
+ options: ['ignorePackages'],
errors: [
{
message: 'Missing file extension for ".."',
diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
index 110cfff52a..227bffc80d 100644
--- a/tests/src/rules/named.js
+++ b/tests/src/rules/named.js
@@ -208,7 +208,7 @@ ruleTester.run('named', rule, {
invalid: [].concat(
test({ code: 'import { somethingElse } from "./test-module"',
- errors: [ error('somethingElse', './test-module') ] }),
+ errors: [error('somethingElse', './test-module')] }),
test({ code: 'import { baz } from "./bar"',
errors: [error('baz', './bar')] }),
@@ -330,7 +330,7 @@ ruleTester.run('named', rule, {
// es2022: Arbitrary module namespace identifier names
testVersion('>= 8.7', () => ({
code: 'import { "somethingElse" as somethingElse } from "./test-module"',
- errors: [ error('somethingElse', './test-module', 'Literal') ],
+ errors: [error('somethingElse', './test-module', 'Literal')],
parserOptions: { ecmaVersion: 2022 },
})),
testVersion('>= 8.7', () => ({
diff --git a/tests/src/rules/namespace.js b/tests/src/rules/namespace.js
index d368fd3fe9..1475ae9b7d 100644
--- a/tests/src/rules/namespace.js
+++ b/tests/src/rules/namespace.js
@@ -284,7 +284,7 @@ const invalid = [].concat(
test({
code: "import b from './deep/default'; console.log(b.e)",
- errors: [ "'e' not found in imported namespace 'b'." ],
+ errors: ["'e' not found in imported namespace 'b'."],
}),
// respect hoisting
@@ -317,12 +317,12 @@ const invalid = [].concat(
// es2022: Arbitrary module namespace identifier names
testVersion('>= 8.7', () => ({
code: `import { "b" as b } from "./deep/a"; console.log(b.e)`,
- errors: [ "'e' not found in imported namespace 'b'." ],
+ errors: ["'e' not found in imported namespace 'b'."],
parserOptions: { ecmaVersion: 2022 },
})),
testVersion('>= 8.7', () => ({
code: `import { "b" as b } from "./deep/a"; console.log(b.c.e)`,
- errors: [ "'e' not found in deeply imported namespace 'b.c'." ],
+ errors: ["'e' not found in deeply imported namespace 'b.c'."],
parserOptions: { ecmaVersion: 2022 },
})),
);
@@ -345,32 +345,32 @@ const invalid = [].concat(
test({
parser,
code: `import * as a from "./${folder}/a"; console.log(a.b.e)`,
- errors: [ "'e' not found in deeply imported namespace 'a.b'." ],
+ errors: ["'e' not found in deeply imported namespace 'a.b'."],
}),
test({
parser,
code: `import { b } from "./${folder}/a"; console.log(b.e)`,
- errors: [ "'e' not found in imported namespace 'b'." ],
+ errors: ["'e' not found in imported namespace 'b'."],
}),
test({
parser,
code: `import * as a from "./${folder}/a"; console.log(a.b.c.e)`,
- errors: [ "'e' not found in deeply imported namespace 'a.b.c'." ],
+ errors: ["'e' not found in deeply imported namespace 'a.b.c'."],
}),
test({
parser,
code: `import { b } from "./${folder}/a"; console.log(b.c.e)`,
- errors: [ "'e' not found in deeply imported namespace 'b.c'." ],
+ errors: ["'e' not found in deeply imported namespace 'b.c'."],
}),
test({
parser,
code: `import * as a from "./${folder}/a"; var {b:{ e }} = a`,
- errors: [ "'e' not found in deeply imported namespace 'a.b'." ],
+ errors: ["'e' not found in deeply imported namespace 'a.b'."],
}),
test({
parser,
code: `import * as a from "./${folder}/a"; var {b:{c:{ e }}} = a`,
- errors: [ "'e' not found in deeply imported namespace 'a.b.c'." ],
+ errors: ["'e' not found in deeply imported namespace 'a.b.c'."],
}));
});
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index 9ec6eb757b..8f3338eee8 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -346,11 +346,11 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
// some comment
var foo = 'bar';
`,
- errors: [ {
+ errors: [{
line: 3,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ considerComments: true }],
},
@@ -373,11 +373,11 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
**/
var bar = 42;
`,
- errors: [ {
+ errors: [{
line: 3,
column: 9,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ considerComments: true }],
},
@@ -394,54 +394,54 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
// Some random single line comment
var bar = 42;
`,
- errors: [ {
+ errors: [{
line: 3,
column: 9,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ considerComments: true, count: 1 }],
},
{
code: `import foo from 'foo';\nexport default function() {};`,
output: `import foo from 'foo';\n\nexport default function() {};`,
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `import foo from 'foo';\n\nexport default function() {};`,
output: `import foo from 'foo';\n\n\nexport default function() {};`,
options: [{ count: 2 }],
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `var foo = require('foo-module');\nvar something = 123;`,
output: `var foo = require('foo-module');\n\nvar something = 123;`,
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: REQUIRE_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `import foo from 'foo';\nexport default function() {};`,
output: `import foo from 'foo';\n\nexport default function() {};`,
options: [{ count: 1 }],
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
@@ -495,20 +495,20 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `var path = require('path');\nvar foo = require('foo');\nvar bar = 42;`,
output: `var path = require('path');\nvar foo = require('foo');\n\nvar bar = 42;`,
- errors: [ {
+ errors: [{
line: 2,
column: 1,
message: REQUIRE_ERROR_MESSAGE,
- } ],
+ }],
},
{
code: `var assign = Object.assign || require('object-assign');\nvar foo = require('foo');\nvar bar = 42;`,
output: `var assign = Object.assign || require('object-assign');\nvar foo = require('foo');\n\nvar bar = 42;`,
- errors: [ {
+ errors: [{
line: 2,
column: 1,
message: REQUIRE_ERROR_MESSAGE,
- } ],
+ }],
},
{
code: `require('a');\nfoo(require('b'), require('c'), require('d'));\nrequire('d');\nvar foo = 'bar';`,
@@ -535,64 +535,64 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
{
code: `import path from 'path';\nimport foo from 'foo';\nvar bar = 42;`,
output: `import path from 'path';\nimport foo from 'foo';\n\nvar bar = 42;`,
- errors: [ {
+ errors: [{
line: 2,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `import path from 'path';import foo from 'foo';var bar = 42;`,
output: `import path from 'path';import foo from 'foo';\n\nvar bar = 42;`,
- errors: [ {
+ errors: [{
line: 1,
column: 25,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
{
code: `import foo from 'foo';\n@SomeDecorator(foo)\nclass Foo {}`,
output: `import foo from 'foo';\n\n@SomeDecorator(foo)\nclass Foo {}`,
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
{
code: `var foo = require('foo');\n@SomeDecorator(foo)\nclass Foo {}`,
output: `var foo = require('foo');\n\n@SomeDecorator(foo)\nclass Foo {}`,
- errors: [ {
+ errors: [{
line: 1,
column: 1,
message: REQUIRE_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
{
code: `// issue 10042\nimport foo from 'foo';\n@SomeDecorator(foo)\nexport default class Test {}`,
output: `// issue 10042\nimport foo from 'foo';\n\n@SomeDecorator(foo)\nexport default class Test {}`,
- errors: [ {
+ errors: [{
line: 2,
column: 1,
message: IMPORT_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
{
code: `// issue 1004\nconst foo = require('foo');\n@SomeDecorator(foo)\nexport default class Test {}`,
output: `// issue 1004\nconst foo = require('foo');\n\n@SomeDecorator(foo)\nexport default class Test {}`,
- errors: [ {
+ errors: [{
line: 2,
column: 1,
message: REQUIRE_ERROR_MESSAGE,
- } ],
+ }],
parserOptions: { sourceType: 'module' },
parser: parsers.BABEL_OLD,
},
diff --git a/tests/src/rules/no-amd.js b/tests/src/rules/no-amd.js
index 91e29234c8..5317aa8fde 100644
--- a/tests/src/rules/no-amd.js
+++ b/tests/src/rules/no-amd.js
@@ -28,10 +28,10 @@ ruleTester.run('no-amd', require('rules/no-amd'), {
],
invalid: semver.satisfies(eslintPkg.version, '< 4.0.0') ? [] : [
- { code: 'define([], function() {})', errors: [ { message: 'Expected imports instead of AMD define().' }] },
- { code: 'define(["a"], function(a) { console.log(a); })', errors: [ { message: 'Expected imports instead of AMD define().' }] },
+ { code: 'define([], function() {})', errors: [{ message: 'Expected imports instead of AMD define().' }] },
+ { code: 'define(["a"], function(a) { console.log(a); })', errors: [{ message: 'Expected imports instead of AMD define().' }] },
- { code: 'require([], function() {})', errors: [ { message: 'Expected imports instead of AMD require().' }] },
- { code: 'require(["a"], function(a) { console.log(a); })', errors: [ { message: 'Expected imports instead of AMD require().' }] },
+ { code: 'require([], function() {})', errors: [{ message: 'Expected imports instead of AMD require().' }] },
+ { code: 'require(["a"], function(a) { console.log(a); })', errors: [{ message: 'Expected imports instead of AMD require().' }] },
],
});
diff --git a/tests/src/rules/no-commonjs.js b/tests/src/rules/no-commonjs.js
index baa3b907f6..b7c0aa803f 100644
--- a/tests/src/rules/no-commonjs.js
+++ b/tests/src/rules/no-commonjs.js
@@ -69,47 +69,47 @@ ruleTester.run('no-commonjs', require('rules/no-commonjs'), {
// imports
...semver.satisfies(eslintPkg.version, '< 4.0.0') ? [] : [
- { code: 'var x = require("x")', output: 'var x = require("x")', errors: [ { message: IMPORT_MESSAGE }] },
- { code: 'x = require("x")', output: 'x = require("x")', errors: [ { message: IMPORT_MESSAGE }] },
- { code: 'require("x")', output: 'require("x")', errors: [ { message: IMPORT_MESSAGE }] },
+ { code: 'var x = require("x")', output: 'var x = require("x")', errors: [{ message: IMPORT_MESSAGE }] },
+ { code: 'x = require("x")', output: 'x = require("x")', errors: [{ message: IMPORT_MESSAGE }] },
+ { code: 'require("x")', output: 'require("x")', errors: [{ message: IMPORT_MESSAGE }] },
{ code: 'require(`x`)',
parserOptions: { ecmaVersion: 2015 },
output: 'require(`x`)',
- errors: [ { message: IMPORT_MESSAGE }],
+ errors: [{ message: IMPORT_MESSAGE }],
},
{ code: 'if (typeof window !== "undefined") require("x")',
options: [{ allowConditionalRequire: false }],
output: 'if (typeof window !== "undefined") require("x")',
- errors: [ { message: IMPORT_MESSAGE }],
+ errors: [{ message: IMPORT_MESSAGE }],
},
{ code: 'if (typeof window !== "undefined") { require("x") }',
options: [{ allowConditionalRequire: false }],
output: 'if (typeof window !== "undefined") { require("x") }',
- errors: [ { message: IMPORT_MESSAGE }],
+ errors: [{ message: IMPORT_MESSAGE }],
},
{ code: 'try { require("x") } catch (error) {}',
options: [{ allowConditionalRequire: false }],
output: 'try { require("x") } catch (error) {}',
- errors: [ { message: IMPORT_MESSAGE }],
+ errors: [{ message: IMPORT_MESSAGE }],
},
],
// exports
- { code: 'exports.face = "palm"', output: 'exports.face = "palm"', errors: [ { message: EXPORT_MESSAGE }] },
- { code: 'module.exports.face = "palm"', output: 'module.exports.face = "palm"', errors: [ { message: EXPORT_MESSAGE }] },
- { code: 'module.exports = face', output: 'module.exports = face', errors: [ { message: EXPORT_MESSAGE }] },
- { code: 'exports = module.exports = {}', output: 'exports = module.exports = {}', errors: [ { message: EXPORT_MESSAGE }] },
- { code: 'var x = module.exports = {}', output: 'var x = module.exports = {}', errors: [ { message: EXPORT_MESSAGE }] },
+ { code: 'exports.face = "palm"', output: 'exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] },
+ { code: 'module.exports.face = "palm"', output: 'module.exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] },
+ { code: 'module.exports = face', output: 'module.exports = face', errors: [{ message: EXPORT_MESSAGE }] },
+ { code: 'exports = module.exports = {}', output: 'exports = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] },
+ { code: 'var x = module.exports = {}', output: 'var x = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] },
{ code: 'module.exports = {}',
options: ['allow-primitive-modules'],
output: 'module.exports = {}',
- errors: [ { message: EXPORT_MESSAGE }],
+ errors: [{ message: EXPORT_MESSAGE }],
},
{ code: 'var x = module.exports',
options: ['allow-primitive-modules'],
output: 'var x = module.exports',
- errors: [ { message: EXPORT_MESSAGE }],
+ errors: [{ message: EXPORT_MESSAGE }],
},
],
});
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index 6f4e710f9d..21561615c6 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -57,7 +57,7 @@ ruleTester.run('no-extraneous-dependencies', rule, {
// 'project' type
test({
code: 'import "importType"',
- settings: { 'import/resolver': { node: { paths: [ path.join(__dirname, '../../files') ] } } },
+ settings: { 'import/resolver': { node: { paths: [path.join(__dirname, '../../files')] } } },
}),
test({
code: 'import chai from "chai"',
@@ -396,7 +396,7 @@ ruleTester.run('no-extraneous-dependencies', rule, {
test({
code: 'import "not-a-dependency"',
settings: {
- 'import/resolver': { node: { paths: [ path.join(__dirname, '../../files') ] } },
+ 'import/resolver': { node: { paths: [path.join(__dirname, '../../files')] } },
'import/internal-regex': '^not-a-dependency.*',
},
options: [{ includeInternal: true }],
diff --git a/tests/src/rules/no-internal-modules.js b/tests/src/rules/no-internal-modules.js
index 4a733d142a..c1c3015453 100644
--- a/tests/src/rules/no-internal-modules.js
+++ b/tests/src/rules/no-internal-modules.js
@@ -41,51 +41,51 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'import b from "../../api/service"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ '**/api/*' ],
- } ],
+ options: [{
+ allow: ['**/api/*'],
+ }],
}),
test({
code: 'import "jquery/dist/jquery"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ 'jquery/dist/*' ],
- } ],
+ options: [{
+ allow: ['jquery/dist/*'],
+ }],
}),
test({
code: 'import "./app/index.js";\nimport "./app/index"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ '**/index{.js,}' ],
- } ],
+ options: [{
+ allow: ['**/index{.js,}'],
+ }],
}),
test({
code: 'import a from "./plugin2/thing"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- forbid: [ '**/api/*' ],
- } ],
+ options: [{
+ forbid: ['**/api/*'],
+ }],
}),
test({
code: 'const a = require("./plugin2/thing")',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- forbid: [ '**/api/*' ],
- } ],
+ options: [{
+ forbid: ['**/api/*'],
+ }],
}),
test({
code: 'import b from "app/a"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ 'app/**/**' ],
- } ],
+ options: [{
+ forbid: ['app/**/**'],
+ }],
}),
test({
code: 'import b from "@org/package"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '@org/package/*' ],
- } ],
+ options: [{
+ forbid: ['@org/package/*'],
+ }],
}),
// exports
test({
@@ -103,23 +103,23 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'export {b} from "../../api/service"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ '**/api/*' ],
- } ],
+ options: [{
+ allow: ['**/api/*'],
+ }],
}),
test({
code: 'export * from "jquery/dist/jquery"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ 'jquery/dist/*' ],
- } ],
+ options: [{
+ allow: ['jquery/dist/*'],
+ }],
}),
test({
code: 'export * from "./app/index.js";\nexport * from "./app/index"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- allow: [ '**/index{.js,}' ],
- } ],
+ options: [{
+ allow: ['**/index{.js,}'],
+ }],
}),
test({
code: `
@@ -145,30 +145,30 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'export * from "./plugin2/thing"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- forbid: [ '**/api/*' ],
- } ],
+ options: [{
+ forbid: ['**/api/*'],
+ }],
}),
test({
code: 'export * from "app/a"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ 'app/**/**' ],
- } ],
+ options: [{
+ forbid: ['app/**/**'],
+ }],
}),
test({
code: 'export { b } from "@org/package"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '@org/package/*' ],
- } ],
+ options: [{
+ forbid: ['@org/package/*'],
+ }],
}),
test({
code: 'export * from "./app/index.js";\nexport * from "./app/index"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '**/index.ts' ],
- } ],
+ options: [{
+ forbid: ['**/index.ts'],
+ }],
}),
],
@@ -177,39 +177,39 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'import "./plugin2/index.js";\nimport "./plugin2/app/index"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- allow: [ '*/index.js' ],
- } ],
- errors: [ {
+ options: [{
+ allow: ['*/index.js'],
+ }],
+ errors: [{
message: 'Reaching to "./plugin2/app/index" is not allowed.',
line: 2,
column: 8,
- } ],
+ }],
}),
test({
code: 'import "./app/index.js"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- errors: [ {
+ errors: [{
message: 'Reaching to "./app/index.js" is not allowed.',
line: 1,
column: 8,
- } ],
+ }],
}),
test({
code: 'import b from "./plugin2/internal"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- errors: [ {
+ errors: [{
message: 'Reaching to "./plugin2/internal" is not allowed.',
line: 1,
column: 15,
- } ],
+ }],
}),
test({
code: 'import a from "../api/service/index"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- allow: [ '**/internal-modules/*' ],
- } ],
+ options: [{
+ allow: ['**/internal-modules/*'],
+ }],
errors: [
{
message: 'Reaching to "../api/service/index" is not allowed.',
@@ -243,58 +243,58 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'import "./app/index.js"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '*/app/*' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['*/app/*'],
+ }],
+ errors: [{
message: 'Reaching to "./app/index.js" is not allowed.',
line: 1,
column: 8,
- } ],
+ }],
}),
test({
code: 'import b from "@org/package"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '@org/**' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['@org/**'],
+ }],
+ errors: [{
message: 'Reaching to "@org/package" is not allowed.',
line: 1,
column: 15,
- } ],
+ }],
}),
test({
code: 'import b from "app/a/b"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ 'app/**/**' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['app/**/**'],
+ }],
+ errors: [{
message: 'Reaching to "app/a/b" is not allowed.',
line: 1,
column: 15,
- } ],
+ }],
}),
test({
code: 'import get from "lodash.get"',
filename: testFilePath('./internal-modules/plugins/plugin2/index.js'),
- options: [ {
- forbid: [ 'lodash.*' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['lodash.*'],
+ }],
+ errors: [{
message: 'Reaching to "lodash.get" is not allowed.',
line: 1,
column: 17,
- } ],
+ }],
}),
test({
code: 'import "./app/index.js";\nimport "./app/index"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '**/index{.js,}' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['**/index{.js,}'],
+ }],
+ errors: [{
message: 'Reaching to "./app/index.js" is not allowed.',
line: 1,
column: 8,
@@ -302,18 +302,18 @@ ruleTester.run('no-internal-modules', rule, {
message: 'Reaching to "./app/index" is not allowed.',
line: 2,
column: 8,
- } ],
+ }],
}),
test({
code: 'import "@/api/service";',
- options: [ {
- forbid: [ '**/api/*' ],
- } ],
- errors: [ {
+ options: [{
+ forbid: ['**/api/*'],
+ }],
+ errors: [{
message: 'Reaching to "@/api/service" is not allowed.',
line: 1,
column: 8,
- } ],
+ }],
settings: {
'import/resolver': {
webpack: {
@@ -332,39 +332,39 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'export * from "./plugin2/index.js";\nexport * from "./plugin2/app/index"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- allow: [ '*/index.js' ],
- } ],
- errors: [ {
+ options: [{
+ allow: ['*/index.js'],
+ }],
+ errors: [{
message: 'Reaching to "./plugin2/app/index" is not allowed.',
line: 2,
column: 15,
- } ],
+ }],
}),
test({
code: 'export * from "./app/index.js"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- errors: [ {
+ errors: [{
message: 'Reaching to "./app/index.js" is not allowed.',
line: 1,
column: 15,
- } ],
+ }],
}),
test({
code: 'export {b} from "./plugin2/internal"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- errors: [ {
+ errors: [{
message: 'Reaching to "./plugin2/internal" is not allowed.',
line: 1,
column: 17,
- } ],
+ }],
}),
test({
code: 'export {a} from "../api/service/index"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- allow: [ '**/internal-modules/*' ],
- } ],
+ options: [{
+ allow: ['**/internal-modules/*'],
+ }],
errors: [
{
message: 'Reaching to "../api/service/index" is not allowed.',
@@ -398,9 +398,9 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'export * from "./plugin2/thing"',
filename: testFilePath('./internal-modules/plugins/plugin.js'),
- options: [ {
- forbid: [ '**/plugin2/*' ],
- } ],
+ options: [{
+ forbid: ['**/plugin2/*'],
+ }],
errors: [
{
message: 'Reaching to "./plugin2/thing" is not allowed.',
@@ -412,9 +412,9 @@ ruleTester.run('no-internal-modules', rule, {
test({
code: 'export * from "app/a"',
filename: testFilePath('./internal-modules/plugins/plugin2/internal.js'),
- options: [ {
- forbid: [ '**' ],
- } ],
+ options: [{
+ forbid: ['**'],
+ }],
errors: [
{
message: 'Reaching to "app/a" is not allowed.',
diff --git a/tests/src/rules/no-named-as-default.js b/tests/src/rules/no-named-as-default.js
index 04ec28e615..c6646a4f0d 100644
--- a/tests/src/rules/no-named-as-default.js
+++ b/tests/src/rules/no-named-as-default.js
@@ -33,28 +33,28 @@ ruleTester.run('no-named-as-default', rule, {
invalid: [].concat(
test({
code: 'import foo from "./bar";',
- errors: [ {
+ errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ImportDefaultSpecifier' } ] }),
+ type: 'ImportDefaultSpecifier' }] }),
test({
code: 'import foo, { foo as bar } from "./bar";',
- errors: [ {
+ errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ImportDefaultSpecifier' } ] }),
+ type: 'ImportDefaultSpecifier' }] }),
// es7
test({
code: 'export foo from "./bar";',
parser: parsers.BABEL_OLD,
- errors: [ {
+ errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ExportDefaultSpecifier' } ] }),
+ type: 'ExportDefaultSpecifier' }] }),
test({
code: 'export foo, { foo as bar } from "./bar";',
parser: parsers.BABEL_OLD,
- errors: [ {
+ errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ExportDefaultSpecifier' } ] }),
+ type: 'ExportDefaultSpecifier' }] }),
test({
code: 'import foo from "./malformed.js"',
diff --git a/tests/src/rules/no-namespace.js b/tests/src/rules/no-namespace.js
index d75928c1d8..03a23e3dd7 100644
--- a/tests/src/rules/no-namespace.js
+++ b/tests/src/rules/no-namespace.js
@@ -20,7 +20,7 @@ const FIX_TESTS = semver.satisfies(eslintPkg.version, '>5.0.0') ? [
florp(bar);
florp(baz);
`.trim(),
- errors: [ {
+ errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
@@ -43,7 +43,7 @@ const FIX_TESTS = semver.satisfies(eslintPkg.version, '>5.0.0') ? [
florp(foo_bar);
florp(foo_baz_1);
`.trim(),
- errors: [ {
+ errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
@@ -64,7 +64,7 @@ const FIX_TESTS = semver.satisfies(eslintPkg.version, '>5.0.0') ? [
florp(foo_arg);
}
`.trim(),
- errors: [ {
+ errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
@@ -85,29 +85,29 @@ ruleTester.run('no-namespace', require('rules/no-namespace'), {
test({
code: 'import * as foo from \'foo\';',
output: 'import * as foo from \'foo\';',
- errors: [ {
+ errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
- } ],
+ }],
}),
test({
code: 'import defaultExport, * as foo from \'foo\';',
output: 'import defaultExport, * as foo from \'foo\';',
- errors: [ {
+ errors: [{
line: 1,
column: 23,
message: ERROR_MESSAGE,
- } ],
+ }],
}),
test({
code: 'import * as foo from \'./foo\';',
output: 'import * as foo from \'./foo\';',
- errors: [ {
+ errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
- } ],
+ }],
}),
...FIX_TESTS,
],
diff --git a/tests/src/rules/no-relative-packages.js b/tests/src/rules/no-relative-packages.js
index 2d27bcc91e..6104aeb9ca 100644
--- a/tests/src/rules/no-relative-packages.js
+++ b/tests/src/rules/no-relative-packages.js
@@ -42,41 +42,41 @@ ruleTester.run('no-relative-packages', rule, {
test({
code: 'import foo from "./package-named"',
filename: testFilePath('./bar.js'),
- errors: [ {
+ errors: [{
message: 'Relative import from another package is not allowed. Use `package-named` instead of `./package-named`',
line: 1,
column: 17,
- } ],
+ }],
output: 'import foo from "package-named"',
}),
test({
code: 'import foo from "../package-named"',
filename: testFilePath('./package/index.js'),
- errors: [ {
+ errors: [{
message: 'Relative import from another package is not allowed. Use `package-named` instead of `../package-named`',
line: 1,
column: 17,
- } ],
+ }],
output: 'import foo from "package-named"',
}),
test({
code: 'import foo from "../package-scoped"',
filename: testFilePath('./package/index.js'),
- errors: [ {
+ errors: [{
message: `Relative import from another package is not allowed. Use \`${normalize('@scope/package-named')}\` instead of \`../package-scoped\``,
line: 1,
column: 17,
- } ],
+ }],
output: `import foo from "@scope/package-named"`,
}),
test({
code: 'import bar from "../bar"',
filename: testFilePath('./package-named/index.js'),
- errors: [ {
+ errors: [{
message: `Relative import from another package is not allowed. Use \`${normalize('eslint-plugin-import/tests/files/bar')}\` instead of \`../bar\``,
line: 1,
column: 17,
- } ],
+ }],
output: `import bar from "eslint-plugin-import/tests/files/bar"`,
}),
],
diff --git a/tests/src/rules/no-relative-parent-imports.js b/tests/src/rules/no-relative-parent-imports.js
index bfd4e16bcd..1af9b8cf8d 100644
--- a/tests/src/rules/no-relative-parent-imports.js
+++ b/tests/src/rules/no-relative-parent-imports.js
@@ -55,32 +55,32 @@ ruleTester.run('no-relative-parent-imports', rule, {
invalid: [
test({
code: 'import foo from "../plugin.js"',
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `../plugin.js` or consider making `../plugin.js` a package.',
line: 1,
column: 17,
- } ],
+ }],
}),
test({
code: 'require("../plugin.js")',
options: [{ commonjs: true }],
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `../plugin.js` or consider making `../plugin.js` a package.',
line: 1,
column: 9,
- } ],
+ }],
}),
test({
code: 'import("../plugin.js")',
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `../plugin.js` or consider making `../plugin.js` a package.',
line: 1,
column: 8,
- } ],
+ }],
}),
test({
code: 'import foo from "./../plugin.js"',
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `./../plugin.js` or consider making `./../plugin.js` a package.',
line: 1,
column: 17,
@@ -88,7 +88,7 @@ ruleTester.run('no-relative-parent-imports', rule, {
}),
test({
code: 'import foo from "../../api/service"',
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `../../api/service` or consider making `../../api/service` a package.',
line: 1,
column: 17,
@@ -96,7 +96,7 @@ ruleTester.run('no-relative-parent-imports', rule, {
}),
test({
code: 'import("../../api/service")',
- errors: [ {
+ errors: [{
message: 'Relative imports from parent directories are not allowed. Please either pass what you\'re importing through at runtime (dependency injection), move `index.js` to same directory as `../../api/service` or consider making `../../api/service` a package.',
line: 1,
column: 8,
diff --git a/tests/src/rules/no-unresolved.js b/tests/src/rules/no-unresolved.js
index 109099c389..04a53d887b 100644
--- a/tests/src/rules/no-unresolved.js
+++ b/tests/src/rules/no-unresolved.js
@@ -387,7 +387,7 @@ ruleTester.run('no-unresolved (import/resolve legacy)', rule, {
invalid: [
test({
code: 'import * as foo from "jsx-module/foo"',
- errors: [ "Unable to resolve path to module 'jsx-module/foo'." ],
+ errors: ["Unable to resolve path to module 'jsx-module/foo'."],
}),
],
});
@@ -536,12 +536,12 @@ context('TypeScript', () => {
invalid: [
test({
code: 'import { JSONSchema7Type } from "@types/json-schema";',
- errors: [ "Unable to resolve path to module '@types/json-schema'." ],
+ errors: ["Unable to resolve path to module '@types/json-schema'."],
parser,
}),
test({
code: 'export { JSONSchema7Type } from "@types/json-schema";',
- errors: [ "Unable to resolve path to module '@types/json-schema'." ],
+ errors: ["Unable to resolve path to module '@types/json-schema'."],
parser,
}),
],
diff --git a/tests/src/rules/no-useless-path-segments.js b/tests/src/rules/no-useless-path-segments.js
index f960953503..d6d0395dea 100644
--- a/tests/src/rules/no-useless-path-segments.js
+++ b/tests/src/rules/no-useless-path-segments.js
@@ -42,49 +42,49 @@ function runResolverTests(resolver) {
code: 'require("./../files/malformed.js")',
output: 'require("../files/malformed.js")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "./../files/malformed.js", should be "../files/malformed.js"'],
+ errors: ['Useless path segments for "./../files/malformed.js", should be "../files/malformed.js"'],
}),
test({
code: 'require("./../files/malformed")',
output: 'require("../files/malformed")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "./../files/malformed", should be "../files/malformed"'],
+ errors: ['Useless path segments for "./../files/malformed", should be "../files/malformed"'],
}),
test({
code: 'require("../files/malformed.js")',
output: 'require("./malformed.js")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "../files/malformed.js", should be "./malformed.js"'],
+ errors: ['Useless path segments for "../files/malformed.js", should be "./malformed.js"'],
}),
test({
code: 'require("../files/malformed")',
output: 'require("./malformed")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "../files/malformed", should be "./malformed"'],
+ errors: ['Useless path segments for "../files/malformed", should be "./malformed"'],
}),
test({
code: 'require("./test-module/")',
output: 'require("./test-module")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "./test-module/", should be "./test-module"'],
+ errors: ['Useless path segments for "./test-module/", should be "./test-module"'],
}),
test({
code: 'require("./")',
output: 'require(".")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "./", should be "."'],
+ errors: ['Useless path segments for "./", should be "."'],
}),
test({
code: 'require("../")',
output: 'require("..")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "../", should be ".."'],
+ errors: ['Useless path segments for "../", should be ".."'],
}),
test({
code: 'require("./deep//a")',
output: 'require("./deep/a")',
options: [{ commonjs: true }],
- errors: [ 'Useless path segments for "./deep//a", should be "./deep/a"'],
+ errors: ['Useless path segments for "./deep//a", should be "./deep/a"'],
}),
// CommonJS modules + noUselessIndex
@@ -141,42 +141,42 @@ function runResolverTests(resolver) {
test({
code: 'import "./../files/malformed.js"',
output: 'import "../files/malformed.js"',
- errors: [ 'Useless path segments for "./../files/malformed.js", should be "../files/malformed.js"'],
+ errors: ['Useless path segments for "./../files/malformed.js", should be "../files/malformed.js"'],
}),
test({
code: 'import "./../files/malformed"',
output: 'import "../files/malformed"',
- errors: [ 'Useless path segments for "./../files/malformed", should be "../files/malformed"'],
+ errors: ['Useless path segments for "./../files/malformed", should be "../files/malformed"'],
}),
test({
code: 'import "../files/malformed.js"',
output: 'import "./malformed.js"',
- errors: [ 'Useless path segments for "../files/malformed.js", should be "./malformed.js"'],
+ errors: ['Useless path segments for "../files/malformed.js", should be "./malformed.js"'],
}),
test({
code: 'import "../files/malformed"',
output: 'import "./malformed"',
- errors: [ 'Useless path segments for "../files/malformed", should be "./malformed"'],
+ errors: ['Useless path segments for "../files/malformed", should be "./malformed"'],
}),
test({
code: 'import "./test-module/"',
output: 'import "./test-module"',
- errors: [ 'Useless path segments for "./test-module/", should be "./test-module"'],
+ errors: ['Useless path segments for "./test-module/", should be "./test-module"'],
}),
test({
code: 'import "./"',
output: 'import "."',
- errors: [ 'Useless path segments for "./", should be "."'],
+ errors: ['Useless path segments for "./", should be "."'],
}),
test({
code: 'import "../"',
output: 'import ".."',
- errors: [ 'Useless path segments for "../", should be ".."'],
+ errors: ['Useless path segments for "../", should be ".."'],
}),
test({
code: 'import "./deep//a"',
output: 'import "./deep/a"',
- errors: [ 'Useless path segments for "./deep//a", should be "./deep/a"'],
+ errors: ['Useless path segments for "./deep//a", should be "./deep/a"'],
}),
// ES modules + noUselessIndex
@@ -231,19 +231,19 @@ function runResolverTests(resolver) {
test({
code: 'import("./")',
output: 'import(".")',
- errors: [ 'Useless path segments for "./", should be "."'],
+ errors: ['Useless path segments for "./", should be "."'],
parser: parsers.BABEL_OLD,
}),
test({
code: 'import("../")',
output: 'import("..")',
- errors: [ 'Useless path segments for "../", should be ".."'],
+ errors: ['Useless path segments for "../", should be ".."'],
parser: parsers.BABEL_OLD,
}),
test({
code: 'import("./deep//a")',
output: 'import("./deep/a")',
- errors: [ 'Useless path segments for "./deep//a", should be "./deep/a"'],
+ errors: ['Useless path segments for "./deep//a", should be "./deep/a"'],
parser: parsers.BABEL_OLD,
}),
],
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 84b341e1b0..db6aec4fcf 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -236,7 +236,7 @@ ruleTester.run('order', rule, {
import fs from 'fs';
import { add } from './helper';`,
options: [{
- groups: [ 'unknown', 'builtin', 'external', 'parent', 'sibling', 'index' ],
+ groups: ['unknown', 'builtin', 'external', 'parent', 'sibling', 'index'],
}],
}),
// Using unknown import types (e.g. using a resolver alias via babel)
diff --git a/utils/ignore.js b/utils/ignore.js
index e41d1e5a50..960538e706 100644
--- a/utils/ignore.js
+++ b/utils/ignore.js
@@ -20,7 +20,7 @@ function validExtensions(context) {
function makeValidExtensionSet(settings) {
// start with explicit JS-parsed extensions
- const exts = new Set(settings['import/extensions'] || [ '.js' ]);
+ const exts = new Set(settings['import/extensions'] || ['.js']);
// all alternate parser extensions are also valid
if ('import/parsers' in settings) {
From a6de522d1afb734becb6c478766e6c2ed6c873c6 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 10:10:02 -0700
Subject: [PATCH 033/199] [Tests] `no-unused-modules`: properly skip in mocha 3
---
tests/src/rules/no-unused-modules.js | 30 +++++++++++++++-------------
1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 936123ab71..219d996b3a 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -1374,19 +1374,21 @@ describe('parser ignores prefixes like BOM and hashbang', () => {
});
});
-describe('supports flat eslint', { skip: !FlatRuleTester }, () => {
- const flatRuleTester = new FlatRuleTester();
- flatRuleTester.run('no-unused-modules', rule, {
- valid: [{
- options: unusedExportsOptions,
- code: 'import { o2 } from "./file-o"; export default () => 12',
- filename: testFilePath('./no-unused-modules/file-a.js'),
- }],
- invalid: [{
- options: unusedExportsOptions,
- code: 'export default () => 13',
- filename: testFilePath('./no-unused-modules/file-f.js'),
- errors: [error(`exported declaration 'default' not used within other modules`)],
- }],
+(FlatRuleTester ? describe : describe.skip)('supports flat eslint', () => {
+ it('passes', () => {
+ const flatRuleTester = new FlatRuleTester();
+ flatRuleTester.run('no-unused-modules', rule, {
+ valid: [{
+ options: unusedExportsOptions,
+ code: 'import { o2 } from "./file-o"; export default () => 12',
+ filename: testFilePath('./no-unused-modules/file-a.js'),
+ }],
+ invalid: [{
+ options: unusedExportsOptions,
+ code: 'export default () => 13',
+ filename: testFilePath('./no-unused-modules/file-f.js'),
+ errors: [error(`exported declaration 'default' not used within other modules`)],
+ }],
+ });
});
});
From 3e1dd0b7b5af7dc2e5f54fc25534b8a944fd49c2 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 10:47:14 -0700
Subject: [PATCH 034/199] [Fix] `no-unused-modules`: improve schema
- allow empty arrays in `src` and `ignoreExports`
- enforce uniqueness in `src` and `ignoreExport` lists
- allow false/true combo on missingExports/unusedExports
---
CHANGELOG.md | 1 +
docs/rules/no-unused-modules.md | 2 +-
src/rules/no-unused-modules.js | 39 ++++++++++-----------------------
3 files changed, 14 insertions(+), 28 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7febb37111..c85317cca1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`order`]: partial fix for [#2687] (thanks [@ljharb])
- [`no-duplicates`]: Detect across type and regular imports ([#2835], thanks [@benkrejci])
- [`extensions`]: handle `.` and `..` properly ([#2778], thanks [@benasher44])
+ - [`no-unused-modules`]: improve schema (thanks [@ljharb])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
diff --git a/docs/rules/no-unused-modules.md b/docs/rules/no-unused-modules.md
index 5cd24bef41..a8e1a3c182 100644
--- a/docs/rules/no-unused-modules.md
+++ b/docs/rules/no-unused-modules.md
@@ -12,7 +12,7 @@ Reports:
### Usage
-In order for this plugin to work, one of the options `missingExports` or `unusedExports` must be enabled (see "Options" section below). In the future, these options will be enabled by default (see https://github.com/import-js/eslint-plugin-import/issues/1324)
+In order for this plugin to work, at least one of the options `missingExports` or `unusedExports` must be enabled (see "Options" section below). In the future, these options will be enabled by default (see https://github.com/import-js/eslint-plugin-import/issues/1324)
Example:
```
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index a2b6f4ea27..f3d56e4291 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -416,17 +416,16 @@ module.exports = {
src: {
description: 'files/paths to be analyzed (only for unused exports)',
type: 'array',
- minItems: 1,
+ uniqueItems: true,
items: {
type: 'string',
minLength: 1,
},
},
ignoreExports: {
- description:
- 'files/paths for which unused exports will not be reported (e.g module entry points)',
+ description: 'files/paths for which unused exports will not be reported (e.g module entry points)',
type: 'array',
- minItems: 1,
+ uniqueItems: true,
items: {
type: 'string',
minLength: 1,
@@ -441,37 +440,23 @@ module.exports = {
type: 'boolean',
},
},
- not: {
- properties: {
- unusedExports: { enum: [false] },
- missingExports: { enum: [false] },
- },
- },
- anyOf: [{
- not: {
+ anyOf: [
+ {
properties: {
unusedExports: { enum: [true] },
+ src: {
+ minItems: 1,
+ },
},
+ required: ['unusedExports'],
},
- required: ['missingExports'],
- }, {
- not: {
+ {
properties: {
missingExports: { enum: [true] },
},
+ required: ['missingExports'],
},
- required: ['unusedExports'],
- }, {
- properties: {
- unusedExports: { enum: [true] },
- },
- required: ['unusedExports'],
- }, {
- properties: {
- missingExports: { enum: [true] },
- },
- required: ['missingExports'],
- }],
+ ],
}],
},
From d3aa4780e349a8af6466f13524c258544dac3d36 Mon Sep 17 00:00:00 2001
From: Jemi Salo <jemi.salo@gmail.com>
Date: Wed, 26 Jul 2023 16:37:16 +0300
Subject: [PATCH 035/199] [Tests] `no-unused-modules`: document error reported
on entire `export` statement
---
tests/src/rules/no-unused-modules.js | 46 ++++++++++++++++++----------
1 file changed, 30 insertions(+), 16 deletions(-)
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 219d996b3a..80f0fee730 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -164,24 +164,38 @@ ruleTester.run('no-unused-modules', rule, {
invalid: [
test({
options: unusedExportsOptions,
- code: `import eslint from 'eslint'
- import fileA from './file-a'
- import { b } from './file-b'
- import { c1, c2 } from './file-c'
- import { d } from './file-d'
- import { e } from './file-e'
- import { e2 } from './file-e'
- import { h2 } from './file-h'
- import * as l from './file-l'
- export * from './file-n'
- export { default, o0, o3 } from './file-o'
- export { p } from './file-p'
- import s from './file-s'`,
+ code: `
+ import eslint from 'eslint'
+ import fileA from './file-a'
+ import { b } from './file-b'
+ import { c1, c2 } from './file-c'
+ import { d } from './file-d'
+ import { e } from './file-e'
+ import { e2 } from './file-e'
+ import { h2 } from './file-h'
+ import * as l from './file-l'
+ export * from './file-n'
+ export { default, o0, o3 } from './file-o'
+ export { p } from './file-p'
+ import s from './file-s'
+ `,
filename: testFilePath('./no-unused-modules/file-0.js'),
errors: [
- error(`exported declaration 'default' not used within other modules`),
- error(`exported declaration 'o0' not used within other modules`),
- error(`exported declaration 'o3' not used within other modules`),
+ {
+ message: `exported declaration 'default' not used within other modules`,
+ line: 12,
+ column: 9,
+ },
+ {
+ message: `exported declaration 'o0' not used within other modules`,
+ line: 12,
+ column: 9,
+ },
+ {
+ message: `exported declaration 'o3' not used within other modules`,
+ line: 12,
+ column: 9,
+ },
error(`exported declaration 'p' not used within other modules`),
],
}),
From 90e2dfa8c8f2ebdef8dc5d19873b3134c8a916e0 Mon Sep 17 00:00:00 2001
From: Jemi Salo <jemi.salo@gmail.com>
Date: Wed, 26 Jul 2023 16:38:09 +0300
Subject: [PATCH 036/199] [Fix] `no-unused-modules`: report error on binding
instead of parent export
---
CHANGELOG.md | 5 ++++-
src/rules/no-unused-modules.js | 2 +-
tests/src/rules/no-unused-modules.js | 6 +++---
3 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c85317cca1..2f9e67189c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,7 +15,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`order`]: partial fix for [#2687] (thanks [@ljharb])
- [`no-duplicates`]: Detect across type and regular imports ([#2835], thanks [@benkrejci])
- [`extensions`]: handle `.` and `..` properly ([#2778], thanks [@benasher44])
- - [`no-unused-modules`]: improve schema (thanks [@ljharb])
+- [`no-unused-modules`]: improve schema (thanks [@ljharb])
+- [`no-unused-modules`]: report error on binding instead of parent export ([#2842], thanks [@Chamion])
### Changed
- [Docs] [`no-duplicates`]: fix example schema ([#2684], thanks [@simmo])
@@ -1076,6 +1077,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2842]: https://github.com/import-js/eslint-plugin-import/pull/2842
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
[#2778]: https://github.com/import-js/eslint-plugin-import/pull/2778
@@ -1666,6 +1668,7 @@ for info on changes for earlier releases.
[@bradzacher]: https://github.com/bradzacher
[@brendo]: https://github.com/brendo
[@brettz9]: https://github.com/brettz9
+[@Chamion]: https://github.com/Chamion
[@charlessuh]: https://github.com/charlessuh
[@charpeni]: https://github.com/charpeni
[@cherryblossom000]: https://github.com/cherryblossom000
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index f3d56e4291..c8a20f8c0e 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -931,7 +931,7 @@ module.exports = {
},
ExportNamedDeclaration(node) {
node.specifiers.forEach((specifier) => {
- checkUsage(node, specifier.exported.name || specifier.exported.value);
+ checkUsage(specifier, specifier.exported.name || specifier.exported.value);
});
forEachDeclarationIdentifier(node.declaration, (name) => {
checkUsage(node, name);
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 80f0fee730..77fb608ccb 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -184,17 +184,17 @@ ruleTester.run('no-unused-modules', rule, {
{
message: `exported declaration 'default' not used within other modules`,
line: 12,
- column: 9,
+ column: 18,
},
{
message: `exported declaration 'o0' not used within other modules`,
line: 12,
- column: 9,
+ column: 27,
},
{
message: `exported declaration 'o3' not used within other modules`,
line: 12,
- column: 9,
+ column: 31,
},
error(`exported declaration 'p' not used within other modules`),
],
From 70f24f1fefcf3da0f804d273fa3347e9471fbb77 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:25:17 -0700
Subject: [PATCH 037/199] [Tests] allow WSL builds to fail, for now
---
appveyor.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/appveyor.yml b/appveyor.yml
index dbeb0132d6..e50ab87d2a 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -26,6 +26,7 @@ matrix:
allow_failures:
- nodejs_version: "4" # for eslint 5
+ - configuration: WSL
platform:
- x86
From 703e9f9395ed8fe03c6c8c3c4cc04360d7df3d7e Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:38:59 -0700
Subject: [PATCH 038/199] [Refactor] `no-duplicates`, `no-unused-modules`: use
`flatMap` instead of `map` + `filter`
---
src/rules/no-default-export.js | 18 ++++++++++--------
src/rules/no-duplicates.js | 11 +++++------
src/rules/no-restricted-paths.js | 11 ++++++-----
src/rules/no-unused-modules.js | 6 ++----
tests/src/package.js | 3 +--
tests/src/rules/order.js | 2 +-
6 files changed, 25 insertions(+), 26 deletions(-)
diff --git a/src/rules/no-default-export.js b/src/rules/no-default-export.js
index 6e5a537485..dabbae543a 100644
--- a/src/rules/no-default-export.js
+++ b/src/rules/no-default-export.js
@@ -27,14 +27,16 @@ module.exports = {
},
ExportNamedDeclaration(node) {
- node.specifiers.filter((specifier) => (specifier.exported.name || specifier.exported.value) === 'default').forEach((specifier) => {
- const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
- if (specifier.type === 'ExportDefaultSpecifier') {
- context.report({ node, message: preferNamed, loc });
- } else if (specifier.type === 'ExportSpecifier') {
- context.report({ node, message: noAliasDefault(specifier), loc });
- }
- });
+ node.specifiers
+ .filter((specifier) => (specifier.exported.name || specifier.exported.value) === 'default')
+ .forEach((specifier) => {
+ const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
+ if (specifier.type === 'ExportDefaultSpecifier') {
+ context.report({ node, message: preferNamed, loc });
+ } else if (specifier.type === 'ExportSpecifier') {
+ context.report({ node, message: noAliasDefault(specifier), loc });
+ }
+ });
},
};
},
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 2373202cb6..6b4f4d559e 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -1,6 +1,8 @@
import resolve from 'eslint-module-utils/resolve';
-import docsUrl from '../docsUrl';
import semver from 'semver';
+import flatMap from 'array.prototype.flatmap';
+
+import docsUrl from '../docsUrl';
let typescriptPkg;
try {
@@ -51,7 +53,7 @@ function getFix(first, rest, sourceCode, context) {
}
const defaultImportNames = new Set(
- [first, ...rest].map(getDefaultImportName).filter(Boolean),
+ flatMap([].concat(first, rest || []), (x) => getDefaultImportName(x) || []),
);
// Bail if there are multiple different default import names – it's up to the
@@ -62,10 +64,7 @@ function getFix(first, rest, sourceCode, context) {
// Leave it to the user to handle comments. Also skip `import * as ns from
// './foo'` imports, since they cannot be merged into another import.
- const restWithoutComments = rest.filter((node) => !(
- hasProblematicComments(node, sourceCode)
- || hasNamespace(node)
- ));
+ const restWithoutComments = rest.filter((node) => !hasProblematicComments(node, sourceCode) && !hasNamespace(node));
const specifiers = restWithoutComments
.map((node) => {
diff --git a/src/rules/no-restricted-paths.js b/src/rules/no-restricted-paths.js
index bce9fd1a03..cd680a1946 100644
--- a/src/rules/no-restricted-paths.js
+++ b/src/rules/no-restricted-paths.js
@@ -77,9 +77,11 @@ module.exports = {
const restrictedPaths = options.zones || [];
const basePath = options.basePath || process.cwd();
const currentFilename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
- const matchingZones = restrictedPaths.filter((zone) => [].concat(zone.target)
- .map((target) => path.resolve(basePath, target))
- .some((targetPath) => isMatchingTargetPath(currentFilename, targetPath)));
+ const matchingZones = restrictedPaths.filter(
+ (zone) => [].concat(zone.target)
+ .map((target) => path.resolve(basePath, target))
+ .some((targetPath) => isMatchingTargetPath(currentFilename, targetPath)),
+ );
function isMatchingTargetPath(filename, targetPath) {
if (isGlob(targetPath)) {
@@ -231,8 +233,7 @@ module.exports = {
reportInvalidExceptions(validatorsWithInvalidExceptions, node);
const applicableValidatorsForImportPathExcludingExceptions = applicableValidatorsForImportPath
- .filter((validator) => validator.hasValidExceptions)
- .filter((validator) => !validator.isPathException(absoluteImportPath));
+ .filter((validator) => validator.hasValidExceptions && !validator.isPathException(absoluteImportPath));
reportImportsInRestrictedZone(applicableValidatorsForImportPathExcludingExceptions, node, importPath, zone.message);
});
}
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index c8a20f8c0e..ecba3a19ce 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -177,7 +177,7 @@ const resolveFiles = (src, ignoreExports, context) => {
// prepare list of source files, don't consider files from node_modules
return new Set(
- srcFileList.filter(({ filename }) => !isNodeModule(filename)).map(({ filename }) => filename),
+ flatMap(srcFileList, ({ filename }) => isNodeModule(filename) ? [] : filename),
);
};
@@ -359,9 +359,7 @@ const fileIsInPkg = (file) => {
};
const checkPkgFieldObject = (pkgField) => {
- const pkgFieldFiles = values(pkgField)
- .filter((value) => typeof value !== 'boolean')
- .map((value) => join(basePath, value));
+ const pkgFieldFiles = flatMap(values(pkgField), (value) => typeof value === 'boolean' ? [] : join(basePath, value));
if (includes(pkgFieldFiles, file)) {
return true;
diff --git a/tests/src/package.js b/tests/src/package.js
index dd55e2740b..08138084c6 100644
--- a/tests/src/package.js
+++ b/tests/src/package.js
@@ -27,8 +27,7 @@ describe('package', function () {
expect(err).not.to.exist;
files.filter(isJSFile).forEach(function (f) {
- expect(module.rules).to.have
- .property(path.basename(f, '.js'));
+ expect(module.rules).to.have.property(path.basename(f, '.js'));
});
done();
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index db6aec4fcf..2a44aa06aa 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -2736,7 +2736,7 @@ ruleTester.run('order', rule, {
}],
}),
],
- ].filter((t) => !!t),
+ ].filter(Boolean),
});
context('TypeScript', function () {
From 89f5d0d1b2c4200b90b45c37a588f08d59757187 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:40:41 -0700
Subject: [PATCH 039/199] [Refactor] `no-anonymous-default-export`: use
`fromEntries` instead of `reduce`
---
src/rules/no-anonymous-default-export.js | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)
diff --git a/src/rules/no-anonymous-default-export.js b/src/rules/no-anonymous-default-export.js
index 06ea854b33..59a3cbfdac 100644
--- a/src/rules/no-anonymous-default-export.js
+++ b/src/rules/no-anonymous-default-export.js
@@ -60,16 +60,10 @@ const defs = {
},
};
-const schemaProperties = Object.keys(defs)
- .map((key) => defs[key])
- .reduce((acc, def) => {
- acc[def.option] = {
- description: def.description,
- type: 'boolean',
- };
-
- return acc;
- }, {});
+const schemaProperties = fromEntries(values(defs).map((def) => [def.option, {
+ description: def.description,
+ type: 'boolean',
+}]));
const defaults = fromEntries(values(defs).map((def) => [def.option, has(def, 'default') ? def.default : false]));
From e7c248685eb1a74ad0e5093d5466f4de918c4cb6 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:42:52 -0700
Subject: [PATCH 040/199] [Refactor] `no-useless-path-segments`: use `.filter`
instead of `.reduce`
---
src/rules/no-useless-path-segments.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/rules/no-useless-path-segments.js b/src/rules/no-useless-path-segments.js
index 343a4f6230..390a7546d3 100644
--- a/src/rules/no-useless-path-segments.js
+++ b/src/rules/no-useless-path-segments.js
@@ -33,7 +33,7 @@ function normalize(fn) {
}
function countRelativeParents(pathSegments) {
- return pathSegments.reduce((sum, pathSegment) => pathSegment === '..' ? sum + 1 : sum, 0);
+ return pathSegments.filter((x) => x === '..').length;
}
module.exports = {
From be928ae19461f405d813798e49d2968982823c17 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:45:50 -0700
Subject: [PATCH 041/199] [Refactor] `no-internal-modules`: simplify a reduce
---
src/rules/no-internal-modules.js | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/src/rules/no-internal-modules.js b/src/rules/no-internal-modules.js
index 687193f5c5..5ed4565471 100644
--- a/src/rules/no-internal-modules.js
+++ b/src/rules/no-internal-modules.js
@@ -58,16 +58,14 @@ module.exports = {
}
function toSteps(somePath) {
- return normalizeSep(somePath)
+ return normalizeSep(somePath)
.split('/')
+ .filter((step) => step && step !== '.')
.reduce((acc, step) => {
- if (!step || step === '.') {
- return acc;
- } else if (step === '..') {
+ if (step === '..') {
return acc.slice(0, -1);
- } else {
- return acc.concat(step);
}
+ return acc.concat(step);
}, []);
}
From 600fcc10dba3229e5f69373f6e2b0896032ad4b9 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 20:49:06 -0700
Subject: [PATCH 042/199] [Refactor] `order`: use `object.groupby`
---
package.json | 1 +
src/rules/order.js | 9 ++-------
2 files changed, 3 insertions(+), 7 deletions(-)
diff --git a/package.json b/package.json
index e870082e34..c214e59558 100644
--- a/package.json
+++ b/package.json
@@ -114,6 +114,7 @@
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.fromentries": "^2.0.6",
+ "object.groupby": "^1.0.0",
"object.values": "^1.1.6",
"resolve": "^1.22.3",
"semver": "^6.3.1",
diff --git a/src/rules/order.js b/src/rules/order.js
index 27c3f4b0f9..6f70db263c 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -2,6 +2,7 @@
import minimatch from 'minimatch';
import includes from 'array-includes';
+import groupBy from 'object.groupby';
import importType from '../core/importType';
import isStaticRequire from '../core/staticRequire';
@@ -325,13 +326,7 @@ function getSorter(alphabetizeOptions) {
}
function mutateRanksToAlphabetize(imported, alphabetizeOptions) {
- const groupedByRanks = imported.reduce(function (acc, importedItem) {
- if (!Array.isArray(acc[importedItem.rank])) {
- acc[importedItem.rank] = [];
- }
- acc[importedItem.rank].push(importedItem);
- return acc;
- }, {});
+ const groupedByRanks = groupBy(imported, (item) => item.rank);
const sorterFn = getSorter(alphabetizeOptions);
From a257df9fe0683289c51e3ffe7b64ec0062fd69a8 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 27 Jul 2023 21:24:51 -0700
Subject: [PATCH 043/199] Bump to 2.28.0
---
CHANGELOG.md | 5 ++++-
package.json | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2f9e67189c..b7af776f86 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.28.0] - 2023-07-27
+
### Fixed
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
@@ -1535,7 +1537,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.5...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...HEAD
+[2.28.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.5...v2.28.0
[2.27.5]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.4...v2.27.5
[2.27.4]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.3...v2.27.4
[2.27.3]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.2...v2.27.3
diff --git a/package.json b/package.json
index c214e59558..81905b59b2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.27.5",
+ "version": "2.28.0",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 132a433f9cb6541a630211b7299d88935556afee Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:14:03 +1200
Subject: [PATCH 044/199] [Deps] update `is-core-module`, `resolve`
---
package.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/package.json b/package.json
index 81905b59b2..eea3d97a22 100644
--- a/package.json
+++ b/package.json
@@ -110,13 +110,13 @@
"eslint-import-resolver-node": "^0.3.7",
"eslint-module-utils": "^2.8.0",
"has": "^1.0.3",
- "is-core-module": "^2.12.1",
+ "is-core-module": "^2.13.0",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.fromentries": "^2.0.6",
"object.groupby": "^1.0.0",
"object.values": "^1.1.6",
- "resolve": "^1.22.3",
+ "resolve": "^1.22.4",
"semver": "^6.3.1",
"tsconfig-paths": "^3.14.2"
}
From 5209a43607a19fe8fd4e0226bebc393c892438cf Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:17:45 +1200
Subject: [PATCH 045/199] [resolvers] [*] [deps] update `is-core-module`,
`resolve`
---
resolvers/README.md | 4 ++--
resolvers/node/index.js | 8 ++++----
resolvers/node/package.json | 4 ++--
resolvers/webpack/index.js | 6 +++---
resolvers/webpack/package.json | 4 ++--
5 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/resolvers/README.md b/resolvers/README.md
index b664721b83..0eb18684b9 100644
--- a/resolvers/README.md
+++ b/resolvers/README.md
@@ -68,13 +68,13 @@ If the resolver cannot resolve `source` relative to `file`, it should just retur
Here is most of the [Node resolver] at the time of this writing. It is just a wrapper around substack/Browserify's synchronous [`resolve`]:
```js
-var resolve = require('resolve');
+var resolve = require('resolve/sync');
var isCoreModule = require('is-core-module');
exports.resolve = function (source, file, config) {
if (isCoreModule(source)) return { found: true, path: null };
try {
- return { found: true, path: resolve.sync(source, opts(file, config)) };
+ return { found: true, path: resolve(source, opts(file, config)) };
} catch (err) {
return { found: false };
}
diff --git a/resolvers/node/index.js b/resolvers/node/index.js
index d382bca43d..212b3b16b5 100644
--- a/resolvers/node/index.js
+++ b/resolvers/node/index.js
@@ -1,6 +1,6 @@
'use strict';
-const resolve = require('resolve');
+const resolve = require('resolve/sync');
const isCoreModule = require('is-core-module');
const path = require('path');
@@ -19,7 +19,7 @@ exports.resolve = function (source, file, config) {
try {
const cachedFilter = function (pkg, dir) { return packageFilter(pkg, dir, config); };
- resolvedPath = resolve.sync(source, opts(file, config, cachedFilter));
+ resolvedPath = resolve(source, opts(file, config, cachedFilter));
log('Resolved to:', resolvedPath);
return { found: true, path: resolvedPath };
} catch (err) {
@@ -46,7 +46,7 @@ function packageFilter(pkg, dir, config) {
const file = path.join(dir, 'dummy.js');
if (pkg.module) {
try {
- resolve.sync(String(pkg.module).replace(/^(?:\.\/)?/, './'), opts(file, config, identity));
+ resolve(String(pkg.module).replace(/^(?:\.\/)?/, './'), opts(file, config, identity));
pkg.main = pkg.module;
found = true;
} catch (err) {
@@ -55,7 +55,7 @@ function packageFilter(pkg, dir, config) {
}
if (!found && pkg['jsnext:main']) {
try {
- resolve.sync(String(pkg['jsnext:main']).replace(/^(?:\.\/)?/, './'), opts(file, config, identity));
+ resolve(String(pkg['jsnext:main']).replace(/^(?:\.\/)?/, './'), opts(file, config, identity));
pkg.main = pkg['jsnext:main'];
found = true;
} catch (err) {
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
index c63ee976b6..ac4da0d401 100644
--- a/resolvers/node/package.json
+++ b/resolvers/node/package.json
@@ -30,8 +30,8 @@
"homepage": "https://github.com/import-js/eslint-plugin-import",
"dependencies": {
"debug": "^3.2.7",
- "is-core-module": "^2.12.0",
- "resolve": "^1.22.2"
+ "is-core-module": "^2.13.0",
+ "resolve": "^1.22.4"
},
"devDependencies": {
"chai": "^3.5.0",
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 8eb2db5ad6..836d90f97a 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -8,7 +8,7 @@ const find = require('array-find');
const interpret = require('interpret');
const fs = require('fs');
const isCore = require('is-core-module');
-const resolve = require('resolve');
+const resolve = require('resolve/sync');
const semver = require('semver');
const has = require('has');
const isRegex = require('is-regex');
@@ -190,11 +190,11 @@ function createResolveSync(configPath, webpackConfig, cwd) {
try {
// Attempt to resolve webpack from the given `basedir`
- const webpackFilename = resolve.sync('webpack', { basedir, preserveSymlinks: false });
+ const webpackFilename = resolve('webpack', { basedir, preserveSymlinks: false });
const webpackResolveOpts = { basedir: path.dirname(webpackFilename), preserveSymlinks: false };
webpackRequire = function (id) {
- return require(resolve.sync(id, webpackResolveOpts));
+ return require(resolve(id, webpackResolveOpts));
};
} catch (e) {
// Something has gone wrong (or we're in a test). Use our own bundled
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index ba21801e61..8d67875778 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -36,10 +36,10 @@
"find-root": "^1.1.0",
"has": "^1.0.3",
"interpret": "^1.4.0",
- "is-core-module": "^2.12.0",
+ "is-core-module": "^2.13.0",
"is-regex": "^1.1.4",
"lodash": "^4.17.21",
- "resolve": "^1.22.2",
+ "resolve": "^1.22.4",
"semver": "^5.7.1"
},
"peerDependencies": {
From 4a75aaf4270f50ce7b5ddb3e3917613becd927a5 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:18:19 +1200
Subject: [PATCH 046/199] [Deps] remove unused root dep
---
package.json | 1 -
1 file changed, 1 deletion(-)
diff --git a/package.json b/package.json
index eea3d97a22..3884ff0653 100644
--- a/package.json
+++ b/package.json
@@ -116,7 +116,6 @@
"object.fromentries": "^2.0.6",
"object.groupby": "^1.0.0",
"object.values": "^1.1.6",
- "resolve": "^1.22.4",
"semver": "^6.3.1",
"tsconfig-paths": "^3.14.2"
}
From 95f9f004c63a69a0094ecfe5cd1cbeed38413c60 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:19:02 +1200
Subject: [PATCH 047/199] [resolvers/webpack] [deps] update `semver`
---
resolvers/webpack/package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 8d67875778..8f066b19d0 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -40,7 +40,7 @@
"is-regex": "^1.1.4",
"lodash": "^4.17.21",
"resolve": "^1.22.4",
- "semver": "^5.7.1"
+ "semver": "^5.7.2"
},
"peerDependencies": {
"eslint-plugin-import": ">=1.4.0",
From 6f6f414ee1ba9ddc8855a88b616fa9d84381e08b Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:23:21 +1200
Subject: [PATCH 048/199] [resolvers/webpack] v0.13.3
---
resolvers/webpack/CHANGELOG.md | 127 +++++++++++++++++----------------
resolvers/webpack/package.json | 2 +-
2 files changed, 67 insertions(+), 62 deletions(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 1626bb2720..8a0784a500 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,6 +5,12 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## 0.13.3 - 2023-08-05
+ - [deps] update `is-core-module`, `resolve`, `semver`
+ - [eslint] tighten up rules
+ - [Tests] consolidate eslint config
+ - [Docs] HTTP => HTTPS ([#2287], thanks [@Schweinepriester])
+
## 0.13.2 - 2021-10-20
### Changed
@@ -13,35 +19,35 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## 0.13.1 - 2021-05-13
### Added
-- add support for webpack5 'externals function' ([#2023], thanks [@jet2jet])
+ - add support for webpack5 'externals function' ([#2023], thanks [@jet2jet])
### Changed
-- Add warning about async Webpack configs ([#1962], thanks [@ogonkov])
-- Replace `node-libs-browser` with `is-core-module` ([#1967], thanks [@andersk])
-- [meta] add "engines" field to document existing requirements
-- [Refactor] use `is-regex` instead of `instanceof RegExp`
-- [Refactor] use `Array.isArray` instead of `instanceof Array`
-- [deps] update `debug`, `interpret`, `is-core-module`, `lodash`, `resolve`
+ - Add warning about async Webpack configs ([#1962], thanks [@ogonkov])
+ - Replace `node-libs-browser` with `is-core-module` ([#1967], thanks [@andersk])
+ - [meta] add "engines" field to document existing requirements
+ - [Refactor] use `is-regex` instead of `instanceof RegExp`
+ - [Refactor] use `Array.isArray` instead of `instanceof Array`
+ - [deps] update `debug`, `interpret`, `is-core-module`, `lodash`, `resolve`
## 0.13.0 - 2020-09-27
### Breaking
-- [Breaking] Allow to resolve config path relative to working directory (#1276)
+ - [Breaking] Allow to resolve config path relative to working directory (#1276)
## 0.12.2 - 2020-06-16
### Fixed
-- [fix] provide config fallback ([#1705], thanks [@migueloller])
+ - [fix] provide config fallback ([#1705], thanks [@migueloller])
## 0.12.1 - 2020-01-10
### Changed
-- [meta] copy LICENSE file to all npm packages on prepublish ([#1595], thanks [@opichals])
+ - [meta] copy LICENSE file to all npm packages on prepublish ([#1595], thanks [@opichals])
## 0.12.0 - 2019-12-07
### Added
-- [New] enable passing cwd as an option to `eslint-import-resolver-webpack` ([#1503], thanks [@Aghassi])
+ - [New] enable passing cwd as an option to `eslint-import-resolver-webpack` ([#1503], thanks [@Aghassi])
## 0.11.1 - 2019-04-13
@@ -51,110 +57,108 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## 0.11.0 - 2018-01-22
### Added
-- support for `argv` parameter when config is a function. ([#1261], thanks [@keann])
+ - support for `argv` parameter when config is a function. ([#1261], thanks [@keann])
### Fixed
-- crash when webpack config is an array of functions ([#1219]/[#1220] by [@idudinov])
+ - crash when webpack config is an array of functions ([#1219]/[#1220] by [@idudinov])
## 0.10.1 - 2018-06-24
### Fixed
-- log a useful error in a module bug arises ([#768]/[#767], thanks [@mattkrick])
+ - log a useful error in a module bug arises ([#768]/[#767], thanks [@mattkrick])
## 0.10.0 - 2018-05-17
### Changed
-- cache webpack resolve function, for performance ([#788]/[#1091])
+ - cache webpack resolve function, for performance ([#788]/[#1091])
## 0.9.0 - 2018-03-29
### Breaking
-- Fix with `pnpm` by bumping `resolve` ([#968])
+ - Fix with `pnpm` by bumping `resolve` ([#968])
## 0.8.4 - 2018-01-05
### Changed
-- allow newer version of node-libs-browser ([#969])
+ - allow newer version of node-libs-browser ([#969])
## 0.8.3 - 2017-06-23
### Changed
-- `debug` bumped to match others
+ - `debug` bumped to match others
## 0.8.2 - 2017-06-22
### Changed
-- `webpack` peer dep updated to >= 1.11 (works fine with webpack 3 AFAICT)
+ - `webpack` peer dep updated to >= 1.11 (works fine with webpack 3 AFAICT)
## 0.8.1 - 2017-01-19
### Changed
-- official support for Webpack 2.2.0 (RC), thanks [@graingert]
+ - official support for Webpack 2.2.0 (RC), thanks [@graingert]
## 0.8.0 - 2016-12-15
### Changed
-- bumped `resolve` to fix issues with Node builtins (thanks [@SkeLLLa] and [@ljharb])
-- allow `enhanced-resolve` to be version `>= 2` (thanks [@Kovensky])
+ - bumped `resolve` to fix issues with Node builtins (thanks [@SkeLLLa] and [@ljharb])
+ - allow `enhanced-resolve` to be version `>= 2` (thanks [@Kovensky])
## 0.7.1
### Fixed
-- missing `has` dependency ([#681] + [#683], thanks [@benmvp] + [@ljharb])
+ - missing `has` dependency ([#681] + [#683], thanks [@benmvp] + [@ljharb])
## 0.7.0
### Added
-- Support for explicit Webpack config object in `.eslintrc.*`. ([#572], thanks [@jameslnewell])
-- Added `resolve.modules` to configs for webpack2 support ([#569], thanks [@toshafed])
+ - Support for explicit Webpack config object in `.eslintrc.*`. ([#572], thanks [@jameslnewell])
+ - Added `resolve.modules` to configs for webpack2 support ([#569], thanks [@toshafed])
## 0.6.0 - 2016-09-13
### Added
-- support for config-as-function ([#533], thanks [@grahamb])
+ - support for config-as-function ([#533], thanks [@grahamb])
## 0.5.1 - 2016-08-11
### Fixed
-- don't throw and die if no webpack config is found
+ - don't throw and die if no webpack config is found
## 0.5.0 - 2016-08-11
### Added
-- support for Webpack 2 + `module` package.json key! ([#475], thanks [@taion])
+ - support for Webpack 2 + `module` package.json key! ([#475], thanks [@taion])
### Changed
-- don't swallow errors, assume config exists ([#435], thanks [@Kovensky])
+ - don't swallow errors, assume config exists ([#435], thanks [@Kovensky])
## 0.4.0 - 2016-07-17
### Added
-- support for `webpack.ResolverPlugin` ([#377], thanks [@Rogeres])
+ - support for `webpack.ResolverPlugin` ([#377], thanks [@Rogeres])
### Fixed
-- provide string `context` to `externals` functions ([#411] + [#413], thanks [@Satyam])
+ - provide string `context` to `externals` functions ([#411] + [#413], thanks [@Satyam])
## 0.3.2 - 2016-06-30
### Added
-- shared config ([config.js](./config.js)) with barebones settings needed to use this resolver. ([#283])
+ - shared config ([config.js](./config.js)) with barebones settings needed to use this resolver. ([#283])
### Fixed
-- strip resource query ([#357], thanks [@daltones])
-- allow `externals` to be defined as a function ([#363], thanks [@kesne])
+ - strip resource query ([#357], thanks [@daltones])
+ - allow `externals` to be defined as a function ([#363], thanks [@kesne])
## 0.3.1 - 2016-06-02
### Added
-- debug logging. run with `DEBUG=eslint-plugin-import:*` to see log output.
+ - debug logging. run with `DEBUG=eslint-plugin-import:*` to see log output.
## 0.3.0 - 2016-06-01
### Changed
-- use `enhanced-resolve` to support additional plugins instead of re-implementing
- aliases, etc.
+ - use `enhanced-resolve` to support additional plugins instead of re-implementing aliases, etc.
## 0.2.5 - 2016-05-23
### Added
-- Added support for multiple webpack configs ([#181], thanks [@GreenGremlin])
+ - Added support for multiple webpack configs ([#181], thanks [@GreenGremlin])
## 0.2.4 - 2016-04-29
### Changed
-- automatically find webpack config with `interpret`-able extensions ([#287], thanks [@taion])
+ - automatically find webpack config with `interpret`-able extensions ([#287], thanks [@taion])
## 0.2.3 - 2016-04-28
### Fixed
-- `interpret` dependency was declared in the wrong `package.json`.
- Thanks [@jonboiser] for sleuthing ([#286]) and fixing ([#289]).
+ - `interpret` dependency was declared in the wrong `package.json`. Thanks [@jonboiser] for sleuthing ([#286]) and fixing ([#289]).
## 0.2.2 - 2016-04-27
### Added
-- `interpret` configs (such as `.babel.js`).
- Thanks to [@gausie] for the initial PR ([#164], ages ago! 😅) and [@jquense] for tests ([#278]).
+ - `interpret` configs (such as `.babel.js`). Thanks to [@gausie] for the initial PR ([#164], ages ago! 😅) and [@jquense] for tests ([#278]).
+[#2287]: https://github.com/import-js/eslint-plugin-import/pull/2287
[#2023]: https://github.com/import-js/eslint-plugin-import/pull/2023
[#1967]: https://github.com/import-js/eslint-plugin-import/pull/1967
[#1962]: https://github.com/import-js/eslint-plugin-import/pull/1962
@@ -192,29 +196,30 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
[#286]: https://github.com/import-js/eslint-plugin-import/issues/286
[#283]: https://github.com/import-js/eslint-plugin-import/issues/283
+[@Aghassi]: https://github.com/Aghassi
+[@andersk]: https://github.com/andersk
+[@benmvp]: https://github.com/benmvp
+[@daltones]: https://github.com/daltones
+[@echenley]: https://github.com/echenley
[@gausie]: https://github.com/gausie
-[@jquense]: https://github.com/jquense
-[@taion]: https://github.com/taion
+[@grahamb]: https://github.com/grahamb
+[@graingert]: https://github.com/graingert
[@GreenGremlin]: https://github.com/GreenGremlin
-[@daltones]: https://github.com/daltones
+[@idudinov]: https://github.com/idudinov
+[@jameslnewell]: https://github.com/jameslnewell
+[@jet2jet]: https://github.com/jet2jet
+[@jquense]: https://github.com/jquense
+[@keann]: https://github.com/keann
[@kesne]: https://github.com/kesne
-[@Satyam]: https://github.com/Satyam
-[@Rogeres]: https://github.com/Rogeres
[@Kovensky]: https://github.com/Kovensky
-[@grahamb]: https://github.com/grahamb
-[@jameslnewell]: https://github.com/jameslnewell
-[@toshafed]: https://github.com/toshafed
-[@benmvp]: https://github.com/benmvp
[@ljharb]: https://github.com/ljharb
-[@SkeLLLa]: https://github.com/SkeLLLa
-[@graingert]: https://github.com/graingert
[@mattkrick]: https://github.com/mattkrick
-[@idudinov]: https://github.com/idudinov
-[@keann]: https://github.com/keann
-[@echenley]: https://github.com/echenley
-[@Aghassi]: https://github.com/Aghassi
[@migueloller]: https://github.com/migueloller
-[@opichals]: https://github.com/opichals
-[@andersk]: https://github.com/andersk
[@ogonkov]: https://github.com/ogonkov
-[@jet2jet]: https://github.com/jet2jet
+[@opichals]: https://github.com/opichals
+[@Rogeres]: https://github.com/Rogeres
+[@Satyam]: https://github.com/Satyam
+[@Schweinepriester]: https://github.com/Schweinepriester
+[@SkeLLLa]: https://github.com/SkeLLLa
+[@taion]: https://github.com/taion
+[@toshafed]: https://github.com/toshafed
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 8f066b19d0..f1592a5d61 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.2",
+ "version": "0.13.3",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 7f7a9a6d03b480bfa7453fdb58c84191f2724f97 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 5 Aug 2023 15:44:12 +1200
Subject: [PATCH 049/199] [resolvers/node] v0.3.8
---
resolvers/node/CHANGELOG.md | 41 ++++++++++++++++++-------------------
resolvers/node/package.json | 2 +-
2 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/resolvers/node/CHANGELOG.md b/resolvers/node/CHANGELOG.md
index f00006fbd3..1335cbedee 100644
--- a/resolvers/node/CHANGELOG.md
+++ b/resolvers/node/CHANGELOG.md
@@ -5,60 +5,59 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v0.3.8 - 2023-08-05
+ - [deps] update `is-core-module`, `resolve`
+ - [eslint] tighten up rules
+
## v0.3.7 - 2023-01-11
### Changed
-- [Refactor] use `is-core-module` directly
+ - [Refactor] use `is-core-module` directly
## v0.3.6 - 2021-08-15
### Fixed
-- when "module" does not exist, fall back to "main" ([#2186], thanks [@ljharb])
+ - when "module" does not exist, fall back to "main" ([#2186], thanks [@ljharb])
## v0.3.5 - 2021-08-08
### Added
-- use "module" in the same spot as "jsnext:main" ([#2166], thanks [@MustafaHaddara])
+ - use "module" in the same spot as "jsnext:main" ([#2166], thanks [@MustafaHaddara])
## v0.3.4 - 2020-06-16
### Added
-- add `.node` extension ([#1663])
+ - add `.node` extension ([#1663])
## v0.3.3 - 2020-01-10
### Changed
-- [meta] copy LICENSE file to all npm packages on prepublish ([#1595], thanks [@opichals])
+ - [meta] copy LICENSE file to all npm packages on prepublish ([#1595], thanks [@opichals])
## v0.3.2 - 2018-01-05
### Added
-- `.mjs` extension detected by default to support `experimental-modules` ([#939])
+ - `.mjs` extension detected by default to support `experimental-modules` ([#939])
### Deps
-- update `debug`, `resolve`
+ - update `debug`, `resolve`
## v0.3.1 - 2017-06-23
### Changed
-- bumped `debug` dep to match other packages
+ - bumped `debug` dep to match other packages
## v0.3.0 - 2016-12-15
### Changed
-- bumped `resolve` to fix issues with Node builtins (thanks [@SkeLLLa] and [@ljharb])
+ - bumped `resolve` to fix issues with Node builtins (thanks [@SkeLLLa] and [@ljharb])
### Fixed
-- use `files` in `package.json` to ship only `index.js` ([#531], thanks for noticing [@lukeapage])
+ - use `files` in `package.json` to ship only `index.js` ([#531], thanks for noticing [@lukeapage])
## v0.2.3 - 2016-08-20
### Added
-- debug logging (use `DEBUG=eslint-plugin-import:resolver:node eslint [...]`)
+ - debug logging (use `DEBUG=eslint-plugin-import:resolver:node eslint [...]`)
## v0.2.2 - 2016-07-14
### Fixed
-- Node resolver no longer declares the import plugin as a `peerDependency`. See [#437]
- for a well-articulated and thoughtful expression of why this doesn't make sense.
- Thanks [@jasonkarns] for the issue and the PR to fix it ([#438]).
-
- Also, apologies to the others who expressed this before, but I never understood
- what the problem was.😅
+ - Node resolver no longer declares the import plugin as a `peerDependency`. See [#437] for a well-articulated and thoughtful expression of why this doesn't make sense. Thanks [@jasonkarns] for the issue and the PR to fix it ([#438]). Also, apologies to the others who expressed this before, but I never understood what the problem was.😅
## v0.2.1
### Fixed
-- find files with `.json` extensions (#333, thanks for noticing @jfmengels)
+ - find files with `.json` extensions (#333, thanks for noticing @jfmengels)
[#2186]: https://github.com/import-js/eslint-plugin-import/issues/2186
[#2166]: https://github.com/import-js/eslint-plugin-import/pull/2166
@@ -70,8 +69,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
[#437]: https://github.com/import-js/eslint-plugin-import/issues/437
[@jasonkarns]: https://github.com/jasonkarns
-[@lukeapage]: https://github.com/lukeapage
-[@SkeLLLa]: https://github.com/SkeLLLa
[@ljharb]: https://github.com/ljharb
-[@opichals]: https://github.com/opichals
+[@lukeapage]: https://github.com/lukeapage
[@MustafaHaddara]: https://github.com/MustafaHaddara
+[@opichals]: https://github.com/opichals
+[@SkeLLLa]: https://github.com/SkeLLLa
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
index ac4da0d401..33bf3b0102 100644
--- a/resolvers/node/package.json
+++ b/resolvers/node/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-node",
- "version": "0.3.7",
+ "version": "0.3.8",
"description": "Node default behavior import resolution plugin for eslint-plugin-import.",
"main": "index.js",
"files": [
From 0501367f48a2f74cc6d13bf120ad2fe629a96de1 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Sat, 5 Aug 2023 17:46:38 +0800
Subject: [PATCH 050/199] [Docs] remove duplicate fixable notices in docs
---
CHANGELOG.md | 4 ++++
docs/rules/newline-after-import.md | 3 +--
docs/rules/no-duplicates.md | 1 -
docs/rules/no-namespace.md | 3 +--
docs/rules/no-relative-packages.md | 2 --
docs/rules/order.md | 1 -
6 files changed, 6 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b7af776f86..96dbd8c107 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Changed
+- [Docs] remove duplicate fixable notices in docs ([#2850], thanks [@bmish])
+
## [2.28.0] - 2023-07-27
### Fixed
@@ -1079,6 +1082,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2850]: https://github.com/import-js/eslint-plugin-import/pull/2850
[#2842]: https://github.com/import-js/eslint-plugin-import/pull/2842
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
diff --git a/docs/rules/newline-after-import.md b/docs/rules/newline-after-import.md
index ed0a5b678f..6aa75be552 100644
--- a/docs/rules/newline-after-import.md
+++ b/docs/rules/newline-after-import.md
@@ -5,11 +5,10 @@
<!-- end auto-generated rule header -->
Enforces having one or more empty lines after the last top-level import statement or require call.
-+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule.
## Rule Details
-This rule supports the following options:
+This rule supports the following options:
- `count` which sets the number of newlines that are enforced after the last top-level import statement or require call. This option defaults to `1`.
- `considerComments` which enforces the rule on comments after the last import-statement as well when set to true. This option defaults to `false`.
diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md
index dd741c21a5..50f779b456 100644
--- a/docs/rules/no-duplicates.md
+++ b/docs/rules/no-duplicates.md
@@ -7,7 +7,6 @@
<!-- end auto-generated rule header -->
Reports if a resolved path is imported more than once.
-+(fixable) The `--fix` option on the [command line] automatically fixes some problems reported by this rule.
ESLint core has a similar rule ([`no-duplicate-imports`](https://eslint.org/docs/rules/no-duplicate-imports)), but this version
is different in two key ways:
diff --git a/docs/rules/no-namespace.md b/docs/rules/no-namespace.md
index 5545bce229..623dae049c 100644
--- a/docs/rules/no-namespace.md
+++ b/docs/rules/no-namespace.md
@@ -6,8 +6,7 @@
Enforce a convention of not using namespace (a.k.a. "wildcard" `*`) imports.
-+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule, provided that the namespace object is only used for direct member access, e.g. `namespace.a`.
-The `--fix` functionality for this rule requires ESLint 5 or newer.
+The rule is auto-fixable when the namespace object is only used for direct member access, e.g. `namespace.a`.
### Options
diff --git a/docs/rules/no-relative-packages.md b/docs/rules/no-relative-packages.md
index 4919de94e5..df21c25dd0 100644
--- a/docs/rules/no-relative-packages.md
+++ b/docs/rules/no-relative-packages.md
@@ -9,8 +9,6 @@ Use this rule to prevent importing packages through relative paths.
It's useful in Yarn/Lerna workspaces, were it's possible to import a sibling
package using `../package` relative path, while direct `package` is the correct one.
-+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule.
-
### Examples
Given the following folder structure:
diff --git a/docs/rules/order.md b/docs/rules/order.md
index e3deacaf24..6dc4520e8d 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -5,7 +5,6 @@
<!-- end auto-generated rule header -->
Enforce a convention in the order of `require()` / `import` statements.
-+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule.
With the [`groups`](#groups-array) option set to `["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"]` the order is as shown in the following example:
From 69fce5c549a026d6efebac1233f54489a412b6e3 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 8 Aug 2023 13:30:39 +1200
Subject: [PATCH 051/199] =?UTF-8?q?[Tests]=20actually=20test=20non-babel?=
=?UTF-8?q?=E2=80=99d=20packages=20without=20babel?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Caused https://github.com/import-js/eslint-plugin-import/commit/8c155baaca39dc78c5a3a63ff1bdd53b58f343e0#r123814192
---
.gitignore | 4 ----
memo-parser/.nycrc | 19 +++++++++++++++++++
resolvers/node/.nycrc | 15 +++++++++++++++
resolvers/webpack/.nycrc | 15 +++++++++++++++
scripts/copyMetafiles.js | 1 -
utils/.nycrc | 15 +++++++++++++++
6 files changed, 64 insertions(+), 5 deletions(-)
create mode 100644 memo-parser/.nycrc
create mode 100644 resolvers/node/.nycrc
create mode 100644 resolvers/webpack/.nycrc
create mode 100644 utils/.nycrc
diff --git a/.gitignore b/.gitignore
index 8e2f6da1ee..587dbd9280 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,13 +25,9 @@ resolvers/node/LICENSE
resolvers/webpack/LICENSE
utils/LICENSE
memo-parser/.npmrc
-memo-parser/.nycrc
resolvers/node/.npmrc
-resolvers/node/.nycrc
resolvers/webpack/.npmrc
-resolvers/webpack/.nycrc
utils/.npmrc
-utils/.nycrc
# Dependency directory
# Commenting this out is preferred by some people, see
diff --git a/memo-parser/.nycrc b/memo-parser/.nycrc
new file mode 100644
index 0000000000..5d75e2157c
--- /dev/null
+++ b/memo-parser/.nycrc
@@ -0,0 +1,19 @@
+{
+ "all": true,
+ "check-coverage": false,
+ "reporter": ["text-summary", "lcov", "text", "html", "json"],
+ "require": [
+ "babel-register"
+ ],
+ "sourceMap": true,
+ "instrument": false,
+ "exclude": [
+ "coverage",
+ "test",
+ "tests",
+ "resolvers/*/test",
+ "scripts",
+ "memo-parser",
+ "lib"
+ ]
+}
diff --git a/resolvers/node/.nycrc b/resolvers/node/.nycrc
new file mode 100644
index 0000000000..1084360870
--- /dev/null
+++ b/resolvers/node/.nycrc
@@ -0,0 +1,15 @@
+{
+ "all": true,
+ "check-coverage": false,
+ "reporter": ["text-summary", "lcov", "text", "html", "json"],
+ "instrument": false,
+ "exclude": [
+ "coverage",
+ "test",
+ "tests",
+ "resolvers/*/test",
+ "scripts",
+ "memo-parser",
+ "lib"
+ ]
+}
diff --git a/resolvers/webpack/.nycrc b/resolvers/webpack/.nycrc
new file mode 100644
index 0000000000..1084360870
--- /dev/null
+++ b/resolvers/webpack/.nycrc
@@ -0,0 +1,15 @@
+{
+ "all": true,
+ "check-coverage": false,
+ "reporter": ["text-summary", "lcov", "text", "html", "json"],
+ "instrument": false,
+ "exclude": [
+ "coverage",
+ "test",
+ "tests",
+ "resolvers/*/test",
+ "scripts",
+ "memo-parser",
+ "lib"
+ ]
+}
diff --git a/scripts/copyMetafiles.js b/scripts/copyMetafiles.js
index 6140bd2dc9..01ff4f36f2 100644
--- a/scripts/copyMetafiles.js
+++ b/scripts/copyMetafiles.js
@@ -5,7 +5,6 @@ import resolverDirectories from './resolverDirectories';
const files = [
'LICENSE',
'.npmrc',
- '.nycrc',
];
const directories = [].concat(
diff --git a/utils/.nycrc b/utils/.nycrc
new file mode 100644
index 0000000000..1084360870
--- /dev/null
+++ b/utils/.nycrc
@@ -0,0 +1,15 @@
+{
+ "all": true,
+ "check-coverage": false,
+ "reporter": ["text-summary", "lcov", "text", "html", "json"],
+ "instrument": false,
+ "exclude": [
+ "coverage",
+ "test",
+ "tests",
+ "resolvers/*/test",
+ "scripts",
+ "memo-parser",
+ "lib"
+ ]
+}
From 10913e7447956da08a5547c5b874eb1a489c549c Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 8 Aug 2023 13:38:04 +1200
Subject: [PATCH 052/199] [resolvers] [*] [fix] restore node 6 compatibility
See 69fce5c5 and https://github.com/import-js/eslint-plugin-import/commit/8c155baaca39dc78c5a3a63ff1bdd53b58f343e0#r123814192
---
.eslintrc | 50 +++++++++++++++++++-------------------
resolvers/node/index.js | 6 ++---
resolvers/webpack/index.js | 8 +++---
3 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/.eslintrc b/.eslintrc
index 932055e8d4..3c9c658f2f 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -189,37 +189,17 @@
"no-console": "off",
},
},
- {
- "files": "resolvers/**",
- "env": {
- "es6": false,
- },
- },
- {
- "files": "resolvers/webpack/**",
- "rules": {
- "no-console": 1,
- "prefer-template": 0,
- "prefer-object-spread": 0,
- "prefer-rest-params": 0,
- },
- "env": {
- "es6": true,
- },
- },
{
"files": [
- "resolvers/*/test/**/*",
+ "resolvers/**",
+ "utils/**",
],
"env": {
- "mocha": true,
- "es6": false
+ "es6": false,
},
- },
- {
- "files": "utils/**",
"parserOptions": {
- "ecmaVersion": 6,
+ "sourceType": "module",
+ "ecmaVersion": 2016,
},
"rules": {
"comma-dangle": ["error", {
@@ -229,11 +209,31 @@
"exports": "always-multiline",
"functions": "never"
}],
+ "prefer-destructuring": "warn",
"prefer-object-spread": "off",
+ "prefer-rest-params": "off",
+ "prefer-spread": "warn",
"prefer-template": "off",
+ }
+ },
+ {
+ "files": [
+ "resolvers/webpack/**",
+ "utils/**",
+ ],
+ "rules": {
"no-console": 1,
},
},
+ {
+ "files": [
+ "resolvers/*/test/**/*",
+ ],
+ "env": {
+ "mocha": true,
+ "es6": false
+ },
+ },
{
"files": "tests/**",
"env": {
diff --git a/resolvers/node/index.js b/resolvers/node/index.js
index 212b3b16b5..7f207fbf31 100644
--- a/resolvers/node/index.js
+++ b/resolvers/node/index.js
@@ -29,14 +29,14 @@ exports.resolve = function (source, file, config) {
};
function opts(file, config, packageFilter) {
- return { // more closely matches Node (#333)
+ return Object.assign({ // more closely matches Node (#333)
// plus 'mjs' for native modules! (#939)
extensions: ['.mjs', '.js', '.json', '.node'],
- ...config,
+ }, config, {
// path.resolve will handle paths relative to CWD
basedir: path.dirname(path.resolve(file)),
packageFilter,
- };
+ });
}
function identity(x) { return x; }
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 836d90f97a..a9fc003813 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -270,18 +270,18 @@ function createWebpack1ResolveSync(webpackRequire, resolveConfig, plugins) {
makeRootPlugin(ModulesInRootPlugin, 'module', resolveConfig.root),
new ModulesInDirectoriesPlugin(
'module',
- resolveConfig.modulesDirectories || resolveConfig.modules || ['web_modules', 'node_modules'],
+ resolveConfig.modulesDirectories || resolveConfig.modules || ['web_modules', 'node_modules']
),
makeRootPlugin(ModulesInRootPlugin, 'module', resolveConfig.fallback),
new ModuleAsFilePlugin('module'),
new ModuleAsDirectoryPlugin('module'),
new DirectoryDescriptionFilePlugin(
'package.json',
- ['module', 'jsnext:main'].concat(resolveConfig.packageMains || webpack1DefaultMains),
+ ['module', 'jsnext:main'].concat(resolveConfig.packageMains || webpack1DefaultMains)
),
new DirectoryDefaultFilePlugin(['index']),
new FileAppendPlugin(resolveConfig.extensions || ['', '.webpack.js', '.web.js', '.js']),
- new ResultSymlinkPlugin(),
+ new ResultSymlinkPlugin()
);
const resolvePlugins = [];
@@ -419,7 +419,7 @@ function findConfigPath(configPath, packageDir) {
}
const maybePath = path.resolve(
- path.join(packageDir, 'webpack.config' + maybeExtension),
+ path.join(packageDir, 'webpack.config' + maybeExtension)
);
if (fs.existsSync(maybePath)) {
configPath = maybePath;
From 559480d4571c7fde70177bbe2de0a57090a1facb Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 8 Aug 2023 15:48:41 +1200
Subject: [PATCH 053/199] [resolvers/webpack] v0.13.4
---
resolvers/webpack/CHANGELOG.md | 3 +++
resolvers/webpack/package.json | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 8a0784a500..d5723757f8 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## 0.13.4 - 2023-08-08
+ - [fix] restore node 6 compatibility
+
## 0.13.3 - 2023-08-05
- [deps] update `is-core-module`, `resolve`, `semver`
- [eslint] tighten up rules
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index f1592a5d61..0ae63cfdd4 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.3",
+ "version": "0.13.4",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From c7042539bc0faf9af57be4baee1e1f17fad17fdb Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 8 Aug 2023 15:49:58 +1200
Subject: [PATCH 054/199] [resolvers/node] v0.3.9
---
resolvers/node/CHANGELOG.md | 3 +++
resolvers/node/package.json | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/resolvers/node/CHANGELOG.md b/resolvers/node/CHANGELOG.md
index 1335cbedee..8e11359a92 100644
--- a/resolvers/node/CHANGELOG.md
+++ b/resolvers/node/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v0.3.9 - 2023-08-08
+ - [fix] restore node 6 compatibility
+
## v0.3.8 - 2023-08-05
- [deps] update `is-core-module`, `resolve`
- [eslint] tighten up rules
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
index 33bf3b0102..bfaab40413 100644
--- a/resolvers/node/package.json
+++ b/resolvers/node/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-node",
- "version": "0.3.8",
+ "version": "0.3.9",
"description": "Node default behavior import resolution plugin for eslint-plugin-import.",
"main": "index.js",
"files": [
From 26ea4f865bbfa162c533e82171379b73249003b0 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Tue, 8 Aug 2023 10:11:09 +0800
Subject: [PATCH 055/199] [Docs] Add markdownlint
---
.markdownlint.json | 10 +++
.markdownlintignore | 2 +
CONTRIBUTING.md | 20 +++---
README.md | 16 ++---
docs/rules/consistent-type-specifier-style.md | 4 +-
docs/rules/default.md | 9 +--
docs/rules/dynamic-import-chunkname.md | 5 ++
docs/rules/export.md | 3 +-
docs/rules/exports-last.md | 3 +-
docs/rules/extensions.md | 10 +--
docs/rules/first.md | 5 +-
docs/rules/group-exports.md | 1 -
docs/rules/max-dependencies.md | 2 +
docs/rules/named.md | 8 +--
docs/rules/namespace.md | 9 ++-
docs/rules/newline-after-import.md | 7 ++-
docs/rules/no-absolute-path.md | 6 +-
docs/rules/no-amd.md | 4 +-
docs/rules/no-anonymous-default-export.md | 2 +
docs/rules/no-commonjs.md | 5 +-
docs/rules/no-cycle.md | 7 +--
docs/rules/no-deprecated.md | 19 +++---
docs/rules/no-duplicates.md | 3 +
docs/rules/no-empty-named-blocks.md | 8 ++-
docs/rules/no-extraneous-dependencies.md | 6 +-
docs/rules/no-import-module-exports.md | 5 +-
docs/rules/no-internal-modules.md | 14 +++--
docs/rules/no-mutable-exports.md | 4 +-
docs/rules/no-named-as-default-member.md | 5 +-
docs/rules/no-named-as-default.md | 11 ++--
docs/rules/no-named-default.md | 3 +
docs/rules/no-namespace.md | 4 +-
docs/rules/no-nodejs-modules.md | 4 +-
docs/rules/no-relative-packages.md | 7 ++-
docs/rules/no-relative-parent-imports.md | 63 ++++++++++---------
docs/rules/no-restricted-paths.md | 42 ++++++-------
docs/rules/no-unassigned-import.md | 9 ++-
docs/rules/no-unresolved.md | 10 +--
docs/rules/no-unused-modules.md | 36 ++++++++---
docs/rules/no-useless-path-segments.md | 3 +-
docs/rules/no-webpack-loader-syntax.md | 1 +
docs/rules/order.md | 43 +++++++------
docs/rules/prefer-default-export.md | 5 +-
docs/rules/unambiguous.md | 7 ++-
memo-parser/README.md | 4 +-
package.json | 3 +-
resolvers/README.md | 23 ++++---
resolvers/webpack/README.md | 4 +-
48 files changed, 274 insertions(+), 210 deletions(-)
create mode 100644 .markdownlint.json
create mode 100644 .markdownlintignore
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 0000000000..d179615f45
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,10 @@
+{
+ "line-length": false,
+ "ul-indent": {
+ "start_indent": 1,
+ "start_indented": true
+ },
+ "ul-style": {
+ "style": "dash"
+ }
+}
diff --git a/.markdownlintignore b/.markdownlintignore
new file mode 100644
index 0000000000..6ed5b5b6ee
--- /dev/null
+++ b/.markdownlintignore
@@ -0,0 +1,2 @@
+CHANGELOG.md
+node_modules
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2a79e7139e..871e90ad8c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,15 +6,15 @@ Thanks for your interest in helping out! Here are a **few** _weird_ tricks to ~~
When opening an [issue](#issues):
-- [ ] search open/closed issues
-- [ ] discuss bug/enhancement in new or old issue
+ - [ ] search open/closed issues
+ - [ ] discuss bug/enhancement in new or old issue
[PR](#prs) time:
-- [ ] write tests
-- [ ] implement feature/fix bug
-- [ ] update docs
-- [ ] make a note in change log
+ - [ ] write tests
+ - [ ] implement feature/fix bug
+ - [ ] update docs
+ - [ ] make a note in change log
Remember, you don't need to do it all yourself; any of these are helpful! 😎
@@ -22,10 +22,10 @@ Remember, you don't need to do it all yourself; any of these are helpful! 😎
If you are new to `eslint`, below are a few resources that will help you to familiarize yourself with the project.
-- Watch [this presentation](https://www.youtube.com/watch?v=2W9tUnALrLg) to learn the fundamental concept of Abstract Syntax Trees (AST) and the way `eslint` works under the hood.
-- Familiarize yourself with the [AST explorer](https://astexplorer.net/) tool. Look into rules in `docs/rules`, create patterns in the rules, then analyze its AST.
-- Explore the blog posts on how to create a custom rule. [One blog post](https://blog.yonatan.dev/writing-a-custom-eslint-rule-to-spot-undeclared-props/). [Second blog post](https://betterprogramming.pub/creating-custom-eslint-rules-cdc579694608).
-- Read the official `eslint` [developer guide](https://eslint.org/docs/latest/developer-guide/architecture/).
+ - Watch [this presentation](https://www.youtube.com/watch?v=2W9tUnALrLg) to learn the fundamental concept of Abstract Syntax Trees (AST) and the way `eslint` works under the hood.
+ - Familiarize yourself with the [AST explorer](https://astexplorer.net/) tool. Look into rules in `docs/rules`, create patterns in the rules, then analyze its AST.
+ - Explore the blog posts on how to create a custom rule. [One blog post](https://blog.yonatan.dev/writing-a-custom-eslint-rule-to-spot-undeclared-props/). [Second blog post](https://betterprogramming.pub/creating-custom-eslint-rules-cdc579694608).
+ - Read the official `eslint` [developer guide](https://eslint.org/docs/latest/developer-guide/architecture/).
## Issues
diff --git a/README.md b/README.md
index ca99b8fafb..1baa0069b3 100644
--- a/README.md
+++ b/README.md
@@ -131,7 +131,7 @@ rules:
# etc...
```
-# TypeScript
+## TypeScript
You may use the following snippet or assemble your own config using the granular settings described below it.
@@ -154,7 +154,7 @@ settings:
[`@typescript-eslint/parser`]: https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser
[`eslint-import-resolver-typescript`]: https://github.com/import-js/eslint-import-resolver-typescript
-# Resolvers
+## Resolvers
With the advent of module bundlers and the current state of modules and module
syntax specs, it's not always obvious where `import x from 'module'` should look
@@ -175,7 +175,7 @@ resolvers are just npm packages, so [third party packages are supported](https:/
You can reference resolvers in several ways (in order of precedence):
-- as a conventional `eslint-import-resolver` name, like `eslint-import-resolver-foo`:
+ - as a conventional `eslint-import-resolver` name, like `eslint-import-resolver-foo`:
```yaml
# .eslintrc.yml
@@ -195,7 +195,7 @@ module.exports = {
}
```
-- with a full npm module name, like `my-awesome-npm-module`:
+ - with a full npm module name, like `my-awesome-npm-module`:
```yaml
# .eslintrc.yml
@@ -214,7 +214,7 @@ module.exports = {
}
```
-- with a filesystem path to resolver, defined in this example as a `computed property` name:
+ - with a filesystem path to resolver, defined in this example as a `computed property` name:
```js
// .eslintrc.js
@@ -336,11 +336,11 @@ If you are using `yarn` PnP as your package manager, add the `.yarn` folder and
Each item in this array is either a folder's name, its subpath, or its absolute prefix path:
-- `jspm_modules` will match any file or folder named `jspm_modules` or which has a direct or non-direct parent named `jspm_modules`, e.g. `/home/me/project/jspm_modules` or `/home/me/project/jspm_modules/some-pkg/index.js`.
+ - `jspm_modules` will match any file or folder named `jspm_modules` or which has a direct or non-direct parent named `jspm_modules`, e.g. `/home/me/project/jspm_modules` or `/home/me/project/jspm_modules/some-pkg/index.js`.
-- `packages/core` will match any path that contains these two segments, for example `/home/me/project/packages/core/src/utils.js`.
+ - `packages/core` will match any path that contains these two segments, for example `/home/me/project/packages/core/src/utils.js`.
-- `/home/me/project/packages` will only match files and directories inside this directory, and the directory itself.
+ - `/home/me/project/packages` will only match files and directories inside this directory, and the directory itself.
Please note that incomplete names are not allowed here so `components` won't match `bower_components` and `packages/ui` won't match `packages/ui-utils` (but will match `packages/ui/utils`).
diff --git a/docs/rules/consistent-type-specifier-style.md b/docs/rules/consistent-type-specifier-style.md
index 54c09049ef..41d98e4e1f 100644
--- a/docs/rules/consistent-type-specifier-style.md
+++ b/docs/rules/consistent-type-specifier-style.md
@@ -37,8 +37,8 @@ This rule includes a fixer that will automatically convert your specifiers to th
The rule accepts a single string option which may be one of:
-- `'prefer-inline'` - enforces that named type-only specifiers are only ever written with an inline marker; and never as part of a top-level, type-only import.
-- `'prefer-top-level'` - enforces that named type-only specifiers only ever written as part of a top-level, type-only import; and never with an inline marker.
+ - `'prefer-inline'` - enforces that named type-only specifiers are only ever written with an inline marker; and never as part of a top-level, type-only import.
+ - `'prefer-top-level'` - enforces that named type-only specifiers only ever written as part of a top-level, type-only import; and never with an inline marker.
By default the rule will use the `prefer-inline` option.
diff --git a/docs/rules/default.md b/docs/rules/default.md
index ffbbdc166a..9f8c919bf3 100644
--- a/docs/rules/default.md
+++ b/docs/rules/default.md
@@ -19,7 +19,6 @@ A module path that is [ignored] or not [unambiguously an ES module] will not be
[ignored]: ../README.md#importignore
[unambiguously an ES module]: https://github.com/bmeck/UnambiguousJavaScriptGrammar
-
## Rule Details
Given:
@@ -54,7 +53,6 @@ import bar from './bar' // no default export found in ./bar
import baz from './baz' // no default export found in ./baz
```
-
## When Not To Use It
If you are using CommonJS and/or modifying the exported namespace of any module at
@@ -65,10 +63,9 @@ either, so such a situation will be reported in the importing module.
## Further Reading
-- Lee Byron's [ES7] export proposal
-- [`import/ignore`] setting
-- [`jsnext:main`] (Rollup)
-
+ - Lee Byron's [ES7] export proposal
+ - [`import/ignore`] setting
+ - [`jsnext:main`] (Rollup)
[ES7]: https://github.com/leebyron/ecmascript-more-export-from
[`import/ignore`]: ../../README.md#importignore
diff --git a/docs/rules/dynamic-import-chunkname.md b/docs/rules/dynamic-import-chunkname.md
index 472a366485..35ae9df516 100644
--- a/docs/rules/dynamic-import-chunkname.md
+++ b/docs/rules/dynamic-import-chunkname.md
@@ -7,8 +7,10 @@ This rule reports any dynamic imports without a webpackChunkName specified in a
This rule enforces naming of webpack chunks in dynamic imports. When you don't explicitly name chunks, webpack will autogenerate chunk names that are not consistent across builds, which prevents long-term browser caching.
## Rule Details
+
This rule runs against `import()` by default, but can be configured to also run against an alternative dynamic-import function, e.g. 'dynamicImport.'
You can also configure the regex format you'd like to accept for the webpackChunkName - for example, if we don't want the number 6 to show up in our chunk names:
+
```javascript
{
"dynamic-import-chunkname": [2, {
@@ -19,6 +21,7 @@ You can also configure the regex format you'd like to accept for the webpackChun
```
### invalid
+
The following patterns are invalid:
```javascript
@@ -53,7 +56,9 @@ import(
'someModule',
);
```
+
### valid
+
The following patterns are valid:
```javascript
diff --git a/docs/rules/export.md b/docs/rules/export.md
index 115d2d8b29..54a8a39cf3 100644
--- a/docs/rules/export.md
+++ b/docs/rules/export.md
@@ -17,6 +17,7 @@ export default makeClass // Multiple default exports.
```
or
+
```js
export const foo = function () { /*...*/ } // Multiple exports of name 'foo'.
@@ -31,6 +32,6 @@ intent to rename, etc.
## Further Reading
-- Lee Byron's [ES7] export proposal
+ - Lee Byron's [ES7] export proposal
[ES7]: https://github.com/leebyron/ecmascript-more-export-from
diff --git a/docs/rules/exports-last.md b/docs/rules/exports-last.md
index 6b3e4bac40..56e947e94b 100644
--- a/docs/rules/exports-last.md
+++ b/docs/rules/exports-last.md
@@ -4,7 +4,6 @@
This rule enforces that all exports are declared at the bottom of the file. This rule will report any export declarations that comes before any non-export statements.
-
## This will be reported
```JS
@@ -45,7 +44,7 @@ export const str = 'foo'
If you don't mind exports being sprinkled throughout a file, you may not want to enable this rule.
-#### ES6 exports only
+### ES6 exports only
The exports-last rule is currently only working on ES6 exports. You may not want to enable this rule if you're using CommonJS exports.
diff --git a/docs/rules/extensions.md b/docs/rules/extensions.md
index df4f341287..946ccb7bf8 100644
--- a/docs/rules/extensions.md
+++ b/docs/rules/extensions.md
@@ -10,13 +10,13 @@ In order to provide a consistent use of file extensions across your code base, t
This rule either takes one string option, one object option, or a string and an object option. If it is the string `"never"` (the default value), then the rule forbids the use for any extension. If it is the string `"always"`, then the rule enforces the use of extensions for all import statements. If it is the string `"ignorePackages"`, then the rule enforces the use of extensions for all import statements except package imports.
-```
+```json
"import/extensions": [<severity>, "never" | "always" | "ignorePackages"]
```
By providing an object you can configure each extension separately.
-```
+```json
"import/extensions": [<severity>, {
<extension>: "never" | "always" | "ignorePackages"
}]
@@ -26,7 +26,7 @@ By providing an object you can configure each extension separately.
By providing both a string and an object, the string will set the default setting for all extensions, and the object can be used to set granular overrides for specific extensions.
-```
+```json
"import/extensions": [
<severity>,
"never" | "always" | "ignorePackages",
@@ -40,7 +40,7 @@ For example, `["error", "never", { "svg": "always" }]` would require that all ex
`ignorePackages` can be set as a separate boolean option like this:
-```
+```json
"import/extensions": [
<severity>,
"never" | "always" | "ignorePackages",
@@ -62,7 +62,7 @@ When disallowing the use of certain extensions this rule makes an exception and
For example, given the following folder structure:
-```
+```pt
├── foo
│ ├── bar.js
│ ├── bar.json
diff --git a/docs/rules/first.md b/docs/rules/first.md
index 21904e2fa1..c765a29739 100644
--- a/docs/rules/first.md
+++ b/docs/rules/first.md
@@ -57,6 +57,7 @@ Given that, see [#255] for the reasoning.
### With Fixer
This rule contains a fixer to reorder in-body import to top, the following criteria applied:
+
1. Never re-order relative to each other, even if `absolute-first` is set.
2. If an import creates an identifier, and that identifier is referenced at module level *before* the import itself, that won't be re-ordered.
@@ -67,8 +68,8 @@ enable this rule.
## Further Reading
-- [`import/order`]: a major step up from `absolute-first`
-- Issue [#255]
+ - [`import/order`]: a major step up from `absolute-first`
+ - Issue [#255]
[`import/order`]: ./order.md
[#255]: https://github.com/import-js/eslint-plugin-import/issues/255
diff --git a/docs/rules/group-exports.md b/docs/rules/group-exports.md
index 67e76de2fe..9fb212de6a 100644
--- a/docs/rules/group-exports.md
+++ b/docs/rules/group-exports.md
@@ -71,7 +71,6 @@ export {first}
export type {firstType}
```
-
### Invalid
```js
diff --git a/docs/rules/max-dependencies.md b/docs/rules/max-dependencies.md
index 1da74f6818..1ecbca64d3 100644
--- a/docs/rules/max-dependencies.md
+++ b/docs/rules/max-dependencies.md
@@ -47,6 +47,7 @@ Ignores `type` imports. Type imports are a feature released in TypeScript 3.8, y
Given `{"max": 2, "ignoreTypeImports": true}`:
+<!-- markdownlint-disable-next-line MD024 -- duplicate header -->
### Fail
```ts
@@ -55,6 +56,7 @@ import b from './b';
import c from './c';
```
+<!-- markdownlint-disable-next-line MD024 -- duplicate header -->
### Pass
```ts
diff --git a/docs/rules/named.md b/docs/rules/named.md
index 6d376defac..44f8dc6584 100644
--- a/docs/rules/named.md
+++ b/docs/rules/named.md
@@ -18,7 +18,6 @@ A module path that is [ignored] or not [unambiguously an ES module] will not be
[unambiguously an ES module]: https://github.com/bmeck/UnambiguousJavaScriptGrammar
[Flow]: https://flow.org/
-
## Rule Details
Given:
@@ -94,10 +93,9 @@ runtime, you will likely see false positives with this rule.
## Further Reading
-- [`import/ignore`] setting
-- [`jsnext:main`] deprecation
-- [`pkg.module`] (Rollup)
-
+ - [`import/ignore`] setting
+ - [`jsnext:main`] deprecation
+ - [`pkg.module`] (Rollup)
[`jsnext:main`]: https://github.com/jsforum/jsforum/issues/5
[`pkg.module`]: https://github.com/rollup/rollup/wiki/pkg.module
diff --git a/docs/rules/namespace.md b/docs/rules/namespace.md
index 5ac25b750d..1a177f5819 100644
--- a/docs/rules/namespace.md
+++ b/docs/rules/namespace.md
@@ -30,6 +30,7 @@ redefinition of the namespace in an intermediate scope. Adherence to the ESLint
For [ES7], reports if an exported namespace would be empty (no names exported from the referenced module.)
Given:
+
```js
// @module ./named-exports
export const a = 1
@@ -44,7 +45,9 @@ export class ExportedClass { }
// ES7
export * as deep from './deep'
```
+
and:
+
```js
// @module ./deep
export const e = "MC2"
@@ -94,9 +97,9 @@ still can't be statically analyzed any further.
## Further Reading
-- Lee Byron's [ES7] export proposal
-- [`import/ignore`] setting
-- [`jsnext:main`](Rollup)
+ - Lee Byron's [ES7] export proposal
+ - [`import/ignore`] setting
+ - [`jsnext:main`](Rollup)
[ES7]: https://github.com/leebyron/ecmascript-more-export-from
[`import/ignore`]: ../../README.md#importignore
diff --git a/docs/rules/newline-after-import.md b/docs/rules/newline-after-import.md
index 6aa75be552..fec6b23aca 100644
--- a/docs/rules/newline-after-import.md
+++ b/docs/rules/newline-after-import.md
@@ -9,9 +9,10 @@ Enforces having one or more empty lines after the last top-level import statemen
## Rule Details
This rule supports the following options:
-- `count` which sets the number of newlines that are enforced after the last top-level import statement or require call. This option defaults to `1`.
-- `considerComments` which enforces the rule on comments after the last import-statement as well when set to true. This option defaults to `false`.
+ - `count` which sets the number of newlines that are enforced after the last top-level import statement or require call. This option defaults to `1`.
+
+ - `considerComments` which enforces the rule on comments after the last import-statement as well when set to true. This option defaults to `false`.
Valid:
@@ -103,6 +104,7 @@ const FOO = 'BAR'
```
## Example options usage
+
```json
{
"rules": {
@@ -111,7 +113,6 @@ const FOO = 'BAR'
}
```
-
## When Not To Use It
If you like to visually group module imports with its usage, you don't want to use this rule.
diff --git a/docs/rules/no-absolute-path.md b/docs/rules/no-absolute-path.md
index a796f9d574..48fb9532bd 100644
--- a/docs/rules/no-absolute-path.md
+++ b/docs/rules/no-absolute-path.md
@@ -38,9 +38,9 @@ By default, only ES6 imports and CommonJS `require` calls will have this rule en
You may provide an options object providing true/false for any of
-- `esmodule`: defaults to `true`
-- `commonjs`: defaults to `true`
-- `amd`: defaults to `false`
+ - `esmodule`: defaults to `true`
+ - `commonjs`: defaults to `true`
+ - `amd`: defaults to `false`
If `{ amd: true }` is provided, dependency paths for AMD-style `define` and `require`
calls will be resolved:
diff --git a/docs/rules/no-amd.md b/docs/rules/no-amd.md
index 155c19b3ca..6e592ba758 100644
--- a/docs/rules/no-amd.md
+++ b/docs/rules/no-amd.md
@@ -33,5 +33,5 @@ Special thanks to @xjamundx for donating his no-define rule as a start to this.
## Further Reading
-- [`no-commonjs`](./no-commonjs.md): report CommonJS `require` and `exports`
-- Source: https://github.com/xjamundx/eslint-plugin-modules
+ - [`no-commonjs`](./no-commonjs.md): report CommonJS `require` and `exports`
+ - Source: <https://github.com/xjamundx/eslint-plugin-modules>
diff --git a/docs/rules/no-anonymous-default-export.md b/docs/rules/no-anonymous-default-export.md
index d3c88f94e0..70efb84501 100644
--- a/docs/rules/no-anonymous-default-export.md
+++ b/docs/rules/no-anonymous-default-export.md
@@ -28,6 +28,7 @@ The complete default configuration looks like this.
## Rule Details
### Fail
+
```js
export default []
@@ -48,6 +49,7 @@ export default new Foo()
```
### Pass
+
```js
const foo = 123
export default foo
diff --git a/docs/rules/no-commonjs.md b/docs/rules/no-commonjs.md
index 09a6b44010..4dc9c8c5d9 100644
--- a/docs/rules/no-commonjs.md
+++ b/docs/rules/no-commonjs.md
@@ -86,12 +86,11 @@ don't want this rule.
It is also fairly noisy if you have a larger codebase that is being transitioned
from CommonJS to ES6 modules.
-
## Contributors
Special thanks to @xjamundx for donating the module.exports and exports.* bits.
## Further Reading
-- [`no-amd`](./no-amd.md): report on AMD `require`, `define`
-- Source: https://github.com/xjamundx/eslint-plugin-modules
+ - [`no-amd`](./no-amd.md): report on AMD `require`, `define`
+ - Source: <https://github.com/xjamundx/eslint-plugin-modules>
diff --git a/docs/rules/no-cycle.md b/docs/rules/no-cycle.md
index 6635ba73f0..76e96f95f2 100644
--- a/docs/rules/no-cycle.md
+++ b/docs/rules/no-cycle.md
@@ -24,7 +24,6 @@ for that, see [`no-self-import`].
This rule ignores type-only imports in Flow and TypeScript syntax (`import type` and `import typeof`), which have no runtime effect.
-
## Rule Details
### Options
@@ -103,9 +102,9 @@ this rule enabled.
## Further Reading
-- [Original inspiring issue](https://github.com/import-js/eslint-plugin-import/issues/941)
-- Rule to detect that module imports itself: [`no-self-import`]
-- [`import/external-module-folders`] setting
+ - [Original inspiring issue](https://github.com/import-js/eslint-plugin-import/issues/941)
+ - Rule to detect that module imports itself: [`no-self-import`]
+ - [`import/external-module-folders`] setting
[`no-self-import`]: ./no-self-import.md
diff --git a/docs/rules/no-deprecated.md b/docs/rules/no-deprecated.md
index 641fc1a8f4..a647d77ad5 100644
--- a/docs/rules/no-deprecated.md
+++ b/docs/rules/no-deprecated.md
@@ -3,7 +3,7 @@
<!-- end auto-generated rule header -->
Reports use of a deprecated name, as indicated by a JSDoc block with a `@deprecated`
-tag or TomDoc `Deprecated: ` comment.
+tag or TomDoc `Deprecated:` comment.
using a JSDoc `@deprecated` tag:
@@ -45,19 +45,18 @@ export function multiply(six, nine) {
Only JSDoc is enabled by default. Other documentation styles can be enabled with
the `import/docstyle` setting.
-
```yaml
# .eslintrc.yml
settings:
import/docstyle: ['jsdoc', 'tomdoc']
```
-### Worklist
+## Worklist
-- [x] report explicit imports on the import node
-- [x] support namespaces
- - [x] should bubble up through deep namespaces (#157)
-- [x] report explicit imports at reference time (at the identifier) similar to namespace
-- [x] mark module deprecated if file JSDoc has a @deprecated tag?
-- [ ] don't flag redeclaration of imported, deprecated names
-- [ ] flag destructuring
+ - [x] report explicit imports on the import node
+ - [x] support namespaces
+ - [x] should bubble up through deep namespaces (#157)
+ - [x] report explicit imports at reference time (at the identifier) similar to namespace
+ - [x] mark module deprecated if file JSDoc has a @deprecated tag?
+ - [ ] don't flag redeclaration of imported, deprecated names
+ - [ ] flag destructuring
diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md
index 50f779b456..29c16f15d1 100644
--- a/docs/rules/no-duplicates.md
+++ b/docs/rules/no-duplicates.md
@@ -17,6 +17,7 @@ is different in two key ways:
## Rule Details
Valid:
+
```js
import SomeDefaultClass, * as names from './mod'
// Flow `type` import from same module is fine
@@ -52,6 +53,7 @@ Config:
```
And then the following code becomes valid:
+
```js
import minifiedMod from './mod?minify'
import noCommentsMod from './mod?comments=0'
@@ -59,6 +61,7 @@ import originalMod from './mod'
```
It will still catch duplicates when using the same module and the exact same query string:
+
```js
import SomeDefaultClass from './mod?minify'
diff --git a/docs/rules/no-empty-named-blocks.md b/docs/rules/no-empty-named-blocks.md
index 7bf4d695cf..85821d8afe 100644
--- a/docs/rules/no-empty-named-blocks.md
+++ b/docs/rules/no-empty-named-blocks.md
@@ -9,35 +9,41 @@ Reports the use of empty named import blocks.
## Rule Details
### Valid
+
```js
import { mod } from 'mod'
import Default, { mod } from 'mod'
```
When using typescript
+
```js
import type { mod } from 'mod'
```
When using flow
+
```js
import typeof { mod } from 'mod'
```
### Invalid
+
```js
import {} from 'mod'
import Default, {} from 'mod'
```
When using typescript
+
```js
import type Default, {} from 'mod'
import type {} from 'mod'
```
When using flow
+
```js
import typeof {} from 'mod'
import typeof Default, {} from 'mod'
-```
\ No newline at end of file
+```
diff --git a/docs/rules/no-extraneous-dependencies.md b/docs/rules/no-extraneous-dependencies.md
index 660875d1da..547e5c2e57 100644
--- a/docs/rules/no-extraneous-dependencies.md
+++ b/docs/rules/no-extraneous-dependencies.md
@@ -7,7 +7,7 @@ The closest parent `package.json` will be used. If no `package.json` is found, t
Modules have to be installed for this rule to work.
-### Options
+## Options
This rule supports the following options:
@@ -60,6 +60,7 @@ folder layouts:
## Rule Details
Given the following `package.json`:
+
```json
{
"name": "my-project",
@@ -88,7 +89,6 @@ Given the following `package.json`:
}
```
-
## Fail
```js
@@ -117,7 +117,6 @@ var foo = require('./foo');
import type { MyType } from 'foo';
```
-
## Pass
```js
@@ -135,7 +134,6 @@ import type { MyType } from 'foo';
import react from 'react';
```
-
## When Not To Use It
If you do not have a `package.json` file in your project.
diff --git a/docs/rules/no-import-module-exports.md b/docs/rules/no-import-module-exports.md
index 08aacfcc34..1c57226495 100644
--- a/docs/rules/no-import-module-exports.md
+++ b/docs/rules/no-import-module-exports.md
@@ -12,7 +12,8 @@ If you have multiple entry points or are using `js:next` this rule includes an
## Options
-#### `exceptions`
+### `exceptions`
+
- An array of globs. The rule will be omitted from any file that matches a glob
in the options array. For example, the following setting will omit the rule
in the `some-file.js` file.
@@ -43,6 +44,7 @@ console.log(baz)
```
### Pass
+
Given the following package.json:
```json
@@ -75,4 +77,5 @@ module.exports = foo;
```
### Further Reading
+
- [webpack issue #4039](https://github.com/webpack/webpack/issues/4039)
diff --git a/docs/rules/no-internal-modules.md b/docs/rules/no-internal-modules.md
index 47f7490da6..433b55140d 100644
--- a/docs/rules/no-internal-modules.md
+++ b/docs/rules/no-internal-modules.md
@@ -8,14 +8,14 @@ Use this rule to prevent importing the submodules of other modules.
This rule has two mutally exclusive options that are arrays of [minimatch/glob patterns](https://github.com/isaacs/node-glob#glob-primer) patterns:
-- `allow` that include paths and import statements that can be imported with reaching.
-- `forbid` that exclude paths and import statements that can be imported with reaching.
+ - `allow` that include paths and import statements that can be imported with reaching.
+ - `forbid` that exclude paths and import statements that can be imported with reaching.
### Examples
Given the following folder structure:
-```
+```pt
my-project
├── actions
│ └── getUser.js
@@ -33,7 +33,8 @@ my-project
```
And the .eslintrc file:
-```
+
+```json
{
...
"rules": {
@@ -76,7 +77,7 @@ export { settings } from '../app';
Given the following folder structure:
-```
+```pt
my-project
├── actions
│ └── getUser.js
@@ -94,7 +95,8 @@ my-project
```
And the .eslintrc file:
-```
+
+```json
{
...
"rules": {
diff --git a/docs/rules/no-mutable-exports.md b/docs/rules/no-mutable-exports.md
index f0a6251c19..ce51627858 100644
--- a/docs/rules/no-mutable-exports.md
+++ b/docs/rules/no-mutable-exports.md
@@ -43,8 +43,8 @@ export function getCount() {} // reported here: exported function is reassigned
To prevent general reassignment of these identifiers, exported or not, you may
want to enable the following core ESLint rules:
-- [no-func-assign]
-- [no-class-assign]
+ - [no-func-assign]
+ - [no-class-assign]
[no-func-assign]: https://eslint.org/docs/rules/no-func-assign
[no-class-assign]: https://eslint.org/docs/rules/no-class-assign
diff --git a/docs/rules/no-named-as-default-member.md b/docs/rules/no-named-as-default-member.md
index 5e0f5069e9..e8935fb7df 100644
--- a/docs/rules/no-named-as-default-member.md
+++ b/docs/rules/no-named-as-default-member.md
@@ -17,13 +17,12 @@ Furthermore, [in Babel 5 this is actually how things worked][blog]. This was
fixed in Babel 6. Before upgrading an existing codebase to Babel 6, it can be
useful to run this lint rule.
-
[blog]: https://kentcdodds.com/blog/misunderstanding-es6-modules-upgrading-babel-tears-and-a-solution
-
## Rule Details
Given:
+
```js
// foo.js
export default 'foo';
@@ -31,11 +30,13 @@ export const bar = 'baz';
```
...this would be valid:
+
```js
import foo, {bar} from './foo.js';
```
...and the following would be reported:
+
```js
// Caution: `foo` also has a named export `bar`.
// Check if you meant to write `import {bar} from './foo.js'` instead.
diff --git a/docs/rules/no-named-as-default.md b/docs/rules/no-named-as-default.md
index b3715e6c44..043d699424 100644
--- a/docs/rules/no-named-as-default.md
+++ b/docs/rules/no-named-as-default.md
@@ -8,12 +8,13 @@ Reports use of an exported name as the locally imported name of a default export
Rationale: using an exported name as the name of the default export is likely...
-- *misleading*: others familiar with `foo.js` probably expect the name to be `foo`
-- *a mistake*: only needed to import `bar` and forgot the brackets (the case that is prompting this)
+ - _misleading_: others familiar with `foo.js` probably expect the name to be `foo`
+ - _a mistake_: only needed to import `bar` and forgot the brackets (the case that is prompting this)
## Rule Details
Given:
+
```js
// foo.js
export default 'foo';
@@ -21,11 +22,13 @@ export const bar = 'baz';
```
...this would be valid:
+
```js
import foo from './foo.js';
```
...and this would be reported:
+
```js
// message: Using exported name 'bar' as identifier for default export.
import bar from './foo.js';
@@ -43,8 +46,8 @@ export bar from './foo.js';
## Further Reading
-- ECMAScript Proposal: [export ns from]
-- ECMAScript Proposal: [export default from]
+ - ECMAScript Proposal: [export ns from]
+ - ECMAScript Proposal: [export default from]
[export ns from]: https://github.com/leebyron/ecmascript-export-ns-from
[export default from]: https://github.com/leebyron/ecmascript-export-default-from
diff --git a/docs/rules/no-named-default.md b/docs/rules/no-named-default.md
index 2f3d54b807..05860cde1e 100644
--- a/docs/rules/no-named-default.md
+++ b/docs/rules/no-named-default.md
@@ -13,6 +13,7 @@ Note that type imports, as used by [Flow], are always ignored.
## Rule Details
Given:
+
```js
// foo.js
export default 'foo';
@@ -20,12 +21,14 @@ export const bar = 'baz';
```
...these would be valid:
+
```js
import foo from './foo.js';
import foo, { bar } from './foo.js';
```
...and these would be reported:
+
```js
// message: Using exported name 'bar' as identifier for default export.
import { default as foo } from './foo.js';
diff --git a/docs/rules/no-namespace.md b/docs/rules/no-namespace.md
index 623dae049c..c7346515a5 100644
--- a/docs/rules/no-namespace.md
+++ b/docs/rules/no-namespace.md
@@ -8,11 +8,11 @@ Enforce a convention of not using namespace (a.k.a. "wildcard" `*`) imports.
The rule is auto-fixable when the namespace object is only used for direct member access, e.g. `namespace.a`.
-### Options
+## Options
This rule supports the following options:
-- `ignore`: array of glob strings for modules that should be ignored by the rule.
+ - `ignore`: array of glob strings for modules that should be ignored by the rule.
## Rule Details
diff --git a/docs/rules/no-nodejs-modules.md b/docs/rules/no-nodejs-modules.md
index 624c27e059..5cbc907286 100644
--- a/docs/rules/no-nodejs-modules.md
+++ b/docs/rules/no-nodejs-modules.md
@@ -4,11 +4,11 @@
Forbid the use of Node.js builtin modules. Can be useful for client-side web projects that do not have access to those modules.
-### Options
+## Options
This rule supports the following options:
-- `allow`: Array of names of allowed modules. Defaults to an empty array.
+ - `allow`: Array of names of allowed modules. Defaults to an empty array.
## Rule Details
diff --git a/docs/rules/no-relative-packages.md b/docs/rules/no-relative-packages.md
index df21c25dd0..4014ed9859 100644
--- a/docs/rules/no-relative-packages.md
+++ b/docs/rules/no-relative-packages.md
@@ -9,11 +9,11 @@ Use this rule to prevent importing packages through relative paths.
It's useful in Yarn/Lerna workspaces, were it's possible to import a sibling
package using `../package` relative path, while direct `package` is the correct one.
-### Examples
+## Examples
Given the following folder structure:
-```
+```pt
my-project
├── packages
│ ├── foo
@@ -26,7 +26,8 @@ my-project
```
And the .eslintrc file:
-```
+
+```json
{
...
"rules": {
diff --git a/docs/rules/no-relative-parent-imports.md b/docs/rules/no-relative-parent-imports.md
index e5684eb1cf..c1f9784871 100644
--- a/docs/rules/no-relative-parent-imports.md
+++ b/docs/rules/no-relative-parent-imports.md
@@ -8,7 +8,7 @@ This rule is useful for enforcing tree-like folder structures instead of complex
To fix violations of this rule there are three general strategies. Given this example:
-```
+```pt
numbers
└── three.js
add.js
@@ -32,51 +32,51 @@ You can,
1. Move the file to be in a sibling folder (or higher) of the dependency.
-`three.js` could be be in the same folder as `add.js`:
+ `three.js` could be be in the same folder as `add.js`:
-```
-three.js
-add.js
-```
+ ```pt
+ three.js
+ add.js
+ ```
-or since `add` doesn't have any imports, it could be in it's own directory (namespace):
+ or since `add` doesn't have any imports, it could be in it's own directory (namespace):
-```
-math
-└── add.js
-three.js
-```
+ ```pt
+ math
+ └── add.js
+ three.js
+ ```
2. Pass the dependency as an argument at runtime (dependency injection)
-```js
-// three.js
-export default function three(add) {
- return add([1, 2]);
-}
+ ```js
+ // three.js
+ export default function three(add) {
+ return add([1, 2]);
+ }
-// somewhere else when you use `three.js`:
-import add from './add';
-import three from './numbers/three';
-console.log(three(add));
-```
+ // somewhere else when you use `three.js`:
+ import add from './add';
+ import three from './numbers/three';
+ console.log(three(add));
+ ```
3. Make the dependency a package so it's globally available to all files in your project:
-```js
-import add from 'add'; // from https://www.npmjs.com/package/add
-export default function three() {
- return add([1,2]);
-}
-```
+ ```js
+ import add from 'add'; // from https://www.npmjs.com/package/add
+ export default function three() {
+ return add([1,2]);
+ }
+ ```
These are (respectively) static, dynamic & global solutions to graph-like dependency resolution.
-### Examples
+## Examples
Given the following folder structure:
-```
+```pt
my-project
├── lib
│ ├── a.js
@@ -85,7 +85,8 @@ my-project
```
And the .eslintrc file:
-```
+
+```json
{
...
"rules": {
diff --git a/docs/rules/no-restricted-paths.md b/docs/rules/no-restricted-paths.md
index 344c33bb67..293f3ba009 100644
--- a/docs/rules/no-restricted-paths.md
+++ b/docs/rules/no-restricted-paths.md
@@ -13,25 +13,26 @@ This rule has one option. The option is an object containing the definition of a
The default value for `basePath` is the current working directory.
Each zone consists of the `target` paths, a `from` paths, and an optional `except` and `message` attribute.
-- `target` contains the paths where the restricted imports should be applied. It can be expressed by
- - directory string path that matches all its containing files
- - glob pattern matching all the targeted files
- - an array of multiple of the two types above
-- `from` paths define the folders that are not allowed to be used in an import. It can be expressed by
- - directory string path that matches all its containing files
- - glob pattern matching all the files restricted to be imported
- - an array of multiple directory string path
- - an array of multiple glob patterns
-- `except` may be defined for a zone, allowing exception paths that would otherwise violate the related `from`. Note that it does not alter the behaviour of `target` in any way.
- - in case `from` contains only glob patterns, `except` must be an array of glob patterns as well
- - in case `from` contains only directory path, `except` is relative to `from` and cannot backtrack to a parent directory
-- `message` - will be displayed in case of the rule violation.
+
+ - `target` contains the paths where the restricted imports should be applied. It can be expressed by
+ - directory string path that matches all its containing files
+ - glob pattern matching all the targeted files
+ - an array of multiple of the two types above
+ - `from` paths define the folders that are not allowed to be used in an import. It can be expressed by
+ - directory string path that matches all its containing files
+ - glob pattern matching all the files restricted to be imported
+ - an array of multiple directory string path
+ - an array of multiple glob patterns
+ - `except` may be defined for a zone, allowing exception paths that would otherwise violate the related `from`. Note that it does not alter the behaviour of `target` in any way.
+ - in case `from` contains only glob patterns, `except` must be an array of glob patterns as well
+ - in case `from` contains only directory path, `except` is relative to `from` and cannot backtrack to a parent directory
+ - `message` - will be displayed in case of the rule violation.
### Examples
Given the following folder structure:
-```
+```pt
my-project
├── client
│ └── foo.js
@@ -58,7 +59,7 @@ import baz from '../client/baz';
Given the following folder structure:
-```
+```pt
my-project
├── client
│ └── foo.js
@@ -74,7 +75,7 @@ and the current file being linted is `my-project/server/one/a.js`.
and the current configuration is set to:
-```
+```json
{ "zones": [ {
"target": "./tests/files/restricted-paths/server/one",
"from": "./tests/files/restricted-paths/server",
@@ -99,7 +100,7 @@ import b from './b'
Given the following folder structure:
-```
+```pt
my-project
├── client
└── foo.js
@@ -111,7 +112,7 @@ my-project
and the current configuration is set to:
-```
+```json
{ "zones": [ {
"target": "./tests/files/restricted-paths/client/!(sub-module)/**/*",
"from": "./tests/files/restricted-paths/client/sub-module/**/*",
@@ -134,7 +135,7 @@ import b from './baz'
Given the following folder structure:
-```
+```pt
my-project
└── one
└── a.js
@@ -149,7 +150,7 @@ my-project
and the current configuration is set to:
-```
+```json
{
"zones": [
{
@@ -195,4 +196,3 @@ import a from '../one/a'
```js
import a from './a'
```
-
diff --git a/docs/rules/no-unassigned-import.md b/docs/rules/no-unassigned-import.md
index 6f763e9737..617395e2c3 100644
--- a/docs/rules/no-unassigned-import.md
+++ b/docs/rules/no-unassigned-import.md
@@ -3,12 +3,13 @@
<!-- end auto-generated rule header -->
With both CommonJS' `require` and the ES6 modules' `import` syntax, it is possible to import a module but not to use its result. This can be done explicitly by not assigning the module to as variable. Doing so can mean either of the following things:
-- The module is imported but not used
-- The module has side-effects (like [`should`](https://www.npmjs.com/package/should)). Having side-effects, makes it hard to know whether the module is actually used or can be removed. It can also make it harder to test or mock parts of your application.
+
+ - The module is imported but not used
+ - The module has side-effects (like [`should`](https://www.npmjs.com/package/should)). Having side-effects, makes it hard to know whether the module is actually used or can be removed. It can also make it harder to test or mock parts of your application.
This rule aims to remove modules with side-effects by reporting when a module is imported but not assigned.
-### Options
+## Options
This rule supports the following option:
@@ -16,7 +17,6 @@ This rule supports the following option:
Note that the globs start from the where the linter is executed (usually project root), but not from each file that includes the source. Learn more in both the pass and fail examples below.
-
## Fail
```js
@@ -28,7 +28,6 @@ import '../styles/app.css'
// {"allow": ["styles/*.css"]}
```
-
## Pass
```js
diff --git a/docs/rules/no-unresolved.md b/docs/rules/no-unresolved.md
index 13f7928877..ca1da39c00 100644
--- a/docs/rules/no-unresolved.md
+++ b/docs/rules/no-unresolved.md
@@ -50,6 +50,7 @@ const { default: x } = require('./foo') // ignored
```
Both may be provided, too:
+
```js
/*eslint import/no-unresolved: [2, { commonjs: true, amd: true }]*/
const { default: x } = require('./foo') // reported if './foo' is not found
@@ -84,7 +85,6 @@ const { default: x } = require('./foo') // reported if './foo' is actually './Fo
The `caseSensitive` option does not detect case for the current working directory. The `caseSensitiveStrict` option allows checking `cwd` in resolved path. By default, the option is disabled.
-
```js
/*eslint import/no-unresolved: [2, { caseSensitiveStrict: true }]*/
@@ -102,9 +102,9 @@ If you're using a module bundler other than Node or Webpack, you may end up with
## Further Reading
-- [Resolver plugins](../../README.md#resolvers)
-- [Node resolver](https://npmjs.com/package/eslint-import-resolver-node) (default)
-- [Webpack resolver](https://npmjs.com/package/eslint-import-resolver-webpack)
-- [`import/ignore`] global setting
+ - [Resolver plugins](../../README.md#resolvers)
+ - [Node resolver](https://npmjs.com/package/eslint-import-resolver-node) (default)
+ - [Webpack resolver](https://npmjs.com/package/eslint-import-resolver-webpack)
+ - [`import/ignore`] global setting
[`import/ignore`]: ../../README.md#importignore
diff --git a/docs/rules/no-unused-modules.md b/docs/rules/no-unused-modules.md
index a8e1a3c182..53c2479272 100644
--- a/docs/rules/no-unused-modules.md
+++ b/docs/rules/no-unused-modules.md
@@ -3,19 +3,20 @@
<!-- end auto-generated rule header -->
Reports:
- - modules without any exports
- - individual exports not being statically `import`ed or `require`ed from other modules in the same project
- - dynamic imports are supported if argument is a literal string
+ - modules without any exports
+ - individual exports not being statically `import`ed or `require`ed from other modules in the same project
+ - dynamic imports are supported if argument is a literal string
## Rule Details
### Usage
-In order for this plugin to work, at least one of the options `missingExports` or `unusedExports` must be enabled (see "Options" section below). In the future, these options will be enabled by default (see https://github.com/import-js/eslint-plugin-import/issues/1324)
+In order for this plugin to work, at least one of the options `missingExports` or `unusedExports` must be enabled (see "Options" section below). In the future, these options will be enabled by default (see <https://github.com/import-js/eslint-plugin-import/issues/1324>)
Example:
-```
+
+```json
"rules: {
...otherRules,
"import/no-unused-modules": [1, {"unusedExports": true}]
@@ -26,14 +27,15 @@ Example:
This rule takes the following option:
-- **`missingExports`**: if `true`, files without any exports are reported (defaults to `false`)
-- **`unusedExports`**: if `true`, exports without any static usage within other modules are reported (defaults to `false`)
-- `src`: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
-- `ignoreExports`: an array with files/paths for which unused exports will not be reported (e.g module entry points in a published package)
-
+ - **`missingExports`**: if `true`, files without any exports are reported (defaults to `false`)
+ - **`unusedExports`**: if `true`, exports without any static usage within other modules are reported (defaults to `false`)
+ - `src`: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
+ - `ignoreExports`: an array with files/paths for which unused exports will not be reported (e.g module entry points in a published package)
### Example for missing exports
+
#### The following will be reported
+
```js
const class MyClass { /*...*/ }
@@ -45,18 +47,23 @@ function makeClass() { return new MyClass(...arguments) }
```js
export default function () { /*...*/ }
```
+
```js
export const foo = function () { /*...*/ }
```
+
```js
export { foo, bar }
```
+
```js
export { foo as bar }
```
### Example for unused exports
+
given file-f:
+
```js
import { e } from 'file-a'
import { f } from 'file-b'
@@ -65,24 +72,32 @@ export { default, i0 } from 'file-d' // both will be reported
export const j = 99 // will be reported
```
+
and file-d:
+
```js
export const i0 = 9 // will not be reported
export const i1 = 9 // will be reported
export default () => {} // will not be reported
```
+
and file-c:
+
```js
export const h = 8 // will not be reported
export default () => {} // will be reported, as export * only considers named exports and ignores default exports
```
+
and file-b:
+
```js
import two, { b, c, doAnything } from 'file-a'
export const f = 6 // will not be reported
```
+
and file-a:
+
```js
const b = 2
const c = 3
@@ -102,6 +117,7 @@ export default 5 // will not be reported
```
#### Important Note
+
Exports from files listed as a main file (`main`, `browser`, or `bin` fields in `package.json`) will be ignored by default. This only applies if the `package.json` is not set to `private: true`
## When not to use
diff --git a/docs/rules/no-useless-path-segments.md b/docs/rules/no-useless-path-segments.md
index c8dc67727a..22c4bf965b 100644
--- a/docs/rules/no-useless-path-segments.md
+++ b/docs/rules/no-useless-path-segments.md
@@ -10,7 +10,7 @@ Use this rule to prevent unnecessary path segments in import and require stateme
Given the following folder structure:
-```
+```pt
my-project
├── app.js
├── footer.js
@@ -62,6 +62,7 @@ import fs from "fs";
### noUselessIndex
If you want to detect unnecessary `/index` or `/index.js` (depending on the specified file extensions, see below) imports in your paths, you can enable the option `noUselessIndex`. By default it is set to `false`:
+
```js
"import/no-useless-path-segments": ["error", {
noUselessIndex: true,
diff --git a/docs/rules/no-webpack-loader-syntax.md b/docs/rules/no-webpack-loader-syntax.md
index e1b7a4bd9d..291b1c058a 100644
--- a/docs/rules/no-webpack-loader-syntax.md
+++ b/docs/rules/no-webpack-loader-syntax.md
@@ -5,6 +5,7 @@
Forbid Webpack loader syntax in imports.
[Webpack](https://webpack.js.org) allows specifying the [loaders](https://webpack.js.org/concepts/loaders/) to use in the import source string using a special syntax like this:
+
```js
var moduleWithOneLoader = require("my-loader!./my-awesome-module");
```
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 6dc4520e8d..2335699e6c 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -36,7 +36,6 @@ Unassigned imports are ignored, as the order they are imported in may be importa
Statements using the ES6 `import` syntax must appear before any `require()` statements.
-
## Fail
```ts
@@ -54,7 +53,6 @@ var path = require('path');
import foo from './foo'; // `import` statements must be before `require` statement
```
-
## Pass
```ts
@@ -83,11 +81,12 @@ var path = require('path');
This rule supports the following options:
-### `groups: [array]`:
+### `groups: [array]`
How groups are defined, and the order to respect. `groups` must be an array of `string` or [`string`]. The only allowed `string`s are:
`"builtin"`, `"external"`, `"internal"`, `"unknown"`, `"parent"`, `"sibling"`, `"index"`, `"object"`, `"type"`.
The enforced order is the same as the order of each element in a group. Omitted types are implicitly grouped together as the last element. Example:
+
```ts
[
'builtin', // Built-in types are first
@@ -97,6 +96,7 @@ The enforced order is the same as the order of each element in a group. Omitted
// Then the rest: internal and external type
]
```
+
The default value is `["builtin", "external", "parent", "sibling", "index"]`.
You can set the options like this:
@@ -119,7 +119,7 @@ You can set the options like this:
]
```
-### `pathGroups: [array of objects]`:
+### `pathGroups: [array of objects]`
To be able to group by paths mostly needed with aliases pathGroups can be defined.
@@ -145,7 +145,7 @@ Properties of the objects
}
```
-### `distinctGroup: [boolean]`:
+### `distinctGroup: [boolean]`
This changes how `pathGroups[].position` affects grouping. The property is most useful when `newlines-between` is set to `always` and at least 1 `pathGroups` entry has a `position` property set.
@@ -154,6 +154,7 @@ By default, in the context of a particular `pathGroup` entry, when setting `posi
Note that currently, `distinctGroup` defaults to `true`. However, in a later update, the default will change to `false`
Example:
+
```json
{
"import/order": ["error", {
@@ -170,12 +171,13 @@ Example:
}
```
-### `pathGroupsExcludedImportTypes: [array]`:
+### `pathGroupsExcludedImportTypes: [array]`
This defines import types that are not handled by configured pathGroups.
This is mostly needed when you want to handle path groups that look like external imports.
Example:
+
```json
{
"import/order": ["error", {
@@ -194,6 +196,7 @@ Example:
You can also use `patterns`(e.g., `react`, `react-router-dom`, etc).
Example:
+
```json
{
"import/order": [
@@ -211,16 +214,17 @@ Example:
]
}
```
+
The default value is `["builtin", "external", "object"]`.
-### `newlines-between: [ignore|always|always-and-inside-groups|never]`:
+### `newlines-between: [ignore|always|always-and-inside-groups|never]`
Enforces or forbids new lines between import groups:
-- If set to `ignore`, no errors related to new lines between import groups will be reported.
-- If set to `always`, at least one new line between each group will be enforced, and new lines inside a group will be forbidden. To prevent multiple lines between imports, core `no-multiple-empty-lines` rule can be used.
-- If set to `always-and-inside-groups`, it will act like `always` except newlines are allowed inside import groups.
-- If set to `never`, no new lines are allowed in the entire import section.
+ - If set to `ignore`, no errors related to new lines between import groups will be reported.
+ - If set to `always`, at least one new line between each group will be enforced, and new lines inside a group will be forbidden. To prevent multiple lines between imports, core `no-multiple-empty-lines` rule can be used.
+ - If set to `always-and-inside-groups`, it will act like `always` except newlines are allowed inside import groups.
+ - If set to `never`, no new lines are allowed in the entire import section.
The default value is `"ignore"`.
@@ -284,15 +288,16 @@ import index from './';
import sibling from './foo';
```
-### `alphabetize: {order: asc|desc|ignore, orderImportKind: asc|desc|ignore, caseInsensitive: true|false}`:
+### `alphabetize: {order: asc|desc|ignore, orderImportKind: asc|desc|ignore, caseInsensitive: true|false}`
Sort the order within each group in alphabetical manner based on **import path**:
-- `order`: use `asc` to sort in ascending order, and `desc` to sort in descending order (default: `ignore`).
-- `orderImportKind`: use `asc` to sort in ascending order various import kinds, e.g. imports prefixed with `type` or `typeof`, with same import path. Use `desc` to sort in descending order (default: `ignore`).
-- `caseInsensitive`: use `true` to ignore case, and `false` to consider case (default: `false`).
+ - `order`: use `asc` to sort in ascending order, and `desc` to sort in descending order (default: `ignore`).
+ - `orderImportKind`: use `asc` to sort in ascending order various import kinds, e.g. imports prefixed with `type` or `typeof`, with same import path. Use `desc` to sort in descending order (default: `ignore`).
+ - `caseInsensitive`: use `true` to ignore case, and `false` to consider case (default: `false`).
Example setting:
+
```ts
alphabetize: {
order: 'asc', /* sort in ascending order. Options: ['ignore', 'asc', 'desc'] */
@@ -322,9 +327,9 @@ import React, { PureComponent } from 'react';
import { compose, apply } from 'xcompose';
```
-### `warnOnUnassignedImports: true|false`:
+### `warnOnUnassignedImports: true|false`
-* default: `false`
+ - default: `false`
Warns when unassigned imports are out of order. These warning will not be fixed
with `--fix` because unassigned imports are used for side-effects and changing the
@@ -351,9 +356,9 @@ import './styles.css';
## Related
-- [`import/external-module-folders`] setting
+ - [`import/external-module-folders`] setting
-- [`import/internal-regex`] setting
+ - [`import/internal-regex`] setting
[`import/external-module-folders`]: ../../README.md#importexternal-module-folders
diff --git a/docs/rules/prefer-default-export.md b/docs/rules/prefer-default-export.md
index 5d335f4c12..e2a7bacd73 100644
--- a/docs/rules/prefer-default-export.md
+++ b/docs/rules/prefer-default-export.md
@@ -6,12 +6,12 @@ In exporting files, this rule checks if there is default export or not.
## Rule Details
-##### rule schema:
+### rule schema
```javascript
"import/prefer-default-export": [
( "off" | "warn" | "error" ),
- { "target": "single" | "any" } // default is "single"
+ { "target": "single" | "any" } // default is "single"
]
```
@@ -109,7 +109,6 @@ How to setup config file for this rule:
}
```
-
The following patterns are *not* considered warnings:
```javascript
diff --git a/docs/rules/unambiguous.md b/docs/rules/unambiguous.md
index da77a7453f..e9e5bf73da 100644
--- a/docs/rules/unambiguous.md
+++ b/docs/rules/unambiguous.md
@@ -32,6 +32,7 @@ export {} // simple way to mark side-effects-only file as 'module' without any i
```
...whereas the following file would be reported:
+
```js
(function x() { return 42 })()
```
@@ -48,9 +49,9 @@ a `module`.
## Further Reading
-- [Unambiguous JavaScript Grammar]
-- [`parserOptions.sourceType`]
-- [node-eps#13](https://github.com/nodejs/node-eps/issues/13)
+ - [Unambiguous JavaScript Grammar]
+ - [`parserOptions.sourceType`]
+ - [node-eps#13](https://github.com/nodejs/node-eps/issues/13)
[`parserOptions.sourceType`]: https://eslint.org/docs/user-guide/configuring#specifying-parser-options
[Unambiguous JavaScript Grammar]: https://github.com/nodejs/node-eps/blob/HEAD/002-es-modules.md#32-determining-if-source-is-an-es-module
diff --git a/memo-parser/README.md b/memo-parser/README.md
index 8a2a3cb5cd..741e0ed4d0 100644
--- a/memo-parser/README.md
+++ b/memo-parser/README.md
@@ -1,13 +1,11 @@
# eslint-plugin-import/memo-parser
-
-## NOTE!
+## NOTE
This used to improve performance, but as of ESLint 5 and v2 of this plugin, it seems to just consume a bunch of memory and slightly increase lint times.
**Not recommended for use at this time!**
-
This parser is just a memoizing wrapper around some actual parser.
To configure, just add your _actual_ parser to the `parserOptions`, like so:
diff --git a/package.json b/package.json
index 3884ff0653..bd45d8fa5c 100644
--- a/package.json
+++ b/package.json
@@ -24,7 +24,7 @@
"copy-metafiles": "node --require babel-register ./scripts/copyMetafiles",
"watch": "npm run tests-only -- -- --watch",
"pretest": "linklocal",
- "posttest": "eslint . && npm run update:eslint-docs -- --check",
+ "posttest": "eslint . && npm run update:eslint-docs -- --check && markdownlint \"**/*.md\"",
"mocha": "cross-env BABEL_ENV=test nyc mocha",
"tests-only": "npm run mocha tests/src",
"test": "npm run tests-only",
@@ -87,6 +87,7 @@
"in-publish": "^2.0.1",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
+ "markdownlint-cli": "^0.35.0",
"mocha": "^3.5.3",
"npm-which": "^3.0.1",
"nyc": "^11.9.0",
diff --git a/resolvers/README.md b/resolvers/README.md
index 0eb18684b9..e55ebb6104 100644
--- a/resolvers/README.md
+++ b/resolvers/README.md
@@ -2,14 +2,16 @@
Resolvers must export two names:
-### `interfaceVersion => Number`
+## `interfaceVersion => Number`
This document currently describes version 2 of the resolver interface. As such, a resolver implementing this version should
```js
export const interfaceVersion = 2
```
+
or
+
```js
exports.interfaceVersion = 2
```
@@ -18,9 +20,10 @@ To the extent it is feasible, trailing versions of the resolvers will continue t
Currently, version 1 is assumed if no `interfaceVersion` is available. (didn't think to define it until v2, heh. 😅)
-### `resolve(source, file, config) => { found: Boolean, path: String? }`
+## `resolve(source, file, config) => { found: Boolean, path: String? }`
Given:
+
```js
// /some/path/to/module.js
import ... from './imported-file'
@@ -37,27 +40,29 @@ settings:
node: { paths: [a, b, c] }
```
-#### Arguments
+### Arguments
The arguments provided will be:
-##### `source`
+#### `source`
+
the module identifier (`./imported-file`).
-##### `file`
+#### `file`
+
the absolute path to the file making the import (`/some/path/to/module.js`)
-##### `config`
+#### `config`
an object provided via the `import/resolver` setting. `my-cool-resolver` will get `["some", "stuff"]` as its `config`, while
`node` will get `{ "paths": ["a", "b", "c"] }` provided as `config`.
-#### Return value
+### Return value
The first resolver to return `{found: true}` is considered the source of truth. The returned object has:
-- `found`: `true` if the `source` module can be resolved relative to `file`, else `false`
-- `path`: an absolute path `String` if the module can be located on the filesystem; else, `null`.
+ - `found`: `true` if the `source` module can be resolved relative to `file`, else `false`
+ - `path`: an absolute path `String` if the module can be located on the filesystem; else, `null`.
An example of a `null` path is a Node core module, such as `fs` or `crypto`. These modules can always be resolved, but the path need not be provided as the plugin will not attempt to parse core modules at this time.
diff --git a/resolvers/webpack/README.md b/resolvers/webpack/README.md
index cdb9222fae..06513ba141 100644
--- a/resolvers/webpack/README.md
+++ b/resolvers/webpack/README.md
@@ -13,13 +13,13 @@ changes.
To use with `eslint-plugin-import`, run:
-```
+```sh
npm i eslint-import-resolver-webpack -g
```
or if you manage ESLint as a dev dependency:
-```
+```sh
# inside your project's working tree
npm install eslint-import-resolver-webpack --save-dev
```
From 2e7612ffdfe7721919cdb39832a78cf0b8828162 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 9 Aug 2023 23:12:59 +1200
Subject: [PATCH 056/199] [Dev Deps] pin `jackspeak` since 2.1.2+ depends on
npm aliases, which kill the install process in npm < 6
See https://github.com/isaacs/jackspeak/issues/4
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index bd45d8fa5c..553d9c6a95 100644
--- a/package.json
+++ b/package.json
@@ -85,6 +85,7 @@
"fs-copy-file-sync": "^1.1.1",
"glob": "^7.2.3",
"in-publish": "^2.0.1",
+ "jackspeak": "=2.1.1",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
"markdownlint-cli": "^0.35.0",
From b9b9c86e918e268c325066af5938ad779f5f6e97 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 11 Aug 2023 09:22:27 -0700
Subject: [PATCH 057/199] [resolvers/webpack] [refactor] switch to a maintained
array.prototype.find package
---
resolvers/webpack/CHANGELOG.md | 1 +
resolvers/webpack/index.js | 2 +-
resolvers/webpack/package.json | 2 +-
3 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index d5723757f8..914ce12732 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
+ - [refactor] switch to a maintained array.prototype.find package
## 0.13.4 - 2023-08-08
- [fix] restore node 6 compatibility
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index a9fc003813..b66ff38034 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -4,7 +4,7 @@ const findRoot = require('find-root');
const path = require('path');
const get = require('lodash/get');
const isEqual = require('lodash/isEqual');
-const find = require('array-find');
+const find = require('array.prototype.find');
const interpret = require('interpret');
const fs = require('fs');
const isCore = require('is-core-module');
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 0ae63cfdd4..3c87b2a1fa 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -30,7 +30,7 @@
},
"homepage": "https://github.com/import-js/eslint-plugin-import/tree/HEAD/resolvers/webpack",
"dependencies": {
- "array-find": "^1.0.0",
+ "array.prototype.find": "^2.2.1",
"debug": "^3.2.7",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
From 2c18c2906dab446023afc3117d6cfdca0d2bbcec Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 15 Aug 2023 22:00:05 -0700
Subject: [PATCH 058/199] [resolvers/webpack] [refactor] remove `lodash/get`
usage
---
resolvers/webpack/index.js | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index b66ff38034..1eea7d7ab5 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -2,7 +2,6 @@
const findRoot = require('find-root');
const path = require('path');
-const get = require('lodash/get');
const isEqual = require('lodash/isEqual');
const find = require('array.prototype.find');
const interpret = require('interpret');
@@ -51,15 +50,15 @@ exports.resolve = function (source, file, settings) {
let webpackConfig;
- const _configPath = get(settings, 'config');
+ const _configPath = settings && settings.config;
/**
* Attempt to set the current working directory.
* If none is passed, default to the `cwd` where the config is located.
*/
- const cwd = get(settings, 'cwd');
- const configIndex = get(settings, 'config-index');
- const env = get(settings, 'env');
- const argv = get(settings, 'argv', {});
+ const cwd = settings && settings.cwd;
+ const configIndex = settings && settings['config-index'];
+ const env = settings && settings.env;
+ const argv = settings && typeof settings.argv !== 'undefined' ? settings.argv : {};
let packageDir;
let configPath = typeof _configPath === 'string' && _configPath.startsWith('.')
From 1e81734ddd7a040053d08045c922b15ea9d2045e Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 15 Aug 2023 22:03:34 -0700
Subject: [PATCH 059/199] [resolvers/webpack] [refactor] replace
`lodash/isEqual` usage with `deep-equal`
---
resolvers/webpack/index.js | 4 ++--
resolvers/webpack/package.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 1eea7d7ab5..a19591f1a2 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -2,7 +2,7 @@
const findRoot = require('find-root');
const path = require('path');
-const isEqual = require('lodash/isEqual');
+const deepEqual = require('deep-equal');
const find = require('array.prototype.find');
const interpret = require('interpret');
const fs = require('fs');
@@ -163,7 +163,7 @@ const MAX_CACHE = 10;
const _cache = [];
function getResolveSync(configPath, webpackConfig, cwd) {
const cacheKey = { configPath, webpackConfig };
- let cached = find(_cache, function (entry) { return isEqual(entry.key, cacheKey); });
+ let cached = find(_cache, function (entry) { return deepEqual(entry.key, cacheKey, { strict: true }); });
if (!cached) {
cached = {
key: cacheKey,
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 3c87b2a1fa..af20386a1e 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -32,13 +32,13 @@
"dependencies": {
"array.prototype.find": "^2.2.1",
"debug": "^3.2.7",
+ "deep-equal": "^2.2.2",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
"has": "^1.0.3",
"interpret": "^1.4.0",
"is-core-module": "^2.13.0",
"is-regex": "^1.1.4",
- "lodash": "^4.17.21",
"resolve": "^1.22.4",
"semver": "^5.7.2"
},
From 22a080249074a86339ef4f30af02490e6084eb49 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 15 Aug 2023 22:06:00 -0700
Subject: [PATCH 060/199] [resolvers/webpack] [deps] update `resolve`
---
resolvers/webpack/package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index af20386a1e..29405df2ad 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -39,7 +39,7 @@
"interpret": "^1.4.0",
"is-core-module": "^2.13.0",
"is-regex": "^1.1.4",
- "resolve": "^1.22.4",
+ "resolve": "^2.0.0-next.4",
"semver": "^5.7.2"
},
"peerDependencies": {
From da71746147450a5b7eeeaca77efc521125d91d41 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 15 Aug 2023 22:14:38 -0700
Subject: [PATCH 061/199] [resolvers/webpack] v0.13.5
---
resolvers/webpack/CHANGELOG.md | 7 ++++++-
resolvers/webpack/package.json | 2 +-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 914ce12732..f7a9bc86ec 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,7 +4,12 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
- - [refactor] switch to a maintained array.prototype.find package
+
+## 0.13.5 - 2023-08-15
+ - [refactor] replace `lodash/isEqual` usage with `deep-equal`
+ - [refactor] remove `lodash/get` usage
+ - [refactor] switch to a maintained `array.prototype.find` package
+ - [deps] update `resolve`
## 0.13.4 - 2023-08-08
- [fix] restore node 6 compatibility
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 29405df2ad..74791e49c4 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.4",
+ "version": "0.13.5",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From cd1dff7544c90c79ef162e93fbe1e1e62d5e80bc Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 16 Aug 2023 11:31:56 -0700
Subject: [PATCH 062/199] Revert "[resolvers/webpack] [refactor] replace
`lodash/isEqual` usage with `deep-equal`"
This reverts commit 1e81734ddd7a040053d08045c922b15ea9d2045e.
Fixes #2857.
---
resolvers/webpack/index.js | 4 ++--
resolvers/webpack/package.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index a19591f1a2..1eea7d7ab5 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -2,7 +2,7 @@
const findRoot = require('find-root');
const path = require('path');
-const deepEqual = require('deep-equal');
+const isEqual = require('lodash/isEqual');
const find = require('array.prototype.find');
const interpret = require('interpret');
const fs = require('fs');
@@ -163,7 +163,7 @@ const MAX_CACHE = 10;
const _cache = [];
function getResolveSync(configPath, webpackConfig, cwd) {
const cacheKey = { configPath, webpackConfig };
- let cached = find(_cache, function (entry) { return deepEqual(entry.key, cacheKey, { strict: true }); });
+ let cached = find(_cache, function (entry) { return isEqual(entry.key, cacheKey); });
if (!cached) {
cached = {
key: cacheKey,
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 74791e49c4..59aafdead6 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -32,13 +32,13 @@
"dependencies": {
"array.prototype.find": "^2.2.1",
"debug": "^3.2.7",
- "deep-equal": "^2.2.2",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
"has": "^1.0.3",
"interpret": "^1.4.0",
"is-core-module": "^2.13.0",
"is-regex": "^1.1.4",
+ "lodash": "^4.17.21",
"resolve": "^2.0.0-next.4",
"semver": "^5.7.2"
},
From e9de30a9cbf8daab9f7e62131596d554884a56ac Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 16 Aug 2023 11:34:26 -0700
Subject: [PATCH 063/199] [resolvers/webpack] v0.13.6
---
resolvers/webpack/CHANGELOG.md | 3 +++
resolvers/webpack/package.json | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index f7a9bc86ec..457cd36ed4 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## 0.13.6 - 2023-08-16
+ - [refactor] revert back to `lodash/isEqual`
+
## 0.13.5 - 2023-08-15
- [refactor] replace `lodash/isEqual` usage with `deep-equal`
- [refactor] remove `lodash/get` usage
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 59aafdead6..c3363611b0 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.5",
+ "version": "0.13.6",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 0847443b0a6d8273a862960e51ffcf478f636abf Mon Sep 17 00:00:00 2001
From: Ynda Jas <yndajas@gmail.com>
Date: Wed, 9 Aug 2023 12:15:50 +0100
Subject: [PATCH 064/199] Revert 1fa2971 (breaking group change in `order`)
1fa2971 changed the way groups work when there is only one, leading
to single nested groups being treated as though they were unnested.
Prior to this, if you wanted to group e.g. builtin and external
imports together at the top and everything else together as a second
group, a single nested group was the way to do it
[It appears that this change was unintentional][1], and was made to
try to fix what seems to be a misunderstanding around nested groups
([#2687]). [The docs][2] continue to suggest that nested groups
should be "mingled together" and makes no reference to a single nested
group with no other groups being an invalid option
This therefore reverts the change to how groups work when there is
only one. No documentation change should be necessary given this is
already the described behaviour
[1]: https://github.com/import-js/eslint-plugin-import/issues/2687#issuecomment-1671038558
[2]: https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md#groups-array
---
CHANGELOG.md | 5 ++++
src/rules/order.js | 4 ---
tests/src/rules/order.js | 61 +++++++++++++++++-----------------------
3 files changed, 31 insertions(+), 39 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 96dbd8c107..bc7da43bf3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Fixed
+- [`order`]: revert breaking change to single nested group ([#2854], thanks [@yndajas])
+
### Changed
- [Docs] remove duplicate fixable notices in docs ([#2850], thanks [@bmish])
@@ -1082,6 +1085,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
[#2850]: https://github.com/import-js/eslint-plugin-import/pull/2850
[#2842]: https://github.com/import-js/eslint-plugin-import/pull/2842
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
@@ -1887,5 +1891,6 @@ for info on changes for earlier releases.
[@wtgtybhertgeghgtwtg]: https://github.com/wtgtybhertgeghgtwtg
[@xM8WVqaG]: https://github.com/xM8WVqaG
[@xpl]: https://github.com/xpl
+[@yndajas]: https://github.com/yndajas
[@yordis]: https://github.com/yordis
[@zloirock]: https://github.com/zloirock
diff --git a/src/rules/order.js b/src/rules/order.js
index 6f70db263c..44d25be63c 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -422,10 +422,6 @@ const types = ['builtin', 'external', 'internal', 'unknown', 'parent', 'sibling'
// Example: { index: 0, sibling: 1, parent: 1, external: 1, builtin: 2, internal: 2 }
// Will throw an error if it contains a type that does not exist, or has a duplicate
function convertGroupsToRanks(groups) {
- if (groups.length === 1) {
- // TODO: remove this `if` and fix the bug
- return convertGroupsToRanks(groups[0]);
- }
const rankObject = groups.reduce(function (res, group, index) {
[].concat(group).forEach(function (groupItem) {
if (types.indexOf(groupItem) === -1) {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 2a44aa06aa..a6a8735a6f 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -2753,7 +2753,7 @@ context('TypeScript', function () {
};
ruleTester.run('order', rule, {
- valid: [
+ valid: [].concat(
// #1667: typescript type import support
// Option alphabetize: {order: 'asc'}
@@ -2962,7 +2962,31 @@ context('TypeScript', function () {
},
],
}),
- ],
+ isCoreModule('node:child_process') && isCoreModule('node:fs/promises') ? [
+ test({
+ code: `
+ import express from 'express';
+ import log4js from 'log4js';
+ import chpro from 'node:child_process';
+ // import fsp from 'node:fs/promises';
+ `,
+ options: [{
+ groups: [
+ [
+ 'builtin',
+ 'external',
+ 'internal',
+ 'parent',
+ 'sibling',
+ 'index',
+ 'object',
+ 'type',
+ ],
+ ],
+ }],
+ }),
+ ] : [],
+ ),
invalid: [].concat(
// Option alphabetize: {order: 'asc'}
test({
@@ -3218,39 +3242,6 @@ context('TypeScript', function () {
// { message: '`node:fs/promises` import should occur before import of `express`' },
],
}),
-
- test({
- code: `
- import express from 'express';
- import log4js from 'log4js';
- import chpro from 'node:child_process';
- // import fsp from 'node:fs/promises';
- `,
- output: `
- import chpro from 'node:child_process';
- import express from 'express';
- import log4js from 'log4js';
- // import fsp from 'node:fs/promises';
- `,
- options: [{
- groups: [
- [
- 'builtin',
- 'external',
- 'internal',
- 'parent',
- 'sibling',
- 'index',
- 'object',
- 'type',
- ],
- ],
- }],
- errors: [
- { message: '`node:child_process` import should occur before import of `express`' },
- // { message: '`node:fs/promises` import should occur before import of `express`' },
- ],
- }),
] : [],
),
});
From cd957286efe1c4aa0423f82ac5576c75fd3be71e Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 18 Aug 2023 13:40:46 -0700
Subject: [PATCH 065/199] Bump to 2.28.1
---
CHANGELOG.md | 5 ++++-
package.json | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bc7da43bf3..4d5b23d828 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.28.1] - 2023-08-18
+
### Fixed
- [`order`]: revert breaking change to single nested group ([#2854], thanks [@yndajas])
@@ -1545,7 +1547,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...HEAD
+[2.28.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...v2.28.1
[2.28.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.5...v2.28.0
[2.27.5]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.4...v2.27.5
[2.27.4]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.3...v2.27.4
diff --git a/package.json b/package.json
index 553d9c6a95..6128a4e76b 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.28.0",
+ "version": "2.28.1",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 4d32d68558e3cc995ddbdffc30c96d10a634f6fe Mon Sep 17 00:00:00 2001
From: James <5511220+Zamiell@users.noreply.github.com>
Date: Mon, 7 Aug 2023 15:47:59 -0400
Subject: [PATCH 066/199] [New] TypeScript config: add .cts and .mts extensions
---
CHANGELOG.md | 7 ++++++-
config/typescript.js | 11 +++++++----
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4d5b23d828..cd7a4380a6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Added
+- TypeScript config: add .cts and .mts extensions ([#2851], thanks [@Zamiell])
+
## [2.28.1] - 2023-08-18
### Fixed
@@ -1088,6 +1091,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
+[#2851]: https://github.com/import-js/eslint-plugin-import/pull/2851
[#2850]: https://github.com/import-js/eslint-plugin-import/pull/2850
[#2842]: https://github.com/import-js/eslint-plugin-import/pull/2842
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
@@ -1896,4 +1900,5 @@ for info on changes for earlier releases.
[@xpl]: https://github.com/xpl
[@yndajas]: https://github.com/yndajas
[@yordis]: https://github.com/yordis
-[@zloirock]: https://github.com/zloirock
+[@Zamiell]: https://github.com/Zamiell
+[@zloirock]: https://github.com/zloirock
\ No newline at end of file
diff --git a/config/typescript.js b/config/typescript.js
index 9fd789dbf7..ff7d0795c8 100644
--- a/config/typescript.js
+++ b/config/typescript.js
@@ -1,19 +1,22 @@
/**
- * Adds `.jsx`, `.ts` and `.tsx` as an extension, and enables JSX/TSX parsing.
+ * This config:
+ * 1) adds `.jsx`, `.ts`, `.cts`, `.mts`, and `.tsx` as an extension
+ * 2) enables JSX/TSX parsing
*/
// Omit `.d.ts` because 1) TypeScript compilation already confirms that
// types are resolved, and 2) it would mask an unresolved
// `.ts`/`.tsx`/`.js`/`.jsx` implementation.
-const allExtensions = ['.ts', '.tsx', '.js', '.jsx'];
+const typeScriptExtensions = ['.ts', '.cts', '.mts', '.tsx'];
-module.exports = {
+const allExtensions = [...typeScriptExtensions, '.js', '.jsx'];
+module.exports = {
settings: {
'import/extensions': allExtensions,
'import/external-module-folders': ['node_modules', 'node_modules/@types'],
'import/parsers': {
- '@typescript-eslint/parser': ['.ts', '.tsx'],
+ '@typescript-eslint/parser': typeScriptExtensions,
},
'import/resolver': {
node: {
From 04e68a2179c17b6b73b0c589ca8c092cdb1cb1e5 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 18 Aug 2023 16:24:35 -0700
Subject: [PATCH 067/199] [resolvers/webpack] [fix] use the `dirname` of the
`configPath` as `basedir`
Fixes #2859
---
resolvers/webpack/CHANGELOG.md | 2 ++
resolvers/webpack/index.js | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 457cd36ed4..bd567c4cb5 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
+ - [fix] use the `dirname` of the `configPath` as `basedir` ([#2859])
## 0.13.6 - 2023-08-16
- [refactor] revert back to `lodash/isEqual`
@@ -197,6 +198,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
[#181]: https://github.com/import-js/eslint-plugin-import/pull/181
[#164]: https://github.com/import-js/eslint-plugin-import/pull/164
+[#2859]: https://github.com/import-js/eslint-plugin-import/issues/2859
[#2268]: https://github.com/import-js/eslint-plugin-import/issues/2268
[#1219]: https://github.com/import-js/eslint-plugin-import/issues/1219
[#788]: https://github.com/import-js/eslint-plugin-import/issues/788
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 1eea7d7ab5..ebd77af1ed 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -183,7 +183,7 @@ function createResolveSync(configPath, webpackConfig, cwd) {
if (typeof configPath === 'string') {
// This can be changed via the settings passed in when defining the resolver
- basedir = cwd || configPath;
+ basedir = cwd || path.dirname(configPath);
log(`Attempting to load webpack path from ${basedir}`);
}
From 6b95a021938139726b3f862beb37012d6e2afab2 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 19 Aug 2023 10:37:28 -0700
Subject: [PATCH 068/199] [resolvers/webpack] v0.13.7
---
resolvers/webpack/CHANGELOG.md | 2 ++
resolvers/webpack/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index bd567c4cb5..99746c7706 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,6 +4,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
+
+## 0.13.7 - 2023-08-19
- [fix] use the `dirname` of the `configPath` as `basedir` ([#2859])
## 0.13.6 - 2023-08-16
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index c3363611b0..28a6184f7c 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.6",
+ "version": "0.13.7",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 87051212306f8cd08cb62555b94fae259146468c Mon Sep 17 00:00:00 2001
From: Anix <anik220798@gmail.com>
Date: Tue, 27 Oct 2020 14:20:05 +0000
Subject: [PATCH 069/199] [New] `newline-after-import`: new option `exactCount`
and docs update
Fixes #1901. Fixes #514.
Co-authored-by: Anix <anik220798@gmail.com>
Co-authored-by: reosarevok <reosarevok@metabrainz.org>
---
CHANGELOG.md | 3 +-
docs/rules/newline-after-import.md | 91 +++++++++++++++-----
src/rules/newline-after-import.js | 17 +++-
tests/src/rules/newline-after-import.js | 108 ++++++++++++++++++++++++
4 files changed, 193 insertions(+), 26 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cd7a4380a6..567ed26459 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- TypeScript config: add .cts and .mts extensions ([#2851], thanks [@Zamiell])
+- [`newline-after-import`]: new option `exactCount` and docs update ([#1933], thanks [@anikethsaha] and [@reosarevok])
## [2.28.1] - 2023-08-18
@@ -1901,4 +1902,4 @@ for info on changes for earlier releases.
[@yndajas]: https://github.com/yndajas
[@yordis]: https://github.com/yordis
[@Zamiell]: https://github.com/Zamiell
-[@zloirock]: https://github.com/zloirock
\ No newline at end of file
+[@zloirock]: https://github.com/zloirock
diff --git a/docs/rules/newline-after-import.md b/docs/rules/newline-after-import.md
index fec6b23aca..ef5aeed767 100644
--- a/docs/rules/newline-after-import.md
+++ b/docs/rules/newline-after-import.md
@@ -12,70 +12,119 @@ This rule supports the following options:
- `count` which sets the number of newlines that are enforced after the last top-level import statement or require call. This option defaults to `1`.
+ - `exactCount` which enforce the exact numbers of newlines that is mentioned in `count`. This option defaults to `false`.
+
- `considerComments` which enforces the rule on comments after the last import-statement as well when set to true. This option defaults to `false`.
Valid:
```js
-import defaultExport from './foo'
+import defaultExport from './foo';
-const FOO = 'BAR'
+const FOO = 'BAR';
```
```js
-import defaultExport from './foo'
-import { bar } from 'bar-lib'
+import defaultExport from './foo';
+import { bar } from 'bar-lib';
-const FOO = 'BAR'
+const FOO = 'BAR';
```
```js
-const FOO = require('./foo')
-const BAR = require('./bar')
+const FOO = require('./foo');
+const BAR = require('./bar');
-const BAZ = 1
+const BAZ = 1;
```
Invalid:
```js
import * as foo from 'foo'
-const FOO = 'BAR'
+const FOO = 'BAR';
```
```js
-import * as foo from 'foo'
-const FOO = 'BAR'
+import * as foo from 'foo';
+const FOO = 'BAR';
-import { bar } from 'bar-lib'
+import { bar } from 'bar-lib';
```
```js
-const FOO = require('./foo')
-const BAZ = 1
-const BAR = require('./bar')
+const FOO = require('./foo');
+const BAZ = 1;
+const BAR = require('./bar');
```
With `count` set to `2` this will be considered valid:
```js
-import defaultExport from './foo'
+import defaultExport from './foo';
-const FOO = 'BAR'
+const FOO = 'BAR';
+```
+
+```js
+import defaultExport from './foo';
+
+
+
+const FOO = 'BAR';
```
With `count` set to `2` these will be considered invalid:
```js
-import defaultExport from './foo'
-const FOO = 'BAR'
+import defaultExport from './foo';
+const FOO = 'BAR';
```
```js
-import defaultExport from './foo'
+import defaultExport from './foo';
-const FOO = 'BAR'
+const FOO = 'BAR';
+```
+
+With `count` set to `2` and `exactCount` set to `true` this will be considered valid:
+
+```js
+import defaultExport from './foo';
+
+
+const FOO = 'BAR';
+```
+
+With `count` set to `2` and `exactCount` set to `true` these will be considered invalid:
+
+```js
+import defaultExport from './foo';
+const FOO = 'BAR';
+```
+
+```js
+import defaultExport from './foo';
+
+const FOO = 'BAR';
+```
+
+```js
+import defaultExport from './foo';
+
+
+
+const FOO = 'BAR';
+```
+
+```js
+import defaultExport from './foo';
+
+
+
+
+const FOO = 'BAR';
```
With `considerComments` set to `false` this will be considered valid:
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index 8855e26e52..9b469110be 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -69,6 +69,7 @@ module.exports = {
type: 'integer',
minimum: 1,
},
+ exactCount: { type: 'boolean' },
considerComments: { type: 'boolean' },
},
additionalProperties: false,
@@ -78,7 +79,12 @@ module.exports = {
create(context) {
let level = 0;
const requireCalls = [];
- const options = { count: 1, considerComments: false, ...context.options[0] };
+ const options = {
+ count: 1,
+ exactCount: false,
+ considerComments: false,
+ ...context.options[0],
+ };
function checkForNewLine(node, nextNode, type) {
if (isExportDefaultClass(nextNode) || isExportNameClass(nextNode)) {
@@ -94,7 +100,10 @@ module.exports = {
const lineDifference = getLineDifference(node, nextNode);
const EXPECTED_LINE_DIFFERENCE = options.count + 1;
- if (lineDifference < EXPECTED_LINE_DIFFERENCE) {
+ if (
+ lineDifference < EXPECTED_LINE_DIFFERENCE
+ || options.exactCount && lineDifference !== EXPECTED_LINE_DIFFERENCE
+ ) {
let column = node.loc.start.column;
if (node.loc.start.line !== node.loc.end.line) {
@@ -107,7 +116,7 @@ module.exports = {
column,
},
message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after ${type} statement not followed by another ${type}.`,
- fix: (fixer) => fixer.insertTextAfter(
+ fix: options.exactCount && EXPECTED_LINE_DIFFERENCE < lineDifference ? undefined : (fixer) => fixer.insertTextAfter(
node,
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference),
),
@@ -132,7 +141,7 @@ module.exports = {
column,
},
message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after import statement not followed by another import.`,
- fix: (fixer) => fixer.insertTextAfter(
+ fix: options.exactCount && EXPECTED_LINE_DIFFERENCE < lineDifference ? undefined : (fixer) => fixer.insertTextAfter(
node,
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference),
),
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index 8f3338eee8..bd11da4191 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -46,6 +46,16 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 6 },
options: [{ considerComments: true }],
},
+ {
+ code: `
+ const x = () => require('baz') && require('bar')
+
+ // Some random single line comment
+ var bar = 42;
+ `,
+ parserOptions: { ecmaVersion: 6 },
+ options: [{ considerComments: true, count: 1, exactCount: true }],
+ },
{
code: `
const x = () => require('baz') && require('bar')
@@ -122,6 +132,21 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ count: 2 }],
},
+ {
+ code: `import foo from 'foo';\n\n\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 2, exactCount: true }],
+ },
+ {
+ code: `import foo from 'foo';\n\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 1, exactCount: true }],
+ },
+ {
+ code: `import foo from 'foo';\n\n\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 1 }],
+ },
{
code: `import foo from 'foo';\n\n\n\n\nvar bar = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
@@ -141,6 +166,11 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ count: 4 }],
},
+ {
+ code: `var foo = require('foo-module');\n\n\n\n\nvar foo = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 4, exactCount: true }],
+ },
{
code: `require('foo-module');\n\nvar foo = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
@@ -620,5 +650,83 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { sourceType: 'module' },
parser: parsers.BABEL_OLD,
})) || [],
+ {
+ code: `import foo from 'foo';\n\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n\n\n\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\n\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n\n\n\n\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\n\n\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `
+ import foo from 'foo';
+
+
+ // Some random single line comment
+ var bar = 42;
+ `,
+ output: `
+ import foo from 'foo';
+
+
+ // Some random single line comment
+ var bar = 42;
+ `,
+ errors: [{
+ line: 2,
+ column: 9,
+ message: IMPORT_ERROR_MESSAGE,
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ considerComments: true, count: 1, exactCount: true }],
+ },
+ {
+ code: `import foo from 'foo';export default function() {};`,
+ output: `import foo from 'foo';\n\nexport default function() {};`,
+ options: [{ count: 1, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE,
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `const foo = require('foo');\n\n\n\nconst bar = function() {};`,
+ output: `const foo = require('foo');\n\n\n\nconst bar = function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: 'Expected 2 empty lines after require statement not followed by another require.',
+ }],
+ parserOptions: { ecmaVersion: 2015 },
+ },
),
});
From 66cb10f302a23c0b72c4a3ead26374a6729a9017 Mon Sep 17 00:00:00 2001
From: Kinland <16787581+kinland@users.noreply.github.com>
Date: Mon, 25 Sep 2023 19:16:00 -0700
Subject: [PATCH 070/199] [Fix] `newline-after-import`: fix `exactCount` with
`considerComments` false positive, when there is a leading comment
Fixes #2882.
---
CHANGELOG.md | 5 +-
src/rules/newline-after-import.js | 2 +-
tests/src/rules/newline-after-import.js | 133 ++++++++++++++++++++++++
3 files changed, 138 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 567ed26459..6af7f748a4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- TypeScript config: add .cts and .mts extensions ([#2851], thanks [@Zamiell])
- [`newline-after-import`]: new option `exactCount` and docs update ([#1933], thanks [@anikethsaha] and [@reosarevok])
+- [`newline-after-import`]: fix `exactCount` with `considerComments` false positive, when there is a leading comment ([#2884], thanks [@kinland])
## [2.28.1] - 2023-08-18
@@ -1091,6 +1092,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
[#2851]: https://github.com/import-js/eslint-plugin-import/pull/2851
[#2850]: https://github.com/import-js/eslint-plugin-import/pull/2850
@@ -1769,6 +1771,7 @@ for info on changes for earlier releases.
[@kentcdodds]: https://github.com/kentcdodds
[@kevin940726]: https://github.com/kevin940726
[@kgregory]: https://github.com/kgregory
+[@kinland]: https://github.com/kinland
[@kirill-konshin]: https://github.com/kirill-konshin
[@kiwka]: https://github.com/kiwka
[@klimashkin]: https://github.com/klimashkin
@@ -1776,8 +1779,8 @@ for info on changes for earlier releases.
[@knpwrs]: https://github.com/knpwrs
[@KostyaZgara]: https://github.com/KostyaZgara
[@kylemh]: https://github.com/kylemh
-[@laysent]: https://github.com/laysent
[@laurens-dg]: https://github.com/laurens-dg
+[@laysent]: https://github.com/laysent
[@le0nik]: https://github.com/le0nik
[@leipert]: https://github.com/leipert
[@lemonmade]: https://github.com/lemonmade
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index 9b469110be..a33bb615b9 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -169,7 +169,7 @@ module.exports = {
let nextComment;
if (typeof parent.comments !== 'undefined' && options.considerComments) {
- nextComment = parent.comments.find((o) => o.loc.start.line === endLine + 1);
+ nextComment = parent.comments.find((o) => o.loc.start.line >= endLine && o.loc.start.line <= endLine + options.count + 1);
}
// skip "export import"s
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index bd11da4191..6a8fb83e40 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -142,6 +142,31 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ count: 1, exactCount: true }],
},
+ {
+ code: `import foo from 'foo';\n\n// Some random comment\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 2, exactCount: true }],
+ },
+ {
+ code: `import foo from 'foo';\n// Some random comment\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 1, exactCount: true }],
+ },
+ {
+ code: `import foo from 'foo';\n\n\n// Some random comment\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ },
+ {
+ code: `import foo from 'foo';\n\n// Some random comment\nvar bar = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 1, exactCount: true, considerComments: true }],
+ },
+ {
+ code: `/**\n * A leading comment\n */\nimport foo from 'foo';\n\n// Some random comment\nexport {foo};`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 2, exactCount: true }],
+ },
{
code: `import foo from 'foo';\n\n\nvar bar = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
@@ -171,6 +196,16 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ count: 4, exactCount: true }],
},
+ {
+ code: `var foo = require('foo-module');\n\n// Some random comment\n\n\nvar foo = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 4, exactCount: true }],
+ },
+ {
+ code: `var foo = require('foo-module');\n\n\n\n// Some random comment\nvar foo = 'bar';`,
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ count: 4, exactCount: true, considerComments: true }],
+ },
{
code: `require('foo-module');\n\nvar foo = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
@@ -683,6 +718,72 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
+ {
+ code: `import foo from 'foo';\n// some random comment\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n// some random comment\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n// some random comment\n\n\nexport default function() {};`,
+ output: `import foo from 'foo';\n// some random comment\n\n\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n// some random comment\n\n\n\nexport default function() {};`,
+ output: `import foo from 'foo';\n// some random comment\n\n\n\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n// some random comment\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\n// some random comment\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n\n// some random comment\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\n// some random comment\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
+ {
+ code: `import foo from 'foo';\n\n\n\n// some random comment\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n\n\n// some random comment\nexport default function() {};`,
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ },
{
code: `
import foo from 'foo';
@@ -728,5 +829,37 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015 },
},
+ {
+ code: `const foo = require('foo');\n\n\n\n// some random comment\nconst bar = function() {};`,
+ output: `const foo = require('foo');\n\n\n\n// some random comment\nconst bar = function() {};`,
+ options: [{ count: 2, exactCount: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: 'Expected 2 empty lines after require statement not followed by another require.',
+ }],
+ parserOptions: { ecmaVersion: 2015 },
+ },
+ {
+ code: `import foo from 'foo';// some random comment\nexport default function() {};`,
+ output: `import foo from 'foo';\n\n// some random comment\nexport default function() {};`,
+ options: [{ count: 1, exactCount: true, considerComments: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: IMPORT_ERROR_MESSAGE,
+ }],
+ parserOptions: { ecmaVersion: 2015, considerComments: true, sourceType: 'module' },
+ },
+ {
+ code: `const foo = require('foo');\n\n\n// some random comment\nconst bar = function() {};`,
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ errors: [{
+ line: 1,
+ column: 1,
+ message: 'Expected 2 empty lines after require statement not followed by another require.',
+ }],
+ parserOptions: { ecmaVersion: 2015 },
+ },
),
});
From 2c281d15d06dc54c90cfa5c28b276b189ecd8f3f Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 22:25:32 -0700
Subject: [PATCH 071/199] [resolvers/webpack] [refactor] use `hasown` instead
of `has`
---
resolvers/webpack/index.js | 4 ++--
resolvers/webpack/package.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index ebd77af1ed..3ca2874dd8 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -9,7 +9,7 @@ const fs = require('fs');
const isCore = require('is-core-module');
const resolve = require('resolve/sync');
const semver = require('semver');
-const has = require('has');
+const hasOwn = require('hasown');
const isRegex = require('is-regex');
const log = require('debug')('eslint-plugin-import:resolver:webpack');
@@ -382,7 +382,7 @@ function findExternal(source, externals, context, resolveSync) {
// else, vanilla object
for (const key in externals) {
- if (!has(externals, key)) { continue; }
+ if (!hasOwn(externals, key)) { continue; }
if (source === key) { return true; }
}
return false;
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 28a6184f7c..0810ca70dd 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -34,7 +34,7 @@
"debug": "^3.2.7",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
- "has": "^1.0.3",
+ "hasown": "^2.0.0",
"interpret": "^1.4.0",
"is-core-module": "^2.13.0",
"is-regex": "^1.1.4",
From 30d61b6dc45e712899a4b9184964a948251adfcf Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 22:26:45 -0700
Subject: [PATCH 072/199] [resolvers/webpack] [deps] update
`array.prototype.find`, `is-core-module`, `resolve`
---
resolvers/webpack/package.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 0810ca70dd..b348b6e2bb 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -30,16 +30,16 @@
},
"homepage": "https://github.com/import-js/eslint-plugin-import/tree/HEAD/resolvers/webpack",
"dependencies": {
- "array.prototype.find": "^2.2.1",
+ "array.prototype.find": "^2.2.2",
"debug": "^3.2.7",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
"hasown": "^2.0.0",
"interpret": "^1.4.0",
- "is-core-module": "^2.13.0",
+ "is-core-module": "^2.13.1",
"is-regex": "^1.1.4",
"lodash": "^4.17.21",
- "resolve": "^2.0.0-next.4",
+ "resolve": "^2.0.0-next.5",
"semver": "^5.7.2"
},
"peerDependencies": {
From 6d2540f2eefc063d07a841088836e1dcee652cd9 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 22:28:03 -0700
Subject: [PATCH 073/199] [resolvers/webpack] v0.13.8
---
resolvers/webpack/CHANGELOG.md | 5 +++++
resolvers/webpack/package.json | 2 +-
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 99746c7706..4fed046b46 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,6 +5,11 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## 0.13.8 - 2023-10-22
+ - [refactor] use `hasown` instead of `has`
+ - [deps] update `array.prototype.find`, `is-core-module`, `resolve`
+
+
## 0.13.7 - 2023-08-19
- [fix] use the `dirname` of the `configPath` as `basedir` ([#2859])
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index b348b6e2bb..3fa47d9362 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.7",
+ "version": "0.13.8",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 78f50b852a0dc187ccbfd6b4592e4f59ba78d339 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 23:08:13 -0700
Subject: [PATCH 074/199] [Deps] update `array-includes`,
`array.prototype.findlastindex`, `array.prototype.flat`,
`array.prototype.flatmap`, `eslint-import-resolver-node`, `is-core-module`,
`object.fromentries`, `object.groupby`, `object.values`
---
package.json | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/package.json b/package.json
index 6128a4e76b..2fdc9c4c2f 100644
--- a/package.json
+++ b/package.json
@@ -103,21 +103,21 @@
"eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8"
},
"dependencies": {
- "array-includes": "^3.1.6",
- "array.prototype.findlastindex": "^1.2.2",
- "array.prototype.flat": "^1.3.1",
- "array.prototype.flatmap": "^1.3.1",
+ "array-includes": "^3.1.7",
+ "array.prototype.findlastindex": "^1.2.3",
+ "array.prototype.flat": "^1.3.2",
+ "array.prototype.flatmap": "^1.3.2",
"debug": "^3.2.7",
"doctrine": "^2.1.0",
- "eslint-import-resolver-node": "^0.3.7",
+ "eslint-import-resolver-node": "^0.3.9",
"eslint-module-utils": "^2.8.0",
"has": "^1.0.3",
- "is-core-module": "^2.13.0",
+ "is-core-module": "^2.13.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
- "object.fromentries": "^2.0.6",
- "object.groupby": "^1.0.0",
- "object.values": "^1.1.6",
+ "object.fromentries": "^2.0.7",
+ "object.groupby": "^1.0.1",
+ "object.values": "^1.1.7",
"semver": "^6.3.1",
"tsconfig-paths": "^3.14.2"
}
From ec6a8ea3c386241daaf208fe78da151b30415357 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 23:08:57 -0700
Subject: [PATCH 075/199] [Refactor] use `hasown` instead of `has`
---
package.json | 2 +-
src/rules/no-anonymous-default-export.js | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/package.json b/package.json
index 2fdc9c4c2f..1d9acd4f2b 100644
--- a/package.json
+++ b/package.json
@@ -111,7 +111,7 @@
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
"eslint-module-utils": "^2.8.0",
- "has": "^1.0.3",
+ "hasown": "^2.0.0",
"is-core-module": "^2.13.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
diff --git a/src/rules/no-anonymous-default-export.js b/src/rules/no-anonymous-default-export.js
index 59a3cbfdac..4f6947e814 100644
--- a/src/rules/no-anonymous-default-export.js
+++ b/src/rules/no-anonymous-default-export.js
@@ -3,7 +3,7 @@
* @author Duncan Beevers
*/
-import has from 'has';
+import hasOwn from 'hasown';
import values from 'object.values';
import fromEntries from 'object.fromentries';
@@ -65,7 +65,7 @@ const schemaProperties = fromEntries(values(defs).map((def) => [def.option, {
type: 'boolean',
}]));
-const defaults = fromEntries(values(defs).map((def) => [def.option, has(def, 'default') ? def.default : false]));
+const defaults = fromEntries(values(defs).map((def) => [def.option, hasOwn(def, 'default') ? def.default : false]));
module.exports = {
meta: {
From 6d34c88a91a9cb7556700b7cb83c8a27731ff302 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 22 Oct 2023 23:12:22 -0700
Subject: [PATCH 076/199] Bump to 2.29.0
---
CHANGELOG.md | 5 ++++-
package.json | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6af7f748a4..bc3fc1918d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.29.0] - 2023-10-22
+
### Added
- TypeScript config: add .cts and .mts extensions ([#2851], thanks [@Zamiell])
- [`newline-after-import`]: new option `exactCount` and docs update ([#1933], thanks [@anikethsaha] and [@reosarevok])
@@ -1554,7 +1556,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.0...HEAD
+[2.29.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...v2.29.0
[2.28.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...v2.28.1
[2.28.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.5...v2.28.0
[2.27.5]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.4...v2.27.5
diff --git a/package.json b/package.json
index 1d9acd4f2b..bd92f4f692 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.28.1",
+ "version": "2.29.0",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 12f0300100b9bb90c6a952d07c133f2d5842ad57 Mon Sep 17 00:00:00 2001
From: Noureldin Shaker <43860275+Pandemic1617@users.noreply.github.com>
Date: Tue, 7 Nov 2023 15:37:39 +0000
Subject: [PATCH 077/199] [Fix] `no-extraneous-dependencies`: ignore `export
type { ... } from '...'` when `includeTypes` is false
---
CHANGELOG.md | 5 +++++
src/rules/no-extraneous-dependencies.js | 1 +
tests/src/rules/no-extraneous-dependencies.js | 12 ++++++++++++
3 files changed, 18 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bc3fc1918d..f902dec7f0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Fixed
+- [`no-extraneous-dependencies`]: ignore `export type { ... } from '...'` when `includeTypes` is `false` ([#2919], thanks [@Pandemic1617])
+
## [2.29.0] - 2023-10-22
### Added
@@ -1094,6 +1097,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
[#2851]: https://github.com/import-js/eslint-plugin-import/pull/2851
@@ -1830,6 +1834,7 @@ for info on changes for earlier releases.
[@ntdb]: https://github.com/ntdb
[@nwalters512]: https://github.com/nwalters512
[@ombene]: https://github.com/ombene
+[@Pandemic1617]: https://github.com/Pandemic1617
[@ota-meshi]: https://github.com/ota-meshi
[@OutdatedVersion]: https://github.com/OutdatedVersion
[@panrafal]: https://github.com/panrafal
diff --git a/src/rules/no-extraneous-dependencies.js b/src/rules/no-extraneous-dependencies.js
index 0408e0866d..df97987901 100644
--- a/src/rules/no-extraneous-dependencies.js
+++ b/src/rules/no-extraneous-dependencies.js
@@ -177,6 +177,7 @@ function reportIfMissing(context, deps, depsOptions, node, name) {
&& (
node.importKind === 'type'
|| node.importKind === 'typeof'
+ || node.exportKind === 'type'
|| Array.isArray(node.specifiers) && node.specifiers.length && node.specifiers.every((specifier) => specifier.importKind === 'type' || specifier.importKind === 'typeof')
)
) {
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index 21561615c6..cb0398ada2 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -427,6 +427,18 @@ describe('TypeScript', () => {
options: [{ packageDir: packageDirWithTypescriptDevDependencies, devDependencies: false }],
...parserConfig,
}),
+
+ test({
+ code: 'import type { T } from "a"; export type { T };',
+ options: [{ packageDir: packageDirWithTypescriptDevDependencies, devDependencies: false }],
+ ...parserConfig,
+ }),
+
+ test({
+ code: 'export type { T } from "a";',
+ options: [{ packageDir: packageDirWithTypescriptDevDependencies, devDependencies: false }],
+ ...parserConfig,
+ }),
],
invalid: [
test({
From 9fd3c42707d71987e439a847f2e213f55c84f734 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 24 Nov 2023 21:29:58 -0800
Subject: [PATCH 078/199] [Tests] `no-duplicates`: add passing test
Closes #2840
---
tests/src/rules/no-duplicates.js | 62 ++++++++++++++++++++++++++++++++
1 file changed, 62 insertions(+)
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index d61fda86e1..f83221105a 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -482,6 +482,68 @@ import {x,y} from './foo'
errors: ["'../constants' imported multiple times.", "'../constants' imported multiple times."],
...jsxConfig,
}),
+
+ test({
+ code: `
+ import {A1,} from 'foo';
+ import {B1,} from 'foo';
+ import {C1,} from 'foo';
+
+ import {
+ A2,
+ } from 'bar';
+ import {
+ B2,
+ } from 'bar';
+ import {
+ C2,
+ } from 'bar';
+
+ `,
+ output: `
+ import {A1,B1,C1} from 'foo';
+ ${''}
+ import {
+ A2,
+ ${''}
+ B2,
+ C2} from 'bar';
+ ${''}
+ `,
+ errors: [
+ {
+ message: "'foo' imported multiple times.",
+ line: 2,
+ column: 27,
+ },
+ {
+ message: "'foo' imported multiple times.",
+ line: 3,
+ column: 27,
+ },
+ {
+ message: "'foo' imported multiple times.",
+ line: 4,
+ column: 27,
+ },
+ {
+ message: "'bar' imported multiple times.",
+ line: 8,
+ column: 16,
+ },
+ {
+ message: "'bar' imported multiple times.",
+ line: 11,
+ column: 16,
+ },
+ {
+ message: "'bar' imported multiple times.",
+ line: 14,
+ column: 16,
+ },
+ ],
+ ...jsxConfig,
+ }),
],
});
From e67259e4c167d46e9cc5472d3afa32369fbf2eff Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 3 Dec 2023 22:32:42 -0800
Subject: [PATCH 079/199] [Fix] `no-unused-modules`: support export patterns
with array destructuring
Fixes #2930
---
CHANGELOG.md | 3 +++
src/rules/no-unused-modules.js | 5 +++++
tests/src/rules/no-unused-modules.js | 9 +++++++++
3 files changed, 17 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f902dec7f0..a56216a7a6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-extraneous-dependencies`]: ignore `export type { ... } from '...'` when `includeTypes` is `false` ([#2919], thanks [@Pandemic1617])
+- [`no-unused-modules`]: support export patterns with array destructuring ([#2930], thanks [@ljharb])
## [2.29.0] - 2023-10-22
@@ -1435,6 +1436,8 @@ for info on changes for earlier releases.
[#211]: https://github.com/import-js/eslint-plugin-import/pull/211
[#164]: https://github.com/import-js/eslint-plugin-import/pull/164
[#157]: https://github.com/import-js/eslint-plugin-import/pull/157
+
+[#2930]: https://github.com/import-js/eslint-plugin-import/issues/2930
[#2687]: https://github.com/import-js/eslint-plugin-import/issues/2687
[#2684]: https://github.com/import-js/eslint-plugin-import/issues/2684
[#2674]: https://github.com/import-js/eslint-plugin-import/issues/2674
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index ecba3a19ce..8229d880ce 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -74,6 +74,7 @@ const FUNCTION_DECLARATION = 'FunctionDeclaration';
const CLASS_DECLARATION = 'ClassDeclaration';
const IDENTIFIER = 'Identifier';
const OBJECT_PATTERN = 'ObjectPattern';
+const ARRAY_PATTERN = 'ArrayPattern';
const TS_INTERFACE_DECLARATION = 'TSInterfaceDeclaration';
const TS_TYPE_ALIAS_DECLARATION = 'TSTypeAliasDeclaration';
const TS_ENUM_DECLARATION = 'TSEnumDeclaration';
@@ -97,6 +98,10 @@ function forEachDeclarationIdentifier(declaration, cb) {
cb(pattern.name);
}
});
+ } else if (id.type === ARRAY_PATTERN) {
+ id.elements.forEach(({ name }) => {
+ cb(name);
+ });
} else {
cb(id.name);
}
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 77fb608ccb..9aa5ce53d7 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -160,6 +160,15 @@ ruleTester.run('no-unused-modules', rule, {
filename: testFilePath('./no-unused-modules/file-o.js'),
parser: parsers.BABEL_OLD,
}),
+ test({
+ options: unusedExportsOptions,
+ code: `
+ export const [o0, o2] = createLoadingAndErrorSelectors(
+ AUTH_USER
+ );
+ `,
+ filename: testFilePath('./no-unused-modules/file-o.js'),
+ }),
],
invalid: [
test({
From 8c83eafe4a709c0c275279a7bf99d92fa4e034a5 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 4 Dec 2023 08:28:05 -0800
Subject: [PATCH 080/199] [Tests] node v21.3 has a broken `fs.writeFile`
See https://github.com/nodejs/node/pull/50990 / https://github.com/nodejs/node/issues/50989
---
tests/src/rules/no-unused-modules.js | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 9aa5ce53d7..b09d5d759c 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -732,7 +732,7 @@ describe('renameDefault', () => {
describe('test behavior for new file', () => {
before(() => {
- fs.writeFileSync(testFilePath('./no-unused-modules/file-added-0.js'), '', { encoding: 'utf8' });
+ fs.writeFileSync(testFilePath('./no-unused-modules/file-added-0.js'), '', { encoding: 'utf8', flag: 'w' });
});
// add import in newly created file
@@ -840,7 +840,7 @@ describe('test behavior for new file', () => {
describe('test behavior for new file', () => {
before(() => {
- fs.writeFileSync(testFilePath('./no-unused-modules/file-added-1.js'), '', { encoding: 'utf8' });
+ fs.writeFileSync(testFilePath('./no-unused-modules/file-added-1.js'), '', { encoding: 'utf8', flag: 'w' });
});
ruleTester.run('no-unused-modules', rule, {
valid: [
@@ -875,7 +875,7 @@ describe('test behavior for new file', () => {
describe('test behavior for new file', () => {
before(() => {
- fs.writeFileSync(testFilePath('./no-unused-modules/file-added-2.js'), '', { encoding: 'utf8' });
+ fs.writeFileSync(testFilePath('./no-unused-modules/file-added-2.js'), '', { encoding: 'utf8', flag: 'w' });
});
ruleTester.run('no-unused-modules', rule, {
valid: [
@@ -901,7 +901,7 @@ describe('test behavior for new file', () => {
describe('test behavior for new file', () => {
before(() => {
- fs.writeFileSync(testFilePath('./no-unused-modules/file-added-3.js'), '', { encoding: 'utf8' });
+ fs.writeFileSync(testFilePath('./no-unused-modules/file-added-3.js'), '', { encoding: 'utf8', flag: 'w' });
});
ruleTester.run('no-unused-modules', rule, {
valid: [
@@ -952,7 +952,7 @@ describe('test behavior for destructured exports', () => {
describe('test behavior for new file', () => {
before(() => {
- fs.writeFileSync(testFilePath('./no-unused-modules/file-added-4.js.js'), '', { encoding: 'utf8' });
+ fs.writeFileSync(testFilePath('./no-unused-modules/file-added-4.js.js'), '', { encoding: 'utf8', flag: 'w' });
});
ruleTester.run('no-unused-modules', rule, {
valid: [
From 80aee736721397cd073636950fef30aa65e165d3 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 14 Dec 2023 10:36:00 -0800
Subject: [PATCH 081/199] [Dev Deps] update `chai`, `eslint-doc-generator`,
`markdownlint-cli`
---
package.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/package.json b/package.json
index bd92f4f692..b899f56919 100644
--- a/package.json
+++ b/package.json
@@ -69,11 +69,11 @@
"babel-preset-flow": "^6.23.0",
"babel-register": "^6.26.0",
"babylon": "^6.18.0",
- "chai": "^4.3.7",
+ "chai": "^4.3.10",
"cross-env": "^4.0.0",
"escope": "^3.6.0",
"eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8",
- "eslint-doc-generator": "^1.4.3",
+ "eslint-doc-generator": "^1.6.1",
"eslint-import-resolver-node": "file:./resolvers/node",
"eslint-import-resolver-typescript": "^1.0.2 || ^1.1.1",
"eslint-import-resolver-webpack": "file:./resolvers/webpack",
@@ -88,7 +88,7 @@
"jackspeak": "=2.1.1",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
- "markdownlint-cli": "^0.35.0",
+ "markdownlint-cli": "^0.38.0",
"mocha": "^3.5.3",
"npm-which": "^3.0.1",
"nyc": "^11.9.0",
From 48fec35fbe9d20f5c859a02d0e4acef70759c875 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 14 Dec 2023 10:37:05 -0800
Subject: [PATCH 082/199] [Deps] update `tsconfig-paths`
Thanks to https://github.com/dividab/tsconfig-paths/pull/260!
Closes #2447. Fixes #2652. Fixes #2890. Fixes #2751.
May help with #2617, #2765.
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index b899f56919..b84f57e8e4 100644
--- a/package.json
+++ b/package.json
@@ -119,6 +119,6 @@
"object.groupby": "^1.0.1",
"object.values": "^1.1.7",
"semver": "^6.3.1",
- "tsconfig-paths": "^3.14.2"
+ "tsconfig-paths": "^3.15.0"
}
}
From ee5fadeffff68f2300bed7f67a310496cb969d61 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 14 Dec 2023 10:54:28 -0800
Subject: [PATCH 083/199] Bump to 2.29.1
---
CHANGELOG.md | 8 +++++++-
package.json | 2 +-
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a56216a7a6..b81ad61a61 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,9 +6,12 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.29.1] - 2023-12-14
+
### Fixed
- [`no-extraneous-dependencies`]: ignore `export type { ... } from '...'` when `includeTypes` is `false` ([#2919], thanks [@Pandemic1617])
- [`no-unused-modules`]: support export patterns with array destructuring ([#2930], thanks [@ljharb])
+- [Deps] update `tsconfig-paths` ([#2447], thanks [@domdomegg])
## [2.29.0] - 2023-10-22
@@ -1445,6 +1448,7 @@ for info on changes for earlier releases.
[#2666]: https://github.com/import-js/eslint-plugin-import/issues/2666
[#2665]: https://github.com/import-js/eslint-plugin-import/issues/2665
[#2577]: https://github.com/import-js/eslint-plugin-import/issues/2577
+[#2447]: https://github.com/import-js/eslint-plugin-import/issues/2447
[#2444]: https://github.com/import-js/eslint-plugin-import/issues/2444
[#2412]: https://github.com/import-js/eslint-plugin-import/issues/2412
[#2392]: https://github.com/import-js/eslint-plugin-import/issues/2392
@@ -1563,7 +1567,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.0...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.1...HEAD
+[2.29.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.0...v2.29.1
[2.29.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...v2.29.0
[2.28.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...v2.28.1
[2.28.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.27.5...v2.28.0
@@ -1715,6 +1720,7 @@ for info on changes for earlier releases.
[@devinrhode2]: https://github.com/devinrhode2
[@devongovett]: https://github.com/devongovett
[@dmnd]: https://github.com/dmnd
+[@domdomegg]: https://github.com/domdomegg
[@duncanbeevers]: https://github.com/duncanbeevers
[@dwardu]: https://github.com/dwardu
[@echenley]: https://github.com/echenley
diff --git a/package.json b/package.json
index b84f57e8e4..5c0af48543 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.29.0",
+ "version": "2.29.1",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 678cc943898d89270d397fe4ab363c07415d7a5e Mon Sep 17 00:00:00 2001
From: mulztob <49060581+mulztob@users.noreply.github.com>
Date: Mon, 18 Dec 2023 08:43:34 +0100
Subject: [PATCH 084/199] [Docs] `no-extraneous-dependencies`: Make glob
pattern description more explicit
---
CHANGELOG.md | 7 ++++++-
docs/rules/no-extraneous-dependencies.md | 2 +-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b81ad61a61..13a201c90b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Changed
+- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
+
## [2.29.1] - 2023-12-14
### Fixed
@@ -1101,6 +1104,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
@@ -1835,6 +1839,7 @@ for info on changes for earlier releases.
[@mplewis]: https://github.com/mplewis
[@mrmckeb]: https://github.com/mrmckeb
[@msvab]: https://github.com/msvab
+[@mulztob]: https://github.com/mulztob
[@mx-bernhard]: https://github.com/mx-bernhard
[@Nfinished]: https://github.com/Nfinished
[@nickofthyme]: https://github.com/nickofthyme
@@ -1843,9 +1848,9 @@ for info on changes for earlier releases.
[@ntdb]: https://github.com/ntdb
[@nwalters512]: https://github.com/nwalters512
[@ombene]: https://github.com/ombene
-[@Pandemic1617]: https://github.com/Pandemic1617
[@ota-meshi]: https://github.com/ota-meshi
[@OutdatedVersion]: https://github.com/OutdatedVersion
+[@Pandemic1617]: https://github.com/Pandemic1617
[@panrafal]: https://github.com/panrafal
[@paztis]: https://github.com/paztis
[@pcorpet]: https://github.com/pcorpet
diff --git a/docs/rules/no-extraneous-dependencies.md b/docs/rules/no-extraneous-dependencies.md
index 547e5c2e57..848d5bb0da 100644
--- a/docs/rules/no-extraneous-dependencies.md
+++ b/docs/rules/no-extraneous-dependencies.md
@@ -32,7 +32,7 @@ You can also use an array of globs instead of literal booleans:
"import/no-extraneous-dependencies": ["error", {"devDependencies": ["**/*.test.js", "**/*.spec.js"]}]
```
-When using an array of globs, the setting will be set to `true` (no errors reported) if the name of the file being linted matches a single glob in the array, and `false` otherwise.
+When using an array of globs, the setting will be set to `true` (no errors reported) if the name of the file being linted (i.e. not the imported file/module) matches a single glob in the array, and `false` otherwise.
There are 2 boolean options to opt into checking extra imports that are normally ignored: `includeInternal`, which enables the checking of internal modules, and `includeTypes`, which enables checking of type imports in TypeScript.
From 6f0668c937a247d27c90cb391d4255fdfdd46a0f Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 18 Dec 2023 18:22:00 -0800
Subject: [PATCH 085/199] [Dev Deps] pin `markdownlint-cli` to v0.35, because
v0.36+ depends on a `glob` that breaks CI
See https://github.com/isaacs/jackspeak/issues/4
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 5c0af48543..dbe14f24c3 100644
--- a/package.json
+++ b/package.json
@@ -88,7 +88,7 @@
"jackspeak": "=2.1.1",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
- "markdownlint-cli": "^0.38.0",
+ "markdownlint-cli": "~0.35",
"mocha": "^3.5.3",
"npm-which": "^3.0.1",
"nyc": "^11.9.0",
From e9489d8f7378d7bf78a33898b963aead48efe186 Mon Sep 17 00:00:00 2001
From: JW <jiangweixian1994@gmail.com>
Date: Sun, 17 Dec 2023 13:35:24 +0800
Subject: [PATCH 086/199] [New] `dynamic-import-chunkname`: add `allowEmpty`
option to allow empty leading comments
---
docs/rules/dynamic-import-chunkname.md | 35 ++++++++++++++++++++-
src/rules/dynamic-import-chunkname.js | 9 ++++--
tests/src/rules/dynamic-import-chunkname.js | 30 ++++++++++++++++++
3 files changed, 70 insertions(+), 4 deletions(-)
diff --git a/docs/rules/dynamic-import-chunkname.md b/docs/rules/dynamic-import-chunkname.md
index 35ae9df516..dd526c8913 100644
--- a/docs/rules/dynamic-import-chunkname.md
+++ b/docs/rules/dynamic-import-chunkname.md
@@ -15,7 +15,8 @@ You can also configure the regex format you'd like to accept for the webpackChun
{
"dynamic-import-chunkname": [2, {
importFunctions: ["dynamicImport"],
- webpackChunknameFormat: "[a-zA-Z0-57-9-/_]+"
+ webpackChunknameFormat: "[a-zA-Z0-57-9-/_]+",
+ allowEmpty: false
}]
}
```
@@ -87,6 +88,38 @@ The following patterns are valid:
);
```
+### `allowEmpty: true`
+
+If you want to allow dynamic imports without a webpackChunkName, you can set `allowEmpty: true` in the rule config. This will allow dynamic imports without a leading comment, or with a leading comment that does not contain a webpackChunkName.
+
+Given `{ "allowEmpty": true }`:
+
+<!-- markdownlint-disable-next-line MD024 -- duplicate header -->
+### valid
+
+The following patterns are valid:
+
+```javascript
+import('someModule');
+
+import(
+ /* webpackChunkName: "someModule" */
+ 'someModule',
+);
+```
+<!-- markdownlint-disable-next-line MD024 -- duplicate header -->
+### invalid
+
+The following patterns are invalid:
+
+```javascript
+// incorrectly formatted comment
+import(
+ /*webpackChunkName:"someModule"*/
+ 'someModule',
+);
+```
+
## When Not To Use It
If you don't care that webpack will autogenerate chunk names and may blow up browser caches and bundle size reports.
diff --git a/src/rules/dynamic-import-chunkname.js b/src/rules/dynamic-import-chunkname.js
index 96ceff2e16..a62e5c6c12 100644
--- a/src/rules/dynamic-import-chunkname.js
+++ b/src/rules/dynamic-import-chunkname.js
@@ -19,6 +19,9 @@ module.exports = {
type: 'string',
},
},
+ allowEmpty: {
+ type: 'boolean',
+ },
webpackChunknameFormat: {
type: 'string',
},
@@ -28,7 +31,7 @@ module.exports = {
create(context) {
const config = context.options[0];
- const { importFunctions = [] } = config || {};
+ const { importFunctions = [], allowEmpty = false } = config || {};
const { webpackChunknameFormat = '([0-9a-zA-Z-_/.]|\\[(request|index)\\])+' } = config || {};
const paddedCommentRegex = /^ (\S[\s\S]+\S) $/;
@@ -42,7 +45,7 @@ module.exports = {
? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
: sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.
- if (!leadingComments || leadingComments.length === 0) {
+ if ((!leadingComments || leadingComments.length === 0) && !allowEmpty) {
context.report({
node,
message: 'dynamic imports require a leading comment with the webpack chunkname',
@@ -94,7 +97,7 @@ module.exports = {
}
}
- if (!isChunknamePresent) {
+ if (!isChunknamePresent && !allowEmpty) {
context.report({
node,
message:
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index 73617a6f36..c710507b26 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -12,6 +12,10 @@ const pickyCommentOptions = [{
importFunctions: ['dynamicImport'],
webpackChunknameFormat: pickyCommentFormat,
}];
+const allowEmptyOptions = [{
+ importFunctions: ['dynamicImport'],
+ allowEmpty: true,
+}];
const multipleImportFunctionOptions = [{
importFunctions: ['dynamicImport', 'definitelyNotStaticImport'],
}];
@@ -83,6 +87,19 @@ ruleTester.run('dynamic-import-chunkname', rule, {
)`,
options,
},
+ {
+ code: `import('test')`,
+ options: allowEmptyOptions,
+ parser,
+ },
+ {
+ code: `import(
+ /* webpackMode: "lazy" */
+ 'test'
+ )`,
+ options: allowEmptyOptions,
+ parser,
+ },
{
code: `import(
/* webpackChunkName: "someModule" */
@@ -975,6 +992,19 @@ context('TypeScript', () => {
ruleTester.run('dynamic-import-chunkname', rule, {
valid: [
+ {
+ code: `import('test')`,
+ options: allowEmptyOptions,
+ parser: typescriptParser,
+ },
+ {
+ code: `import(
+ /* webpackMode: "lazy" */
+ 'test'
+ )`,
+ options: allowEmptyOptions,
+ parser: typescriptParser,
+ },
{
code: `import(
/* webpackChunkName: "someModule" */
From 7a21f7e10f18c04473faadca94928af6b8e28009 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 29 Dec 2023 09:18:33 -0800
Subject: [PATCH 087/199] [meta] add missing changelog entry from #2942
---
CHANGELOG.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 13a201c90b..3330dd331f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Added
+- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
+
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1105,6 +1108,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
+[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
@@ -1774,6 +1778,7 @@ for info on changes for earlier releases.
[@jeffshaver]: https://github.com/jeffshaver
[@jf248]: https://github.com/jf248
[@jfmengels]: https://github.com/jfmengels
+[@JiangWeixian]: https://github.com/JiangWeixian
[@jimbolla]: https://github.com/jimbolla
[@jkimbo]: https://github.com/jkimbo
[@joaovieira]: https://github.com/joaovieira
From 1dc7fc66056c2b802aa9d72941846f08e1679544 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 14 Feb 2024 09:05:18 -0800
Subject: [PATCH 088/199] [Deps] update `array.prototype.findlastindex`,
`hasown`, `object.groupby`
---
package.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/package.json b/package.json
index dbe14f24c3..7d6d63e718 100644
--- a/package.json
+++ b/package.json
@@ -104,19 +104,19 @@
},
"dependencies": {
"array-includes": "^3.1.7",
- "array.prototype.findlastindex": "^1.2.3",
+ "array.prototype.findlastindex": "^1.2.4",
"array.prototype.flat": "^1.3.2",
"array.prototype.flatmap": "^1.3.2",
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
"eslint-module-utils": "^2.8.0",
- "hasown": "^2.0.0",
+ "hasown": "^2.0.1",
"is-core-module": "^2.13.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.fromentries": "^2.0.7",
- "object.groupby": "^1.0.1",
+ "object.groupby": "^1.0.2",
"object.values": "^1.1.7",
"semver": "^6.3.1",
"tsconfig-paths": "^3.15.0"
From 4d298b5ea61c359a39ac8b2c49f88b18070f4773 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 14 Feb 2024 09:10:10 -0800
Subject: [PATCH 089/199] [patch] `no-unused-modules`: add console message to
help debug #2866
---
CHANGELOG.md | 2 ++
src/rules/no-unused-modules.js | 4 ++++
2 files changed, 6 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3330dd331f..06cdb922e5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
+- [`no-unused-modules`]: add console message to help debug [#2866]
## [2.29.1] - 2023-12-14
@@ -1111,6 +1112,7 @@ for info on changes for earlier releases.
[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
+[#2866]: https://github.com/import-js/eslint-plugin-import/pull/2866
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
[#2851]: https://github.com/import-js/eslint-plugin-import/pull/2851
[#2850]: https://github.com/import-js/eslint-plugin-import/pull/2850
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 8229d880ce..ec3425dacd 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -529,6 +529,10 @@ module.exports = {
exports = exportList.get(file);
+ if (!exports) {
+ console.error(`file \`${file}\` has no exports. Please update to the latest, and if it still happens, report this on https://github.com/import-js/eslint-plugin-import/issues/2866!`);
+ }
+
// special case: export * from
const exportAll = exports.get(EXPORT_ALL_DECLARATION);
if (typeof exportAll !== 'undefined' && exportedValue !== IMPORT_DEFAULT_SPECIFIER) {
From e55d05a85105769a563631ffcb55e818363ab8b6 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 14 Feb 2024 09:30:58 -0800
Subject: [PATCH 090/199] [Dev Deps] pin `jsonc-parser` due to a breaking
change
See https://github.com/microsoft/node-jsonc-parser/issues/85
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index 7d6d63e718..638942f97c 100644
--- a/package.json
+++ b/package.json
@@ -86,6 +86,7 @@
"glob": "^7.2.3",
"in-publish": "^2.0.1",
"jackspeak": "=2.1.1",
+ "jsonc-parser": "=3.2.0",
"linklocal": "^2.8.2",
"lodash.isarray": "^4.0.0",
"markdownlint-cli": "~0.35",
From 20e3f297f9dd190eddb71e8277777ae7d583e7ef Mon Sep 17 00:00:00 2001
From: Josh Goldberg <git@joshuakgoldberg.com>
Date: Sat, 10 Feb 2024 17:44:15 -0500
Subject: [PATCH 091/199] [utils] [fix] `parse`: also delete
`parserOptions.EXPERIMENTAL_useProjectService`
---
utils/CHANGELOG.md | 5 +++++
utils/parse.js | 1 +
2 files changed, 6 insertions(+)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index ae3588a390..9067cc1ef1 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Fixed
+- `parse`: also delete `parserOptions.EXPERIMENTAL_useProjectService` ([#2963], thanks [@JoshuaKGoldberg])
+
## v2.8.0 - 2023-04-14
### New
@@ -131,6 +134,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#2963]: https://github.com/import-js/eslint-plugin-import/pull/2963
[#2755]: https://github.com/import-js/eslint-plugin-import/pull/2755
[#2714]: https://github.com/import-js/eslint-plugin-import/pull/2714
[#2523]: https://github.com/import-js/eslint-plugin-import/pull/2523
@@ -169,6 +173,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@hulkish]: https://github.com/hulkish
[@Hypnosphi]: https://github.com/Hypnosphi
[@iamnapo]: https://github.com/iamnapo
+[@JoshuaKGoldberg]: https://github.com/JoshuaKGoldberg
[@JounQin]: https://github.com/JounQin
[@kaiyoma]: https://github.com/kaiyoma
[@leipert]: https://github.com/leipert
diff --git a/utils/parse.js b/utils/parse.js
index 7646b3177c..bddd2d913d 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -81,6 +81,7 @@ exports.default = function parse(path, content, context) {
// "project" or "projects" in parserOptions. Removing these options means the parser will
// only parse one file in isolate mode, which is much, much faster.
// https://github.com/import-js/eslint-plugin-import/issues/1408#issuecomment-509298962
+ delete parserOptions.EXPERIMENTAL_useProjectService;
delete parserOptions.project;
delete parserOptions.projects;
From 3c7f99062f57d879058f690c51e4866fbe635b8f Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Fri, 23 Feb 2024 16:43:11 -0800
Subject: [PATCH 092/199] [utils] add types
---
.eslintrc | 4 +--
utils/.attw.json | 5 +++
utils/.npmignore | 1 +
utils/CHANGELOG.md | 3 ++
utils/ModuleCache.d.ts | 22 +++++++++++++
utils/ModuleCache.js | 38 ++++++++++++-----------
utils/declaredScope.d.ts | 8 +++++
utils/declaredScope.js | 3 +-
utils/hash.d.ts | 14 +++++++++
utils/hash.js | 8 +++--
utils/ignore.d.ts | 12 ++++++++
utils/ignore.js | 12 ++++++--
utils/module-require.d.ts | 3 ++
utils/module-require.js | 5 +++
utils/moduleVisitor.d.ts | 26 ++++++++++++++++
utils/moduleVisitor.js | 51 ++++++++++++++++++------------
utils/package.json | 12 ++++++++
utils/parse.d.ts | 11 +++++++
utils/parse.js | 34 +++++++++++++++++---
utils/pkgDir.d.ts | 3 ++
utils/pkgDir.js | 1 +
utils/pkgUp.d.ts | 3 ++
utils/pkgUp.js | 4 +++
utils/readPkgUp.d.ts | 5 +++
utils/readPkgUp.js | 2 ++
utils/resolve.d.ts | 30 ++++++++++++++++++
utils/resolve.js | 65 +++++++++++++++++++++++++--------------
utils/tsconfig.json | 49 +++++++++++++++++++++++++++++
utils/types.d.ts | 9 ++++++
utils/unambiguous.d.ts | 7 +++++
utils/unambiguous.js | 5 ++-
utils/visit.d.ts | 9 ++++++
utils/visit.js | 13 +++++---
33 files changed, 397 insertions(+), 80 deletions(-)
create mode 100644 utils/.attw.json
create mode 100644 utils/.npmignore
create mode 100644 utils/ModuleCache.d.ts
create mode 100644 utils/declaredScope.d.ts
create mode 100644 utils/hash.d.ts
create mode 100644 utils/ignore.d.ts
create mode 100644 utils/module-require.d.ts
create mode 100644 utils/moduleVisitor.d.ts
create mode 100644 utils/parse.d.ts
create mode 100644 utils/pkgDir.d.ts
create mode 100644 utils/pkgUp.d.ts
create mode 100644 utils/readPkgUp.d.ts
create mode 100644 utils/resolve.d.ts
create mode 100644 utils/tsconfig.json
create mode 100644 utils/types.d.ts
create mode 100644 utils/unambiguous.d.ts
create mode 100644 utils/visit.d.ts
diff --git a/.eslintrc b/.eslintrc
index 3c9c658f2f..ddf7bc5628 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -209,10 +209,10 @@
"exports": "always-multiline",
"functions": "never"
}],
- "prefer-destructuring": "warn",
+ "prefer-destructuring": "off",
"prefer-object-spread": "off",
"prefer-rest-params": "off",
- "prefer-spread": "warn",
+ "prefer-spread": "off",
"prefer-template": "off",
}
},
diff --git a/utils/.attw.json b/utils/.attw.json
new file mode 100644
index 0000000000..45dd01e12f
--- /dev/null
+++ b/utils/.attw.json
@@ -0,0 +1,5 @@
+{
+ "ignoreRules": [
+ "cjs-only-exports-default"
+ ]
+}
diff --git a/utils/.npmignore b/utils/.npmignore
new file mode 100644
index 0000000000..366f3ebb6e
--- /dev/null
+++ b/utils/.npmignore
@@ -0,0 +1 @@
+.attw.json
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 9067cc1ef1..a0aa43da75 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -8,6 +8,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- `parse`: also delete `parserOptions.EXPERIMENTAL_useProjectService` ([#2963], thanks [@JoshuaKGoldberg])
+### Changed
+- add types (thanks [@ljharb])
+
## v2.8.0 - 2023-04-14
### New
diff --git a/utils/ModuleCache.d.ts b/utils/ModuleCache.d.ts
new file mode 100644
index 0000000000..72a72a0699
--- /dev/null
+++ b/utils/ModuleCache.d.ts
@@ -0,0 +1,22 @@
+import type { ESLintSettings } from "./types";
+
+export type CacheKey = unknown;
+export type CacheObject = {
+ result: unknown;
+ lastSeen: ReturnType<typeof process.hrtime>;
+};
+
+declare class ModuleCache {
+ map: Map<CacheKey, CacheObject>;
+
+ constructor(map?: Map<CacheKey, CacheObject>);
+
+ get<T>(cacheKey: CacheKey, settings: ESLintSettings): T | undefined;
+
+ set<T>(cacheKey: CacheKey, result: T): T;
+
+ static getSettings(settings: ESLintSettings): { lifetime: number } & Omit<ESLintSettings['import/cache'], 'lifetime'>;
+}
+export default ModuleCache;
+
+export type { ModuleCache }
diff --git a/utils/ModuleCache.js b/utils/ModuleCache.js
index 4b1edc0eff..24c76849dd 100644
--- a/utils/ModuleCache.js
+++ b/utils/ModuleCache.js
@@ -4,26 +4,26 @@ exports.__esModule = true;
const log = require('debug')('eslint-module-utils:ModuleCache');
+/** @type {import('./ModuleCache').ModuleCache} */
class ModuleCache {
+ /** @param {typeof import('./ModuleCache').ModuleCache.prototype.map} map */
constructor(map) {
- this.map = map || new Map();
+ this.map = map || /** @type {{typeof import('./ModuleCache').ModuleCache.prototype.map} */ new Map();
}
- /**
- * returns value for returning inline
- * @param {[type]} cacheKey [description]
- * @param {[type]} result [description]
- */
+ /** @type {typeof import('./ModuleCache').ModuleCache.prototype.set} */
set(cacheKey, result) {
this.map.set(cacheKey, { result, lastSeen: process.hrtime() });
log('setting entry for', cacheKey);
return result;
}
+ /** @type {typeof import('./ModuleCache').ModuleCache.prototype.get} */
get(cacheKey, settings) {
if (this.map.has(cacheKey)) {
const f = this.map.get(cacheKey);
// check freshness
+ // @ts-expect-error TS can't narrow properly from `has` and `get`
if (process.hrtime(f.lastSeen)[0] < settings.lifetime) { return f.result; }
} else {
log('cache miss for', cacheKey);
@@ -32,19 +32,21 @@ class ModuleCache {
return undefined;
}
-}
-
-ModuleCache.getSettings = function (settings) {
- const cacheSettings = Object.assign({
- lifetime: 30, // seconds
- }, settings['import/cache']);
+ /** @type {typeof import('./ModuleCache').ModuleCache.getSettings} */
+ static getSettings(settings) {
+ /** @type {ReturnType<typeof ModuleCache.getSettings>} */
+ const cacheSettings = Object.assign({
+ lifetime: 30, // seconds
+ }, settings['import/cache']);
+
+ // parse infinity
+ // @ts-expect-error the lack of type overlap is because we're abusing `cacheSettings` as a temporary object
+ if (cacheSettings.lifetime === '∞' || cacheSettings.lifetime === 'Infinity') {
+ cacheSettings.lifetime = Infinity;
+ }
- // parse infinity
- if (cacheSettings.lifetime === '∞' || cacheSettings.lifetime === 'Infinity') {
- cacheSettings.lifetime = Infinity;
+ return cacheSettings;
}
-
- return cacheSettings;
-};
+}
exports.default = ModuleCache;
diff --git a/utils/declaredScope.d.ts b/utils/declaredScope.d.ts
new file mode 100644
index 0000000000..e37200d870
--- /dev/null
+++ b/utils/declaredScope.d.ts
@@ -0,0 +1,8 @@
+import { Rule, Scope } from 'eslint';
+
+declare function declaredScope(
+ context: Rule.RuleContext,
+ name: string
+): Scope.Scope['type'] | undefined;
+
+export default declaredScope;
diff --git a/utils/declaredScope.js b/utils/declaredScope.js
index dd2a20149f..0f0a3d9458 100644
--- a/utils/declaredScope.js
+++ b/utils/declaredScope.js
@@ -2,9 +2,10 @@
exports.__esModule = true;
+/** @type {import('./declaredScope').default} */
exports.default = function declaredScope(context, name) {
const references = context.getScope().references;
const reference = references.find((x) => x.identifier.name === name);
- if (!reference) { return undefined; }
+ if (!reference || !reference.resolved) { return undefined; }
return reference.resolved.scope.type;
};
diff --git a/utils/hash.d.ts b/utils/hash.d.ts
new file mode 100644
index 0000000000..5e4cf471bd
--- /dev/null
+++ b/utils/hash.d.ts
@@ -0,0 +1,14 @@
+import type { Hash } from 'crypto';
+
+declare function hashArray(value: Array<unknown>, hash?: Hash): Hash;
+
+declare function hashObject<T extends object>(value: T, hash?: Hash): Hash;
+
+declare function hashify(
+ value: Array<unknown> | object | unknown,
+ hash?: Hash,
+): Hash;
+
+export default hashify;
+
+export { hashArray, hashObject };
diff --git a/utils/hash.js b/utils/hash.js
index b9bff25bd9..b3ce618b54 100644
--- a/utils/hash.js
+++ b/utils/hash.js
@@ -11,6 +11,7 @@ const createHash = require('crypto').createHash;
const stringify = JSON.stringify;
+/** @type {import('./hash').default} */
function hashify(value, hash) {
if (!hash) { hash = createHash('sha256'); }
@@ -26,6 +27,7 @@ function hashify(value, hash) {
}
exports.default = hashify;
+/** @type {import('./hash').hashArray} */
function hashArray(array, hash) {
if (!hash) { hash = createHash('sha256'); }
@@ -41,13 +43,15 @@ function hashArray(array, hash) {
hashify.array = hashArray;
exports.hashArray = hashArray;
-function hashObject(object, hash) {
- if (!hash) { hash = createHash('sha256'); }
+/** @type {import('./hash').hashObject} */
+function hashObject(object, optionalHash) {
+ const hash = optionalHash || createHash('sha256');
hash.update('{');
Object.keys(object).sort().forEach((key) => {
hash.update(stringify(key));
hash.update(':');
+ // @ts-expect-error the key is guaranteed to exist on the object here
hashify(object[key], hash);
hash.update(',');
});
diff --git a/utils/ignore.d.ts b/utils/ignore.d.ts
new file mode 100644
index 0000000000..53953b33e9
--- /dev/null
+++ b/utils/ignore.d.ts
@@ -0,0 +1,12 @@
+import { Rule } from 'eslint';
+import type { ESLintSettings, Extension } from './types';
+
+declare function ignore(path: string, context: Rule.RuleContext): boolean;
+
+declare function getFileExtensions(settings: ESLintSettings): Set<Extension>;
+
+declare function hasValidExtension(path: string, context: Rule.RuleContext): path is `${string}${Extension}`;
+
+export default ignore;
+
+export { getFileExtensions, hasValidExtension }
diff --git a/utils/ignore.js b/utils/ignore.js
index 960538e706..59ac821eb8 100644
--- a/utils/ignore.js
+++ b/utils/ignore.js
@@ -7,7 +7,10 @@ const extname = require('path').extname;
const log = require('debug')('eslint-plugin-import:utils:ignore');
// one-shot memoized
-let cachedSet; let lastSettings;
+/** @type {Set<import('./types').Extension>} */ let cachedSet;
+/** @type {import('./types').ESLintSettings} */ let lastSettings;
+
+/** @type {(context: import('eslint').Rule.RuleContext) => Set<import('./types').Extension>} */
function validExtensions(context) {
if (cachedSet && context.settings === lastSettings) {
return cachedSet;
@@ -18,8 +21,10 @@ function validExtensions(context) {
return cachedSet;
}
+/** @type {import('./ignore').getFileExtensions} */
function makeValidExtensionSet(settings) {
// start with explicit JS-parsed extensions
+ /** @type {Set<import('./types').Extension>} */
const exts = new Set(settings['import/extensions'] || ['.js']);
// all alternate parser extensions are also valid
@@ -37,6 +42,7 @@ function makeValidExtensionSet(settings) {
}
exports.getFileExtensions = makeValidExtensionSet;
+/** @type {import('./ignore').default} */
exports.default = function ignore(path, context) {
// check extension whitelist first (cheap)
if (!hasValidExtension(path, context)) { return true; }
@@ -55,7 +61,9 @@ exports.default = function ignore(path, context) {
return false;
};
+/** @type {import('./ignore').hasValidExtension} */
function hasValidExtension(path, context) {
- return validExtensions(context).has(extname(path));
+ // eslint-disable-next-line no-extra-parens
+ return validExtensions(context).has(/** @type {import('./types').Extension} */ (extname(path)));
}
exports.hasValidExtension = hasValidExtension;
diff --git a/utils/module-require.d.ts b/utils/module-require.d.ts
new file mode 100644
index 0000000000..91df90d616
--- /dev/null
+++ b/utils/module-require.d.ts
@@ -0,0 +1,3 @@
+declare function moduleRequire<T>(p: string): T;
+
+export default moduleRequire;
diff --git a/utils/module-require.js b/utils/module-require.js
index 96ef82ba51..14006c5dc6 100644
--- a/utils/module-require.js
+++ b/utils/module-require.js
@@ -6,23 +6,28 @@ const Module = require('module');
const path = require('path');
// borrowed from babel-eslint
+/** @type {(filename: string) => Module} */
function createModule(filename) {
const mod = new Module(filename);
mod.filename = filename;
+ // @ts-expect-error _nodeModulesPaths are undocumented
mod.paths = Module._nodeModulePaths(path.dirname(filename));
return mod;
}
+/** @type {import('./module-require').default} */
exports.default = function moduleRequire(p) {
try {
// attempt to get espree relative to eslint
const eslintPath = require.resolve('eslint');
const eslintModule = createModule(eslintPath);
+ // @ts-expect-error _resolveFilename is undocumented
return require(Module._resolveFilename(p, eslintModule));
} catch (err) { /* ignore */ }
try {
// try relative to entry point
+ // @ts-expect-error TODO: figure out what this is
return require.main.require(p);
} catch (err) { /* ignore */ }
diff --git a/utils/moduleVisitor.d.ts b/utils/moduleVisitor.d.ts
new file mode 100644
index 0000000000..6f30186d71
--- /dev/null
+++ b/utils/moduleVisitor.d.ts
@@ -0,0 +1,26 @@
+import type { Rule } from 'eslint';
+import type { Node } from 'estree';
+
+type Visitor = (source: Node, importer: unknown) => any;
+
+type Options = {
+ amd?: boolean;
+ commonjs?: boolean;
+ esmodule?: boolean;
+ ignore?: string[];
+};
+
+declare function moduleVisitor(
+ visitor: Visitor,
+ options?: Options,
+): object;
+
+export default moduleVisitor;
+
+export type Schema = NonNullable<Rule.RuleModule['schema']>;
+
+declare function makeOptionsSchema(additionalProperties?: Partial<Schema>): Schema
+
+declare const optionsSchema: Schema;
+
+export { makeOptionsSchema, optionsSchema };
diff --git a/utils/moduleVisitor.js b/utils/moduleVisitor.js
index c312ca2d45..acdee6774f 100644
--- a/utils/moduleVisitor.js
+++ b/utils/moduleVisitor.js
@@ -2,50 +2,58 @@
exports.__esModule = true;
+/** @typedef {import('estree').Node} Node */
+/** @typedef {{ arguments: import('estree').CallExpression['arguments'], callee: Node }} Call */
+/** @typedef {import('estree').ImportDeclaration | import('estree').ExportNamedDeclaration | import('estree').ExportAllDeclaration} Declaration */
+
/**
* Returns an object of node visitors that will call
* 'visitor' with every discovered module path.
*
- * todo: correct function prototype for visitor
- * @param {Function(String)} visitor [description]
- * @param {[type]} options [description]
- * @return {object}
+ * @type {(import('./moduleVisitor').default)}
*/
exports.default = function visitModules(visitor, options) {
+ const ignore = options && options.ignore;
+ const amd = !!(options && options.amd);
+ const commonjs = !!(options && options.commonjs);
// if esmodule is not explicitly disabled, it is assumed to be enabled
- options = Object.assign({ esmodule: true }, options);
+ const esmodule = !!Object.assign({ esmodule: true }, options).esmodule;
- let ignoreRegExps = [];
- if (options.ignore != null) {
- ignoreRegExps = options.ignore.map((p) => new RegExp(p));
- }
+ const ignoreRegExps = ignore == null ? [] : ignore.map((p) => new RegExp(p));
+ /** @type {(source: undefined | null | import('estree').Literal, importer: Parameters<typeof visitor>[1]) => void} */
function checkSourceValue(source, importer) {
if (source == null) { return; } //?
// handle ignore
- if (ignoreRegExps.some((re) => re.test(source.value))) { return; }
+ if (ignoreRegExps.some((re) => re.test(String(source.value)))) { return; }
// fire visitor
visitor(source, importer);
}
// for import-y declarations
+ /** @type {(node: Declaration) => void} */
function checkSource(node) {
checkSourceValue(node.source, node);
}
// for esmodule dynamic `import()` calls
+ /** @type {(node: import('estree').ImportExpression | import('estree').CallExpression) => void} */
function checkImportCall(node) {
+ /** @type {import('estree').Expression | import('estree').Literal | import('estree').CallExpression['arguments'][0]} */
let modulePath;
// refs https://github.com/estree/estree/blob/HEAD/es2020.md#importexpression
if (node.type === 'ImportExpression') {
modulePath = node.source;
} else if (node.type === 'CallExpression') {
+ // @ts-expect-error this structure is from an older version of eslint
if (node.callee.type !== 'Import') { return; }
if (node.arguments.length !== 1) { return; }
modulePath = node.arguments[0];
+ } else {
+ throw new TypeError('this should be unreachable');
}
if (modulePath.type !== 'Literal') { return; }
@@ -56,6 +64,7 @@ exports.default = function visitModules(visitor, options) {
// for CommonJS `require` calls
// adapted from @mctep: https://git.io/v4rAu
+ /** @type {(call: Call) => void} */
function checkCommon(call) {
if (call.callee.type !== 'Identifier') { return; }
if (call.callee.name !== 'require') { return; }
@@ -68,6 +77,7 @@ exports.default = function visitModules(visitor, options) {
checkSourceValue(modulePath, call);
}
+ /** @type {(call: Call) => void} */
function checkAMD(call) {
if (call.callee.type !== 'Identifier') { return; }
if (call.callee.name !== 'require' && call.callee.name !== 'define') { return; }
@@ -77,6 +87,7 @@ exports.default = function visitModules(visitor, options) {
if (modules.type !== 'ArrayExpression') { return; }
for (const element of modules.elements) {
+ if (!element) { continue; }
if (element.type !== 'Literal') { continue; }
if (typeof element.value !== 'string') { continue; }
@@ -92,7 +103,7 @@ exports.default = function visitModules(visitor, options) {
}
const visitors = {};
- if (options.esmodule) {
+ if (esmodule) {
Object.assign(visitors, {
ImportDeclaration: checkSource,
ExportNamedDeclaration: checkSource,
@@ -102,12 +113,12 @@ exports.default = function visitModules(visitor, options) {
});
}
- if (options.commonjs || options.amd) {
+ if (commonjs || amd) {
const currentCallExpression = visitors.CallExpression;
- visitors.CallExpression = function (call) {
+ visitors.CallExpression = /** @type {(call: Call) => void} */ function (call) {
if (currentCallExpression) { currentCallExpression(call); }
- if (options.commonjs) { checkCommon(call); }
- if (options.amd) { checkAMD(call); }
+ if (commonjs) { checkCommon(call); }
+ if (amd) { checkAMD(call); }
};
}
@@ -115,10 +126,11 @@ exports.default = function visitModules(visitor, options) {
};
/**
- * make an options schema for the module visitor, optionally
- * adding extra fields.
+ * make an options schema for the module visitor, optionally adding extra fields.
+ * @type {import('./moduleVisitor').makeOptionsSchema}
*/
function makeOptionsSchema(additionalProperties) {
+ /** @type {import('./moduleVisitor').Schema} */
const base = {
type: 'object',
properties: {
@@ -137,6 +149,7 @@ function makeOptionsSchema(additionalProperties) {
if (additionalProperties) {
for (const key in additionalProperties) {
+ // @ts-expect-error TS always has trouble with arbitrary object assignment/mutation
base.properties[key] = additionalProperties[key];
}
}
@@ -146,8 +159,6 @@ function makeOptionsSchema(additionalProperties) {
exports.makeOptionsSchema = makeOptionsSchema;
/**
- * json schema object for options parameter. can be used to build
- * rule options schema object.
- * @type {Object}
+ * json schema object for options parameter. can be used to build rule options schema object.
*/
exports.optionsSchema = makeOptionsSchema();
diff --git a/utils/package.json b/utils/package.json
index d56c442b1a..04c338b1a8 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -7,6 +7,7 @@
},
"scripts": {
"prepublishOnly": "cp ../{LICENSE,.npmrc} ./",
+ "tsc": "tsc -p .",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
@@ -28,9 +29,20 @@
"dependencies": {
"debug": "^3.2.7"
},
+ "devDependencies": {
+ "@types/debug": "^4.1.12",
+ "@types/eslint": "^8.56.3",
+ "@types/node": "^20.11.20",
+ "typescript": "next"
+ },
"peerDependenciesMeta": {
"eslint": {
"optional": true
}
+ },
+ "publishConfig": {
+ "ignore": [
+ ".attw.json"
+ ]
}
}
diff --git a/utils/parse.d.ts b/utils/parse.d.ts
new file mode 100644
index 0000000000..f92ab3edc6
--- /dev/null
+++ b/utils/parse.d.ts
@@ -0,0 +1,11 @@
+import { AST, Rule } from 'eslint';
+
+
+
+declare function parse(
+ path: string,
+ content: string,
+ context: Rule.RuleContext
+): AST.Program | null | undefined;
+
+export default parse;
diff --git a/utils/parse.js b/utils/parse.js
index bddd2d913d..804186ca97 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -2,12 +2,16 @@
exports.__esModule = true;
+/** @typedef {`.${string}`} Extension */
+/** @typedef {NonNullable<import('eslint').Rule.RuleContext['settings']> & { 'import/extensions'?: Extension[], 'import/parsers'?: { [k: string]: Extension[] }, 'import/cache'?: { lifetime: number | '∞' | 'Infinity' } }} ESLintSettings */
+
const moduleRequire = require('./module-require').default;
const extname = require('path').extname;
const fs = require('fs');
const log = require('debug')('eslint-plugin-import:parse');
+/** @type {(parserPath: NonNullable<import('eslint').Rule.RuleContext['parserPath']>) => unknown} */
function getBabelEslintVisitorKeys(parserPath) {
if (parserPath.endsWith('index.js')) {
const hypotheticalLocation = parserPath.replace('index.js', 'visitor-keys.js');
@@ -19,6 +23,7 @@ function getBabelEslintVisitorKeys(parserPath) {
return null;
}
+/** @type {(parserPath: import('eslint').Rule.RuleContext['parserPath'], parserInstance: { VisitorKeys: unknown }, parsedResult?: { visitorKeys?: unknown }) => unknown} */
function keysFromParser(parserPath, parserInstance, parsedResult) {
// Exposed by @typescript-eslint/parser and @babel/eslint-parser
if (parsedResult && parsedResult.visitorKeys) {
@@ -35,22 +40,28 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
// this exists to smooth over the unintentional breaking change in v2.7.
// TODO, semver-major: avoid mutating `ast` and return a plain object instead.
+/** @type {<T extends import('eslint').AST.Program>(ast: T, visitorKeys: unknown) => T} */
function makeParseReturn(ast, visitorKeys) {
if (ast) {
+ // @ts-expect-error see TODO
ast.visitorKeys = visitorKeys;
+ // @ts-expect-error see TODO
ast.ast = ast;
}
return ast;
}
+/** @type {(text: string) => string} */
function stripUnicodeBOM(text) {
return text.charCodeAt(0) === 0xFEFF ? text.slice(1) : text;
}
+/** @type {(text: string) => string} */
function transformHashbang(text) {
return text.replace(/^#!([^\r\n]+)/u, (_, captured) => `//${captured}`);
}
+/** @type {import('./parse').default} */
exports.default = function parse(path, content, context) {
if (context == null) { throw new Error('need context to parse properly'); }
@@ -97,10 +108,12 @@ exports.default = function parse(path, content, context) {
try {
const parserRaw = parser.parseForESLint(content, parserOptions);
ast = parserRaw.ast;
+ // @ts-expect-error TODO: FIXME
return makeParseReturn(ast, keysFromParser(parserOrPath, parser, parserRaw));
} catch (e) {
console.warn();
console.warn('Error while parsing ' + parserOptions.filePath);
+ // @ts-expect-error e is almost certainly an Error here
console.warn('Line ' + e.lineNumber + ', column ' + e.column + ': ' + e.message);
}
if (!ast || typeof ast !== 'object') {
@@ -109,34 +122,45 @@ exports.default = function parse(path, content, context) {
'`parseForESLint` from parser `' + (typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`') + '` is invalid and will just be ignored'
);
} else {
+ // @ts-expect-error TODO: FIXME
return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
}
}
const ast = parser.parse(content, parserOptions);
+ // @ts-expect-error TODO: FIXME
return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
};
+/** @type {(path: string, context: import('eslint').Rule.RuleContext) => string | null | (import('eslint').Linter.ParserModule)} */
function getParser(path, context) {
const parserPath = getParserPath(path, context);
if (parserPath) {
return parserPath;
}
- const isFlat = context.languageOptions
- && context.languageOptions.parser
+ if (
+ !!context.languageOptions
+ && !!context.languageOptions.parser
&& typeof context.languageOptions.parser !== 'string'
&& (
+ // @ts-expect-error TODO: figure out a better type
typeof context.languageOptions.parser.parse === 'function'
+ // @ts-expect-error TODO: figure out a better type
|| typeof context.languageOptions.parser.parseForESLint === 'function'
- );
+ )
+ ) {
+ return context.languageOptions.parser;
+ }
- return isFlat ? context.languageOptions.parser : null;
+ return null;
}
+/** @type {(path: string, context: import('eslint').Rule.RuleContext & { settings?: ESLintSettings }) => import('eslint').Rule.RuleContext['parserPath']} */
function getParserPath(path, context) {
const parsers = context.settings['import/parsers'];
if (parsers != null) {
- const extension = extname(path);
+ // eslint-disable-next-line no-extra-parens
+ const extension = /** @type {Extension} */ (extname(path));
for (const parserPath in parsers) {
if (parsers[parserPath].indexOf(extension) > -1) {
// use this alternate parser
diff --git a/utils/pkgDir.d.ts b/utils/pkgDir.d.ts
new file mode 100644
index 0000000000..af01e2e9bf
--- /dev/null
+++ b/utils/pkgDir.d.ts
@@ -0,0 +1,3 @@
+declare function pkgDir(cwd: string): string | null;
+
+export default pkgDir;
diff --git a/utils/pkgDir.js b/utils/pkgDir.js
index 34412202f1..84c334680a 100644
--- a/utils/pkgDir.js
+++ b/utils/pkgDir.js
@@ -5,6 +5,7 @@ const pkgUp = require('./pkgUp').default;
exports.__esModule = true;
+/** @type {import('./pkgDir').default} */
exports.default = function (cwd) {
const fp = pkgUp({ cwd });
return fp ? path.dirname(fp) : null;
diff --git a/utils/pkgUp.d.ts b/utils/pkgUp.d.ts
new file mode 100644
index 0000000000..6382457bec
--- /dev/null
+++ b/utils/pkgUp.d.ts
@@ -0,0 +1,3 @@
+declare function pkgUp(opts?: { cwd?: string }): string | null;
+
+export default pkgUp;
diff --git a/utils/pkgUp.js b/utils/pkgUp.js
index 889f62265f..076e59fd76 100644
--- a/utils/pkgUp.js
+++ b/utils/pkgUp.js
@@ -31,10 +31,13 @@ const path = require('path');
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
+/** @type {(filename: string | string[], cwd?: string) => string | null} */
function findUp(filename, cwd) {
let dir = path.resolve(cwd || '');
const root = path.parse(dir).root;
+ /** @type {string[]} */ // @ts-expect-error TS sucks with concat
const filenames = [].concat(filename);
// eslint-disable-next-line no-constant-condition
@@ -52,6 +55,7 @@ function findUp(filename, cwd) {
}
}
+/** @type {import('./pkgUp').default} */
exports.default = function pkgUp(opts) {
return findUp('package.json', opts && opts.cwd);
};
diff --git a/utils/readPkgUp.d.ts b/utils/readPkgUp.d.ts
new file mode 100644
index 0000000000..5fc1668879
--- /dev/null
+++ b/utils/readPkgUp.d.ts
@@ -0,0 +1,5 @@
+import pkgUp from './pkgUp';
+
+declare function readPkgUp(opts?: Parameters<typeof pkgUp>[0]): {} | { pkg: string, path: string };
+
+export default readPkgUp;
diff --git a/utils/readPkgUp.js b/utils/readPkgUp.js
index d34fa6c818..08371931f2 100644
--- a/utils/readPkgUp.js
+++ b/utils/readPkgUp.js
@@ -5,6 +5,7 @@ exports.__esModule = true;
const fs = require('fs');
const pkgUp = require('./pkgUp').default;
+/** @type {(str: string) => string} */
function stripBOM(str) {
return str.replace(/^\uFEFF/, '');
}
@@ -35,6 +36,7 @@ function stripBOM(str) {
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+/** @type {import('./readPkgUp').default} */
exports.default = function readPkgUp(opts) {
const fp = pkgUp(opts);
diff --git a/utils/resolve.d.ts b/utils/resolve.d.ts
new file mode 100644
index 0000000000..bb885bcfaf
--- /dev/null
+++ b/utils/resolve.d.ts
@@ -0,0 +1,30 @@
+import type { Rule } from 'eslint';
+
+import type ModuleCache from './ModuleCache';
+import type { ESLintSettings } from './types';
+
+export type ResultNotFound = { found: false, path?: undefined };
+export type ResultFound = { found: true, path: string | null };
+export type ResolvedResult = ResultNotFound | ResultFound;
+
+export type ResolverResolve = (modulePath: string, sourceFile:string, config: unknown) => ResolvedResult;
+export type ResolverResolveImport = (modulePath: string, sourceFile:string, config: unknown) => string | undefined;
+export type Resolver = { interfaceVersion?: 1 | 2, resolve: ResolverResolve, resolveImport: ResolverResolveImport };
+
+declare function resolve(
+ p: string,
+ context: Rule.RuleContext,
+): ResolvedResult['path'];
+
+export default resolve;
+
+declare function fileExistsWithCaseSync(
+ filepath: string | null,
+ cacheSettings: ESLintSettings,
+ strict: boolean
+): boolean | ReturnType<typeof ModuleCache.prototype.get>;
+
+declare function relative(modulePath: string, sourceFile: string, settings: ESLintSettings): ResolvedResult['path'];
+
+
+export { fileExistsWithCaseSync, relative };
diff --git a/utils/resolve.js b/utils/resolve.js
index 0ed5bdb0c9..05f7b35abf 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -19,16 +19,22 @@ const fileExistsCache = new ModuleCache();
// Polyfill Node's `Module.createRequireFromPath` if not present (added in Node v10.12.0)
// Use `Module.createRequire` if available (added in Node v12.2.0)
-const createRequire = Module.createRequire || Module.createRequireFromPath || function (filename) {
- const mod = new Module(filename, null);
- mod.filename = filename;
- mod.paths = Module._nodeModulePaths(path.dirname(filename));
-
- mod._compile(`module.exports = require;`, filename);
-
- return mod.exports;
-};
-
+const createRequire = Module.createRequire
+ // @ts-expect-error this only exists in older node
+ || Module.createRequireFromPath
+ || /** @type {(filename: string) => unknown} */ function (filename) {
+ const mod = new Module(filename, void null);
+ mod.filename = filename;
+ // @ts-expect-error _nodeModulePaths is undocumented
+ mod.paths = Module._nodeModulePaths(path.dirname(filename));
+
+ // @ts-expect-error _compile is undocumented
+ mod._compile(`module.exports = require;`, filename);
+
+ return mod.exports;
+ };
+
+/** @type {<T extends string>(target: T, sourceFile?: string | null | undefined) => undefined | ReturnType<typeof require>} */
function tryRequire(target, sourceFile) {
let resolved;
try {
@@ -52,6 +58,7 @@ function tryRequire(target, sourceFile) {
}
// https://stackoverflow.com/a/27382838
+/** @type {import('./resolve').fileExistsWithCaseSync} */
exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cacheSettings, strict) {
// don't care if the FS is case-sensitive
if (CASE_SENSITIVE_FS) { return true; }
@@ -80,12 +87,10 @@ exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cache
return result;
};
-function relative(modulePath, sourceFile, settings) {
- return fullResolve(modulePath, sourceFile, settings).path;
-}
-
+/** @type {import('./types').ESLintSettings | null} */
let prevSettings = null;
let memoizedHash = '';
+/** @type {(modulePath: string, sourceFile: string, settings: import('./types').ESLintSettings) => import('./resolve').ResolvedResult} */
function fullResolve(modulePath, sourceFile, settings) {
// check if this is a bonus core module
const coreSet = new Set(settings['import/core-modules']);
@@ -105,10 +110,12 @@ function fullResolve(modulePath, sourceFile, settings) {
const cachedPath = fileExistsCache.get(cacheKey, cacheSettings);
if (cachedPath !== undefined) { return { found: true, path: cachedPath }; }
+ /** @type {(resolvedPath: string | null) => void} */
function cache(resolvedPath) {
fileExistsCache.set(cacheKey, resolvedPath);
}
+ /** @type {(resolver: import('./resolve').Resolver, config: unknown) => import('./resolve').ResolvedResult} */
function withResolver(resolver, config) {
if (resolver.interfaceVersion === 2) {
return resolver.resolve(modulePath, sourceFile, config);
@@ -145,8 +152,14 @@ function fullResolve(modulePath, sourceFile, settings) {
// cache(undefined)
return { found: false };
}
+
+/** @type {import('./resolve').relative} */
+function relative(modulePath, sourceFile, settings) {
+ return fullResolve(modulePath, sourceFile, settings).path;
+}
exports.relative = relative;
+/** @type {<T extends Map<string, unknown>>(resolvers: string[] | string | { [k: string]: string }, map: T) => T} */
function resolverReducer(resolvers, map) {
if (Array.isArray(resolvers)) {
resolvers.forEach((r) => resolverReducer(r, map));
@@ -170,9 +183,12 @@ function resolverReducer(resolvers, map) {
throw err;
}
+/** @type {(sourceFile: string) => string} */
function getBaseDir(sourceFile) {
return pkgDir(sourceFile) || process.cwd();
}
+
+/** @type {(name: string, sourceFile: string) => import('./resolve').Resolver} */
function requireResolver(name, sourceFile) {
// Try to resolve package with conventional name
const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile)
@@ -193,23 +209,23 @@ function requireResolver(name, sourceFile) {
return resolver;
}
+/** @type {(resolver: object) => resolver is import('./resolve').Resolver} */
function isResolverValid(resolver) {
- if (resolver.interfaceVersion === 2) {
- return resolver.resolve && typeof resolver.resolve === 'function';
- } else {
- return resolver.resolveImport && typeof resolver.resolveImport === 'function';
+ if ('interfaceVersion' in resolver && resolver.interfaceVersion === 2) {
+ return 'resolve' in resolver && !!resolver.resolve && typeof resolver.resolve === 'function';
}
+ return 'resolveImport' in resolver && !!resolver.resolveImport && typeof resolver.resolveImport === 'function';
}
+/** @type {Set<import('eslint').Rule.RuleContext>} */
const erroredContexts = new Set();
/**
* Given
- * @param {string} p - module path
- * @param {object} context - ESLint context
- * @return {string} - the full module filesystem path;
- * null if package is core;
- * undefined if not found
+ * @param p - module path
+ * @param context - ESLint context
+ * @return - the full module filesystem path; null if package is core; undefined if not found
+ * @type {import('./resolve').default}
*/
function resolve(p, context) {
try {
@@ -218,8 +234,11 @@ function resolve(p, context) {
if (!erroredContexts.has(context)) {
// The `err.stack` string starts with `err.name` followed by colon and `err.message`.
// We're filtering out the default `err.name` because it adds little value to the message.
+ // @ts-expect-error this might be an Error
let errMessage = err.message;
+ // @ts-expect-error this might be an Error
if (err.name !== ERROR_NAME && err.stack) {
+ // @ts-expect-error this might be an Error
errMessage = err.stack.replace(/^Error: /, '');
}
context.report({
diff --git a/utils/tsconfig.json b/utils/tsconfig.json
new file mode 100644
index 0000000000..4d1c86efdf
--- /dev/null
+++ b/utils/tsconfig.json
@@ -0,0 +1,49 @@
+{
+ "compilerOptions": {
+ /* Visit https://aka.ms/tsconfig to read more about this file */
+
+ /* Projects */
+
+ /* Language and Environment */
+ "target": "ES2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+ // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
+ "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
+ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
+
+ /* Modules */
+ "module": "commonjs", /* Specify what module code is generated. */
+ "rootDir": "./", /* Specify the root folder within your source files. */
+ "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
+ // "typeRoots": ["types"], /* Specify multiple folders that act like './node_modules/@types'. */
+ "resolveJsonModule": true, /* Enable importing .json files. */
+ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
+
+ /* JavaScript Support */
+ "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+ "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
+ "maxNodeModuleJsDepth": 0, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+ /* Emit */
+ "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+ "declarationMap": true, /* Create sourcemaps for d.ts files. */
+ "noEmit": true, /* Disable emitting files from a compilation. */
+
+ /* Interop Constraints */
+ "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+
+ /* Type Checking */
+ "strict": true, /* Enable all strict type-checking options. */
+
+ /* Completeness */
+ //"skipLibCheck": true /* Skip type checking all .d.ts files. */
+ },
+ "exclude": [
+ "coverage"
+ ]
+}
diff --git a/utils/types.d.ts b/utils/types.d.ts
new file mode 100644
index 0000000000..e0c4f5749d
--- /dev/null
+++ b/utils/types.d.ts
@@ -0,0 +1,9 @@
+import type { Rule } from 'eslint';
+
+export type Extension = `.${string}`;
+
+export type ESLintSettings = NonNullable<Rule.RuleContext['settings']> & {
+ 'import/extensions'?: Extension[];
+ 'import/parsers'?: { [k: string]: Extension[] };
+ 'import/cache'?: { lifetime: number | '∞' | 'Infinity' };
+};
diff --git a/utils/unambiguous.d.ts b/utils/unambiguous.d.ts
new file mode 100644
index 0000000000..1679224189
--- /dev/null
+++ b/utils/unambiguous.d.ts
@@ -0,0 +1,7 @@
+import type { AST } from 'eslint';
+
+declare function isModule(ast: AST.Program): boolean;
+
+declare function test(content: string): boolean;
+
+export { isModule, test }
diff --git a/utils/unambiguous.js b/utils/unambiguous.js
index 24cb123157..20aabd1bd4 100644
--- a/utils/unambiguous.js
+++ b/utils/unambiguous.js
@@ -11,7 +11,7 @@ const pattern = /(^|;)\s*(export|import)((\s+\w)|(\s*[{*=]))|import\(/m;
*
* Not perfect, just a fast way to disqualify large non-ES6 modules and
* avoid a parse.
- * @type {RegExp}
+ * @type {import('./unambiguous').test}
*/
exports.test = function isMaybeUnambiguousModule(content) {
return pattern.test(content);
@@ -22,8 +22,7 @@ const unambiguousNodeType = /^(?:(?:Exp|Imp)ort.*Declaration|TSExportAssignment)
/**
* Given an AST, return true if the AST unambiguously represents a module.
- * @param {Program node} ast
- * @return {Boolean}
+ * @type {import('./unambiguous').isModule}
*/
exports.isModule = function isUnambiguousModule(ast) {
return ast.body && ast.body.some((node) => unambiguousNodeType.test(node.type));
diff --git a/utils/visit.d.ts b/utils/visit.d.ts
new file mode 100644
index 0000000000..50559aaab0
--- /dev/null
+++ b/utils/visit.d.ts
@@ -0,0 +1,9 @@
+import type { Node } from 'estree';
+
+declare function visit(
+ node: Node,
+ keys: { [k in Node['type']]?: (keyof Node)[] },
+ visitorSpec: { [k in Node['type'] | `${Node['type']}:Exit`]?: Function }
+): void;
+
+export default visit;
diff --git a/utils/visit.js b/utils/visit.js
index 6178faeaa0..dd0c6248da 100644
--- a/utils/visit.js
+++ b/utils/visit.js
@@ -2,24 +2,29 @@
exports.__esModule = true;
+/** @type {import('./visit').default} */
exports.default = function visit(node, keys, visitorSpec) {
if (!node || !keys) {
return;
}
const type = node.type;
- if (typeof visitorSpec[type] === 'function') {
- visitorSpec[type](node);
+ const visitor = visitorSpec[type];
+ if (typeof visitor === 'function') {
+ visitor(node);
}
const childFields = keys[type];
if (!childFields) {
return;
}
childFields.forEach((fieldName) => {
+ // @ts-expect-error TS sucks with concat
[].concat(node[fieldName]).forEach((item) => {
visit(item, keys, visitorSpec);
});
});
- if (typeof visitorSpec[`${type}:Exit`] === 'function') {
- visitorSpec[`${type}:Exit`](node);
+
+ const exit = visitorSpec[`${type}:Exit`];
+ if (typeof exit === 'function') {
+ exit(node);
}
};
From df751e0d004aacc34f975477163fb221485a85f6 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 26 Feb 2024 16:21:46 -0800
Subject: [PATCH 093/199] [utils] v2.8.1
---
utils/CHANGELOG.md | 2 ++
utils/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index a0aa43da75..b1344b9e0d 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.8.1 - 2024-02-26
+
### Fixed
- `parse`: also delete `parserOptions.EXPERIMENTAL_useProjectService` ([#2963], thanks [@JoshuaKGoldberg])
diff --git a/utils/package.json b/utils/package.json
index 04c338b1a8..275e364dca 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.8.0",
+ "version": "2.8.1",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From b87746016dbb1aab7d5ec9331a39ccdabedfb1b7 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 10 Mar 2024 22:50:46 -0700
Subject: [PATCH 094/199] [utils] [types] use shared config
---
utils/CHANGELOG.md | 3 +++
utils/package.json | 1 +
utils/tsconfig.json | 56 ++++++++-------------------------------------
3 files changed, 13 insertions(+), 47 deletions(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index b1344b9e0d..3e2f5a8997 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Changed
+- [types] use shared config (thanks [@ljharb])
+
## v2.8.1 - 2024-02-26
### Fixed
diff --git a/utils/package.json b/utils/package.json
index 275e364dca..df4871790b 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -30,6 +30,7 @@
"debug": "^3.2.7"
},
"devDependencies": {
+ "@ljharb/tsconfig": "^0.2.0",
"@types/debug": "^4.1.12",
"@types/eslint": "^8.56.3",
"@types/node": "^20.11.20",
diff --git a/utils/tsconfig.json b/utils/tsconfig.json
index 4d1c86efdf..9e6fbc5cc1 100644
--- a/utils/tsconfig.json
+++ b/utils/tsconfig.json
@@ -1,49 +1,11 @@
{
- "compilerOptions": {
- /* Visit https://aka.ms/tsconfig to read more about this file */
-
- /* Projects */
-
- /* Language and Environment */
- "target": "ES2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
- // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
- // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
- "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
- // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
-
- /* Modules */
- "module": "commonjs", /* Specify what module code is generated. */
- "rootDir": "./", /* Specify the root folder within your source files. */
- "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
- // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
- // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
- // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
- // "typeRoots": ["types"], /* Specify multiple folders that act like './node_modules/@types'. */
- "resolveJsonModule": true, /* Enable importing .json files. */
- // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
-
- /* JavaScript Support */
- "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
- "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
- "maxNodeModuleJsDepth": 0, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
- /* Emit */
- "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
- "declarationMap": true, /* Create sourcemaps for d.ts files. */
- "noEmit": true, /* Disable emitting files from a compilation. */
-
- /* Interop Constraints */
- "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
- "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
- "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
-
- /* Type Checking */
- "strict": true, /* Enable all strict type-checking options. */
-
- /* Completeness */
- //"skipLibCheck": true /* Skip type checking all .d.ts files. */
- },
- "exclude": [
- "coverage"
- ]
+ "extends": "@ljharb/tsconfig",
+ "compilerOptions": {
+ "target": "ES2017",
+ "moduleResolution": "node",
+ "maxNodeModuleJsDepth": 0,
+ },
+ "exclude": [
+ "coverage",
+ ],
}
From d5ab2ccf4da82f6bc7a7daa586cea3fa1171d527 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 10 Mar 2024 22:56:37 -0700
Subject: [PATCH 095/199] [Docs] run `npm run update:eslint-docs
---
README.md | 2 +-
docs/rules/no-empty-named-blocks.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 1baa0069b3..d6f107d1c9 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
⌨️ Set in the `typescript` configuration.\
🚸 Set in the `warnings` configuration.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
-💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
❌ Deprecated.
### Helpful warnings
diff --git a/docs/rules/no-empty-named-blocks.md b/docs/rules/no-empty-named-blocks.md
index 85821d8afe..ad83c535f8 100644
--- a/docs/rules/no-empty-named-blocks.md
+++ b/docs/rules/no-empty-named-blocks.md
@@ -1,6 +1,6 @@
# import/no-empty-named-blocks
-🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
<!-- end auto-generated rule header -->
From 51185dd347a7c83904743433592b2f74d73e709d Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Wed, 13 Mar 2024 18:32:47 +0200
Subject: [PATCH 096/199] [Refactor] `ExportMap`: make procedures static
instead of monkeypatching exportmap
---
CHANGELOG.md | 2 +
src/ExportMap.js | 908 +++++++++++++++++++++++------------------------
2 files changed, 456 insertions(+), 454 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 06cdb922e5..9552774dce 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
- [`no-unused-modules`]: add console message to help debug [#2866]
+- [Refactor] `ExportMap`: make procedures static instead of monkeypatching exportmap ([#2982], thanks [@soryy708])
## [2.29.1] - 2023-12-14
@@ -1108,6 +1109,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2982]: https://github.com/import-js/eslint-plugin-import/pull/2982
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
diff --git a/src/ExportMap.js b/src/ExportMap.js
index f61d3c170a..9ee65a504f 100644
--- a/src/ExportMap.js
+++ b/src/ExportMap.js
@@ -26,6 +26,97 @@ const log = debug('eslint-plugin-import:ExportMap');
const exportCache = new Map();
const tsconfigCache = new Map();
+/**
+ * parse docs from the first node that has leading comments
+ */
+function captureDoc(source, docStyleParsers, ...nodes) {
+ const metadata = {};
+
+ // 'some' short-circuits on first 'true'
+ nodes.some((n) => {
+ try {
+
+ let leadingComments;
+
+ // n.leadingComments is legacy `attachComments` behavior
+ if ('leadingComments' in n) {
+ leadingComments = n.leadingComments;
+ } else if (n.range) {
+ leadingComments = source.getCommentsBefore(n);
+ }
+
+ if (!leadingComments || leadingComments.length === 0) { return false; }
+
+ for (const name in docStyleParsers) {
+ const doc = docStyleParsers[name](leadingComments);
+ if (doc) {
+ metadata.doc = doc;
+ }
+ }
+
+ return true;
+ } catch (err) {
+ return false;
+ }
+ });
+
+ return metadata;
+}
+
+/**
+ * parse JSDoc from leading comments
+ * @param {object[]} comments
+ * @return {{ doc: object }}
+ */
+function captureJsDoc(comments) {
+ let doc;
+
+ // capture XSDoc
+ comments.forEach((comment) => {
+ // skip non-block comments
+ if (comment.type !== 'Block') { return; }
+ try {
+ doc = doctrine.parse(comment.value, { unwrap: true });
+ } catch (err) {
+ /* don't care, for now? maybe add to `errors?` */
+ }
+ });
+
+ return doc;
+}
+
+/**
+ * parse TomDoc section from comments
+ */
+function captureTomDoc(comments) {
+ // collect lines up to first paragraph break
+ const lines = [];
+ for (let i = 0; i < comments.length; i++) {
+ const comment = comments[i];
+ if (comment.value.match(/^\s*$/)) { break; }
+ lines.push(comment.value.trim());
+ }
+
+ // return doctrine-like object
+ const statusMatch = lines.join(' ').match(/^(Public|Internal|Deprecated):\s*(.+)/);
+ if (statusMatch) {
+ return {
+ description: statusMatch[2],
+ tags: [{
+ title: statusMatch[1].toLowerCase(),
+ description: statusMatch[2],
+ }],
+ };
+ }
+}
+
+const availableDocStyleParsers = {
+ jsdoc: captureJsDoc,
+ tomdoc: captureTomDoc,
+};
+
+const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
+
export default class ExportMap {
constructor(path) {
this.path = path;
@@ -203,534 +294,443 @@ export default class ExportMap {
message: `Parse errors in imported module '${declaration.source.value}': ${msg}`,
});
}
-}
-/**
- * parse docs from the first node that has leading comments
- */
-function captureDoc(source, docStyleParsers, ...nodes) {
- const metadata = {};
+ static get(source, context) {
+ const path = resolve(source, context);
+ if (path == null) { return null; }
- // 'some' short-circuits on first 'true'
- nodes.some((n) => {
- try {
+ return ExportMap.for(childContext(path, context));
+ }
- let leadingComments;
+ static for(context) {
+ const { path } = context;
- // n.leadingComments is legacy `attachComments` behavior
- if ('leadingComments' in n) {
- leadingComments = n.leadingComments;
- } else if (n.range) {
- leadingComments = source.getCommentsBefore(n);
- }
+ const cacheKey = context.cacheKey || hashObject(context).digest('hex');
+ let exportMap = exportCache.get(cacheKey);
- if (!leadingComments || leadingComments.length === 0) { return false; }
+ // return cached ignore
+ if (exportMap === null) { return null; }
- for (const name in docStyleParsers) {
- const doc = docStyleParsers[name](leadingComments);
- if (doc) {
- metadata.doc = doc;
- }
+ const stats = fs.statSync(path);
+ if (exportMap != null) {
+ // date equality check
+ if (exportMap.mtime - stats.mtime === 0) {
+ return exportMap;
}
-
- return true;
- } catch (err) {
- return false;
+ // future: check content equality?
}
- });
-
- return metadata;
-}
-
-const availableDocStyleParsers = {
- jsdoc: captureJsDoc,
- tomdoc: captureTomDoc,
-};
-
-/**
- * parse JSDoc from leading comments
- * @param {object[]} comments
- * @return {{ doc: object }}
- */
-function captureJsDoc(comments) {
- let doc;
- // capture XSDoc
- comments.forEach((comment) => {
- // skip non-block comments
- if (comment.type !== 'Block') { return; }
- try {
- doc = doctrine.parse(comment.value, { unwrap: true });
- } catch (err) {
- /* don't care, for now? maybe add to `errors?` */
+ // check valid extensions first
+ if (!hasValidExtension(path, context)) {
+ exportCache.set(cacheKey, null);
+ return null;
}
- });
-
- return doc;
-}
-
-/**
- * parse TomDoc section from comments
- */
-function captureTomDoc(comments) {
- // collect lines up to first paragraph break
- const lines = [];
- for (let i = 0; i < comments.length; i++) {
- const comment = comments[i];
- if (comment.value.match(/^\s*$/)) { break; }
- lines.push(comment.value.trim());
- }
-
- // return doctrine-like object
- const statusMatch = lines.join(' ').match(/^(Public|Internal|Deprecated):\s*(.+)/);
- if (statusMatch) {
- return {
- description: statusMatch[2],
- tags: [{
- title: statusMatch[1].toLowerCase(),
- description: statusMatch[2],
- }],
- };
- }
-}
-
-const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
-
-ExportMap.get = function (source, context) {
- const path = resolve(source, context);
- if (path == null) { return null; }
-
- return ExportMap.for(childContext(path, context));
-};
-
-ExportMap.for = function (context) {
- const { path } = context;
-
- const cacheKey = context.cacheKey || hashObject(context).digest('hex');
- let exportMap = exportCache.get(cacheKey);
- // return cached ignore
- if (exportMap === null) { return null; }
-
- const stats = fs.statSync(path);
- if (exportMap != null) {
- // date equality check
- if (exportMap.mtime - stats.mtime === 0) {
- return exportMap;
+ // check for and cache ignore
+ if (isIgnored(path, context)) {
+ log('ignored path due to ignore settings:', path);
+ exportCache.set(cacheKey, null);
+ return null;
}
- // future: check content equality?
- }
-
- // check valid extensions first
- if (!hasValidExtension(path, context)) {
- exportCache.set(cacheKey, null);
- return null;
- }
- // check for and cache ignore
- if (isIgnored(path, context)) {
- log('ignored path due to ignore settings:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
-
- const content = fs.readFileSync(path, { encoding: 'utf8' });
-
- // check for and cache unambiguous modules
- if (!unambiguous.test(content)) {
- log('ignored path due to unambiguous regex:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
+ const content = fs.readFileSync(path, { encoding: 'utf8' });
- log('cache miss', cacheKey, 'for path', path);
- exportMap = ExportMap.parse(path, content, context);
+ // check for and cache unambiguous modules
+ if (!unambiguous.test(content)) {
+ log('ignored path due to unambiguous regex:', path);
+ exportCache.set(cacheKey, null);
+ return null;
+ }
- // ambiguous modules return null
- if (exportMap == null) {
- log('ignored path due to ambiguous parse:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
+ log('cache miss', cacheKey, 'for path', path);
+ exportMap = ExportMap.parse(path, content, context);
- exportMap.mtime = stats.mtime;
+ // ambiguous modules return null
+ if (exportMap == null) {
+ log('ignored path due to ambiguous parse:', path);
+ exportCache.set(cacheKey, null);
+ return null;
+ }
- exportCache.set(cacheKey, exportMap);
- return exportMap;
-};
+ exportMap.mtime = stats.mtime;
-ExportMap.parse = function (path, content, context) {
- const m = new ExportMap(path);
- const isEsModuleInteropTrue = isEsModuleInterop();
-
- let ast;
- let visitorKeys;
- try {
- const result = parse(path, content, context);
- ast = result.ast;
- visitorKeys = result.visitorKeys;
- } catch (err) {
- m.errors.push(err);
- return m; // can't continue
+ exportCache.set(cacheKey, exportMap);
+ return exportMap;
}
- m.visitorKeys = visitorKeys;
-
- let hasDynamicImports = false;
+ static parse(path, content, context) {
+ const m = new ExportMap(path);
+ const isEsModuleInteropTrue = isEsModuleInterop();
- function processDynamicImport(source) {
- hasDynamicImports = true;
- if (source.type !== 'Literal') {
- return null;
- }
- const p = remotePath(source.value);
- if (p == null) {
- return null;
+ let ast;
+ let visitorKeys;
+ try {
+ const result = parse(path, content, context);
+ ast = result.ast;
+ visitorKeys = result.visitorKeys;
+ } catch (err) {
+ m.errors.push(err);
+ return m; // can't continue
}
- const importedSpecifiers = new Set();
- importedSpecifiers.add('ImportNamespaceSpecifier');
- const getter = thunkFor(p, context);
- m.imports.set(p, {
- getter,
- declarations: new Set([{
- source: {
- // capturing actual node reference holds full AST in memory!
- value: source.value,
- loc: source.loc,
- },
- importedSpecifiers,
- dynamic: true,
- }]),
- });
- }
- visit(ast, visitorKeys, {
- ImportExpression(node) {
- processDynamicImport(node.source);
- },
- CallExpression(node) {
- if (node.callee.type === 'Import') {
- processDynamicImport(node.arguments[0]);
- }
- },
- });
+ m.visitorKeys = visitorKeys;
- const unambiguouslyESM = unambiguous.isModule(ast);
- if (!unambiguouslyESM && !hasDynamicImports) { return null; }
+ let hasDynamicImports = false;
- const docstyle = context.settings && context.settings['import/docstyle'] || ['jsdoc'];
- const docStyleParsers = {};
- docstyle.forEach((style) => {
- docStyleParsers[style] = availableDocStyleParsers[style];
- });
+ function processDynamicImport(source) {
+ hasDynamicImports = true;
+ if (source.type !== 'Literal') {
+ return null;
+ }
+ const p = remotePath(source.value);
+ if (p == null) {
+ return null;
+ }
+ const importedSpecifiers = new Set();
+ importedSpecifiers.add('ImportNamespaceSpecifier');
+ const getter = thunkFor(p, context);
+ m.imports.set(p, {
+ getter,
+ declarations: new Set([{
+ source: {
+ // capturing actual node reference holds full AST in memory!
+ value: source.value,
+ loc: source.loc,
+ },
+ importedSpecifiers,
+ dynamic: true,
+ }]),
+ });
+ }
- // attempt to collect module doc
- if (ast.comments) {
- ast.comments.some((c) => {
- if (c.type !== 'Block') { return false; }
- try {
- const doc = doctrine.parse(c.value, { unwrap: true });
- if (doc.tags.some((t) => t.title === 'module')) {
- m.doc = doc;
- return true;
+ visit(ast, visitorKeys, {
+ ImportExpression(node) {
+ processDynamicImport(node.source);
+ },
+ CallExpression(node) {
+ if (node.callee.type === 'Import') {
+ processDynamicImport(node.arguments[0]);
}
- } catch (err) { /* ignore */ }
- return false;
+ },
});
- }
- const namespaces = new Map();
+ const unambiguouslyESM = unambiguous.isModule(ast);
+ if (!unambiguouslyESM && !hasDynamicImports) { return null; }
- function remotePath(value) {
- return resolve.relative(value, path, context.settings);
- }
+ const docstyle = context.settings && context.settings['import/docstyle'] || ['jsdoc'];
+ const docStyleParsers = {};
+ docstyle.forEach((style) => {
+ docStyleParsers[style] = availableDocStyleParsers[style];
+ });
- function resolveImport(value) {
- const rp = remotePath(value);
- if (rp == null) { return null; }
- return ExportMap.for(childContext(rp, context));
- }
+ // attempt to collect module doc
+ if (ast.comments) {
+ ast.comments.some((c) => {
+ if (c.type !== 'Block') { return false; }
+ try {
+ const doc = doctrine.parse(c.value, { unwrap: true });
+ if (doc.tags.some((t) => t.title === 'module')) {
+ m.doc = doc;
+ return true;
+ }
+ } catch (err) { /* ignore */ }
+ return false;
+ });
+ }
- function getNamespace(identifier) {
- if (!namespaces.has(identifier.name)) { return; }
+ const namespaces = new Map();
- return function () {
- return resolveImport(namespaces.get(identifier.name));
- };
- }
+ function remotePath(value) {
+ return resolve.relative(value, path, context.settings);
+ }
- function addNamespace(object, identifier) {
- const nsfn = getNamespace(identifier);
- if (nsfn) {
- Object.defineProperty(object, 'namespace', { get: nsfn });
+ function resolveImport(value) {
+ const rp = remotePath(value);
+ if (rp == null) { return null; }
+ return ExportMap.for(childContext(rp, context));
}
- return object;
- }
+ function getNamespace(identifier) {
+ if (!namespaces.has(identifier.name)) { return; }
- function processSpecifier(s, n, m) {
- const nsource = n.source && n.source.value;
- const exportMeta = {};
- let local;
-
- switch (s.type) {
- case 'ExportDefaultSpecifier':
- if (!nsource) { return; }
- local = 'default';
- break;
- case 'ExportNamespaceSpecifier':
- m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
- get() { return resolveImport(nsource); },
- }));
- return;
- case 'ExportAllDeclaration':
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.source.value));
- return;
- case 'ExportSpecifier':
- if (!n.source) {
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.local));
- return;
- }
- // else falls through
- default:
- local = s.local.name;
- break;
+ return function () {
+ return resolveImport(namespaces.get(identifier.name));
+ };
}
- // todo: JSDoc
- m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) });
- }
-
- function captureDependencyWithSpecifiers(n) {
- // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
- const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
- // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
- // shouldn't be considered to be just importing types
- let specifiersOnlyImportingTypes = n.specifiers.length > 0;
- const importedSpecifiers = new Set();
- n.specifiers.forEach((specifier) => {
- if (specifier.type === 'ImportSpecifier') {
- importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
- } else if (supportedImportTypes.has(specifier.type)) {
- importedSpecifiers.add(specifier.type);
+ function addNamespace(object, identifier) {
+ const nsfn = getNamespace(identifier);
+ if (nsfn) {
+ Object.defineProperty(object, 'namespace', { get: nsfn });
}
- // import { type Foo } (Flow); import { typeof Foo } (Flow)
- specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
- && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
- });
- captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, importedSpecifiers);
- }
+ return object;
+ }
- function captureDependency({ source }, isOnlyImportingTypes, importedSpecifiers = new Set()) {
- if (source == null) { return null; }
+ function processSpecifier(s, n, m) {
+ const nsource = n.source && n.source.value;
+ const exportMeta = {};
+ let local;
+
+ switch (s.type) {
+ case 'ExportDefaultSpecifier':
+ if (!nsource) { return; }
+ local = 'default';
+ break;
+ case 'ExportNamespaceSpecifier':
+ m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
+ get() { return resolveImport(nsource); },
+ }));
+ return;
+ case 'ExportAllDeclaration':
+ m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.source.value));
+ return;
+ case 'ExportSpecifier':
+ if (!n.source) {
+ m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.local));
+ return;
+ }
+ // else falls through
+ default:
+ local = s.local.name;
+ break;
+ }
- const p = remotePath(source.value);
- if (p == null) { return null; }
+ // todo: JSDoc
+ m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) });
+ }
- const declarationMetadata = {
- // capturing actual node reference holds full AST in memory!
- source: { value: source.value, loc: source.loc },
- isOnlyImportingTypes,
- importedSpecifiers,
- };
+ function captureDependencyWithSpecifiers(n) {
+ // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
+ const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
+ // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
+ // shouldn't be considered to be just importing types
+ let specifiersOnlyImportingTypes = n.specifiers.length > 0;
+ const importedSpecifiers = new Set();
+ n.specifiers.forEach((specifier) => {
+ if (specifier.type === 'ImportSpecifier') {
+ importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
+ } else if (supportedImportTypes.has(specifier.type)) {
+ importedSpecifiers.add(specifier.type);
+ }
- const existing = m.imports.get(p);
- if (existing != null) {
- existing.declarations.add(declarationMetadata);
- return existing.getter;
+ // import { type Foo } (Flow); import { typeof Foo } (Flow)
+ specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
+ && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
+ });
+ captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, importedSpecifiers);
}
- const getter = thunkFor(p, context);
- m.imports.set(p, { getter, declarations: new Set([declarationMetadata]) });
- return getter;
- }
+ function captureDependency({ source }, isOnlyImportingTypes, importedSpecifiers = new Set()) {
+ if (source == null) { return null; }
- const source = makeSourceCode(content, ast);
+ const p = remotePath(source.value);
+ if (p == null) { return null; }
- function readTsConfig(context) {
- const tsconfigInfo = tsConfigLoader({
- cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
- getEnv: (key) => process.env[key],
- });
- try {
- if (tsconfigInfo.tsConfigPath !== undefined) {
- // Projects not using TypeScript won't have `typescript` installed.
- if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
-
- const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
- return ts.parseJsonConfigFileContent(
- configFile.config,
- ts.sys,
- dirname(tsconfigInfo.tsConfigPath),
- );
- }
- } catch (e) {
- // Catch any errors
- }
+ const declarationMetadata = {
+ // capturing actual node reference holds full AST in memory!
+ source: { value: source.value, loc: source.loc },
+ isOnlyImportingTypes,
+ importedSpecifiers,
+ };
- return null;
- }
+ const existing = m.imports.get(p);
+ if (existing != null) {
+ existing.declarations.add(declarationMetadata);
+ return existing.getter;
+ }
- function isEsModuleInterop() {
- const cacheKey = hashObject({
- tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
- }).digest('hex');
- let tsConfig = tsconfigCache.get(cacheKey);
- if (typeof tsConfig === 'undefined') {
- tsConfig = readTsConfig(context);
- tsconfigCache.set(cacheKey, tsConfig);
+ const getter = thunkFor(p, context);
+ m.imports.set(p, { getter, declarations: new Set([declarationMetadata]) });
+ return getter;
}
- return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
- }
+ const source = makeSourceCode(content, ast);
- ast.body.forEach(function (n) {
- if (n.type === 'ExportDefaultDeclaration') {
- const exportMeta = captureDoc(source, docStyleParsers, n);
- if (n.declaration.type === 'Identifier') {
- addNamespace(exportMeta, n.declaration);
+ function readTsConfig(context) {
+ const tsconfigInfo = tsConfigLoader({
+ cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
+ getEnv: (key) => process.env[key],
+ });
+ try {
+ if (tsconfigInfo.tsConfigPath !== undefined) {
+ // Projects not using TypeScript won't have `typescript` installed.
+ if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
+
+ const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
+ return ts.parseJsonConfigFileContent(
+ configFile.config,
+ ts.sys,
+ dirname(tsconfigInfo.tsConfigPath),
+ );
+ }
+ } catch (e) {
+ // Catch any errors
}
- m.namespace.set('default', exportMeta);
- return;
- }
- if (n.type === 'ExportAllDeclaration') {
- const getter = captureDependency(n, n.exportKind === 'type');
- if (getter) { m.dependencies.add(getter); }
- if (n.exported) {
- processSpecifier(n, n.exported, m);
- }
- return;
+ return null;
}
- // capture namespaces in case of later export
- if (n.type === 'ImportDeclaration') {
- captureDependencyWithSpecifiers(n);
-
- const ns = n.specifiers.find((s) => s.type === 'ImportNamespaceSpecifier');
- if (ns) {
- namespaces.set(ns.local.name, n.source.value);
+ function isEsModuleInterop() {
+ const cacheKey = hashObject({
+ tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
+ }).digest('hex');
+ let tsConfig = tsconfigCache.get(cacheKey);
+ if (typeof tsConfig === 'undefined') {
+ tsConfig = readTsConfig(context);
+ tsconfigCache.set(cacheKey, tsConfig);
}
- return;
+
+ return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
}
- if (n.type === 'ExportNamedDeclaration') {
- captureDependencyWithSpecifiers(n);
-
- // capture declaration
- if (n.declaration != null) {
- switch (n.declaration.type) {
- case 'FunctionDeclaration':
- case 'ClassDeclaration':
- case 'TypeAlias': // flowtype with babel-eslint parser
- case 'InterfaceDeclaration':
- case 'DeclareFunction':
- case 'TSDeclareFunction':
- case 'TSEnumDeclaration':
- case 'TSTypeAliasDeclaration':
- case 'TSInterfaceDeclaration':
- case 'TSAbstractClassDeclaration':
- case 'TSModuleDeclaration':
- m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n));
- break;
- case 'VariableDeclaration':
- n.declaration.declarations.forEach((d) => {
- recursivePatternCapture(
- d.id,
- (id) => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n)),
- );
- });
- break;
- default:
+ ast.body.forEach(function (n) {
+ if (n.type === 'ExportDefaultDeclaration') {
+ const exportMeta = captureDoc(source, docStyleParsers, n);
+ if (n.declaration.type === 'Identifier') {
+ addNamespace(exportMeta, n.declaration);
}
+ m.namespace.set('default', exportMeta);
+ return;
}
- n.specifiers.forEach((s) => processSpecifier(s, n, m));
- }
+ if (n.type === 'ExportAllDeclaration') {
+ const getter = captureDependency(n, n.exportKind === 'type');
+ if (getter) { m.dependencies.add(getter); }
+ if (n.exported) {
+ processSpecifier(n, n.exported, m);
+ }
+ return;
+ }
- const exports = ['TSExportAssignment'];
- if (isEsModuleInteropTrue) {
- exports.push('TSNamespaceExportDeclaration');
- }
+ // capture namespaces in case of later export
+ if (n.type === 'ImportDeclaration') {
+ captureDependencyWithSpecifiers(n);
- // This doesn't declare anything, but changes what's being exported.
- if (includes(exports, n.type)) {
- const exportedName = n.type === 'TSNamespaceExportDeclaration'
- ? (n.id || n.name).name
- : n.expression && n.expression.name || n.expression.id && n.expression.id.name || null;
- const declTypes = [
- 'VariableDeclaration',
- 'ClassDeclaration',
- 'TSDeclareFunction',
- 'TSEnumDeclaration',
- 'TSTypeAliasDeclaration',
- 'TSInterfaceDeclaration',
- 'TSAbstractClassDeclaration',
- 'TSModuleDeclaration',
- ];
- const exportedDecls = ast.body.filter(({ type, id, declarations }) => includes(declTypes, type) && (
- id && id.name === exportedName || declarations && declarations.find((d) => d.id.name === exportedName)
- ));
- if (exportedDecls.length === 0) {
- // Export is not referencing any local declaration, must be re-exporting
- m.namespace.set('default', captureDoc(source, docStyleParsers, n));
+ const ns = n.specifiers.find((s) => s.type === 'ImportNamespaceSpecifier');
+ if (ns) {
+ namespaces.set(ns.local.name, n.source.value);
+ }
return;
}
- if (
- isEsModuleInteropTrue // esModuleInterop is on in tsconfig
- && !m.namespace.has('default') // and default isn't added already
- ) {
- m.namespace.set('default', {}); // add default export
- }
- exportedDecls.forEach((decl) => {
- if (decl.type === 'TSModuleDeclaration') {
- if (decl.body && decl.body.type === 'TSModuleDeclaration') {
- m.namespace.set(decl.body.id.name, captureDoc(source, docStyleParsers, decl.body));
- } else if (decl.body && decl.body.body) {
- decl.body.body.forEach((moduleBlockNode) => {
- // Export-assignment exports all members in the namespace,
- // explicitly exported or not.
- const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration'
- ? moduleBlockNode.declaration
- : moduleBlockNode;
-
- if (!namespaceDecl) {
- // TypeScript can check this for us; we needn't
- } else if (namespaceDecl.type === 'VariableDeclaration') {
- namespaceDecl.declarations.forEach((d) => recursivePatternCapture(d.id, (id) => m.namespace.set(
- id.name,
- captureDoc(source, docStyleParsers, decl, namespaceDecl, moduleBlockNode),
- )),
+
+ if (n.type === 'ExportNamedDeclaration') {
+ captureDependencyWithSpecifiers(n);
+
+ // capture declaration
+ if (n.declaration != null) {
+ switch (n.declaration.type) {
+ case 'FunctionDeclaration':
+ case 'ClassDeclaration':
+ case 'TypeAlias': // flowtype with babel-eslint parser
+ case 'InterfaceDeclaration':
+ case 'DeclareFunction':
+ case 'TSDeclareFunction':
+ case 'TSEnumDeclaration':
+ case 'TSTypeAliasDeclaration':
+ case 'TSInterfaceDeclaration':
+ case 'TSAbstractClassDeclaration':
+ case 'TSModuleDeclaration':
+ m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n));
+ break;
+ case 'VariableDeclaration':
+ n.declaration.declarations.forEach((d) => {
+ recursivePatternCapture(
+ d.id,
+ (id) => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n)),
);
- } else {
- m.namespace.set(
- namespaceDecl.id.name,
- captureDoc(source, docStyleParsers, moduleBlockNode));
- }
- });
+ });
+ break;
+ default:
}
- } else {
- // Export as default
- m.namespace.set('default', captureDoc(source, docStyleParsers, decl));
}
- });
- }
- });
- if (
- isEsModuleInteropTrue // esModuleInterop is on in tsconfig
- && m.namespace.size > 0 // anything is exported
- && !m.namespace.has('default') // and default isn't added already
- ) {
- m.namespace.set('default', {}); // add default export
- }
+ n.specifiers.forEach((s) => processSpecifier(s, n, m));
+ }
+
+ const exports = ['TSExportAssignment'];
+ if (isEsModuleInteropTrue) {
+ exports.push('TSNamespaceExportDeclaration');
+ }
+
+ // This doesn't declare anything, but changes what's being exported.
+ if (includes(exports, n.type)) {
+ const exportedName = n.type === 'TSNamespaceExportDeclaration'
+ ? (n.id || n.name).name
+ : n.expression && n.expression.name || n.expression.id && n.expression.id.name || null;
+ const declTypes = [
+ 'VariableDeclaration',
+ 'ClassDeclaration',
+ 'TSDeclareFunction',
+ 'TSEnumDeclaration',
+ 'TSTypeAliasDeclaration',
+ 'TSInterfaceDeclaration',
+ 'TSAbstractClassDeclaration',
+ 'TSModuleDeclaration',
+ ];
+ const exportedDecls = ast.body.filter(({ type, id, declarations }) => includes(declTypes, type) && (
+ id && id.name === exportedName || declarations && declarations.find((d) => d.id.name === exportedName)
+ ));
+ if (exportedDecls.length === 0) {
+ // Export is not referencing any local declaration, must be re-exporting
+ m.namespace.set('default', captureDoc(source, docStyleParsers, n));
+ return;
+ }
+ if (
+ isEsModuleInteropTrue // esModuleInterop is on in tsconfig
+ && !m.namespace.has('default') // and default isn't added already
+ ) {
+ m.namespace.set('default', {}); // add default export
+ }
+ exportedDecls.forEach((decl) => {
+ if (decl.type === 'TSModuleDeclaration') {
+ if (decl.body && decl.body.type === 'TSModuleDeclaration') {
+ m.namespace.set(decl.body.id.name, captureDoc(source, docStyleParsers, decl.body));
+ } else if (decl.body && decl.body.body) {
+ decl.body.body.forEach((moduleBlockNode) => {
+ // Export-assignment exports all members in the namespace,
+ // explicitly exported or not.
+ const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration'
+ ? moduleBlockNode.declaration
+ : moduleBlockNode;
+
+ if (!namespaceDecl) {
+ // TypeScript can check this for us; we needn't
+ } else if (namespaceDecl.type === 'VariableDeclaration') {
+ namespaceDecl.declarations.forEach((d) => recursivePatternCapture(d.id, (id) => m.namespace.set(
+ id.name,
+ captureDoc(source, docStyleParsers, decl, namespaceDecl, moduleBlockNode),
+ )),
+ );
+ } else {
+ m.namespace.set(
+ namespaceDecl.id.name,
+ captureDoc(source, docStyleParsers, moduleBlockNode));
+ }
+ });
+ }
+ } else {
+ // Export as default
+ m.namespace.set('default', captureDoc(source, docStyleParsers, decl));
+ }
+ });
+ }
+ });
- if (unambiguouslyESM) {
- m.parseGoal = 'Module';
+ if (
+ isEsModuleInteropTrue // esModuleInterop is on in tsconfig
+ && m.namespace.size > 0 // anything is exported
+ && !m.namespace.has('default') // and default isn't added already
+ ) {
+ m.namespace.set('default', {}); // add default export
+ }
+
+ if (unambiguouslyESM) {
+ m.parseGoal = 'Module';
+ }
+ return m;
}
- return m;
-};
+}
/**
* The creation of this closure is isolated from other scopes
From 2d38b3367e90df2eabd6c6aad0a05d6a1fc96734 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 13 Mar 2024 14:23:09 -0700
Subject: [PATCH 097/199] [resolvers] [*] [refactor] avoid hoisting
---
resolvers/node/index.js | 40 +--
resolvers/webpack/index.js | 588 ++++++++++++++++++-------------------
2 files changed, 314 insertions(+), 314 deletions(-)
diff --git a/resolvers/node/index.js b/resolvers/node/index.js
index 7f207fbf31..9e0e753cc7 100644
--- a/resolvers/node/index.js
+++ b/resolvers/node/index.js
@@ -8,26 +8,6 @@ const log = require('debug')('eslint-plugin-import:resolver:node');
exports.interfaceVersion = 2;
-exports.resolve = function (source, file, config) {
- log('Resolving:', source, 'from:', file);
- let resolvedPath;
-
- if (isCoreModule(source)) {
- log('resolved to core');
- return { found: true, path: null };
- }
-
- try {
- const cachedFilter = function (pkg, dir) { return packageFilter(pkg, dir, config); };
- resolvedPath = resolve(source, opts(file, config, cachedFilter));
- log('Resolved to:', resolvedPath);
- return { found: true, path: resolvedPath };
- } catch (err) {
- log('resolve threw error:', err);
- return { found: false };
- }
-};
-
function opts(file, config, packageFilter) {
return Object.assign({ // more closely matches Node (#333)
// plus 'mjs' for native modules! (#939)
@@ -64,3 +44,23 @@ function packageFilter(pkg, dir, config) {
}
return pkg;
}
+
+exports.resolve = function (source, file, config) {
+ log('Resolving:', source, 'from:', file);
+ let resolvedPath;
+
+ if (isCoreModule(source)) {
+ log('resolved to core');
+ return { found: true, path: null };
+ }
+
+ try {
+ const cachedFilter = function (pkg, dir) { return packageFilter(pkg, dir, config); };
+ resolvedPath = resolve(source, opts(file, config, cachedFilter));
+ log('Resolved to:', resolvedPath);
+ return { found: true, path: resolvedPath };
+ } catch (err) {
+ log('resolve threw error:', err);
+ return { found: false };
+ }
+};
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 3ca2874dd8..da16eda593 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -16,203 +16,133 @@ const log = require('debug')('eslint-plugin-import:resolver:webpack');
exports.interfaceVersion = 2;
-/**
- * Find the full path to 'source', given 'file' as a full reference path.
- *
- * resolveImport('./foo', '/Users/ben/bar.js') => '/Users/ben/foo.js'
- * @param {string} source - the module to resolve; i.e './some-module'
- * @param {string} file - the importing file's full path; i.e. '/usr/local/bin/file.js'
- * @param {object} settings - the webpack config file name, as well as cwd
- * @example
- * options: {
- * // Path to the webpack config
- * config: 'webpack.config.js',
- * // Path to be used to determine where to resolve webpack from
- * // (may differ from the cwd in some cases)
- * cwd: process.cwd()
- * }
- * @return {string?} the resolved path to source, undefined if not resolved, or null
- * if resolved to a non-FS resource (i.e. script tag at page load)
- */
-exports.resolve = function (source, file, settings) {
-
- // strip loaders
- const finalBang = source.lastIndexOf('!');
- if (finalBang >= 0) {
- source = source.slice(finalBang + 1);
- }
-
- // strip resource query
- const finalQuestionMark = source.lastIndexOf('?');
- if (finalQuestionMark >= 0) {
- source = source.slice(0, finalQuestionMark);
- }
-
- let webpackConfig;
-
- const _configPath = settings && settings.config;
- /**
- * Attempt to set the current working directory.
- * If none is passed, default to the `cwd` where the config is located.
- */
- const cwd = settings && settings.cwd;
- const configIndex = settings && settings['config-index'];
- const env = settings && settings.env;
- const argv = settings && typeof settings.argv !== 'undefined' ? settings.argv : {};
- let packageDir;
-
- let configPath = typeof _configPath === 'string' && _configPath.startsWith('.')
- ? path.resolve(_configPath)
- : _configPath;
-
- log('Config path from settings:', configPath);
-
- // see if we've got a config path, a config object, an array of config objects or a config function
- if (!configPath || typeof configPath === 'string') {
-
- // see if we've got an absolute path
- if (!configPath || !path.isAbsolute(configPath)) {
- // if not, find ancestral package.json and use its directory as base for the path
- packageDir = findRoot(path.resolve(file));
- if (!packageDir) { throw new Error('package not found above ' + file); }
- }
-
- configPath = findConfigPath(configPath, packageDir);
-
- log('Config path resolved to:', configPath);
- if (configPath) {
- try {
- webpackConfig = require(configPath);
- } catch (e) {
- console.log('Error resolving webpackConfig', e);
- throw e;
- }
+function registerCompiler(moduleDescriptor) {
+ if (moduleDescriptor) {
+ if (typeof moduleDescriptor === 'string') {
+ require(moduleDescriptor);
+ } else if (!Array.isArray(moduleDescriptor)) {
+ moduleDescriptor.register(require(moduleDescriptor.module));
} else {
- log('No config path found relative to', file, '; using {}');
- webpackConfig = {};
- }
-
- if (webpackConfig && webpackConfig.default) {
- log('Using ES6 module "default" key instead of module.exports.');
- webpackConfig = webpackConfig.default;
+ for (let i = 0; i < moduleDescriptor.length; i++) {
+ try {
+ registerCompiler(moduleDescriptor[i]);
+ break;
+ } catch (e) {
+ log('Failed to register compiler for moduleDescriptor[]:', i, moduleDescriptor);
+ }
+ }
}
-
- } else {
- webpackConfig = configPath;
- configPath = null;
}
+}
- if (typeof webpackConfig === 'function') {
- webpackConfig = webpackConfig(env, argv);
- }
+function findConfigPath(configPath, packageDir) {
+ const extensions = Object.keys(interpret.extensions).sort(function (a, b) {
+ return a === '.js' ? -1 : b === '.js' ? 1 : a.length - b.length;
+ });
+ let extension;
- if (Array.isArray(webpackConfig)) {
- webpackConfig = webpackConfig.map((cfg) => {
- if (typeof cfg === 'function') {
- return cfg(env, argv);
+ if (configPath) {
+ // extensions is not reused below, so safe to mutate it here.
+ extensions.reverse();
+ extensions.forEach(function (maybeExtension) {
+ if (extension) {
+ return;
}
- return cfg;
+ if (configPath.substr(-maybeExtension.length) === maybeExtension) {
+ extension = maybeExtension;
+ }
});
- if (typeof configIndex !== 'undefined' && webpackConfig.length > configIndex) {
- webpackConfig = webpackConfig[configIndex];
- } else {
- webpackConfig = find(webpackConfig, function findFirstWithResolve(config) {
- return !!config.resolve;
- });
+ // see if we've got an absolute path
+ if (!path.isAbsolute(configPath)) {
+ configPath = path.join(packageDir, configPath);
}
- }
-
- if (typeof webpackConfig.then === 'function') {
- webpackConfig = {};
+ } else {
+ extensions.forEach(function (maybeExtension) {
+ if (extension) {
+ return;
+ }
- console.warn('Webpack config returns a `Promise`; that signature is not supported at the moment. Using empty object instead.');
+ const maybePath = path.resolve(
+ path.join(packageDir, 'webpack.config' + maybeExtension)
+ );
+ if (fs.existsSync(maybePath)) {
+ configPath = maybePath;
+ extension = maybeExtension;
+ }
+ });
}
- if (webpackConfig == null) {
- webpackConfig = {};
-
- console.warn('No webpack configuration with a "resolve" field found. Using empty object instead.');
- }
+ registerCompiler(interpret.extensions[extension]);
+ return configPath;
+}
- log('Using config: ', webpackConfig);
+function findExternal(source, externals, context, resolveSync) {
+ if (!externals) { return false; }
- const resolveSync = getResolveSync(configPath, webpackConfig, cwd);
+ // string match
+ if (typeof externals === 'string') { return source === externals; }
- // externals
- if (findExternal(source, webpackConfig.externals, path.dirname(file), resolveSync)) {
- return { found: true, path: null };
+ // array: recurse
+ if (Array.isArray(externals)) {
+ return externals.some(function (e) { return findExternal(source, e, context, resolveSync); });
}
- // otherwise, resolve "normally"
-
- try {
- return { found: true, path: resolveSync(path.dirname(file), source) };
- } catch (err) {
- if (isCore(source)) {
- return { found: true, path: null };
- }
-
- log('Error during module resolution:', err);
- return { found: false };
+ if (isRegex(externals)) {
+ return externals.test(source);
}
-};
-const MAX_CACHE = 10;
-const _cache = [];
-function getResolveSync(configPath, webpackConfig, cwd) {
- const cacheKey = { configPath, webpackConfig };
- let cached = find(_cache, function (entry) { return isEqual(entry.key, cacheKey); });
- if (!cached) {
- cached = {
- key: cacheKey,
- value: createResolveSync(configPath, webpackConfig, cwd),
+ if (typeof externals === 'function') {
+ let functionExternalFound = false;
+ const callback = function (err, value) {
+ if (err) {
+ functionExternalFound = false;
+ } else {
+ functionExternalFound = findExternal(source, value, context, resolveSync);
+ }
};
- // put in front and pop last item
- if (_cache.unshift(cached) > MAX_CACHE) {
- _cache.pop();
+ // - for prior webpack 5, 'externals function' uses 3 arguments
+ // - for webpack 5, the count of arguments is less than 3
+ if (externals.length === 3) {
+ externals.call(null, context, source, callback);
+ } else {
+ const ctx = {
+ context,
+ request: source,
+ contextInfo: {
+ issuer: '',
+ issuerLayer: null,
+ compiler: '',
+ },
+ getResolve: () => (resolveContext, requestToResolve, cb) => {
+ if (cb) {
+ try {
+ cb(null, resolveSync(resolveContext, requestToResolve));
+ } catch (e) {
+ cb(e);
+ }
+ } else {
+ log('getResolve without callback not supported');
+ return Promise.reject(new Error('Not supported'));
+ }
+ },
+ };
+ const result = externals.call(null, ctx, callback);
+ // todo handling Promise object (using synchronous-promise package?)
+ if (result && typeof result.then === 'function') {
+ log('Asynchronous functions for externals not supported');
+ }
}
- }
- return cached.value;
-}
-
-function createResolveSync(configPath, webpackConfig, cwd) {
- let webpackRequire;
- let basedir = null;
-
- if (typeof configPath === 'string') {
- // This can be changed via the settings passed in when defining the resolver
- basedir = cwd || path.dirname(configPath);
- log(`Attempting to load webpack path from ${basedir}`);
- }
-
- try {
- // Attempt to resolve webpack from the given `basedir`
- const webpackFilename = resolve('webpack', { basedir, preserveSymlinks: false });
- const webpackResolveOpts = { basedir: path.dirname(webpackFilename), preserveSymlinks: false };
-
- webpackRequire = function (id) {
- return require(resolve(id, webpackResolveOpts));
- };
- } catch (e) {
- // Something has gone wrong (or we're in a test). Use our own bundled
- // enhanced-resolve.
- log('Using bundled enhanced-resolve.');
- webpackRequire = require;
+ return functionExternalFound;
}
- const enhancedResolvePackage = webpackRequire('enhanced-resolve/package.json');
- const enhancedResolveVersion = enhancedResolvePackage.version;
- log('enhanced-resolve version:', enhancedResolveVersion);
-
- const resolveConfig = webpackConfig.resolve || {};
-
- if (semver.major(enhancedResolveVersion) >= 2) {
- return createWebpack2ResolveSync(webpackRequire, resolveConfig);
+ // else, vanilla object
+ for (const key in externals) {
+ if (!hasOwn(externals, key)) { continue; }
+ if (source === key) { return true; }
}
-
- return createWebpack1ResolveSync(webpackRequire, resolveConfig, webpackConfig.plugins);
+ return false;
}
/**
@@ -242,6 +172,22 @@ const webpack1DefaultMains = [
'webpack', 'browser', 'web', 'browserify', ['jam', 'main'], 'main',
];
+/* eslint-disable */
+// from https://github.com/webpack/webpack/blob/v1.13.0/lib/WebpackOptionsApply.js#L365
+function makeRootPlugin(ModulesInRootPlugin, name, root) {
+ if (typeof root === 'string') {
+ return new ModulesInRootPlugin(name, root);
+ } else if (Array.isArray(root)) {
+ return function() {
+ root.forEach(function (root) {
+ this.apply(new ModulesInRootPlugin(name, root));
+ }, this);
+ };
+ }
+ return function () {};
+}
+/* eslint-enable */
+
// adapted from tests &
// https://github.com/webpack/webpack/blob/v1.13.0/lib/WebpackOptionsApply.js#L322
function createWebpack1ResolveSync(webpackRequire, resolveConfig, plugins) {
@@ -298,154 +244,208 @@ function createWebpack1ResolveSync(webpackRequire, resolveConfig, plugins) {
});
}
- resolver.apply.apply(resolver, resolvePlugins);
-
- return function () {
- return resolver.resolveSync.apply(resolver, arguments);
- };
+ resolver.apply.apply(resolver, resolvePlugins);
+
+ return function () {
+ return resolver.resolveSync.apply(resolver, arguments);
+ };
+}
+
+function createResolveSync(configPath, webpackConfig, cwd) {
+ let webpackRequire;
+ let basedir = null;
+
+ if (typeof configPath === 'string') {
+ // This can be changed via the settings passed in when defining the resolver
+ basedir = cwd || path.dirname(configPath);
+ log(`Attempting to load webpack path from ${basedir}`);
+ }
+
+ try {
+ // Attempt to resolve webpack from the given `basedir`
+ const webpackFilename = resolve('webpack', { basedir, preserveSymlinks: false });
+ const webpackResolveOpts = { basedir: path.dirname(webpackFilename), preserveSymlinks: false };
+
+ webpackRequire = function (id) {
+ return require(resolve(id, webpackResolveOpts));
+ };
+ } catch (e) {
+ // Something has gone wrong (or we're in a test). Use our own bundled
+ // enhanced-resolve.
+ log('Using bundled enhanced-resolve.');
+ webpackRequire = require;
+ }
+
+ const enhancedResolvePackage = webpackRequire('enhanced-resolve/package.json');
+ const enhancedResolveVersion = enhancedResolvePackage.version;
+ log('enhanced-resolve version:', enhancedResolveVersion);
+
+ const resolveConfig = webpackConfig.resolve || {};
+
+ if (semver.major(enhancedResolveVersion) >= 2) {
+ return createWebpack2ResolveSync(webpackRequire, resolveConfig);
+ }
+
+ return createWebpack1ResolveSync(webpackRequire, resolveConfig, webpackConfig.plugins);
}
-/* eslint-disable */
-// from https://github.com/webpack/webpack/blob/v1.13.0/lib/WebpackOptionsApply.js#L365
-function makeRootPlugin(ModulesInRootPlugin, name, root) {
- if (typeof root === 'string') {
- return new ModulesInRootPlugin(name, root);
- } else if (Array.isArray(root)) {
- return function() {
- root.forEach(function (root) {
- this.apply(new ModulesInRootPlugin(name, root));
- }, this);
+const MAX_CACHE = 10;
+const _cache = [];
+function getResolveSync(configPath, webpackConfig, cwd) {
+ const cacheKey = { configPath, webpackConfig };
+ let cached = find(_cache, function (entry) { return isEqual(entry.key, cacheKey); });
+ if (!cached) {
+ cached = {
+ key: cacheKey,
+ value: createResolveSync(configPath, webpackConfig, cwd),
};
+ // put in front and pop last item
+ if (_cache.unshift(cached) > MAX_CACHE) {
+ _cache.pop();
+ }
}
- return function () {};
+ return cached.value;
}
-/* eslint-enable */
-function findExternal(source, externals, context, resolveSync) {
- if (!externals) { return false; }
-
- // string match
- if (typeof externals === 'string') { return source === externals; }
+/**
+ * Find the full path to 'source', given 'file' as a full reference path.
+ *
+ * resolveImport('./foo', '/Users/ben/bar.js') => '/Users/ben/foo.js'
+ * @param {string} source - the module to resolve; i.e './some-module'
+ * @param {string} file - the importing file's full path; i.e. '/usr/local/bin/file.js'
+ * @param {object} settings - the webpack config file name, as well as cwd
+ * @example
+ * options: {
+ * // Path to the webpack config
+ * config: 'webpack.config.js',
+ * // Path to be used to determine where to resolve webpack from
+ * // (may differ from the cwd in some cases)
+ * cwd: process.cwd()
+ * }
+ * @return {string?} the resolved path to source, undefined if not resolved, or null
+ * if resolved to a non-FS resource (i.e. script tag at page load)
+ */
+exports.resolve = function (source, file, settings) {
- // array: recurse
- if (Array.isArray(externals)) {
- return externals.some(function (e) { return findExternal(source, e, context, resolveSync); });
+ // strip loaders
+ const finalBang = source.lastIndexOf('!');
+ if (finalBang >= 0) {
+ source = source.slice(finalBang + 1);
}
- if (isRegex(externals)) {
- return externals.test(source);
+ // strip resource query
+ const finalQuestionMark = source.lastIndexOf('?');
+ if (finalQuestionMark >= 0) {
+ source = source.slice(0, finalQuestionMark);
}
- if (typeof externals === 'function') {
- let functionExternalFound = false;
- const callback = function (err, value) {
- if (err) {
- functionExternalFound = false;
- } else {
- functionExternalFound = findExternal(source, value, context, resolveSync);
+ let webpackConfig;
+
+ const _configPath = settings && settings.config;
+ /**
+ * Attempt to set the current working directory.
+ * If none is passed, default to the `cwd` where the config is located.
+ */
+ const cwd = settings && settings.cwd;
+ const configIndex = settings && settings['config-index'];
+ const env = settings && settings.env;
+ const argv = settings && typeof settings.argv !== 'undefined' ? settings.argv : {};
+ let packageDir;
+
+ let configPath = typeof _configPath === 'string' && _configPath.startsWith('.')
+ ? path.resolve(_configPath)
+ : _configPath;
+
+ log('Config path from settings:', configPath);
+
+ // see if we've got a config path, a config object, an array of config objects or a config function
+ if (!configPath || typeof configPath === 'string') {
+
+ // see if we've got an absolute path
+ if (!configPath || !path.isAbsolute(configPath)) {
+ // if not, find ancestral package.json and use its directory as base for the path
+ packageDir = findRoot(path.resolve(file));
+ if (!packageDir) { throw new Error('package not found above ' + file); }
+ }
+
+ configPath = findConfigPath(configPath, packageDir);
+
+ log('Config path resolved to:', configPath);
+ if (configPath) {
+ try {
+ webpackConfig = require(configPath);
+ } catch (e) {
+ console.log('Error resolving webpackConfig', e);
+ throw e;
}
- };
- // - for prior webpack 5, 'externals function' uses 3 arguments
- // - for webpack 5, the count of arguments is less than 3
- if (externals.length === 3) {
- externals.call(null, context, source, callback);
} else {
- const ctx = {
- context,
- request: source,
- contextInfo: {
- issuer: '',
- issuerLayer: null,
- compiler: '',
- },
- getResolve: () => (resolveContext, requestToResolve, cb) => {
- if (cb) {
- try {
- cb(null, resolveSync(resolveContext, requestToResolve));
- } catch (e) {
- cb(e);
- }
- } else {
- log('getResolve without callback not supported');
- return Promise.reject(new Error('Not supported'));
- }
- },
- };
- const result = externals.call(null, ctx, callback);
- // todo handling Promise object (using synchronous-promise package?)
- if (result && typeof result.then === 'function') {
- log('Asynchronous functions for externals not supported');
- }
+ log('No config path found relative to', file, '; using {}');
+ webpackConfig = {};
}
- return functionExternalFound;
- }
- // else, vanilla object
- for (const key in externals) {
- if (!hasOwn(externals, key)) { continue; }
- if (source === key) { return true; }
+ if (webpackConfig && webpackConfig.default) {
+ log('Using ES6 module "default" key instead of module.exports.');
+ webpackConfig = webpackConfig.default;
+ }
+
+ } else {
+ webpackConfig = configPath;
+ configPath = null;
}
- return false;
-}
-function findConfigPath(configPath, packageDir) {
- const extensions = Object.keys(interpret.extensions).sort(function (a, b) {
- return a === '.js' ? -1 : b === '.js' ? 1 : a.length - b.length;
- });
- let extension;
+ if (typeof webpackConfig === 'function') {
+ webpackConfig = webpackConfig(env, argv);
+ }
- if (configPath) {
- // extensions is not reused below, so safe to mutate it here.
- extensions.reverse();
- extensions.forEach(function (maybeExtension) {
- if (extension) {
- return;
+ if (Array.isArray(webpackConfig)) {
+ webpackConfig = webpackConfig.map((cfg) => {
+ if (typeof cfg === 'function') {
+ return cfg(env, argv);
}
- if (configPath.substr(-maybeExtension.length) === maybeExtension) {
- extension = maybeExtension;
- }
+ return cfg;
});
- // see if we've got an absolute path
- if (!path.isAbsolute(configPath)) {
- configPath = path.join(packageDir, configPath);
+ if (typeof configIndex !== 'undefined' && webpackConfig.length > configIndex) {
+ webpackConfig = webpackConfig[configIndex];
+ } else {
+ webpackConfig = find(webpackConfig, function findFirstWithResolve(config) {
+ return !!config.resolve;
+ });
}
- } else {
- extensions.forEach(function (maybeExtension) {
- if (extension) {
- return;
- }
+ }
- const maybePath = path.resolve(
- path.join(packageDir, 'webpack.config' + maybeExtension)
- );
- if (fs.existsSync(maybePath)) {
- configPath = maybePath;
- extension = maybeExtension;
- }
- });
+ if (typeof webpackConfig.then === 'function') {
+ webpackConfig = {};
+
+ console.warn('Webpack config returns a `Promise`; that signature is not supported at the moment. Using empty object instead.');
}
- registerCompiler(interpret.extensions[extension]);
- return configPath;
-}
+ if (webpackConfig == null) {
+ webpackConfig = {};
-function registerCompiler(moduleDescriptor) {
- if (moduleDescriptor) {
- if (typeof moduleDescriptor === 'string') {
- require(moduleDescriptor);
- } else if (!Array.isArray(moduleDescriptor)) {
- moduleDescriptor.register(require(moduleDescriptor.module));
- } else {
- for (let i = 0; i < moduleDescriptor.length; i++) {
- try {
- registerCompiler(moduleDescriptor[i]);
- break;
- } catch (e) {
- log('Failed to register compiler for moduleDescriptor[]:', i, moduleDescriptor);
- }
- }
+ console.warn('No webpack configuration with a "resolve" field found. Using empty object instead.');
+ }
+
+ log('Using config: ', webpackConfig);
+
+ const resolveSync = getResolveSync(configPath, webpackConfig, cwd);
+
+ // externals
+ if (findExternal(source, webpackConfig.externals, path.dirname(file), resolveSync)) {
+ return { found: true, path: null };
+ }
+
+ // otherwise, resolve "normally"
+
+ try {
+ return { found: true, path: resolveSync(path.dirname(file), source) };
+ } catch (err) {
+ if (isCore(source)) {
+ return { found: true, path: null };
}
+
+ log('Error during module resolution:', err);
+ return { found: false };
}
-}
+};
From 70ca58fac5d2b2c827caa06fb1925c623e3f4034 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 13 Mar 2024 14:23:38 -0700
Subject: [PATCH 098/199] [utils] [refactor] avoid hoisting
---
utils/ignore.js | 36 +++++++--------
utils/parse.js | 82 ++++++++++++++++-----------------
utils/resolve.js | 116 +++++++++++++++++++++++------------------------
3 files changed, 117 insertions(+), 117 deletions(-)
diff --git a/utils/ignore.js b/utils/ignore.js
index 59ac821eb8..56f2ef7239 100644
--- a/utils/ignore.js
+++ b/utils/ignore.js
@@ -10,17 +10,6 @@ const log = require('debug')('eslint-plugin-import:utils:ignore');
/** @type {Set<import('./types').Extension>} */ let cachedSet;
/** @type {import('./types').ESLintSettings} */ let lastSettings;
-/** @type {(context: import('eslint').Rule.RuleContext) => Set<import('./types').Extension>} */
-function validExtensions(context) {
- if (cachedSet && context.settings === lastSettings) {
- return cachedSet;
- }
-
- lastSettings = context.settings;
- cachedSet = makeValidExtensionSet(context.settings);
- return cachedSet;
-}
-
/** @type {import('./ignore').getFileExtensions} */
function makeValidExtensionSet(settings) {
// start with explicit JS-parsed extensions
@@ -42,6 +31,24 @@ function makeValidExtensionSet(settings) {
}
exports.getFileExtensions = makeValidExtensionSet;
+/** @type {(context: import('eslint').Rule.RuleContext) => Set<import('./types').Extension>} */
+function validExtensions(context) {
+ if (cachedSet && context.settings === lastSettings) {
+ return cachedSet;
+ }
+
+ lastSettings = context.settings;
+ cachedSet = makeValidExtensionSet(context.settings);
+ return cachedSet;
+}
+
+/** @type {import('./ignore').hasValidExtension} */
+function hasValidExtension(path, context) {
+ // eslint-disable-next-line no-extra-parens
+ return validExtensions(context).has(/** @type {import('./types').Extension} */ (extname(path)));
+}
+exports.hasValidExtension = hasValidExtension;
+
/** @type {import('./ignore').default} */
exports.default = function ignore(path, context) {
// check extension whitelist first (cheap)
@@ -60,10 +67,3 @@ exports.default = function ignore(path, context) {
return false;
};
-
-/** @type {import('./ignore').hasValidExtension} */
-function hasValidExtension(path, context) {
- // eslint-disable-next-line no-extra-parens
- return validExtensions(context).has(/** @type {import('./types').Extension} */ (extname(path)));
-}
-exports.hasValidExtension = hasValidExtension;
diff --git a/utils/parse.js b/utils/parse.js
index 804186ca97..94aca1d0f8 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -61,6 +61,47 @@ function transformHashbang(text) {
return text.replace(/^#!([^\r\n]+)/u, (_, captured) => `//${captured}`);
}
+/** @type {(path: string, context: import('eslint').Rule.RuleContext & { settings?: ESLintSettings }) => import('eslint').Rule.RuleContext['parserPath']} */
+function getParserPath(path, context) {
+ const parsers = context.settings['import/parsers'];
+ if (parsers != null) {
+ // eslint-disable-next-line no-extra-parens
+ const extension = /** @type {Extension} */ (extname(path));
+ for (const parserPath in parsers) {
+ if (parsers[parserPath].indexOf(extension) > -1) {
+ // use this alternate parser
+ log('using alt parser:', parserPath);
+ return parserPath;
+ }
+ }
+ }
+ // default to use ESLint parser
+ return context.parserPath;
+}
+
+/** @type {(path: string, context: import('eslint').Rule.RuleContext) => string | null | (import('eslint').Linter.ParserModule)} */
+function getParser(path, context) {
+ const parserPath = getParserPath(path, context);
+ if (parserPath) {
+ return parserPath;
+ }
+ if (
+ !!context.languageOptions
+ && !!context.languageOptions.parser
+ && typeof context.languageOptions.parser !== 'string'
+ && (
+ // @ts-expect-error TODO: figure out a better type
+ typeof context.languageOptions.parser.parse === 'function'
+ // @ts-expect-error TODO: figure out a better type
+ || typeof context.languageOptions.parser.parseForESLint === 'function'
+ )
+ ) {
+ return context.languageOptions.parser;
+ }
+
+ return null;
+}
+
/** @type {import('./parse').default} */
exports.default = function parse(path, content, context) {
if (context == null) { throw new Error('need context to parse properly'); }
@@ -131,44 +172,3 @@ exports.default = function parse(path, content, context) {
// @ts-expect-error TODO: FIXME
return makeParseReturn(ast, keysFromParser(parserOrPath, parser, undefined));
};
-
-/** @type {(path: string, context: import('eslint').Rule.RuleContext) => string | null | (import('eslint').Linter.ParserModule)} */
-function getParser(path, context) {
- const parserPath = getParserPath(path, context);
- if (parserPath) {
- return parserPath;
- }
- if (
- !!context.languageOptions
- && !!context.languageOptions.parser
- && typeof context.languageOptions.parser !== 'string'
- && (
- // @ts-expect-error TODO: figure out a better type
- typeof context.languageOptions.parser.parse === 'function'
- // @ts-expect-error TODO: figure out a better type
- || typeof context.languageOptions.parser.parseForESLint === 'function'
- )
- ) {
- return context.languageOptions.parser;
- }
-
- return null;
-}
-
-/** @type {(path: string, context: import('eslint').Rule.RuleContext & { settings?: ESLintSettings }) => import('eslint').Rule.RuleContext['parserPath']} */
-function getParserPath(path, context) {
- const parsers = context.settings['import/parsers'];
- if (parsers != null) {
- // eslint-disable-next-line no-extra-parens
- const extension = /** @type {Extension} */ (extname(path));
- for (const parserPath in parsers) {
- if (parsers[parserPath].indexOf(extension) > -1) {
- // use this alternate parser
- log('using alt parser:', parserPath);
- return parserPath;
- }
- }
- }
- // default to use ESLint parser
- return context.parserPath;
-}
diff --git a/utils/resolve.js b/utils/resolve.js
index 05f7b35abf..5a3084351e 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -34,6 +34,14 @@ const createRequire = Module.createRequire
return mod.exports;
};
+/** @type {(resolver: object) => resolver is import('./resolve').Resolver} */
+function isResolverValid(resolver) {
+ if ('interfaceVersion' in resolver && resolver.interfaceVersion === 2) {
+ return 'resolve' in resolver && !!resolver.resolve && typeof resolver.resolve === 'function';
+ }
+ return 'resolveImport' in resolver && !!resolver.resolveImport && typeof resolver.resolveImport === 'function';
+}
+
/** @type {<T extends string>(target: T, sourceFile?: string | null | undefined) => undefined | ReturnType<typeof require>} */
function tryRequire(target, sourceFile) {
let resolved;
@@ -57,6 +65,56 @@ function tryRequire(target, sourceFile) {
return require(resolved);
}
+/** @type {<T extends Map<string, unknown>>(resolvers: string[] | string | { [k: string]: string }, map: T) => T} */
+function resolverReducer(resolvers, map) {
+ if (Array.isArray(resolvers)) {
+ resolvers.forEach((r) => resolverReducer(r, map));
+ return map;
+ }
+
+ if (typeof resolvers === 'string') {
+ map.set(resolvers, null);
+ return map;
+ }
+
+ if (typeof resolvers === 'object') {
+ for (const key in resolvers) {
+ map.set(key, resolvers[key]);
+ }
+ return map;
+ }
+
+ const err = new Error('invalid resolver config');
+ err.name = ERROR_NAME;
+ throw err;
+}
+
+/** @type {(sourceFile: string) => string} */
+function getBaseDir(sourceFile) {
+ return pkgDir(sourceFile) || process.cwd();
+}
+
+/** @type {(name: string, sourceFile: string) => import('./resolve').Resolver} */
+function requireResolver(name, sourceFile) {
+ // Try to resolve package with conventional name
+ const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile)
+ || tryRequire(name, sourceFile)
+ || tryRequire(path.resolve(getBaseDir(sourceFile), name));
+
+ if (!resolver) {
+ const err = new Error(`unable to load resolver "${name}".`);
+ err.name = ERROR_NAME;
+ throw err;
+ }
+ if (!isResolverValid(resolver)) {
+ const err = new Error(`${name} with invalid interface loaded as resolver`);
+ err.name = ERROR_NAME;
+ throw err;
+ }
+
+ return resolver;
+}
+
// https://stackoverflow.com/a/27382838
/** @type {import('./resolve').fileExistsWithCaseSync} */
exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cacheSettings, strict) {
@@ -159,64 +217,6 @@ function relative(modulePath, sourceFile, settings) {
}
exports.relative = relative;
-/** @type {<T extends Map<string, unknown>>(resolvers: string[] | string | { [k: string]: string }, map: T) => T} */
-function resolverReducer(resolvers, map) {
- if (Array.isArray(resolvers)) {
- resolvers.forEach((r) => resolverReducer(r, map));
- return map;
- }
-
- if (typeof resolvers === 'string') {
- map.set(resolvers, null);
- return map;
- }
-
- if (typeof resolvers === 'object') {
- for (const key in resolvers) {
- map.set(key, resolvers[key]);
- }
- return map;
- }
-
- const err = new Error('invalid resolver config');
- err.name = ERROR_NAME;
- throw err;
-}
-
-/** @type {(sourceFile: string) => string} */
-function getBaseDir(sourceFile) {
- return pkgDir(sourceFile) || process.cwd();
-}
-
-/** @type {(name: string, sourceFile: string) => import('./resolve').Resolver} */
-function requireResolver(name, sourceFile) {
- // Try to resolve package with conventional name
- const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile)
- || tryRequire(name, sourceFile)
- || tryRequire(path.resolve(getBaseDir(sourceFile), name));
-
- if (!resolver) {
- const err = new Error(`unable to load resolver "${name}".`);
- err.name = ERROR_NAME;
- throw err;
- }
- if (!isResolverValid(resolver)) {
- const err = new Error(`${name} with invalid interface loaded as resolver`);
- err.name = ERROR_NAME;
- throw err;
- }
-
- return resolver;
-}
-
-/** @type {(resolver: object) => resolver is import('./resolve').Resolver} */
-function isResolverValid(resolver) {
- if ('interfaceVersion' in resolver && resolver.interfaceVersion === 2) {
- return 'resolve' in resolver && !!resolver.resolve && typeof resolver.resolve === 'function';
- }
- return 'resolveImport' in resolver && !!resolver.resolveImport && typeof resolver.resolveImport === 'function';
-}
-
/** @type {Set<import('eslint').Rule.RuleContext>} */
const erroredContexts = new Set();
From 2efdf79af9a543a4c4cb02265a56acc2b7ed0317 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 13 Mar 2024 14:23:50 -0700
Subject: [PATCH 099/199] [eslint] avoid hoisting
---
.eslintrc | 10 ++
src/core/importType.js | 49 +++++-----
src/core/packagePath.js | 8 +-
src/rules/no-cycle.js | 8 +-
src/rules/no-duplicates.js | 160 +++++++++++++++----------------
src/rules/no-namespace.js | 140 +++++++++++++--------------
src/rules/no-restricted-paths.js | 18 ++--
src/rules/order.js | 12 +--
tests/src/package.js | 14 +--
tests/src/utils.js | 8 +-
10 files changed, 216 insertions(+), 211 deletions(-)
diff --git a/.eslintrc b/.eslintrc
index ddf7bc5628..8dc0b2637a 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -96,6 +96,7 @@
"no-multiple-empty-lines": [2, { "max": 1, "maxEOF": 1, "maxBOF": 0 }],
"no-return-assign": [2, "always"],
"no-trailing-spaces": 2,
+ "no-use-before-define": [2, { "functions": true, "classes": true, "variables": true }],
"no-var": 2,
"object-curly-spacing": [2, "always"],
"object-shorthand": ["error", "always", {
@@ -225,6 +226,15 @@
"no-console": 1,
},
},
+ {
+ "files": [
+ "utils/**", // TODO
+ "src/ExportMap.js", // TODO
+ ],
+ "rules": {
+ "no-use-before-define": "off",
+ },
+ },
{
"files": [
"resolvers/*/test/**/*",
diff --git a/src/core/importType.js b/src/core/importType.js
index 6a37d1bb14..32e200f1de 100644
--- a/src/core/importType.js
+++ b/src/core/importType.js
@@ -4,6 +4,11 @@ import isCoreModule from 'is-core-module';
import resolve from 'eslint-module-utils/resolve';
import { getContextPackagePath } from './packagePath';
+const scopedRegExp = /^@[^/]+\/?[^/]+/;
+export function isScoped(name) {
+ return name && scopedRegExp.test(name);
+}
+
function baseModule(name) {
if (isScoped(name)) {
const [scope, pkg] = name.split('/');
@@ -30,20 +35,6 @@ export function isBuiltIn(name, settings, path) {
return isCoreModule(base) || extras.indexOf(base) > -1;
}
-export function isExternalModule(name, path, context) {
- if (arguments.length < 3) {
- throw new TypeError('isExternalModule: name, path, and context are all required');
- }
- return (isModule(name) || isScoped(name)) && typeTest(name, context, path) === 'external';
-}
-
-export function isExternalModuleMain(name, path, context) {
- if (arguments.length < 3) {
- throw new TypeError('isExternalModule: name, path, and context are all required');
- }
- return isModuleMain(name) && typeTest(name, context, path) === 'external';
-}
-
const moduleRegExp = /^\w/;
function isModule(name) {
return name && moduleRegExp.test(name);
@@ -54,20 +45,9 @@ function isModuleMain(name) {
return name && moduleMainRegExp.test(name);
}
-const scopedRegExp = /^@[^/]+\/?[^/]+/;
-export function isScoped(name) {
- return name && scopedRegExp.test(name);
-}
-
-const scopedMainRegExp = /^@[^/]+\/?[^/]+$/;
-export function isScopedMain(name) {
- return name && scopedMainRegExp.test(name);
-}
-
function isRelativeToParent(name) {
return (/^\.\.$|^\.\.[\\/]/).test(name);
}
-
const indexFiles = ['.', './', './index', './index.js'];
function isIndex(name) {
return indexFiles.indexOf(name) !== -1;
@@ -123,6 +103,25 @@ function typeTest(name, context, path) {
return 'unknown';
}
+export function isExternalModule(name, path, context) {
+ if (arguments.length < 3) {
+ throw new TypeError('isExternalModule: name, path, and context are all required');
+ }
+ return (isModule(name) || isScoped(name)) && typeTest(name, context, path) === 'external';
+}
+
+export function isExternalModuleMain(name, path, context) {
+ if (arguments.length < 3) {
+ throw new TypeError('isExternalModule: name, path, and context are all required');
+ }
+ return isModuleMain(name) && typeTest(name, context, path) === 'external';
+}
+
+const scopedMainRegExp = /^@[^/]+\/?[^/]+$/;
+export function isScopedMain(name) {
+ return name && scopedMainRegExp.test(name);
+}
+
export default function resolveImportType(name, context) {
return typeTest(name, context, resolve(name, context));
}
diff --git a/src/core/packagePath.js b/src/core/packagePath.js
index 1a7a28f4b4..142f44aa4d 100644
--- a/src/core/packagePath.js
+++ b/src/core/packagePath.js
@@ -2,15 +2,15 @@ import { dirname } from 'path';
import pkgUp from 'eslint-module-utils/pkgUp';
import readPkgUp from 'eslint-module-utils/readPkgUp';
-export function getContextPackagePath(context) {
- return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
-}
-
export function getFilePackagePath(filePath) {
const fp = pkgUp({ cwd: filePath });
return dirname(fp);
}
+export function getContextPackagePath(context) {
+ return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
+}
+
export function getFilePackageName(filePath) {
const { pkg, path } = readPkgUp({ cwd: filePath, normalize: false });
if (pkg) {
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index 5b9d8c0709..11c2f44fc0 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -11,6 +11,10 @@ import docsUrl from '../docsUrl';
const traversed = new Set();
+function routeString(route) {
+ return route.map((s) => `${s.value}:${s.loc.start.line}`).join('=>');
+}
+
module.exports = {
meta: {
type: 'suggestion',
@@ -151,7 +155,3 @@ module.exports = {
});
},
};
-
-function routeString(route) {
- return route.map((s) => `${s.value}:${s.loc.start.line}`).join('=>');
-}
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 6b4f4d559e..033e854e03 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -9,28 +9,68 @@ try {
typescriptPkg = require('typescript/package.json'); // eslint-disable-line import/no-extraneous-dependencies
} catch (e) { /**/ }
-function checkImports(imported, context) {
- for (const [module, nodes] of imported.entries()) {
- if (nodes.length > 1) {
- const message = `'${module}' imported multiple times.`;
- const [first, ...rest] = nodes;
- const sourceCode = context.getSourceCode();
- const fix = getFix(first, rest, sourceCode, context);
+function isPunctuator(node, value) {
+ return node.type === 'Punctuator' && node.value === value;
+}
- context.report({
- node: first.source,
- message,
- fix, // Attach the autofix (if any) to the first import.
- });
+// Get the name of the default import of `node`, if any.
+function getDefaultImportName(node) {
+ const defaultSpecifier = node.specifiers
+ .find((specifier) => specifier.type === 'ImportDefaultSpecifier');
+ return defaultSpecifier != null ? defaultSpecifier.local.name : undefined;
+}
- for (const node of rest) {
- context.report({
- node: node.source,
- message,
- });
- }
- }
- }
+// Checks whether `node` has a namespace import.
+function hasNamespace(node) {
+ const specifiers = node.specifiers
+ .filter((specifier) => specifier.type === 'ImportNamespaceSpecifier');
+ return specifiers.length > 0;
+}
+
+// Checks whether `node` has any non-default specifiers.
+function hasSpecifiers(node) {
+ const specifiers = node.specifiers
+ .filter((specifier) => specifier.type === 'ImportSpecifier');
+ return specifiers.length > 0;
+}
+
+// Checks whether `node` has a comment (that ends) on the previous line or on
+// the same line as `node` (starts).
+function hasCommentBefore(node, sourceCode) {
+ return sourceCode.getCommentsBefore(node)
+ .some((comment) => comment.loc.end.line >= node.loc.start.line - 1);
+}
+
+// Checks whether `node` has a comment (that starts) on the same line as `node`
+// (ends).
+function hasCommentAfter(node, sourceCode) {
+ return sourceCode.getCommentsAfter(node)
+ .some((comment) => comment.loc.start.line === node.loc.end.line);
+}
+
+// Checks whether `node` has any comments _inside,_ except inside the `{...}`
+// part (if any).
+function hasCommentInsideNonSpecifiers(node, sourceCode) {
+ const tokens = sourceCode.getTokens(node);
+ const openBraceIndex = tokens.findIndex((token) => isPunctuator(token, '{'));
+ const closeBraceIndex = tokens.findIndex((token) => isPunctuator(token, '}'));
+ // Slice away the first token, since we're no looking for comments _before_
+ // `node` (only inside). If there's a `{...}` part, look for comments before
+ // the `{`, but not before the `}` (hence the `+1`s).
+ const someTokens = openBraceIndex >= 0 && closeBraceIndex >= 0
+ ? tokens.slice(1, openBraceIndex + 1).concat(tokens.slice(closeBraceIndex + 1))
+ : tokens.slice(1);
+ return someTokens.some((token) => sourceCode.getCommentsBefore(token).length > 0);
+}
+
+// It's not obvious what the user wants to do with comments associated with
+// duplicate imports, so skip imports with comments when autofixing.
+function hasProblematicComments(node, sourceCode) {
+ return (
+ hasCommentBefore(node, sourceCode)
+ || hasCommentAfter(node, sourceCode)
+ || hasCommentInsideNonSpecifiers(node, sourceCode)
+ );
}
function getFix(first, rest, sourceCode, context) {
@@ -203,68 +243,28 @@ function getFix(first, rest, sourceCode, context) {
};
}
-function isPunctuator(node, value) {
- return node.type === 'Punctuator' && node.value === value;
-}
-
-// Get the name of the default import of `node`, if any.
-function getDefaultImportName(node) {
- const defaultSpecifier = node.specifiers
- .find((specifier) => specifier.type === 'ImportDefaultSpecifier');
- return defaultSpecifier != null ? defaultSpecifier.local.name : undefined;
-}
-
-// Checks whether `node` has a namespace import.
-function hasNamespace(node) {
- const specifiers = node.specifiers
- .filter((specifier) => specifier.type === 'ImportNamespaceSpecifier');
- return specifiers.length > 0;
-}
-
-// Checks whether `node` has any non-default specifiers.
-function hasSpecifiers(node) {
- const specifiers = node.specifiers
- .filter((specifier) => specifier.type === 'ImportSpecifier');
- return specifiers.length > 0;
-}
-
-// It's not obvious what the user wants to do with comments associated with
-// duplicate imports, so skip imports with comments when autofixing.
-function hasProblematicComments(node, sourceCode) {
- return (
- hasCommentBefore(node, sourceCode)
- || hasCommentAfter(node, sourceCode)
- || hasCommentInsideNonSpecifiers(node, sourceCode)
- );
-}
-
-// Checks whether `node` has a comment (that ends) on the previous line or on
-// the same line as `node` (starts).
-function hasCommentBefore(node, sourceCode) {
- return sourceCode.getCommentsBefore(node)
- .some((comment) => comment.loc.end.line >= node.loc.start.line - 1);
-}
+function checkImports(imported, context) {
+ for (const [module, nodes] of imported.entries()) {
+ if (nodes.length > 1) {
+ const message = `'${module}' imported multiple times.`;
+ const [first, ...rest] = nodes;
+ const sourceCode = context.getSourceCode();
+ const fix = getFix(first, rest, sourceCode, context);
-// Checks whether `node` has a comment (that starts) on the same line as `node`
-// (ends).
-function hasCommentAfter(node, sourceCode) {
- return sourceCode.getCommentsAfter(node)
- .some((comment) => comment.loc.start.line === node.loc.end.line);
-}
+ context.report({
+ node: first.source,
+ message,
+ fix, // Attach the autofix (if any) to the first import.
+ });
-// Checks whether `node` has any comments _inside,_ except inside the `{...}`
-// part (if any).
-function hasCommentInsideNonSpecifiers(node, sourceCode) {
- const tokens = sourceCode.getTokens(node);
- const openBraceIndex = tokens.findIndex((token) => isPunctuator(token, '{'));
- const closeBraceIndex = tokens.findIndex((token) => isPunctuator(token, '}'));
- // Slice away the first token, since we're no looking for comments _before_
- // `node` (only inside). If there's a `{...}` part, look for comments before
- // the `{`, but not before the `}` (hence the `+1`s).
- const someTokens = openBraceIndex >= 0 && closeBraceIndex >= 0
- ? tokens.slice(1, openBraceIndex + 1).concat(tokens.slice(closeBraceIndex + 1))
- : tokens.slice(1);
- return someTokens.some((token) => sourceCode.getCommentsBefore(token).length > 0);
+ for (const node of rest) {
+ context.report({
+ node: node.source,
+ message,
+ });
+ }
+ }
+ }
}
module.exports = {
diff --git a/src/rules/no-namespace.js b/src/rules/no-namespace.js
index d3e591876f..3c6617a41c 100644
--- a/src/rules/no-namespace.js
+++ b/src/rules/no-namespace.js
@@ -6,9 +6,74 @@
import minimatch from 'minimatch';
import docsUrl from '../docsUrl';
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
+/**
+ * @param {MemberExpression} memberExpression
+ * @returns {string} the name of the member in the object expression, e.g. the `x` in `namespace.x`
+ */
+function getMemberPropertyName(memberExpression) {
+ return memberExpression.property.type === 'Identifier'
+ ? memberExpression.property.name
+ : memberExpression.property.value;
+}
+
+/**
+ * @param {ScopeManager} scopeManager
+ * @param {ASTNode} node
+ * @return {Set<string>}
+ */
+function getVariableNamesInScope(scopeManager, node) {
+ let currentNode = node;
+ let scope = scopeManager.acquire(currentNode);
+ while (scope == null) {
+ currentNode = currentNode.parent;
+ scope = scopeManager.acquire(currentNode, true);
+ }
+ return new Set(scope.variables.concat(scope.upper.variables).map((variable) => variable.name));
+}
+
+/**
+ *
+ * @param {*} names
+ * @param {*} nameConflicts
+ * @param {*} namespaceName
+ */
+function generateLocalNames(names, nameConflicts, namespaceName) {
+ const localNames = {};
+ names.forEach((name) => {
+ let localName;
+ if (!nameConflicts[name].has(name)) {
+ localName = name;
+ } else if (!nameConflicts[name].has(`${namespaceName}_${name}`)) {
+ localName = `${namespaceName}_${name}`;
+ } else {
+ for (let i = 1; i < Infinity; i++) {
+ if (!nameConflicts[name].has(`${namespaceName}_${name}_${i}`)) {
+ localName = `${namespaceName}_${name}_${i}`;
+ break;
+ }
+ }
+ }
+ localNames[name] = localName;
+ });
+ return localNames;
+}
+
+/**
+ * @param {Identifier[]} namespaceIdentifiers
+ * @returns {boolean} `true` if the namespace variable is more than just a glorified constant
+ */
+function usesNamespaceAsObject(namespaceIdentifiers) {
+ return !namespaceIdentifiers.every((identifier) => {
+ const parent = identifier.parent;
+
+ // `namespace.x` or `namespace['x']`
+ return (
+ parent
+ && parent.type === 'MemberExpression'
+ && (parent.property.type === 'Identifier' || parent.property.type === 'Literal')
+ );
+ });
+}
module.exports = {
meta: {
@@ -103,72 +168,3 @@ module.exports = {
};
},
};
-
-/**
- * @param {Identifier[]} namespaceIdentifiers
- * @returns {boolean} `true` if the namespace variable is more than just a glorified constant
- */
-function usesNamespaceAsObject(namespaceIdentifiers) {
- return !namespaceIdentifiers.every((identifier) => {
- const parent = identifier.parent;
-
- // `namespace.x` or `namespace['x']`
- return (
- parent
- && parent.type === 'MemberExpression'
- && (parent.property.type === 'Identifier' || parent.property.type === 'Literal')
- );
- });
-}
-
-/**
- * @param {MemberExpression} memberExpression
- * @returns {string} the name of the member in the object expression, e.g. the `x` in `namespace.x`
- */
-function getMemberPropertyName(memberExpression) {
- return memberExpression.property.type === 'Identifier'
- ? memberExpression.property.name
- : memberExpression.property.value;
-}
-
-/**
- * @param {ScopeManager} scopeManager
- * @param {ASTNode} node
- * @return {Set<string>}
- */
-function getVariableNamesInScope(scopeManager, node) {
- let currentNode = node;
- let scope = scopeManager.acquire(currentNode);
- while (scope == null) {
- currentNode = currentNode.parent;
- scope = scopeManager.acquire(currentNode, true);
- }
- return new Set(scope.variables.concat(scope.upper.variables).map((variable) => variable.name));
-}
-
-/**
- *
- * @param {*} names
- * @param {*} nameConflicts
- * @param {*} namespaceName
- */
-function generateLocalNames(names, nameConflicts, namespaceName) {
- const localNames = {};
- names.forEach((name) => {
- let localName;
- if (!nameConflicts[name].has(name)) {
- localName = name;
- } else if (!nameConflicts[name].has(`${namespaceName}_${name}`)) {
- localName = `${namespaceName}_${name}`;
- } else {
- for (let i = 1; i < Infinity; i++) {
- if (!nameConflicts[name].has(`${namespaceName}_${name}_${i}`)) {
- localName = `${namespaceName}_${name}_${i}`;
- break;
- }
- }
- }
- localNames[name] = localName;
- });
- return localNames;
-}
diff --git a/src/rules/no-restricted-paths.js b/src/rules/no-restricted-paths.js
index cd680a1946..75952dd058 100644
--- a/src/rules/no-restricted-paths.js
+++ b/src/rules/no-restricted-paths.js
@@ -12,6 +12,15 @@ const containsPath = (filepath, target) => {
return relative === '' || !relative.startsWith('..');
};
+function isMatchingTargetPath(filename, targetPath) {
+ if (isGlob(targetPath)) {
+ const mm = new Minimatch(targetPath);
+ return mm.match(filename);
+ }
+
+ return containsPath(filename, targetPath);
+}
+
module.exports = {
meta: {
type: 'problem',
@@ -83,15 +92,6 @@ module.exports = {
.some((targetPath) => isMatchingTargetPath(currentFilename, targetPath)),
);
- function isMatchingTargetPath(filename, targetPath) {
- if (isGlob(targetPath)) {
- const mm = new Minimatch(targetPath);
- return mm.match(filename);
- }
-
- return containsPath(filename, targetPath);
- }
-
function isValidExceptionPath(absoluteFromPath, absoluteExceptionPath) {
const relativeExceptionPath = path.relative(absoluteFromPath, absoluteExceptionPath);
diff --git a/src/rules/order.js b/src/rules/order.js
index 44d25be63c..7071513bf3 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -92,6 +92,12 @@ function findRootNode(node) {
return parent;
}
+function commentOnSameLineAs(node) {
+ return (token) => (token.type === 'Block' || token.type === 'Line')
+ && token.loc.start.line === token.loc.end.line
+ && token.loc.end.line === node.loc.end.line;
+}
+
function findEndOfLineWithComments(sourceCode, node) {
const tokensToEndOfLine = takeTokensAfterWhile(sourceCode, node, commentOnSameLineAs(node));
const endOfTokens = tokensToEndOfLine.length > 0
@@ -111,12 +117,6 @@ function findEndOfLineWithComments(sourceCode, node) {
return result;
}
-function commentOnSameLineAs(node) {
- return (token) => (token.type === 'Block' || token.type === 'Line')
- && token.loc.start.line === token.loc.end.line
- && token.loc.end.line === node.loc.end.line;
-}
-
function findStartOfLineWithComments(sourceCode, node) {
const tokensToEndOfLine = takeTokensBeforeWhile(sourceCode, node, commentOnSameLineAs(node));
const startOfTokens = tokensToEndOfLine.length > 0 ? tokensToEndOfLine[0].range[0] : node.range[0];
diff --git a/tests/src/package.js b/tests/src/package.js
index 08138084c6..c56bd1333d 100644
--- a/tests/src/package.js
+++ b/tests/src/package.js
@@ -45,6 +45,13 @@ describe('package', function () {
});
});
+ function getRulePath(ruleName) {
+ // 'require' does not work with dynamic paths because of the compilation step by babel
+ // (which resolves paths according to the root folder configuration)
+ // the usage of require.resolve on a static path gets around this
+ return path.resolve(require.resolve('rules/no-unresolved'), '..', ruleName);
+ }
+
it('has configs only for rules that exist', function () {
for (const configFile in module.configs) {
const preamble = 'import/';
@@ -54,13 +61,6 @@ describe('package', function () {
.not.to.throw(Error);
}
}
-
- function getRulePath(ruleName) {
- // 'require' does not work with dynamic paths because of the compilation step by babel
- // (which resolves paths according to the root folder configuration)
- // the usage of require.resolve on a static path gets around this
- return path.resolve(require.resolve('rules/no-unresolved'), '..', ruleName);
- }
});
it('marks deprecated rules in their metadata', function () {
diff --git a/tests/src/utils.js b/tests/src/utils.js
index d5215b02e3..24d5504a71 100644
--- a/tests/src/utils.js
+++ b/tests/src/utils.js
@@ -42,10 +42,6 @@ export function eslintVersionSatisfies(specifier) {
return semver.satisfies(eslintPkg.version, specifier);
}
-export function testVersion(specifier, t) {
- return eslintVersionSatisfies(specifier) ? test(t()) : [];
-}
-
export function test(t) {
if (arguments.length !== 1) {
throw new SyntaxError('`test` requires exactly one object argument');
@@ -61,6 +57,10 @@ export function test(t) {
};
}
+export function testVersion(specifier, t) {
+ return eslintVersionSatisfies(specifier) ? test(t()) : [];
+}
+
export function testContext(settings) {
return { getFilename() { return FILENAME; },
settings: settings || {} };
From c77c1a6ace311f99ed25878768c2dbee49c0512a Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Wed, 13 Mar 2024 18:41:22 +0200
Subject: [PATCH 100/199] [eslint] ignore some warnings
---
.eslintrc | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/.eslintrc b/.eslintrc
index 8dc0b2637a..224ffcb0e3 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -235,6 +235,16 @@
"no-use-before-define": "off",
},
},
+ {
+ "files": [
+ "resolvers/webpack/index.js",
+ "resolvers/webpack/test/example.js",
+ "utils/parse.js",
+ ],
+ "rules": {
+ "no-console": "off",
+ },
+ },
{
"files": [
"resolvers/*/test/**/*",
From 7a28ba23885dbb2bda98b5c6d7659134ea6d7777 Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Mon, 18 Mar 2024 21:11:25 +0200
Subject: [PATCH 101/199] [Refactor] `ExportMap`: separate ExportMap instance
from its builder logic
---
.eslintrc | 2 +-
CHANGELOG.md | 2 +
src/exportMap.js | 178 ++++++++++++++++++++
src/{ExportMap.js => exportMapBuilder.js} | 188 +---------------------
src/rules/default.js | 4 +-
src/rules/export.js | 4 +-
src/rules/named.js | 6 +-
src/rules/namespace.js | 11 +-
src/rules/no-cycle.js | 4 +-
src/rules/no-deprecated.js | 7 +-
src/rules/no-named-as-default-member.js | 4 +-
src/rules/no-named-as-default.js | 4 +-
src/rules/no-unused-modules.js | 4 +-
tests/src/core/getExports.js | 60 +++----
14 files changed, 242 insertions(+), 236 deletions(-)
create mode 100644 src/exportMap.js
rename src/{ExportMap.js => exportMapBuilder.js} (78%)
diff --git a/.eslintrc b/.eslintrc
index 224ffcb0e3..1bbbba0148 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -229,7 +229,7 @@
{
"files": [
"utils/**", // TODO
- "src/ExportMap.js", // TODO
+ "src/exportMapBuilder.js", // TODO
],
"rules": {
"no-use-before-define": "off",
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9552774dce..7ad93fbd30 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
- [`no-unused-modules`]: add console message to help debug [#2866]
- [Refactor] `ExportMap`: make procedures static instead of monkeypatching exportmap ([#2982], thanks [@soryy708])
+- [Refactor] `ExportMap`: separate ExportMap instance from its builder logic ([#2985], thanks [@soryy708])
## [2.29.1] - 2023-12-14
@@ -1109,6 +1110,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2985]: https://github.com/import-js/eslint-plugin-import/pull/2985
[#2982]: https://github.com/import-js/eslint-plugin-import/pull/2982
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
diff --git a/src/exportMap.js b/src/exportMap.js
new file mode 100644
index 0000000000..e4d61638c5
--- /dev/null
+++ b/src/exportMap.js
@@ -0,0 +1,178 @@
+export default class ExportMap {
+ constructor(path) {
+ this.path = path;
+ this.namespace = new Map();
+ // todo: restructure to key on path, value is resolver + map of names
+ this.reexports = new Map();
+ /**
+ * star-exports
+ * @type {Set<() => ExportMap>}
+ */
+ this.dependencies = new Set();
+ /**
+ * dependencies of this module that are not explicitly re-exported
+ * @type {Map<string, () => ExportMap>}
+ */
+ this.imports = new Map();
+ this.errors = [];
+ /**
+ * type {'ambiguous' | 'Module' | 'Script'}
+ */
+ this.parseGoal = 'ambiguous';
+ }
+
+ get hasDefault() { return this.get('default') != null; } // stronger than this.has
+
+ get size() {
+ let size = this.namespace.size + this.reexports.size;
+ this.dependencies.forEach((dep) => {
+ const d = dep();
+ // CJS / ignored dependencies won't exist (#717)
+ if (d == null) { return; }
+ size += d.size;
+ });
+ return size;
+ }
+
+ /**
+ * Note that this does not check explicitly re-exported names for existence
+ * in the base namespace, but it will expand all `export * from '...'` exports
+ * if not found in the explicit namespace.
+ * @param {string} name
+ * @return {boolean} true if `name` is exported by this module.
+ */
+ has(name) {
+ if (this.namespace.has(name)) { return true; }
+ if (this.reexports.has(name)) { return true; }
+
+ // default exports must be explicitly re-exported (#328)
+ if (name !== 'default') {
+ for (const dep of this.dependencies) {
+ const innerMap = dep();
+
+ // todo: report as unresolved?
+ if (!innerMap) { continue; }
+
+ if (innerMap.has(name)) { return true; }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * ensure that imported name fully resolves.
+ * @param {string} name
+ * @return {{ found: boolean, path: ExportMap[] }}
+ */
+ hasDeep(name) {
+ if (this.namespace.has(name)) { return { found: true, path: [this] }; }
+
+ if (this.reexports.has(name)) {
+ const reexports = this.reexports.get(name);
+ const imported = reexports.getImport();
+
+ // if import is ignored, return explicit 'null'
+ if (imported == null) { return { found: true, path: [this] }; }
+
+ // safeguard against cycles, only if name matches
+ if (imported.path === this.path && reexports.local === name) {
+ return { found: false, path: [this] };
+ }
+
+ const deep = imported.hasDeep(reexports.local);
+ deep.path.unshift(this);
+
+ return deep;
+ }
+
+ // default exports must be explicitly re-exported (#328)
+ if (name !== 'default') {
+ for (const dep of this.dependencies) {
+ const innerMap = dep();
+ if (innerMap == null) { return { found: true, path: [this] }; }
+ // todo: report as unresolved?
+ if (!innerMap) { continue; }
+
+ // safeguard against cycles
+ if (innerMap.path === this.path) { continue; }
+
+ const innerValue = innerMap.hasDeep(name);
+ if (innerValue.found) {
+ innerValue.path.unshift(this);
+ return innerValue;
+ }
+ }
+ }
+
+ return { found: false, path: [this] };
+ }
+
+ get(name) {
+ if (this.namespace.has(name)) { return this.namespace.get(name); }
+
+ if (this.reexports.has(name)) {
+ const reexports = this.reexports.get(name);
+ const imported = reexports.getImport();
+
+ // if import is ignored, return explicit 'null'
+ if (imported == null) { return null; }
+
+ // safeguard against cycles, only if name matches
+ if (imported.path === this.path && reexports.local === name) { return undefined; }
+
+ return imported.get(reexports.local);
+ }
+
+ // default exports must be explicitly re-exported (#328)
+ if (name !== 'default') {
+ for (const dep of this.dependencies) {
+ const innerMap = dep();
+ // todo: report as unresolved?
+ if (!innerMap) { continue; }
+
+ // safeguard against cycles
+ if (innerMap.path === this.path) { continue; }
+
+ const innerValue = innerMap.get(name);
+ if (innerValue !== undefined) { return innerValue; }
+ }
+ }
+
+ return undefined;
+ }
+
+ forEach(callback, thisArg) {
+ this.namespace.forEach((v, n) => { callback.call(thisArg, v, n, this); });
+
+ this.reexports.forEach((reexports, name) => {
+ const reexported = reexports.getImport();
+ // can't look up meta for ignored re-exports (#348)
+ callback.call(thisArg, reexported && reexported.get(reexports.local), name, this);
+ });
+
+ this.dependencies.forEach((dep) => {
+ const d = dep();
+ // CJS / ignored dependencies won't exist (#717)
+ if (d == null) { return; }
+
+ d.forEach((v, n) => {
+ if (n !== 'default') {
+ callback.call(thisArg, v, n, this);
+ }
+ });
+ });
+ }
+
+ // todo: keys, values, entries?
+
+ reportErrors(context, declaration) {
+ const msg = this.errors
+ .map((e) => `${e.message} (${e.lineNumber}:${e.column})`)
+ .join(', ');
+ context.report({
+ node: declaration.source,
+ message: `Parse errors in imported module '${declaration.source.value}': ${msg}`,
+ });
+ }
+}
diff --git a/src/ExportMap.js b/src/exportMapBuilder.js
similarity index 78%
rename from src/ExportMap.js
rename to src/exportMapBuilder.js
index 9ee65a504f..f2b40e7b4c 100644
--- a/src/ExportMap.js
+++ b/src/exportMapBuilder.js
@@ -18,6 +18,7 @@ import * as unambiguous from 'eslint-module-utils/unambiguous';
import { tsConfigLoader } from 'tsconfig-paths/lib/tsconfig-loader';
import includes from 'array-includes';
+import ExportMap from './exportMap';
let ts;
@@ -117,189 +118,12 @@ const availableDocStyleParsers = {
const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
-export default class ExportMap {
- constructor(path) {
- this.path = path;
- this.namespace = new Map();
- // todo: restructure to key on path, value is resolver + map of names
- this.reexports = new Map();
- /**
- * star-exports
- * @type {Set} of () => ExportMap
- */
- this.dependencies = new Set();
- /**
- * dependencies of this module that are not explicitly re-exported
- * @type {Map} from path = () => ExportMap
- */
- this.imports = new Map();
- this.errors = [];
- /**
- * type {'ambiguous' | 'Module' | 'Script'}
- */
- this.parseGoal = 'ambiguous';
- }
-
- get hasDefault() { return this.get('default') != null; } // stronger than this.has
-
- get size() {
- let size = this.namespace.size + this.reexports.size;
- this.dependencies.forEach((dep) => {
- const d = dep();
- // CJS / ignored dependencies won't exist (#717)
- if (d == null) { return; }
- size += d.size;
- });
- return size;
- }
-
- /**
- * Note that this does not check explicitly re-exported names for existence
- * in the base namespace, but it will expand all `export * from '...'` exports
- * if not found in the explicit namespace.
- * @param {string} name
- * @return {Boolean} true if `name` is exported by this module.
- */
- has(name) {
- if (this.namespace.has(name)) { return true; }
- if (this.reexports.has(name)) { return true; }
-
- // default exports must be explicitly re-exported (#328)
- if (name !== 'default') {
- for (const dep of this.dependencies) {
- const innerMap = dep();
-
- // todo: report as unresolved?
- if (!innerMap) { continue; }
-
- if (innerMap.has(name)) { return true; }
- }
- }
-
- return false;
- }
-
- /**
- * ensure that imported name fully resolves.
- * @param {string} name
- * @return {{ found: boolean, path: ExportMap[] }}
- */
- hasDeep(name) {
- if (this.namespace.has(name)) { return { found: true, path: [this] }; }
-
- if (this.reexports.has(name)) {
- const reexports = this.reexports.get(name);
- const imported = reexports.getImport();
-
- // if import is ignored, return explicit 'null'
- if (imported == null) { return { found: true, path: [this] }; }
-
- // safeguard against cycles, only if name matches
- if (imported.path === this.path && reexports.local === name) {
- return { found: false, path: [this] };
- }
-
- const deep = imported.hasDeep(reexports.local);
- deep.path.unshift(this);
-
- return deep;
- }
-
- // default exports must be explicitly re-exported (#328)
- if (name !== 'default') {
- for (const dep of this.dependencies) {
- const innerMap = dep();
- if (innerMap == null) { return { found: true, path: [this] }; }
- // todo: report as unresolved?
- if (!innerMap) { continue; }
-
- // safeguard against cycles
- if (innerMap.path === this.path) { continue; }
-
- const innerValue = innerMap.hasDeep(name);
- if (innerValue.found) {
- innerValue.path.unshift(this);
- return innerValue;
- }
- }
- }
-
- return { found: false, path: [this] };
- }
-
- get(name) {
- if (this.namespace.has(name)) { return this.namespace.get(name); }
-
- if (this.reexports.has(name)) {
- const reexports = this.reexports.get(name);
- const imported = reexports.getImport();
-
- // if import is ignored, return explicit 'null'
- if (imported == null) { return null; }
-
- // safeguard against cycles, only if name matches
- if (imported.path === this.path && reexports.local === name) { return undefined; }
-
- return imported.get(reexports.local);
- }
-
- // default exports must be explicitly re-exported (#328)
- if (name !== 'default') {
- for (const dep of this.dependencies) {
- const innerMap = dep();
- // todo: report as unresolved?
- if (!innerMap) { continue; }
-
- // safeguard against cycles
- if (innerMap.path === this.path) { continue; }
-
- const innerValue = innerMap.get(name);
- if (innerValue !== undefined) { return innerValue; }
- }
- }
-
- return undefined;
- }
-
- forEach(callback, thisArg) {
- this.namespace.forEach((v, n) => { callback.call(thisArg, v, n, this); });
-
- this.reexports.forEach((reexports, name) => {
- const reexported = reexports.getImport();
- // can't look up meta for ignored re-exports (#348)
- callback.call(thisArg, reexported && reexported.get(reexports.local), name, this);
- });
-
- this.dependencies.forEach((dep) => {
- const d = dep();
- // CJS / ignored dependencies won't exist (#717)
- if (d == null) { return; }
-
- d.forEach((v, n) => {
- if (n !== 'default') {
- callback.call(thisArg, v, n, this);
- }
- });
- });
- }
-
- // todo: keys, values, entries?
-
- reportErrors(context, declaration) {
- const msg = this.errors
- .map((e) => `${e.message} (${e.lineNumber}:${e.column})`)
- .join(', ');
- context.report({
- node: declaration.source,
- message: `Parse errors in imported module '${declaration.source.value}': ${msg}`,
- });
- }
-
+export default class ExportMapBuilder {
static get(source, context) {
const path = resolve(source, context);
if (path == null) { return null; }
- return ExportMap.for(childContext(path, context));
+ return ExportMapBuilder.for(childContext(path, context));
}
static for(context) {
@@ -343,7 +167,7 @@ export default class ExportMap {
}
log('cache miss', cacheKey, 'for path', path);
- exportMap = ExportMap.parse(path, content, context);
+ exportMap = ExportMapBuilder.parse(path, content, context);
// ambiguous modules return null
if (exportMap == null) {
@@ -447,7 +271,7 @@ export default class ExportMap {
function resolveImport(value) {
const rp = remotePath(value);
if (rp == null) { return null; }
- return ExportMap.for(childContext(rp, context));
+ return ExportMapBuilder.for(childContext(rp, context));
}
function getNamespace(identifier) {
@@ -738,7 +562,7 @@ export default class ExportMap {
* caused memory leaks. See #1266.
*/
function thunkFor(p, context) {
- return () => ExportMap.for(childContext(p, context));
+ return () => ExportMapBuilder.for(childContext(p, context));
}
/**
diff --git a/src/rules/default.js b/src/rules/default.js
index 297a80c463..cbaa49f1fc 100644
--- a/src/rules/default.js
+++ b/src/rules/default.js
@@ -1,4 +1,4 @@
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
import docsUrl from '../docsUrl';
module.exports = {
@@ -19,7 +19,7 @@ module.exports = {
);
if (!defaultSpecifier) { return; }
- const imports = Exports.get(node.source.value, context);
+ const imports = ExportMapBuilder.get(node.source.value, context);
if (imports == null) { return; }
if (imports.errors.length) {
diff --git a/src/rules/export.js b/src/rules/export.js
index c540f1e3c9..b1dc5ca9ea 100644
--- a/src/rules/export.js
+++ b/src/rules/export.js
@@ -1,4 +1,4 @@
-import ExportMap, { recursivePatternCapture } from '../ExportMap';
+import ExportMapBuilder, { recursivePatternCapture } from '../exportMapBuilder';
import docsUrl from '../docsUrl';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
@@ -197,7 +197,7 @@ module.exports = {
// `export * as X from 'path'` does not conflict
if (node.exported && node.exported.name) { return; }
- const remoteExports = ExportMap.get(node.source.value, context);
+ const remoteExports = ExportMapBuilder.get(node.source.value, context);
if (remoteExports == null) { return; }
if (remoteExports.errors.length) {
diff --git a/src/rules/named.js b/src/rules/named.js
index e7fe4e4dce..043d72eabe 100644
--- a/src/rules/named.js
+++ b/src/rules/named.js
@@ -1,5 +1,5 @@
import * as path from 'path';
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
import docsUrl from '../docsUrl';
module.exports = {
@@ -41,7 +41,7 @@ module.exports = {
return; // no named imports/exports
}
- const imports = Exports.get(node.source.value, context);
+ const imports = ExportMapBuilder.get(node.source.value, context);
if (imports == null || imports.parseGoal === 'ambiguous') {
return;
}
@@ -93,7 +93,7 @@ module.exports = {
const call = node.init;
const [source] = call.arguments;
const variableImports = node.id.properties;
- const variableExports = Exports.get(source.value, context);
+ const variableExports = ExportMapBuilder.get(source.value, context);
if (
// return if it's not a commonjs require statement
diff --git a/src/rules/namespace.js b/src/rules/namespace.js
index 77a3ea9077..e1ca2870b1 100644
--- a/src/rules/namespace.js
+++ b/src/rules/namespace.js
@@ -1,5 +1,6 @@
import declaredScope from 'eslint-module-utils/declaredScope';
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
+import ExportMap from '../exportMap';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
@@ -8,7 +9,7 @@ function processBodyStatement(context, namespaces, declaration) {
if (declaration.specifiers.length === 0) { return; }
- const imports = Exports.get(declaration.source.value, context);
+ const imports = ExportMapBuilder.get(declaration.source.value, context);
if (imports == null) { return null; }
if (imports.errors.length > 0) {
@@ -88,7 +89,7 @@ module.exports = {
ExportNamespaceSpecifier(namespace) {
const declaration = importDeclaration(context);
- const imports = Exports.get(declaration.source.value, context);
+ const imports = ExportMapBuilder.get(declaration.source.value, context);
if (imports == null) { return null; }
if (imports.errors.length) {
@@ -122,7 +123,7 @@ module.exports = {
let namespace = namespaces.get(dereference.object.name);
const namepath = [dereference.object.name];
// while property is namespace and parent is member expression, keep validating
- while (namespace instanceof Exports && dereference.type === 'MemberExpression') {
+ while (namespace instanceof ExportMap && dereference.type === 'MemberExpression') {
if (dereference.computed) {
if (!allowComputed) {
context.report(
@@ -161,7 +162,7 @@ module.exports = {
// DFS traverse child namespaces
function testKey(pattern, namespace, path = [init.name]) {
- if (!(namespace instanceof Exports)) { return; }
+ if (!(namespace instanceof ExportMap)) { return; }
if (pattern.type !== 'ObjectPattern') { return; }
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index 11c2f44fc0..b7b907b062 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -4,7 +4,7 @@
*/
import resolve from 'eslint-module-utils/resolve';
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
import { isExternalModule } from '../core/importType';
import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import docsUrl from '../docsUrl';
@@ -88,7 +88,7 @@ module.exports = {
return; // ignore type imports
}
- const imported = Exports.get(sourceNode.value, context);
+ const imported = ExportMapBuilder.get(sourceNode.value, context);
if (imported == null) {
return; // no-unresolved territory
diff --git a/src/rules/no-deprecated.js b/src/rules/no-deprecated.js
index 06eeff8ea7..50072f3f85 100644
--- a/src/rules/no-deprecated.js
+++ b/src/rules/no-deprecated.js
@@ -1,5 +1,6 @@
import declaredScope from 'eslint-module-utils/declaredScope';
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
+import ExportMap from '../exportMap';
import docsUrl from '../docsUrl';
function message(deprecation) {
@@ -31,7 +32,7 @@ module.exports = {
if (node.type !== 'ImportDeclaration') { return; }
if (node.source == null) { return; } // local export, ignore
- const imports = Exports.get(node.source.value, context);
+ const imports = ExportMapBuilder.get(node.source.value, context);
if (imports == null) { return; }
const moduleDeprecation = imports.doc && imports.doc.tags.find((t) => t.title === 'deprecated');
@@ -114,7 +115,7 @@ module.exports = {
let namespace = namespaces.get(dereference.object.name);
const namepath = [dereference.object.name];
// while property is namespace and parent is member expression, keep validating
- while (namespace instanceof Exports && dereference.type === 'MemberExpression') {
+ while (namespace instanceof ExportMap && dereference.type === 'MemberExpression') {
// ignore computed parts for now
if (dereference.computed) { return; }
diff --git a/src/rules/no-named-as-default-member.js b/src/rules/no-named-as-default-member.js
index e00a4cbc87..d594c58433 100644
--- a/src/rules/no-named-as-default-member.js
+++ b/src/rules/no-named-as-default-member.js
@@ -4,7 +4,7 @@
* @copyright 2016 Desmond Brand. All rights reserved.
* See LICENSE in root directory for full license.
*/
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
@@ -36,7 +36,7 @@ module.exports = {
return {
ImportDefaultSpecifier(node) {
const declaration = importDeclaration(context);
- const exportMap = Exports.get(declaration.source.value, context);
+ const exportMap = ExportMapBuilder.get(declaration.source.value, context);
if (exportMap == null) { return; }
if (exportMap.errors.length) {
diff --git a/src/rules/no-named-as-default.js b/src/rules/no-named-as-default.js
index 40b1e175b2..3e73ff2f44 100644
--- a/src/rules/no-named-as-default.js
+++ b/src/rules/no-named-as-default.js
@@ -1,4 +1,4 @@
-import Exports from '../ExportMap';
+import ExportMapBuilder from '../exportMapBuilder';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
@@ -20,7 +20,7 @@ module.exports = {
const declaration = importDeclaration(context);
- const imports = Exports.get(declaration.source.value, context);
+ const imports = ExportMapBuilder.get(declaration.source.value, context);
if (imports == null) { return; }
if (imports.errors.length) {
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index ec3425dacd..812efffbca 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -13,7 +13,7 @@ import values from 'object.values';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
-import Exports, { recursivePatternCapture } from '../ExportMap';
+import ExportMapBuilder, { recursivePatternCapture } from '../exportMapBuilder';
import docsUrl from '../docsUrl';
let FileEnumerator;
@@ -194,7 +194,7 @@ const prepareImportsAndExports = (srcFiles, context) => {
srcFiles.forEach((file) => {
const exports = new Map();
const imports = new Map();
- const currentExports = Exports.get(file, context);
+ const currentExports = ExportMapBuilder.get(file, context);
if (currentExports) {
const {
dependencies,
diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
index 1dd6e88014..611a13055f 100644
--- a/tests/src/core/getExports.js
+++ b/tests/src/core/getExports.js
@@ -4,7 +4,7 @@ import sinon from 'sinon';
import eslintPkg from 'eslint/package.json';
import typescriptPkg from 'typescript/package.json';
import * as tsConfigLoader from 'tsconfig-paths/lib/tsconfig-loader';
-import ExportMap from '../../../src/ExportMap';
+import ExportMapBuilder from '../../../src/exportMapBuilder';
import * as fs from 'fs';
@@ -28,7 +28,7 @@ describe('ExportMap', function () {
it('handles ExportAllDeclaration', function () {
let imports;
expect(function () {
- imports = ExportMap.get('./export-all', fakeContext);
+ imports = ExportMapBuilder.get('./export-all', fakeContext);
}).not.to.throw(Error);
expect(imports).to.exist;
@@ -37,25 +37,25 @@ describe('ExportMap', function () {
});
it('returns a cached copy on subsequent requests', function () {
- expect(ExportMap.get('./named-exports', fakeContext))
- .to.exist.and.equal(ExportMap.get('./named-exports', fakeContext));
+ expect(ExportMapBuilder.get('./named-exports', fakeContext))
+ .to.exist.and.equal(ExportMapBuilder.get('./named-exports', fakeContext));
});
it('does not return a cached copy after modification', (done) => {
- const firstAccess = ExportMap.get('./mutator', fakeContext);
+ const firstAccess = ExportMapBuilder.get('./mutator', fakeContext);
expect(firstAccess).to.exist;
// mutate (update modified time)
const newDate = new Date();
fs.utimes(getFilename('mutator.js'), newDate, newDate, (error) => {
expect(error).not.to.exist;
- expect(ExportMap.get('./mutator', fakeContext)).not.to.equal(firstAccess);
+ expect(ExportMapBuilder.get('./mutator', fakeContext)).not.to.equal(firstAccess);
done();
});
});
it('does not return a cached copy with different settings', () => {
- const firstAccess = ExportMap.get('./named-exports', fakeContext);
+ const firstAccess = ExportMapBuilder.get('./named-exports', fakeContext);
expect(firstAccess).to.exist;
const differentSettings = {
@@ -63,7 +63,7 @@ describe('ExportMap', function () {
parserPath: 'espree',
};
- expect(ExportMap.get('./named-exports', differentSettings))
+ expect(ExportMapBuilder.get('./named-exports', differentSettings))
.to.exist.and
.not.to.equal(firstAccess);
});
@@ -71,7 +71,7 @@ describe('ExportMap', function () {
it('does not throw for a missing file', function () {
let imports;
expect(function () {
- imports = ExportMap.get('./does-not-exist', fakeContext);
+ imports = ExportMapBuilder.get('./does-not-exist', fakeContext);
}).not.to.throw(Error);
expect(imports).not.to.exist;
@@ -81,7 +81,7 @@ describe('ExportMap', function () {
it('exports explicit names for a missing file in exports', function () {
let imports;
expect(function () {
- imports = ExportMap.get('./exports-missing', fakeContext);
+ imports = ExportMapBuilder.get('./exports-missing', fakeContext);
}).not.to.throw(Error);
expect(imports).to.exist;
@@ -92,7 +92,7 @@ describe('ExportMap', function () {
it('finds exports for an ES7 module with babel-eslint', function () {
const path = getFilename('jsx/FooES7.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- const imports = ExportMap.parse(
+ const imports = ExportMapBuilder.parse(
path,
contents,
{ parserPath: 'babel-eslint', settings: {} },
@@ -112,7 +112,7 @@ describe('ExportMap', function () {
before('parse file', function () {
const path = getFilename('deprecated.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' }).replace(/[\r]\n/g, lineEnding);
- imports = ExportMap.parse(path, contents, parseContext);
+ imports = ExportMapBuilder.parse(path, contents, parseContext);
// sanity checks
expect(imports.errors).to.be.empty;
@@ -181,7 +181,7 @@ describe('ExportMap', function () {
before('parse file', function () {
const path = getFilename('deprecated-file.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- imports = ExportMap.parse(path, contents, parseContext);
+ imports = ExportMapBuilder.parse(path, contents, parseContext);
// sanity checks
expect(imports.errors).to.be.empty;
@@ -243,7 +243,7 @@ describe('ExportMap', function () {
it('works with espree & traditional namespace exports', function () {
const path = getFilename('deep/a.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- const a = ExportMap.parse(path, contents, espreeContext);
+ const a = ExportMapBuilder.parse(path, contents, espreeContext);
expect(a.errors).to.be.empty;
expect(a.get('b').namespace).to.exist;
expect(a.get('b').namespace.has('c')).to.be.true;
@@ -252,7 +252,7 @@ describe('ExportMap', function () {
it('captures namespace exported as default', function () {
const path = getFilename('deep/default.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- const def = ExportMap.parse(path, contents, espreeContext);
+ const def = ExportMapBuilder.parse(path, contents, espreeContext);
expect(def.errors).to.be.empty;
expect(def.get('default').namespace).to.exist;
expect(def.get('default').namespace.has('c')).to.be.true;
@@ -261,7 +261,7 @@ describe('ExportMap', function () {
it('works with babel-eslint & ES7 namespace exports', function () {
const path = getFilename('deep-es7/a.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- const a = ExportMap.parse(path, contents, babelContext);
+ const a = ExportMapBuilder.parse(path, contents, babelContext);
expect(a.errors).to.be.empty;
expect(a.get('b').namespace).to.exist;
expect(a.get('b').namespace.has('c')).to.be.true;
@@ -278,7 +278,7 @@ describe('ExportMap', function () {
const path = getFilename('deep/cache-1.js');
const contents = fs.readFileSync(path, { encoding: 'utf8' });
- a = ExportMap.parse(path, contents, espreeContext);
+ a = ExportMapBuilder.parse(path, contents, espreeContext);
expect(a.errors).to.be.empty;
expect(a.get('b').namespace).to.exist;
@@ -304,10 +304,10 @@ describe('ExportMap', function () {
context('Map API', function () {
context('#size', function () {
- it('counts the names', () => expect(ExportMap.get('./named-exports', fakeContext))
+ it('counts the names', () => expect(ExportMapBuilder.get('./named-exports', fakeContext))
.to.have.property('size', 12));
- it('includes exported namespace size', () => expect(ExportMap.get('./export-all', fakeContext))
+ it('includes exported namespace size', () => expect(ExportMapBuilder.get('./export-all', fakeContext))
.to.have.property('size', 1));
});
@@ -315,14 +315,14 @@ describe('ExportMap', function () {
context('issue #210: self-reference', function () {
it(`doesn't crash`, function () {
- expect(() => ExportMap.get('./narcissist', fakeContext)).not.to.throw(Error);
+ expect(() => ExportMapBuilder.get('./narcissist', fakeContext)).not.to.throw(Error);
});
it(`'has' circular reference`, function () {
- expect(ExportMap.get('./narcissist', fakeContext))
+ expect(ExportMapBuilder.get('./narcissist', fakeContext))
.to.exist.and.satisfy((m) => m.has('soGreat'));
});
it(`can 'get' circular reference`, function () {
- expect(ExportMap.get('./narcissist', fakeContext))
+ expect(ExportMapBuilder.get('./narcissist', fakeContext))
.to.exist.and.satisfy((m) => m.get('soGreat') != null);
});
});
@@ -335,7 +335,7 @@ describe('ExportMap', function () {
let imports;
before('load imports', function () {
- imports = ExportMap.get('./typescript.ts', context);
+ imports = ExportMapBuilder.get('./typescript.ts', context);
});
it('returns nothing for a TypeScript file', function () {
@@ -372,7 +372,7 @@ describe('ExportMap', function () {
before('load imports', function () {
this.timeout(20e3); // takes a long time :shrug:
sinon.spy(tsConfigLoader, 'tsConfigLoader');
- imports = ExportMap.get('./typescript.ts', context);
+ imports = ExportMapBuilder.get('./typescript.ts', context);
});
after('clear spies', function () {
tsConfigLoader.tsConfigLoader.restore();
@@ -414,9 +414,9 @@ describe('ExportMap', function () {
},
};
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(0);
- ExportMap.parse('./baz.ts', 'export const baz = 5', customContext);
+ ExportMapBuilder.parse('./baz.ts', 'export const baz = 5', customContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(1);
- ExportMap.parse('./baz.ts', 'export const baz = 5', customContext);
+ ExportMapBuilder.parse('./baz.ts', 'export const baz = 5', customContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(1);
const differentContext = {
@@ -426,17 +426,17 @@ describe('ExportMap', function () {
},
};
- ExportMap.parse('./baz.ts', 'export const baz = 5', differentContext);
+ ExportMapBuilder.parse('./baz.ts', 'export const baz = 5', differentContext);
expect(tsConfigLoader.tsConfigLoader.callCount).to.equal(2);
});
it('should cache after parsing for an ambiguous module', function () {
const source = './typescript-declare-module.ts';
- const parseSpy = sinon.spy(ExportMap, 'parse');
+ const parseSpy = sinon.spy(ExportMapBuilder, 'parse');
- expect(ExportMap.get(source, context)).to.be.null;
+ expect(ExportMapBuilder.get(source, context)).to.be.null;
- ExportMap.get(source, context);
+ ExportMapBuilder.get(source, context);
expect(parseSpy.callCount).to.equal(1);
From f3e505bc2bc87f28aa10267aed8172f08c7d9c9a Mon Sep 17 00:00:00 2001
From: minervabot <53988640+minervabot@users.noreply.github.com>
Date: Mon, 2 Jan 2023 02:28:07 -0700
Subject: [PATCH 102/199] [Docs] `order`: Add a quick note on how unbound
imports and --fix
Having unbound imports mixed among the bound ones causes unexpected and incorrect seeming results. I spent several hours trying to fix this problem only to find it was well known!
---
CHANGELOG.md | 3 +++
docs/rules/order.md | 19 +++++++++++++++++++
2 files changed, 22 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7ad93fbd30..77c908dc33 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-unused-modules`]: add console message to help debug [#2866]
- [Refactor] `ExportMap`: make procedures static instead of monkeypatching exportmap ([#2982], thanks [@soryy708])
- [Refactor] `ExportMap`: separate ExportMap instance from its builder logic ([#2985], thanks [@soryy708])
+- [Docs] `order`: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
## [2.29.1] - 2023-12-14
@@ -1130,6 +1131,7 @@ for info on changes for earlier releases.
[#2735]: https://github.com/import-js/eslint-plugin-import/pull/2735
[#2699]: https://github.com/import-js/eslint-plugin-import/pull/2699
[#2664]: https://github.com/import-js/eslint-plugin-import/pull/2664
+[#2640]: https://github.com/import-js/eslint-plugin-import/pull/2640
[#2613]: https://github.com/import-js/eslint-plugin-import/pull/2613
[#2608]: https://github.com/import-js/eslint-plugin-import/pull/2608
[#2605]: https://github.com/import-js/eslint-plugin-import/pull/2605
@@ -1846,6 +1848,7 @@ for info on changes for earlier releases.
[@mgwalker]: https://github.com/mgwalker
[@mhmadhamster]: https://github.com/MhMadHamster
[@MikeyBeLike]: https://github.com/MikeyBeLike
+[@minervabot]: https://github.com/minervabot
[@mpint]: https://github.com/mpint
[@mplewis]: https://github.com/mplewis
[@mrmckeb]: https://github.com/mrmckeb
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 2335699e6c..24692f2d21 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -77,6 +77,25 @@ import foo from './foo';
var path = require('path');
```
+## Limitations of `--fix`
+
+Unbound imports are assumed to have side effects, and will never be moved/reordered. This can cause other imports to get "stuck" around them, and the fix to fail.
+
+```javascript
+import b from 'b'
+import 'format.css'; // This will prevent --fix from working.
+import a from 'a'
+```
+
+As a workaround, move unbound imports to be entirely above or below bound ones.
+
+```javascript
+import 'format1.css'; // OK
+import b from 'b'
+import a from 'a'
+import 'format2.css'; // OK
+```
+
## Options
This rule supports the following options:
From fa60e3d738078fa2fccbc36260b9da534795f720 Mon Sep 17 00:00:00 2001
From: Joey Guerra <github@joeyguerra.com>
Date: Tue, 19 Mar 2024 17:33:40 -0500
Subject: [PATCH 103/199] [Tests] appveyor -> GHA (run tests on Windows in both
pwsh and WSL + Ubuntu)
---
.github/workflows/native-wsl.yml | 151 ++++++++++++++++++++++++++++
CHANGELOG.md | 3 +
appveyor.yml | 165 -------------------------------
3 files changed, 154 insertions(+), 165 deletions(-)
create mode 100644 .github/workflows/native-wsl.yml
delete mode 100644 appveyor.yml
diff --git a/.github/workflows/native-wsl.yml b/.github/workflows/native-wsl.yml
new file mode 100644
index 0000000000..893d2248d1
--- /dev/null
+++ b/.github/workflows/native-wsl.yml
@@ -0,0 +1,151 @@
+name: Native and WSL
+
+on: [push, pull_request]
+
+jobs:
+ build:
+ runs-on: ${{ matrix.os }}
+ defaults:
+ run:
+ shell: ${{ matrix.configuration == 'wsl' && 'wsl-bash {0}' || 'pwsh' }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [windows-2019]
+ node-version: [18, 16, 14, 12, 10, 8, 6, 4]
+ configuration: [wsl, native]
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: Vampire/setup-wsl@v3
+ if: matrix.configuration == 'wsl'
+ with:
+ distribution: Ubuntu-22.04
+ - run: curl --version
+ - name: 'WSL: do all npm install steps'
+ if: matrix.configuration == 'wsl'
+ env:
+ ESLINT_VERSION: 7
+ TRAVIS_NODE_VERSION: ${{ matrix.node-version }}
+ run: |
+ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
+ export NVM_DIR="$HOME/.nvm"
+ [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
+ nvm install --latest-npm ${{ matrix.node-version }}
+
+ if [ ${{ matrix.node-version }} -ge 4 ] && [ ${{ matrix.node-version }} -lt 6 ]; then
+ npm install eslint@4 --no-save --ignore-scripts
+ npm install
+ npm install eslint-import-resolver-typescript@1.0.2 --no-save
+ npm uninstall @angular-eslint/template-parser @typescript-eslint/parser --no-save
+ fi
+ if [ ${{ matrix.node-version }} -ge 6 ] && [ ${{ matrix.node-version }} -lt 7 ]; then
+ npm install eslint@5 --no-save --ignore-scripts
+ npm install
+ npm uninstall @angular-eslint/template-parser --no-save
+ npm install eslint-import-resolver-typescript@1.0.2 @typescript-eslint/parser@3 --no-save
+ fi
+ if [ ${{ matrix.node-version }} -ge 7 ] && [ ${{ matrix.node-version }} -lt 8 ]; then
+ npm install eslint@6 --no-save --ignore-scripts
+ npm install
+ npm install eslint-import-resolver-typescript@1.0.2 typescript-eslint-parser@20 --no-save
+ npm uninstall @angular-eslint/template-parser --no-save
+ fi
+ if [ ${{ matrix.node-version }} -eq 8 ]; then
+ npm install eslint@6 --no-save --ignore-scripts
+ npm install
+ npm uninstall @angular-eslint/template-parser --no-save
+ npm install @typescript-eslint/parser@3 --no-save
+ fi
+ if [ ${{ matrix.node-version }} -gt 8 ] && [ ${{ matrix.node-version }} -lt 10 ]; then
+ npm install eslint@7 --no-save --ignore-scripts
+ npm install
+ npm install @typescript-eslint/parser@3 --no-save
+ fi
+ if [ ${{ matrix.node-version }} -ge 10 ] && [ ${{ matrix.node-version }} -lt 12 ]; then
+ npm install
+ npm install @typescript-eslint/parser@4 --no-save
+ fi
+ if [ ${{ matrix.node-version }} -ge 12 ]; then
+ npm install
+ fi
+ npm run copy-metafiles
+ npm run pretest
+ npm run tests-only
+
+ - name: install dependencies for node <= 10
+ if: matrix.node-version <= '10' && matrix.configuration == 'native'
+ run: |
+ npm install --legacy-peer-deps
+ npm install eslint@7 --no-save
+
+ - name: Install dependencies for node > 10
+ if: matrix.node-version > '10' && matrix.configuration == 'native'
+ run: npm install
+
+ - name: install the latest version of nyc
+ if: matrix.configuration == 'native'
+ run: npm install nyc@latest --no-save
+
+ - name: copy metafiles for node <= 8
+ if: matrix.node-version <= 8 && matrix.configuration == 'native'
+ env:
+ ESLINT_VERSION: 6
+ TRAVIS_NODE_VERSION: ${{ matrix.node-version }}
+ run: |
+ npm run copy-metafiles
+ bash ./tests/dep-time-travel.sh 2>&1
+ - name: copy metafiles for Node > 8
+ if: matrix.node-version > 8 && matrix.configuration == 'native'
+ env:
+ ESLINT_VERSION: 7
+ TRAVIS_NODE_VERSION: ${{ matrix.node-version }}
+ run: |
+ npm run copy-metafiles
+ bash ./tests/dep-time-travel.sh 2>&1
+
+ - name: install ./resolver dependencies in Native
+ if: matrix.configuration == 'native'
+ shell: pwsh
+ run: |
+ npm config set package-lock false
+ $resolverDir = "./resolvers"
+ Get-ChildItem -Directory $resolverDir |
+ ForEach {
+ Write-output $(Resolve-Path $(Join-Path $resolverDir $_.Name))
+ Push-Location $(Resolve-Path $(Join-Path $resolverDir $_.Name))
+ npm install
+ npm ls nyc > $null;
+ if ($?) {
+ npm install nyc@latest --no-save
+ }
+ Pop-Location
+ }
+
+ - name: run tests in Native
+ if: matrix.configuration == 'native'
+ shell: pwsh
+ run: |
+ npm run pretest
+ npm run tests-only
+ $resolverDir = "./resolvers";
+ $resolvers = @();
+ Get-ChildItem -Directory $resolverDir |
+ ForEach {
+ $resolvers += "$(Resolve-Path $(Join-Path $resolverDir $_.Name))";
+ }
+ $env:RESOLVERS = [string]::Join(";", $resolvers);
+ foreach ($resolver in $resolvers) {
+ Set-Location -Path $resolver.Trim('"')
+ npm run tests-only
+ Set-Location -Path $PSScriptRoot
+ }
+
+ - name: codecov
+ uses: codecov/codecov-action@v3.1.5
+
+ windows:
+ runs-on: ubuntu-latest
+ needs: [build]
+ steps:
+ - run: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 77c908dc33..f8a6f80d0e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Refactor] `ExportMap`: make procedures static instead of monkeypatching exportmap ([#2982], thanks [@soryy708])
- [Refactor] `ExportMap`: separate ExportMap instance from its builder logic ([#2985], thanks [@soryy708])
- [Docs] `order`: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
+- [Tests] appveyor -> GHA (run tests on Windows in both pwsh and WSL + Ubuntu) ([#2987], thanks [@joeyguerra])
## [2.29.1] - 2023-12-14
@@ -1111,6 +1112,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
[#2985]: https://github.com/import-js/eslint-plugin-import/pull/2985
[#2982]: https://github.com/import-js/eslint-plugin-import/pull/2982
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
@@ -1791,6 +1793,7 @@ for info on changes for earlier releases.
[@jkimbo]: https://github.com/jkimbo
[@joaovieira]: https://github.com/joaovieira
[@joe-matsec]: https://github.com/joe-matsec
+[@joeyguerra]: https://github.com/joeyguerra
[@johndevedu]: https://github.com/johndevedu
[@johnthagen]: https://github.com/johnthagen
[@jonboiser]: https://github.com/jonboiser
diff --git a/appveyor.yml b/appveyor.yml
deleted file mode 100644
index e50ab87d2a..0000000000
--- a/appveyor.yml
+++ /dev/null
@@ -1,165 +0,0 @@
-configuration:
- - Native
- - WSL
-
-# Test against this version of Node.js
-environment:
- matrix:
- - nodejs_version: "16"
- - nodejs_version: "14"
- - nodejs_version: "12"
- - nodejs_version: "10"
- - nodejs_version: "8"
- # - nodejs_version: "6"
- # - nodejs_version: "4"
-
-image: Visual Studio 2019
-matrix:
- fast_finish: false
- exclude:
- - configuration: WSL
- nodejs_version: "8"
- - configuration: WSL
- nodejs_version: "6"
- - configuration: WSL
- nodejs_version: "4"
-
- allow_failures:
- - nodejs_version: "4" # for eslint 5
- - configuration: WSL
-
-platform:
- - x86
- - x64
-
-# Initialization scripts. (runs before repo cloning)
-init:
- # Declare version-numbers of packages to install
- - ps: >-
- if ($env:nodejs_version -eq "4") {
- $env:NPM_VERSION="3"
- }
- if ($env:nodejs_version -in @("8")) {
- $env:NPM_VERSION="6"
- }
- if ($env:nodejs_version -in @("10", "12", "14", "16")) {
- $env:NPM_VERSION="6" # TODO: use npm 7
- $env:NPM_CONFIG_LEGACY_PEER_DEPS="true"
- }
- - ps: >-
- $env:ESLINT_VERSION="7";
- if ([int]$env:nodejs_version -le 8) {
- $env:ESLINT_VERSION="6"
- }
- if ([int]$env:nodejs_version -le 7) {
- $env:ESLINT_VERSION="5"
- }
- if ([int]$env:nodejs_version -le 6) {
- $env:ESLINT_VERSION="4"
- }
- - ps: $env:WINDOWS_NYC_VERSION = "15.0.1"
- - ps: $env:TRAVIS_NODE_VERSION = $env:nodejs_version
-
- # Add `ci`-command to `PATH` for running commands either using cmd or wsl depending on the configuration
- - ps: $env:PATH += ";$(Join-Path $(pwd) "scripts")"
-
-# Install scripts. (runs after repo cloning)
-before_build:
- # Install propert `npm`-version
- - IF DEFINED NPM_VERSION ci sudo npm install -g npm@%NPM_VERSION%
-
- # Install dependencies
- - ci npm install
- - ci npm run copy-metafiles
- - bash ./tests/dep-time-travel.sh 2>&1
-
- # fix symlinks
- - git config core.symlinks true
- - git reset --hard
- - ci git reset --hard
-
- # Install dependencies of resolvers
- - ps: >-
- $resolverDir = "./resolvers";
- $resolvers = @();
- Get-ChildItem -Directory $resolverDir |
- ForEach {
- $resolvers += "$(Resolve-Path $(Join-Path $resolverDir $_))";
- }
- $env:RESOLVERS = [string]::Join(";", $resolvers);
- - FOR %%G in ("%RESOLVERS:;=";"%") do ( pushd %%~G & ci npm install & popd )
-
- # Install proper `eslint`-version
- - IF DEFINED ESLINT_VERSION ci npm install --no-save eslint@%ESLINT_VERSION%
-
-# Build scripts (project isn't actually built)
-build_script:
- - ps: "# This Project isn't actually built"
-
-# Test scripts
-test_script:
- # Output useful info for debugging.
- - ci node --version
- - ci npm --version
-
- # Run core tests
- - ci npm run pretest
- - ci npm run tests-only
-
- # Run resolver tests
- - ps: >-
- $resolverDir = "./resolvers";
- $resolvers = @();
- Get-ChildItem -Directory $resolverDir |
- ForEach {
- $resolvers += "$(Resolve-Path $(Join-Path $resolverDir $_))";
- }
- $env:RESOLVERS = [string]::Join(";", $resolvers);
- - FOR %%G in ("%RESOLVERS:;=";"%") do ( pushd %%~G & ci npm test & popd )
-
-# Configuration-specific steps
-for:
- - matrix:
- except:
- - configuration: WSL
- install:
- # Get the latest stable version of Node.js or io.js
- - ps: Install-Product node $env:nodejs_version
- before_test:
- # Upgrade nyc
- - ci npm i --no-save nyc@%WINDOWS_NYC_VERSION%
- - ps: >-
- $resolverDir = "./resolvers";
- $resolvers = @();
- Get-ChildItem -Directory $resolverDir |
- ForEach {
- Push-Location $(Resolve-Path $(Join-Path $resolverDir $_));
- ci npm ls nyc > $null;
- if ($?) {
- $resolvers += "$(pwd)";
- }
- Pop-Location;
- }
- $env:RESOLVERS = [string]::Join(";", $resolvers);
- - IF DEFINED RESOLVERS FOR %%G in ("%RESOLVERS:;=";"%") do ( pushd %%~G & ci npm install --no-save nyc@%WINDOWS_NYC_VERSION% & popd )
- # TODO: enable codecov for native windows builds
- #on_success:
- #- ci $ProgressPreference = 'SilentlyContinue'
- #- ci Invoke-WebRequest -Uri https://uploader.codecov.io/latest/windows/codecov.exe
- #- ci -Outfile codecov.exe
- #- ci .\codecov.exe
- - matrix:
- only:
- - configuration: WSL
- # Install scripts. (runs after repo cloning)
- install:
- # Get a specific version of Node.js
- - ps: $env:WSLENV += ":nodejs_version"
- - ps: wsl curl -sL 'https://deb.nodesource.com/setup_${nodejs_version}.x' `| sudo APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 -E bash -
- - wsl sudo DEBIAN_FRONTEND=noninteractive apt install -y nodejs
- on_success:
- - ci curl -Os https://uploader.codecov.io/latest/linux/codecov
- - ci chmod +x codecov
- - ci ./codecov
-
-build: on
From 5508b6c6dfd4c0472ad98b10d3f45788bd6718fc Mon Sep 17 00:00:00 2001
From: Ashok Suthar <coderatlabs@gmail.com>
Date: Thu, 14 Mar 2024 07:45:50 +0100
Subject: [PATCH 104/199] [actions] migrate OSX tests to GHA
Co-authored-by: Ashok Suthar <coderatlabs@gmail.com>
Co-authored-by: Jordan Harband <ljharb@gmail.com>
---
.github/workflows/node-4+.yml | 8 ++++++-
.travis.yml | 40 -----------------------------------
CHANGELOG.md | 4 ++++
3 files changed, 11 insertions(+), 41 deletions(-)
delete mode 100644 .travis.yml
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
index 2925adda8a..62c654decc 100644
--- a/.github/workflows/node-4+.yml
+++ b/.github/workflows/node-4+.yml
@@ -22,11 +22,14 @@ jobs:
latest:
needs: [matrix]
name: 'majors'
- runs-on: ubuntu-latest
+ runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
+ os:
+ - ubuntu-latest
+ - macos-latest
node-version: ${{ fromJson(needs.matrix.outputs.latest) }}
eslint:
- 8
@@ -38,16 +41,19 @@ jobs:
- 2
include:
- node-version: 'lts/*'
+ os: ubuntu-latest
eslint: 7
ts-parser: 4
env:
TS_PARSER: 4
- node-version: 'lts/*'
+ os: ubuntu-latest
eslint: 7
ts-parser: 3
env:
TS_PARSER: 3
- node-version: 'lts/*'
+ os: ubuntu-latest
eslint: 7
ts-parser: 2
env:
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 21a7070fb7..0000000000
--- a/.travis.yml
+++ /dev/null
@@ -1,40 +0,0 @@
-language: node_js
-
-# osx backlog is often deep, so to be polite we can just hit these highlights
-matrix:
- include:
- - os: osx
- env: ESLINT_VERSION=5
- node_js: 14
- - os: osx
- env: ESLINT_VERSION=5
- node_js: 12
- - os: osx
- env: ESLINT_VERSION=5
- node_js: 10
- - os: osx
- env: ESLINT_VERSION=4
- node_js: 8
- - os: osx
- env: ESLINT_VERSION=3
- node_js: 6
- - os: osx
- env: ESLINT_VERSION=2
- node_js: 4
-
- fast_finish: true
-
-before_install:
- - 'nvm install-latest-npm'
- - 'NPM_CONFIG_LEGACY_PEER_DEPS=true npm install'
- - 'npm run copy-metafiles'
-install:
- - 'NPM_CONFIG_LEGACY_PEER_DEPS=true npm install'
- - 'if [ -n "${ESLINT_VERSION}" ]; then ./tests/dep-time-travel.sh; fi'
- - 'npm run pretest'
-
-script:
- - npm run tests-only
-
-after_success:
- - bash <(curl -Os https://uploader.codecov.io/latest/linux/codecov)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f8a6f80d0e..b1aa3a9785 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Refactor] `ExportMap`: separate ExportMap instance from its builder logic ([#2985], thanks [@soryy708])
- [Docs] `order`: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
- [Tests] appveyor -> GHA (run tests on Windows in both pwsh and WSL + Ubuntu) ([#2987], thanks [@joeyguerra])
+- [actions] migrate OSX tests to GHA ([ljharb#37], thanks [@aks-])
## [2.29.1] - 2023-12-14
@@ -1458,6 +1459,8 @@ for info on changes for earlier releases.
[#164]: https://github.com/import-js/eslint-plugin-import/pull/164
[#157]: https://github.com/import-js/eslint-plugin-import/pull/157
+[ljharb#37]: https://github.com/ljharb/eslint-plugin-import/pull/37
+
[#2930]: https://github.com/import-js/eslint-plugin-import/issues/2930
[#2687]: https://github.com/import-js/eslint-plugin-import/issues/2687
[#2684]: https://github.com/import-js/eslint-plugin-import/issues/2684
@@ -1690,6 +1693,7 @@ for info on changes for earlier releases.
[@adjerbetian]: https://github.com/adjerbetian
[@AdriAt360]: https://github.com/AdriAt360
[@ai]: https://github.com/ai
+[@aks-]: https://github.com/aks-
[@aladdin-add]: https://github.com/aladdin-add
[@alex-page]: https://github.com/alex-page
[@alexgorbatchev]: https://github.com/alexgorbatchev
From 38f8d25ef710747fe318d99b3f42e70bd1efc0f4 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sat, 23 Mar 2024 22:47:24 -0700
Subject: [PATCH 105/199] [actions] update actions to node20
---
.github/workflows/node-4+.yml | 4 ++--
.github/workflows/node-pretest.yml | 4 ++--
.github/workflows/packages.yml | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
index 62c654decc..60fa609dbe 100644
--- a/.github/workflows/node-4+.yml
+++ b/.github/workflows/node-4+.yml
@@ -105,7 +105,7 @@ jobs:
eslint: 5
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
- uses: ljharb/actions/node/install@main
continue-on-error: ${{ matrix.eslint == 4 && matrix.node-version == 4 }}
name: 'nvm install ${{ matrix.node-version }} && npm install, with eslint ${{ matrix.eslint }}'
@@ -119,7 +119,7 @@ jobs:
skip-ls-check: true
- run: npm run pretest
- run: npm run tests-only
- - uses: codecov/codecov-action@v3
+ - uses: codecov/codecov-action@v3.1.5
node:
name: 'node 4+'
diff --git a/.github/workflows/node-pretest.yml b/.github/workflows/node-pretest.yml
index e4340018e4..f8db36de57 100644
--- a/.github/workflows/node-pretest.yml
+++ b/.github/workflows/node-pretest.yml
@@ -10,7 +10,7 @@ jobs:
# runs-on: ubuntu-latest
# steps:
- # - uses: actions/checkout@v3
+ # - uses: actions/checkout@v4
# - uses: ljharb/actions/node/install@main
# name: 'nvm install lts/* && npm install'
# with:
@@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
- uses: ljharb/actions/node/install@main
name: 'nvm install lts/* && npm install'
with:
diff --git a/.github/workflows/packages.yml b/.github/workflows/packages.yml
index a6fb4e4cb5..213e1a43ce 100644
--- a/.github/workflows/packages.yml
+++ b/.github/workflows/packages.yml
@@ -38,7 +38,7 @@ jobs:
# - utils
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
- uses: ljharb/actions/node/install@main
name: 'nvm install ${{ matrix.node-version }} && npm install'
env:
@@ -50,7 +50,7 @@ jobs:
after_install: npm run copy-metafiles && ./tests/dep-time-travel.sh && cd ${{ matrix.package }} && npm install
skip-ls-check: true
- run: cd ${{ matrix.package }} && npm run tests-only
- - uses: codecov/codecov-action@v3
+ - uses: codecov/codecov-action@v3.1.5
packages:
name: 'packages: all tests'
From 2de78c1eac5064858cc366e211913c4f9e43919b Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Mon, 25 Mar 2024 19:21:56 +0200
Subject: [PATCH 106/199] [Refactor] `exportMapBuilder`: avoid hoisting
---
.eslintrc | 1 -
CHANGELOG.md | 2 +
src/exportMapBuilder.js | 305 ++++++++++++++++++++--------------------
3 files changed, 155 insertions(+), 153 deletions(-)
diff --git a/.eslintrc b/.eslintrc
index 1bbbba0148..80e1014c60 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -229,7 +229,6 @@
{
"files": [
"utils/**", // TODO
- "src/exportMapBuilder.js", // TODO
],
"rules": {
"no-use-before-define": "off",
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b1aa3a9785..c05ea32c01 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] `order`: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
- [Tests] appveyor -> GHA (run tests on Windows in both pwsh and WSL + Ubuntu) ([#2987], thanks [@joeyguerra])
- [actions] migrate OSX tests to GHA ([ljharb#37], thanks [@aks-])
+- [Refactor] `exportMapBuilder`: avoid hoisting ([#2989], thanks [@soryy708])
## [2.29.1] - 2023-12-14
@@ -1113,6 +1114,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
[#2985]: https://github.com/import-js/eslint-plugin-import/pull/2985
[#2982]: https://github.com/import-js/eslint-plugin-import/pull/2982
diff --git a/src/exportMapBuilder.js b/src/exportMapBuilder.js
index f2b40e7b4c..5aeb306d0b 100644
--- a/src/exportMapBuilder.js
+++ b/src/exportMapBuilder.js
@@ -118,6 +118,100 @@ const availableDocStyleParsers = {
const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
+let parserOptionsHash = '';
+let prevParserOptions = '';
+let settingsHash = '';
+let prevSettings = '';
+/**
+ * don't hold full context object in memory, just grab what we need.
+ * also calculate a cacheKey, where parts of the cacheKey hash are memoized
+ */
+function childContext(path, context) {
+ const { settings, parserOptions, parserPath } = context;
+
+ if (JSON.stringify(settings) !== prevSettings) {
+ settingsHash = hashObject({ settings }).digest('hex');
+ prevSettings = JSON.stringify(settings);
+ }
+
+ if (JSON.stringify(parserOptions) !== prevParserOptions) {
+ parserOptionsHash = hashObject({ parserOptions }).digest('hex');
+ prevParserOptions = JSON.stringify(parserOptions);
+ }
+
+ return {
+ cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
+ settings,
+ parserOptions,
+ parserPath,
+ path,
+ };
+}
+
+/**
+ * sometimes legacy support isn't _that_ hard... right?
+ */
+function makeSourceCode(text, ast) {
+ if (SourceCode.length > 1) {
+ // ESLint 3
+ return new SourceCode(text, ast);
+ } else {
+ // ESLint 4, 5
+ return new SourceCode({ text, ast });
+ }
+}
+
+/**
+ * Traverse a pattern/identifier node, calling 'callback'
+ * for each leaf identifier.
+ * @param {node} pattern
+ * @param {Function} callback
+ * @return {void}
+ */
+export function recursivePatternCapture(pattern, callback) {
+ switch (pattern.type) {
+ case 'Identifier': // base case
+ callback(pattern);
+ break;
+
+ case 'ObjectPattern':
+ pattern.properties.forEach((p) => {
+ if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
+ callback(p.argument);
+ return;
+ }
+ recursivePatternCapture(p.value, callback);
+ });
+ break;
+
+ case 'ArrayPattern':
+ pattern.elements.forEach((element) => {
+ if (element == null) { return; }
+ if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
+ callback(element.argument);
+ return;
+ }
+ recursivePatternCapture(element, callback);
+ });
+ break;
+
+ case 'AssignmentPattern':
+ callback(pattern.left);
+ break;
+ default:
+ }
+}
+
+/**
+ * The creation of this closure is isolated from other scopes
+ * to avoid over-retention of unrelated variables, which has
+ * caused memory leaks. See #1266.
+ */
+function thunkFor(p, context) {
+ // eslint-disable-next-line no-use-before-define
+ return () => ExportMapBuilder.for(childContext(p, context));
+}
+
export default class ExportMapBuilder {
static get(source, context) {
const path = resolve(source, context);
@@ -183,6 +277,43 @@ export default class ExportMapBuilder {
}
static parse(path, content, context) {
+ function readTsConfig(context) {
+ const tsconfigInfo = tsConfigLoader({
+ cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
+ getEnv: (key) => process.env[key],
+ });
+ try {
+ if (tsconfigInfo.tsConfigPath !== undefined) {
+ // Projects not using TypeScript won't have `typescript` installed.
+ if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
+
+ const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
+ return ts.parseJsonConfigFileContent(
+ configFile.config,
+ ts.sys,
+ dirname(tsconfigInfo.tsConfigPath),
+ );
+ }
+ } catch (e) {
+ // Catch any errors
+ }
+
+ return null;
+ }
+
+ function isEsModuleInterop() {
+ const cacheKey = hashObject({
+ tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
+ }).digest('hex');
+ let tsConfig = tsconfigCache.get(cacheKey);
+ if (typeof tsConfig === 'undefined') {
+ tsConfig = readTsConfig(context);
+ tsconfigCache.set(cacheKey, tsConfig);
+ }
+
+ return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
+ }
+
const m = new ExportMap(path);
const isEsModuleInteropTrue = isEsModuleInterop();
@@ -201,6 +332,10 @@ export default class ExportMapBuilder {
let hasDynamicImports = false;
+ function remotePath(value) {
+ return resolve.relative(value, path, context.settings);
+ }
+
function processDynamicImport(source) {
hasDynamicImports = true;
if (source.type !== 'Literal') {
@@ -264,10 +399,6 @@ export default class ExportMapBuilder {
const namespaces = new Map();
- function remotePath(value) {
- return resolve.relative(value, path, context.settings);
- }
-
function resolveImport(value) {
const rp = remotePath(value);
if (rp == null) { return null; }
@@ -324,27 +455,6 @@ export default class ExportMapBuilder {
m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) });
}
- function captureDependencyWithSpecifiers(n) {
- // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
- const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
- // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
- // shouldn't be considered to be just importing types
- let specifiersOnlyImportingTypes = n.specifiers.length > 0;
- const importedSpecifiers = new Set();
- n.specifiers.forEach((specifier) => {
- if (specifier.type === 'ImportSpecifier') {
- importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
- } else if (supportedImportTypes.has(specifier.type)) {
- importedSpecifiers.add(specifier.type);
- }
-
- // import { type Foo } (Flow); import { typeof Foo } (Flow)
- specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
- && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
- });
- captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, importedSpecifiers);
- }
-
function captureDependency({ source }, isOnlyImportingTypes, importedSpecifiers = new Set()) {
if (source == null) { return null; }
@@ -369,44 +479,28 @@ export default class ExportMapBuilder {
return getter;
}
- const source = makeSourceCode(content, ast);
-
- function readTsConfig(context) {
- const tsconfigInfo = tsConfigLoader({
- cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
- getEnv: (key) => process.env[key],
- });
- try {
- if (tsconfigInfo.tsConfigPath !== undefined) {
- // Projects not using TypeScript won't have `typescript` installed.
- if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
-
- const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
- return ts.parseJsonConfigFileContent(
- configFile.config,
- ts.sys,
- dirname(tsconfigInfo.tsConfigPath),
- );
+ function captureDependencyWithSpecifiers(n) {
+ // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
+ const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
+ // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
+ // shouldn't be considered to be just importing types
+ let specifiersOnlyImportingTypes = n.specifiers.length > 0;
+ const importedSpecifiers = new Set();
+ n.specifiers.forEach((specifier) => {
+ if (specifier.type === 'ImportSpecifier') {
+ importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
+ } else if (supportedImportTypes.has(specifier.type)) {
+ importedSpecifiers.add(specifier.type);
}
- } catch (e) {
- // Catch any errors
- }
- return null;
+ // import { type Foo } (Flow); import { typeof Foo } (Flow)
+ specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
+ && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
+ });
+ captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, importedSpecifiers);
}
- function isEsModuleInterop() {
- const cacheKey = hashObject({
- tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
- }).digest('hex');
- let tsConfig = tsconfigCache.get(cacheKey);
- if (typeof tsConfig === 'undefined') {
- tsConfig = readTsConfig(context);
- tsconfigCache.set(cacheKey, tsConfig);
- }
-
- return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
- }
+ const source = makeSourceCode(content, ast);
ast.body.forEach(function (n) {
if (n.type === 'ExportDefaultDeclaration') {
@@ -555,96 +649,3 @@ export default class ExportMapBuilder {
return m;
}
}
-
-/**
- * The creation of this closure is isolated from other scopes
- * to avoid over-retention of unrelated variables, which has
- * caused memory leaks. See #1266.
- */
-function thunkFor(p, context) {
- return () => ExportMapBuilder.for(childContext(p, context));
-}
-
-/**
- * Traverse a pattern/identifier node, calling 'callback'
- * for each leaf identifier.
- * @param {node} pattern
- * @param {Function} callback
- * @return {void}
- */
-export function recursivePatternCapture(pattern, callback) {
- switch (pattern.type) {
- case 'Identifier': // base case
- callback(pattern);
- break;
-
- case 'ObjectPattern':
- pattern.properties.forEach((p) => {
- if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
- callback(p.argument);
- return;
- }
- recursivePatternCapture(p.value, callback);
- });
- break;
-
- case 'ArrayPattern':
- pattern.elements.forEach((element) => {
- if (element == null) { return; }
- if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
- callback(element.argument);
- return;
- }
- recursivePatternCapture(element, callback);
- });
- break;
-
- case 'AssignmentPattern':
- callback(pattern.left);
- break;
- default:
- }
-}
-
-let parserOptionsHash = '';
-let prevParserOptions = '';
-let settingsHash = '';
-let prevSettings = '';
-/**
- * don't hold full context object in memory, just grab what we need.
- * also calculate a cacheKey, where parts of the cacheKey hash are memoized
- */
-function childContext(path, context) {
- const { settings, parserOptions, parserPath } = context;
-
- if (JSON.stringify(settings) !== prevSettings) {
- settingsHash = hashObject({ settings }).digest('hex');
- prevSettings = JSON.stringify(settings);
- }
-
- if (JSON.stringify(parserOptions) !== prevParserOptions) {
- parserOptionsHash = hashObject({ parserOptions }).digest('hex');
- prevParserOptions = JSON.stringify(parserOptions);
- }
-
- return {
- cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
- settings,
- parserOptions,
- parserPath,
- path,
- };
-}
-
-/**
- * sometimes legacy support isn't _that_ hard... right?
- */
-function makeSourceCode(text, ast) {
- if (SourceCode.length > 1) {
- // ESLint 3
- return new SourceCode(text, ast);
- } else {
- // ESLint 4, 5
- return new SourceCode({ text, ast });
- }
-}
From 8587c85a60ccb3839cb2eabe50cf098a4a2c03c2 Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Wed, 27 Mar 2024 18:39:53 +0200
Subject: [PATCH 107/199] [Refactor] `ExportMap`: extract "builder" logic to
separate files
---
CHANGELOG.md | 2 +
src/exportMap/builder.js | 206 +++++++
src/exportMap/captureDependency.js | 60 +++
src/exportMap/childContext.js | 32 ++
src/exportMap/doc.js | 90 ++++
src/{exportMap.js => exportMap/index.js} | 0
src/exportMap/namespace.js | 39 ++
src/exportMap/patternCapture.js | 40 ++
src/exportMap/remotePath.js | 12 +
src/exportMap/specifier.js | 32 ++
src/exportMap/typescript.js | 43 ++
src/exportMap/visitor.js | 171 ++++++
src/exportMapBuilder.js | 651 -----------------------
src/rules/default.js | 2 +-
src/rules/export.js | 3 +-
src/rules/named.js | 2 +-
src/rules/namespace.js | 2 +-
src/rules/no-cycle.js | 2 +-
src/rules/no-deprecated.js | 2 +-
src/rules/no-named-as-default-member.js | 2 +-
src/rules/no-named-as-default.js | 2 +-
src/rules/no-unused-modules.js | 3 +-
tests/src/core/getExports.js | 2 +-
23 files changed, 739 insertions(+), 661 deletions(-)
create mode 100644 src/exportMap/builder.js
create mode 100644 src/exportMap/captureDependency.js
create mode 100644 src/exportMap/childContext.js
create mode 100644 src/exportMap/doc.js
rename src/{exportMap.js => exportMap/index.js} (100%)
create mode 100644 src/exportMap/namespace.js
create mode 100644 src/exportMap/patternCapture.js
create mode 100644 src/exportMap/remotePath.js
create mode 100644 src/exportMap/specifier.js
create mode 100644 src/exportMap/typescript.js
create mode 100644 src/exportMap/visitor.js
delete mode 100644 src/exportMapBuilder.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c05ea32c01..a07647c82d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Tests] appveyor -> GHA (run tests on Windows in both pwsh and WSL + Ubuntu) ([#2987], thanks [@joeyguerra])
- [actions] migrate OSX tests to GHA ([ljharb#37], thanks [@aks-])
- [Refactor] `exportMapBuilder`: avoid hoisting ([#2989], thanks [@soryy708])
+- [Refactor] `ExportMap`: extract "builder" logic to separate files ([#2991], thanks [@soryy708])
## [2.29.1] - 2023-12-14
@@ -1114,6 +1115,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
[#2985]: https://github.com/import-js/eslint-plugin-import/pull/2985
diff --git a/src/exportMap/builder.js b/src/exportMap/builder.js
new file mode 100644
index 0000000000..5348dba375
--- /dev/null
+++ b/src/exportMap/builder.js
@@ -0,0 +1,206 @@
+import fs from 'fs';
+
+import doctrine from 'doctrine';
+
+import debug from 'debug';
+
+import parse from 'eslint-module-utils/parse';
+import visit from 'eslint-module-utils/visit';
+import resolve from 'eslint-module-utils/resolve';
+import isIgnored, { hasValidExtension } from 'eslint-module-utils/ignore';
+
+import { hashObject } from 'eslint-module-utils/hash';
+import * as unambiguous from 'eslint-module-utils/unambiguous';
+
+import ExportMap from '.';
+import childContext from './childContext';
+import { isEsModuleInterop } from './typescript';
+import { RemotePath } from './remotePath';
+import ImportExportVisitorBuilder from './visitor';
+
+const log = debug('eslint-plugin-import:ExportMap');
+
+const exportCache = new Map();
+
+/**
+ * The creation of this closure is isolated from other scopes
+ * to avoid over-retention of unrelated variables, which has
+ * caused memory leaks. See #1266.
+ */
+function thunkFor(p, context) {
+ // eslint-disable-next-line no-use-before-define
+ return () => ExportMapBuilder.for(childContext(p, context));
+}
+
+export default class ExportMapBuilder {
+ static get(source, context) {
+ const path = resolve(source, context);
+ if (path == null) { return null; }
+
+ return ExportMapBuilder.for(childContext(path, context));
+ }
+
+ static for(context) {
+ const { path } = context;
+
+ const cacheKey = context.cacheKey || hashObject(context).digest('hex');
+ let exportMap = exportCache.get(cacheKey);
+
+ // return cached ignore
+ if (exportMap === null) { return null; }
+
+ const stats = fs.statSync(path);
+ if (exportMap != null) {
+ // date equality check
+ if (exportMap.mtime - stats.mtime === 0) {
+ return exportMap;
+ }
+ // future: check content equality?
+ }
+
+ // check valid extensions first
+ if (!hasValidExtension(path, context)) {
+ exportCache.set(cacheKey, null);
+ return null;
+ }
+
+ // check for and cache ignore
+ if (isIgnored(path, context)) {
+ log('ignored path due to ignore settings:', path);
+ exportCache.set(cacheKey, null);
+ return null;
+ }
+
+ const content = fs.readFileSync(path, { encoding: 'utf8' });
+
+ // check for and cache unambiguous modules
+ if (!unambiguous.test(content)) {
+ log('ignored path due to unambiguous regex:', path);
+ exportCache.set(cacheKey, null);
+ return null;
+ }
+
+ log('cache miss', cacheKey, 'for path', path);
+ exportMap = ExportMapBuilder.parse(path, content, context);
+
+ // ambiguous modules return null
+ if (exportMap == null) {
+ log('ignored path due to ambiguous parse:', path);
+ exportCache.set(cacheKey, null);
+ return null;
+ }
+
+ exportMap.mtime = stats.mtime;
+
+ exportCache.set(cacheKey, exportMap);
+ return exportMap;
+ }
+
+ static parse(path, content, context) {
+ const exportMap = new ExportMap(path);
+ const isEsModuleInteropTrue = isEsModuleInterop(context);
+
+ let ast;
+ let visitorKeys;
+ try {
+ const result = parse(path, content, context);
+ ast = result.ast;
+ visitorKeys = result.visitorKeys;
+ } catch (err) {
+ exportMap.errors.push(err);
+ return exportMap; // can't continue
+ }
+
+ exportMap.visitorKeys = visitorKeys;
+
+ let hasDynamicImports = false;
+
+ const remotePathResolver = new RemotePath(path, context);
+
+ function processDynamicImport(source) {
+ hasDynamicImports = true;
+ if (source.type !== 'Literal') {
+ return null;
+ }
+ const p = remotePathResolver.resolve(source.value);
+ if (p == null) {
+ return null;
+ }
+ const importedSpecifiers = new Set();
+ importedSpecifiers.add('ImportNamespaceSpecifier');
+ const getter = thunkFor(p, context);
+ exportMap.imports.set(p, {
+ getter,
+ declarations: new Set([{
+ source: {
+ // capturing actual node reference holds full AST in memory!
+ value: source.value,
+ loc: source.loc,
+ },
+ importedSpecifiers,
+ dynamic: true,
+ }]),
+ });
+ }
+
+ visit(ast, visitorKeys, {
+ ImportExpression(node) {
+ processDynamicImport(node.source);
+ },
+ CallExpression(node) {
+ if (node.callee.type === 'Import') {
+ processDynamicImport(node.arguments[0]);
+ }
+ },
+ });
+
+ const unambiguouslyESM = unambiguous.isModule(ast);
+ if (!unambiguouslyESM && !hasDynamicImports) { return null; }
+
+ // attempt to collect module doc
+ if (ast.comments) {
+ ast.comments.some((c) => {
+ if (c.type !== 'Block') { return false; }
+ try {
+ const doc = doctrine.parse(c.value, { unwrap: true });
+ if (doc.tags.some((t) => t.title === 'module')) {
+ exportMap.doc = doc;
+ return true;
+ }
+ } catch (err) { /* ignore */ }
+ return false;
+ });
+ }
+
+ const visitorBuilder = new ImportExportVisitorBuilder(
+ path,
+ context,
+ exportMap,
+ ExportMapBuilder,
+ content,
+ ast,
+ isEsModuleInteropTrue,
+ thunkFor,
+ );
+ ast.body.forEach(function (astNode) {
+ const visitor = visitorBuilder.build(astNode);
+
+ if (visitor[astNode.type]) {
+ visitor[astNode.type].call(visitorBuilder);
+ }
+ });
+
+ if (
+ isEsModuleInteropTrue // esModuleInterop is on in tsconfig
+ && exportMap.namespace.size > 0 // anything is exported
+ && !exportMap.namespace.has('default') // and default isn't added already
+ ) {
+ exportMap.namespace.set('default', {}); // add default export
+ }
+
+ if (unambiguouslyESM) {
+ exportMap.parseGoal = 'Module';
+ }
+ return exportMap;
+ }
+}
diff --git a/src/exportMap/captureDependency.js b/src/exportMap/captureDependency.js
new file mode 100644
index 0000000000..9ad37d0e20
--- /dev/null
+++ b/src/exportMap/captureDependency.js
@@ -0,0 +1,60 @@
+export function captureDependency(
+ { source },
+ isOnlyImportingTypes,
+ remotePathResolver,
+ exportMap,
+ context,
+ thunkFor,
+ importedSpecifiers = new Set(),
+) {
+ if (source == null) { return null; }
+
+ const p = remotePathResolver.resolve(source.value);
+ if (p == null) { return null; }
+
+ const declarationMetadata = {
+ // capturing actual node reference holds full AST in memory!
+ source: { value: source.value, loc: source.loc },
+ isOnlyImportingTypes,
+ importedSpecifiers,
+ };
+
+ const existing = exportMap.imports.get(p);
+ if (existing != null) {
+ existing.declarations.add(declarationMetadata);
+ return existing.getter;
+ }
+
+ const getter = thunkFor(p, context);
+ exportMap.imports.set(p, { getter, declarations: new Set([declarationMetadata]) });
+ return getter;
+}
+
+const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
+
+export function captureDependencyWithSpecifiers(
+ n,
+ remotePathResolver,
+ exportMap,
+ context,
+ thunkFor,
+) {
+ // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
+ const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
+ // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
+ // shouldn't be considered to be just importing types
+ let specifiersOnlyImportingTypes = n.specifiers.length > 0;
+ const importedSpecifiers = new Set();
+ n.specifiers.forEach((specifier) => {
+ if (specifier.type === 'ImportSpecifier') {
+ importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
+ } else if (supportedImportTypes.has(specifier.type)) {
+ importedSpecifiers.add(specifier.type);
+ }
+
+ // import { type Foo } (Flow); import { typeof Foo } (Flow)
+ specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
+ && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
+ });
+ captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, remotePathResolver, exportMap, context, thunkFor, importedSpecifiers);
+}
diff --git a/src/exportMap/childContext.js b/src/exportMap/childContext.js
new file mode 100644
index 0000000000..5f82b8e575
--- /dev/null
+++ b/src/exportMap/childContext.js
@@ -0,0 +1,32 @@
+import { hashObject } from 'eslint-module-utils/hash';
+
+let parserOptionsHash = '';
+let prevParserOptions = '';
+let settingsHash = '';
+let prevSettings = '';
+
+/**
+ * don't hold full context object in memory, just grab what we need.
+ * also calculate a cacheKey, where parts of the cacheKey hash are memoized
+ */
+export default function childContext(path, context) {
+ const { settings, parserOptions, parserPath } = context;
+
+ if (JSON.stringify(settings) !== prevSettings) {
+ settingsHash = hashObject({ settings }).digest('hex');
+ prevSettings = JSON.stringify(settings);
+ }
+
+ if (JSON.stringify(parserOptions) !== prevParserOptions) {
+ parserOptionsHash = hashObject({ parserOptions }).digest('hex');
+ prevParserOptions = JSON.stringify(parserOptions);
+ }
+
+ return {
+ cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
+ settings,
+ parserOptions,
+ parserPath,
+ path,
+ };
+}
diff --git a/src/exportMap/doc.js b/src/exportMap/doc.js
new file mode 100644
index 0000000000..c721ae25fc
--- /dev/null
+++ b/src/exportMap/doc.js
@@ -0,0 +1,90 @@
+import doctrine from 'doctrine';
+
+/**
+ * parse docs from the first node that has leading comments
+ */
+export function captureDoc(source, docStyleParsers, ...nodes) {
+ const metadata = {};
+
+ // 'some' short-circuits on first 'true'
+ nodes.some((n) => {
+ try {
+
+ let leadingComments;
+
+ // n.leadingComments is legacy `attachComments` behavior
+ if ('leadingComments' in n) {
+ leadingComments = n.leadingComments;
+ } else if (n.range) {
+ leadingComments = source.getCommentsBefore(n);
+ }
+
+ if (!leadingComments || leadingComments.length === 0) { return false; }
+
+ for (const name in docStyleParsers) {
+ const doc = docStyleParsers[name](leadingComments);
+ if (doc) {
+ metadata.doc = doc;
+ }
+ }
+
+ return true;
+ } catch (err) {
+ return false;
+ }
+ });
+
+ return metadata;
+}
+
+/**
+ * parse JSDoc from leading comments
+ * @param {object[]} comments
+ * @return {{ doc: object }}
+ */
+function captureJsDoc(comments) {
+ let doc;
+
+ // capture XSDoc
+ comments.forEach((comment) => {
+ // skip non-block comments
+ if (comment.type !== 'Block') { return; }
+ try {
+ doc = doctrine.parse(comment.value, { unwrap: true });
+ } catch (err) {
+ /* don't care, for now? maybe add to `errors?` */
+ }
+ });
+
+ return doc;
+}
+
+/**
+ * parse TomDoc section from comments
+ */
+function captureTomDoc(comments) {
+ // collect lines up to first paragraph break
+ const lines = [];
+ for (let i = 0; i < comments.length; i++) {
+ const comment = comments[i];
+ if (comment.value.match(/^\s*$/)) { break; }
+ lines.push(comment.value.trim());
+ }
+
+ // return doctrine-like object
+ const statusMatch = lines.join(' ').match(/^(Public|Internal|Deprecated):\s*(.+)/);
+ if (statusMatch) {
+ return {
+ description: statusMatch[2],
+ tags: [{
+ title: statusMatch[1].toLowerCase(),
+ description: statusMatch[2],
+ }],
+ };
+ }
+}
+
+export const availableDocStyleParsers = {
+ jsdoc: captureJsDoc,
+ tomdoc: captureTomDoc,
+};
diff --git a/src/exportMap.js b/src/exportMap/index.js
similarity index 100%
rename from src/exportMap.js
rename to src/exportMap/index.js
diff --git a/src/exportMap/namespace.js b/src/exportMap/namespace.js
new file mode 100644
index 0000000000..370f47579d
--- /dev/null
+++ b/src/exportMap/namespace.js
@@ -0,0 +1,39 @@
+import childContext from './childContext';
+import { RemotePath } from './remotePath';
+
+export default class Namespace {
+ constructor(
+ path,
+ context,
+ ExportMapBuilder,
+ ) {
+ this.remotePathResolver = new RemotePath(path, context);
+ this.context = context;
+ this.ExportMapBuilder = ExportMapBuilder;
+ this.namespaces = new Map();
+ }
+
+ resolveImport(value) {
+ const rp = this.remotePathResolver.resolve(value);
+ if (rp == null) { return null; }
+ return this.ExportMapBuilder.for(childContext(rp, this.context));
+ }
+
+ getNamespace(identifier) {
+ if (!this.namespaces.has(identifier.name)) { return; }
+ return () => this.resolveImport(this.namespaces.get(identifier.name));
+ }
+
+ add(object, identifier) {
+ const nsfn = this.getNamespace(identifier);
+ if (nsfn) {
+ Object.defineProperty(object, 'namespace', { get: nsfn });
+ }
+
+ return object;
+ }
+
+ rawSet(name, value) {
+ this.namespaces.set(name, value);
+ }
+}
diff --git a/src/exportMap/patternCapture.js b/src/exportMap/patternCapture.js
new file mode 100644
index 0000000000..5bc9806417
--- /dev/null
+++ b/src/exportMap/patternCapture.js
@@ -0,0 +1,40 @@
+/**
+ * Traverse a pattern/identifier node, calling 'callback'
+ * for each leaf identifier.
+ * @param {node} pattern
+ * @param {Function} callback
+ * @return {void}
+ */
+export default function recursivePatternCapture(pattern, callback) {
+ switch (pattern.type) {
+ case 'Identifier': // base case
+ callback(pattern);
+ break;
+
+ case 'ObjectPattern':
+ pattern.properties.forEach((p) => {
+ if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
+ callback(p.argument);
+ return;
+ }
+ recursivePatternCapture(p.value, callback);
+ });
+ break;
+
+ case 'ArrayPattern':
+ pattern.elements.forEach((element) => {
+ if (element == null) { return; }
+ if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
+ callback(element.argument);
+ return;
+ }
+ recursivePatternCapture(element, callback);
+ });
+ break;
+
+ case 'AssignmentPattern':
+ callback(pattern.left);
+ break;
+ default:
+ }
+}
diff --git a/src/exportMap/remotePath.js b/src/exportMap/remotePath.js
new file mode 100644
index 0000000000..0dc5fc0954
--- /dev/null
+++ b/src/exportMap/remotePath.js
@@ -0,0 +1,12 @@
+import resolve from 'eslint-module-utils/resolve';
+
+export class RemotePath {
+ constructor(path, context) {
+ this.path = path;
+ this.context = context;
+ }
+
+ resolve(value) {
+ return resolve.relative(value, this.path, this.context.settings);
+ }
+}
diff --git a/src/exportMap/specifier.js b/src/exportMap/specifier.js
new file mode 100644
index 0000000000..dfaaf618e4
--- /dev/null
+++ b/src/exportMap/specifier.js
@@ -0,0 +1,32 @@
+export default function processSpecifier(specifier, astNode, exportMap, namespace) {
+ const nsource = astNode.source && astNode.source.value;
+ const exportMeta = {};
+ let local;
+
+ switch (specifier.type) {
+ case 'ExportDefaultSpecifier':
+ if (!nsource) { return; }
+ local = 'default';
+ break;
+ case 'ExportNamespaceSpecifier':
+ exportMap.namespace.set(specifier.exported.name, Object.defineProperty(exportMeta, 'namespace', {
+ get() { return namespace.resolveImport(nsource); },
+ }));
+ return;
+ case 'ExportAllDeclaration':
+ exportMap.namespace.set(specifier.exported.name || specifier.exported.value, namespace.add(exportMeta, specifier.source.value));
+ return;
+ case 'ExportSpecifier':
+ if (!astNode.source) {
+ exportMap.namespace.set(specifier.exported.name || specifier.exported.value, namespace.add(exportMeta, specifier.local));
+ return;
+ }
+ // else falls through
+ default:
+ local = specifier.local.name;
+ break;
+ }
+
+ // todo: JSDoc
+ exportMap.reexports.set(specifier.exported.name, { local, getImport: () => namespace.resolveImport(nsource) });
+}
diff --git a/src/exportMap/typescript.js b/src/exportMap/typescript.js
new file mode 100644
index 0000000000..7db4356da8
--- /dev/null
+++ b/src/exportMap/typescript.js
@@ -0,0 +1,43 @@
+import { dirname } from 'path';
+import { tsConfigLoader } from 'tsconfig-paths/lib/tsconfig-loader';
+import { hashObject } from 'eslint-module-utils/hash';
+
+let ts;
+const tsconfigCache = new Map();
+
+function readTsConfig(context) {
+ const tsconfigInfo = tsConfigLoader({
+ cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
+ getEnv: (key) => process.env[key],
+ });
+ try {
+ if (tsconfigInfo.tsConfigPath !== undefined) {
+ // Projects not using TypeScript won't have `typescript` installed.
+ if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
+
+ const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
+ return ts.parseJsonConfigFileContent(
+ configFile.config,
+ ts.sys,
+ dirname(tsconfigInfo.tsConfigPath),
+ );
+ }
+ } catch (e) {
+ // Catch any errors
+ }
+
+ return null;
+}
+
+export function isEsModuleInterop(context) {
+ const cacheKey = hashObject({
+ tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
+ }).digest('hex');
+ let tsConfig = tsconfigCache.get(cacheKey);
+ if (typeof tsConfig === 'undefined') {
+ tsConfig = readTsConfig(context);
+ tsconfigCache.set(cacheKey, tsConfig);
+ }
+
+ return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
+}
diff --git a/src/exportMap/visitor.js b/src/exportMap/visitor.js
new file mode 100644
index 0000000000..21c1a7c644
--- /dev/null
+++ b/src/exportMap/visitor.js
@@ -0,0 +1,171 @@
+import includes from 'array-includes';
+import { SourceCode } from 'eslint';
+import { availableDocStyleParsers, captureDoc } from './doc';
+import Namespace from './namespace';
+import processSpecifier from './specifier';
+import { captureDependency, captureDependencyWithSpecifiers } from './captureDependency';
+import recursivePatternCapture from './patternCapture';
+import { RemotePath } from './remotePath';
+
+/**
+ * sometimes legacy support isn't _that_ hard... right?
+ */
+function makeSourceCode(text, ast) {
+ if (SourceCode.length > 1) {
+ // ESLint 3
+ return new SourceCode(text, ast);
+ } else {
+ // ESLint 4, 5
+ return new SourceCode({ text, ast });
+ }
+}
+
+export default class ImportExportVisitorBuilder {
+ constructor(
+ path,
+ context,
+ exportMap,
+ ExportMapBuilder,
+ content,
+ ast,
+ isEsModuleInteropTrue,
+ thunkFor,
+ ) {
+ this.context = context;
+ this.namespace = new Namespace(path, context, ExportMapBuilder);
+ this.remotePathResolver = new RemotePath(path, context);
+ this.source = makeSourceCode(content, ast);
+ this.exportMap = exportMap;
+ this.ast = ast;
+ this.isEsModuleInteropTrue = isEsModuleInteropTrue;
+ this.thunkFor = thunkFor;
+ const docstyle = this.context.settings && this.context.settings['import/docstyle'] || ['jsdoc'];
+ this.docStyleParsers = {};
+ docstyle.forEach((style) => {
+ this.docStyleParsers[style] = availableDocStyleParsers[style];
+ });
+ }
+
+ build(astNode) {
+ return {
+ ExportDefaultDeclaration() {
+ const exportMeta = captureDoc(this.source, this.docStyleParsers, astNode);
+ if (astNode.declaration.type === 'Identifier') {
+ this.namespace.add(exportMeta, astNode.declaration);
+ }
+ this.exportMap.namespace.set('default', exportMeta);
+ },
+ ExportAllDeclaration() {
+ const getter = captureDependency(astNode, astNode.exportKind === 'type', this.remotePathResolver, this.exportMap, this.context, this.thunkFor);
+ if (getter) { this.exportMap.dependencies.add(getter); }
+ if (astNode.exported) {
+ processSpecifier(astNode, astNode.exported, this.exportMap, this.namespace);
+ }
+ },
+ /** capture namespaces in case of later export */
+ ImportDeclaration() {
+ captureDependencyWithSpecifiers(astNode, this.remotePathResolver, this.exportMap, this.context, this.thunkFor);
+ const ns = astNode.specifiers.find((s) => s.type === 'ImportNamespaceSpecifier');
+ if (ns) {
+ this.namespace.rawSet(ns.local.name, astNode.source.value);
+ }
+ },
+ ExportNamedDeclaration() {
+ captureDependencyWithSpecifiers(astNode, this.remotePathResolver, this.exportMap, this.context, this.thunkFor);
+ // capture declaration
+ if (astNode.declaration != null) {
+ switch (astNode.declaration.type) {
+ case 'FunctionDeclaration':
+ case 'ClassDeclaration':
+ case 'TypeAlias': // flowtype with babel-eslint parser
+ case 'InterfaceDeclaration':
+ case 'DeclareFunction':
+ case 'TSDeclareFunction':
+ case 'TSEnumDeclaration':
+ case 'TSTypeAliasDeclaration':
+ case 'TSInterfaceDeclaration':
+ case 'TSAbstractClassDeclaration':
+ case 'TSModuleDeclaration':
+ this.exportMap.namespace.set(astNode.declaration.id.name, captureDoc(this.source, this.docStyleParsers, astNode));
+ break;
+ case 'VariableDeclaration':
+ astNode.declaration.declarations.forEach((d) => {
+ recursivePatternCapture(
+ d.id,
+ (id) => this.exportMap.namespace.set(id.name, captureDoc(this.source, this.docStyleParsers, d, astNode)),
+ );
+ });
+ break;
+ default:
+ }
+ }
+ astNode.specifiers.forEach((s) => processSpecifier(s, astNode, this.exportMap, this.namespace));
+ },
+ TSExportAssignment: () => this.typeScriptExport(astNode),
+ ...this.isEsModuleInteropTrue && { TSNamespaceExportDeclaration: () => this.typeScriptExport(astNode) },
+ };
+ }
+
+ // This doesn't declare anything, but changes what's being exported.
+ typeScriptExport(astNode) {
+ const exportedName = astNode.type === 'TSNamespaceExportDeclaration'
+ ? (astNode.id || astNode.name).name
+ : astNode.expression && astNode.expression.name || astNode.expression.id && astNode.expression.id.name || null;
+ const declTypes = [
+ 'VariableDeclaration',
+ 'ClassDeclaration',
+ 'TSDeclareFunction',
+ 'TSEnumDeclaration',
+ 'TSTypeAliasDeclaration',
+ 'TSInterfaceDeclaration',
+ 'TSAbstractClassDeclaration',
+ 'TSModuleDeclaration',
+ ];
+ const exportedDecls = this.ast.body.filter(({ type, id, declarations }) => includes(declTypes, type) && (
+ id && id.name === exportedName || declarations && declarations.find((d) => d.id.name === exportedName)
+ ));
+ if (exportedDecls.length === 0) {
+ // Export is not referencing any local declaration, must be re-exporting
+ this.exportMap.namespace.set('default', captureDoc(this.source, this.docStyleParsers, astNode));
+ return;
+ }
+ if (
+ this.isEsModuleInteropTrue // esModuleInterop is on in tsconfig
+ && !this.exportMap.namespace.has('default') // and default isn't added already
+ ) {
+ this.exportMap.namespace.set('default', {}); // add default export
+ }
+ exportedDecls.forEach((decl) => {
+ if (decl.type === 'TSModuleDeclaration') {
+ if (decl.body && decl.body.type === 'TSModuleDeclaration') {
+ this.exportMap.namespace.set(decl.body.id.name, captureDoc(this.source, this.docStyleParsers, decl.body));
+ } else if (decl.body && decl.body.body) {
+ decl.body.body.forEach((moduleBlockNode) => {
+ // Export-assignment exports all members in the namespace,
+ // explicitly exported or not.
+ const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration'
+ ? moduleBlockNode.declaration
+ : moduleBlockNode;
+
+ if (!namespaceDecl) {
+ // TypeScript can check this for us; we needn't
+ } else if (namespaceDecl.type === 'VariableDeclaration') {
+ namespaceDecl.declarations.forEach((d) => recursivePatternCapture(d.id, (id) => this.exportMap.namespace.set(
+ id.name,
+ captureDoc(this.source, this.docStyleParsers, decl, namespaceDecl, moduleBlockNode),
+ )),
+ );
+ } else {
+ this.exportMap.namespace.set(
+ namespaceDecl.id.name,
+ captureDoc(this.source, this.docStyleParsers, moduleBlockNode));
+ }
+ });
+ }
+ } else {
+ // Export as default
+ this.exportMap.namespace.set('default', captureDoc(this.source, this.docStyleParsers, decl));
+ }
+ });
+ }
+}
diff --git a/src/exportMapBuilder.js b/src/exportMapBuilder.js
deleted file mode 100644
index 5aeb306d0b..0000000000
--- a/src/exportMapBuilder.js
+++ /dev/null
@@ -1,651 +0,0 @@
-import fs from 'fs';
-import { dirname } from 'path';
-
-import doctrine from 'doctrine';
-
-import debug from 'debug';
-
-import { SourceCode } from 'eslint';
-
-import parse from 'eslint-module-utils/parse';
-import visit from 'eslint-module-utils/visit';
-import resolve from 'eslint-module-utils/resolve';
-import isIgnored, { hasValidExtension } from 'eslint-module-utils/ignore';
-
-import { hashObject } from 'eslint-module-utils/hash';
-import * as unambiguous from 'eslint-module-utils/unambiguous';
-
-import { tsConfigLoader } from 'tsconfig-paths/lib/tsconfig-loader';
-
-import includes from 'array-includes';
-import ExportMap from './exportMap';
-
-let ts;
-
-const log = debug('eslint-plugin-import:ExportMap');
-
-const exportCache = new Map();
-const tsconfigCache = new Map();
-
-/**
- * parse docs from the first node that has leading comments
- */
-function captureDoc(source, docStyleParsers, ...nodes) {
- const metadata = {};
-
- // 'some' short-circuits on first 'true'
- nodes.some((n) => {
- try {
-
- let leadingComments;
-
- // n.leadingComments is legacy `attachComments` behavior
- if ('leadingComments' in n) {
- leadingComments = n.leadingComments;
- } else if (n.range) {
- leadingComments = source.getCommentsBefore(n);
- }
-
- if (!leadingComments || leadingComments.length === 0) { return false; }
-
- for (const name in docStyleParsers) {
- const doc = docStyleParsers[name](leadingComments);
- if (doc) {
- metadata.doc = doc;
- }
- }
-
- return true;
- } catch (err) {
- return false;
- }
- });
-
- return metadata;
-}
-
-/**
- * parse JSDoc from leading comments
- * @param {object[]} comments
- * @return {{ doc: object }}
- */
-function captureJsDoc(comments) {
- let doc;
-
- // capture XSDoc
- comments.forEach((comment) => {
- // skip non-block comments
- if (comment.type !== 'Block') { return; }
- try {
- doc = doctrine.parse(comment.value, { unwrap: true });
- } catch (err) {
- /* don't care, for now? maybe add to `errors?` */
- }
- });
-
- return doc;
-}
-
-/**
- * parse TomDoc section from comments
- */
-function captureTomDoc(comments) {
- // collect lines up to first paragraph break
- const lines = [];
- for (let i = 0; i < comments.length; i++) {
- const comment = comments[i];
- if (comment.value.match(/^\s*$/)) { break; }
- lines.push(comment.value.trim());
- }
-
- // return doctrine-like object
- const statusMatch = lines.join(' ').match(/^(Public|Internal|Deprecated):\s*(.+)/);
- if (statusMatch) {
- return {
- description: statusMatch[2],
- tags: [{
- title: statusMatch[1].toLowerCase(),
- description: statusMatch[2],
- }],
- };
- }
-}
-
-const availableDocStyleParsers = {
- jsdoc: captureJsDoc,
- tomdoc: captureTomDoc,
-};
-
-const supportedImportTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier']);
-
-let parserOptionsHash = '';
-let prevParserOptions = '';
-let settingsHash = '';
-let prevSettings = '';
-/**
- * don't hold full context object in memory, just grab what we need.
- * also calculate a cacheKey, where parts of the cacheKey hash are memoized
- */
-function childContext(path, context) {
- const { settings, parserOptions, parserPath } = context;
-
- if (JSON.stringify(settings) !== prevSettings) {
- settingsHash = hashObject({ settings }).digest('hex');
- prevSettings = JSON.stringify(settings);
- }
-
- if (JSON.stringify(parserOptions) !== prevParserOptions) {
- parserOptionsHash = hashObject({ parserOptions }).digest('hex');
- prevParserOptions = JSON.stringify(parserOptions);
- }
-
- return {
- cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
- settings,
- parserOptions,
- parserPath,
- path,
- };
-}
-
-/**
- * sometimes legacy support isn't _that_ hard... right?
- */
-function makeSourceCode(text, ast) {
- if (SourceCode.length > 1) {
- // ESLint 3
- return new SourceCode(text, ast);
- } else {
- // ESLint 4, 5
- return new SourceCode({ text, ast });
- }
-}
-
-/**
- * Traverse a pattern/identifier node, calling 'callback'
- * for each leaf identifier.
- * @param {node} pattern
- * @param {Function} callback
- * @return {void}
- */
-export function recursivePatternCapture(pattern, callback) {
- switch (pattern.type) {
- case 'Identifier': // base case
- callback(pattern);
- break;
-
- case 'ObjectPattern':
- pattern.properties.forEach((p) => {
- if (p.type === 'ExperimentalRestProperty' || p.type === 'RestElement') {
- callback(p.argument);
- return;
- }
- recursivePatternCapture(p.value, callback);
- });
- break;
-
- case 'ArrayPattern':
- pattern.elements.forEach((element) => {
- if (element == null) { return; }
- if (element.type === 'ExperimentalRestProperty' || element.type === 'RestElement') {
- callback(element.argument);
- return;
- }
- recursivePatternCapture(element, callback);
- });
- break;
-
- case 'AssignmentPattern':
- callback(pattern.left);
- break;
- default:
- }
-}
-
-/**
- * The creation of this closure is isolated from other scopes
- * to avoid over-retention of unrelated variables, which has
- * caused memory leaks. See #1266.
- */
-function thunkFor(p, context) {
- // eslint-disable-next-line no-use-before-define
- return () => ExportMapBuilder.for(childContext(p, context));
-}
-
-export default class ExportMapBuilder {
- static get(source, context) {
- const path = resolve(source, context);
- if (path == null) { return null; }
-
- return ExportMapBuilder.for(childContext(path, context));
- }
-
- static for(context) {
- const { path } = context;
-
- const cacheKey = context.cacheKey || hashObject(context).digest('hex');
- let exportMap = exportCache.get(cacheKey);
-
- // return cached ignore
- if (exportMap === null) { return null; }
-
- const stats = fs.statSync(path);
- if (exportMap != null) {
- // date equality check
- if (exportMap.mtime - stats.mtime === 0) {
- return exportMap;
- }
- // future: check content equality?
- }
-
- // check valid extensions first
- if (!hasValidExtension(path, context)) {
- exportCache.set(cacheKey, null);
- return null;
- }
-
- // check for and cache ignore
- if (isIgnored(path, context)) {
- log('ignored path due to ignore settings:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
-
- const content = fs.readFileSync(path, { encoding: 'utf8' });
-
- // check for and cache unambiguous modules
- if (!unambiguous.test(content)) {
- log('ignored path due to unambiguous regex:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
-
- log('cache miss', cacheKey, 'for path', path);
- exportMap = ExportMapBuilder.parse(path, content, context);
-
- // ambiguous modules return null
- if (exportMap == null) {
- log('ignored path due to ambiguous parse:', path);
- exportCache.set(cacheKey, null);
- return null;
- }
-
- exportMap.mtime = stats.mtime;
-
- exportCache.set(cacheKey, exportMap);
- return exportMap;
- }
-
- static parse(path, content, context) {
- function readTsConfig(context) {
- const tsconfigInfo = tsConfigLoader({
- cwd: context.parserOptions && context.parserOptions.tsconfigRootDir || process.cwd(),
- getEnv: (key) => process.env[key],
- });
- try {
- if (tsconfigInfo.tsConfigPath !== undefined) {
- // Projects not using TypeScript won't have `typescript` installed.
- if (!ts) { ts = require('typescript'); } // eslint-disable-line import/no-extraneous-dependencies
-
- const configFile = ts.readConfigFile(tsconfigInfo.tsConfigPath, ts.sys.readFile);
- return ts.parseJsonConfigFileContent(
- configFile.config,
- ts.sys,
- dirname(tsconfigInfo.tsConfigPath),
- );
- }
- } catch (e) {
- // Catch any errors
- }
-
- return null;
- }
-
- function isEsModuleInterop() {
- const cacheKey = hashObject({
- tsconfigRootDir: context.parserOptions && context.parserOptions.tsconfigRootDir,
- }).digest('hex');
- let tsConfig = tsconfigCache.get(cacheKey);
- if (typeof tsConfig === 'undefined') {
- tsConfig = readTsConfig(context);
- tsconfigCache.set(cacheKey, tsConfig);
- }
-
- return tsConfig && tsConfig.options ? tsConfig.options.esModuleInterop : false;
- }
-
- const m = new ExportMap(path);
- const isEsModuleInteropTrue = isEsModuleInterop();
-
- let ast;
- let visitorKeys;
- try {
- const result = parse(path, content, context);
- ast = result.ast;
- visitorKeys = result.visitorKeys;
- } catch (err) {
- m.errors.push(err);
- return m; // can't continue
- }
-
- m.visitorKeys = visitorKeys;
-
- let hasDynamicImports = false;
-
- function remotePath(value) {
- return resolve.relative(value, path, context.settings);
- }
-
- function processDynamicImport(source) {
- hasDynamicImports = true;
- if (source.type !== 'Literal') {
- return null;
- }
- const p = remotePath(source.value);
- if (p == null) {
- return null;
- }
- const importedSpecifiers = new Set();
- importedSpecifiers.add('ImportNamespaceSpecifier');
- const getter = thunkFor(p, context);
- m.imports.set(p, {
- getter,
- declarations: new Set([{
- source: {
- // capturing actual node reference holds full AST in memory!
- value: source.value,
- loc: source.loc,
- },
- importedSpecifiers,
- dynamic: true,
- }]),
- });
- }
-
- visit(ast, visitorKeys, {
- ImportExpression(node) {
- processDynamicImport(node.source);
- },
- CallExpression(node) {
- if (node.callee.type === 'Import') {
- processDynamicImport(node.arguments[0]);
- }
- },
- });
-
- const unambiguouslyESM = unambiguous.isModule(ast);
- if (!unambiguouslyESM && !hasDynamicImports) { return null; }
-
- const docstyle = context.settings && context.settings['import/docstyle'] || ['jsdoc'];
- const docStyleParsers = {};
- docstyle.forEach((style) => {
- docStyleParsers[style] = availableDocStyleParsers[style];
- });
-
- // attempt to collect module doc
- if (ast.comments) {
- ast.comments.some((c) => {
- if (c.type !== 'Block') { return false; }
- try {
- const doc = doctrine.parse(c.value, { unwrap: true });
- if (doc.tags.some((t) => t.title === 'module')) {
- m.doc = doc;
- return true;
- }
- } catch (err) { /* ignore */ }
- return false;
- });
- }
-
- const namespaces = new Map();
-
- function resolveImport(value) {
- const rp = remotePath(value);
- if (rp == null) { return null; }
- return ExportMapBuilder.for(childContext(rp, context));
- }
-
- function getNamespace(identifier) {
- if (!namespaces.has(identifier.name)) { return; }
-
- return function () {
- return resolveImport(namespaces.get(identifier.name));
- };
- }
-
- function addNamespace(object, identifier) {
- const nsfn = getNamespace(identifier);
- if (nsfn) {
- Object.defineProperty(object, 'namespace', { get: nsfn });
- }
-
- return object;
- }
-
- function processSpecifier(s, n, m) {
- const nsource = n.source && n.source.value;
- const exportMeta = {};
- let local;
-
- switch (s.type) {
- case 'ExportDefaultSpecifier':
- if (!nsource) { return; }
- local = 'default';
- break;
- case 'ExportNamespaceSpecifier':
- m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
- get() { return resolveImport(nsource); },
- }));
- return;
- case 'ExportAllDeclaration':
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.source.value));
- return;
- case 'ExportSpecifier':
- if (!n.source) {
- m.namespace.set(s.exported.name || s.exported.value, addNamespace(exportMeta, s.local));
- return;
- }
- // else falls through
- default:
- local = s.local.name;
- break;
- }
-
- // todo: JSDoc
- m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) });
- }
-
- function captureDependency({ source }, isOnlyImportingTypes, importedSpecifiers = new Set()) {
- if (source == null) { return null; }
-
- const p = remotePath(source.value);
- if (p == null) { return null; }
-
- const declarationMetadata = {
- // capturing actual node reference holds full AST in memory!
- source: { value: source.value, loc: source.loc },
- isOnlyImportingTypes,
- importedSpecifiers,
- };
-
- const existing = m.imports.get(p);
- if (existing != null) {
- existing.declarations.add(declarationMetadata);
- return existing.getter;
- }
-
- const getter = thunkFor(p, context);
- m.imports.set(p, { getter, declarations: new Set([declarationMetadata]) });
- return getter;
- }
-
- function captureDependencyWithSpecifiers(n) {
- // import type { Foo } (TS and Flow); import typeof { Foo } (Flow)
- const declarationIsType = n.importKind === 'type' || n.importKind === 'typeof';
- // import './foo' or import {} from './foo' (both 0 specifiers) is a side effect and
- // shouldn't be considered to be just importing types
- let specifiersOnlyImportingTypes = n.specifiers.length > 0;
- const importedSpecifiers = new Set();
- n.specifiers.forEach((specifier) => {
- if (specifier.type === 'ImportSpecifier') {
- importedSpecifiers.add(specifier.imported.name || specifier.imported.value);
- } else if (supportedImportTypes.has(specifier.type)) {
- importedSpecifiers.add(specifier.type);
- }
-
- // import { type Foo } (Flow); import { typeof Foo } (Flow)
- specifiersOnlyImportingTypes = specifiersOnlyImportingTypes
- && (specifier.importKind === 'type' || specifier.importKind === 'typeof');
- });
- captureDependency(n, declarationIsType || specifiersOnlyImportingTypes, importedSpecifiers);
- }
-
- const source = makeSourceCode(content, ast);
-
- ast.body.forEach(function (n) {
- if (n.type === 'ExportDefaultDeclaration') {
- const exportMeta = captureDoc(source, docStyleParsers, n);
- if (n.declaration.type === 'Identifier') {
- addNamespace(exportMeta, n.declaration);
- }
- m.namespace.set('default', exportMeta);
- return;
- }
-
- if (n.type === 'ExportAllDeclaration') {
- const getter = captureDependency(n, n.exportKind === 'type');
- if (getter) { m.dependencies.add(getter); }
- if (n.exported) {
- processSpecifier(n, n.exported, m);
- }
- return;
- }
-
- // capture namespaces in case of later export
- if (n.type === 'ImportDeclaration') {
- captureDependencyWithSpecifiers(n);
-
- const ns = n.specifiers.find((s) => s.type === 'ImportNamespaceSpecifier');
- if (ns) {
- namespaces.set(ns.local.name, n.source.value);
- }
- return;
- }
-
- if (n.type === 'ExportNamedDeclaration') {
- captureDependencyWithSpecifiers(n);
-
- // capture declaration
- if (n.declaration != null) {
- switch (n.declaration.type) {
- case 'FunctionDeclaration':
- case 'ClassDeclaration':
- case 'TypeAlias': // flowtype with babel-eslint parser
- case 'InterfaceDeclaration':
- case 'DeclareFunction':
- case 'TSDeclareFunction':
- case 'TSEnumDeclaration':
- case 'TSTypeAliasDeclaration':
- case 'TSInterfaceDeclaration':
- case 'TSAbstractClassDeclaration':
- case 'TSModuleDeclaration':
- m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n));
- break;
- case 'VariableDeclaration':
- n.declaration.declarations.forEach((d) => {
- recursivePatternCapture(
- d.id,
- (id) => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n)),
- );
- });
- break;
- default:
- }
- }
-
- n.specifiers.forEach((s) => processSpecifier(s, n, m));
- }
-
- const exports = ['TSExportAssignment'];
- if (isEsModuleInteropTrue) {
- exports.push('TSNamespaceExportDeclaration');
- }
-
- // This doesn't declare anything, but changes what's being exported.
- if (includes(exports, n.type)) {
- const exportedName = n.type === 'TSNamespaceExportDeclaration'
- ? (n.id || n.name).name
- : n.expression && n.expression.name || n.expression.id && n.expression.id.name || null;
- const declTypes = [
- 'VariableDeclaration',
- 'ClassDeclaration',
- 'TSDeclareFunction',
- 'TSEnumDeclaration',
- 'TSTypeAliasDeclaration',
- 'TSInterfaceDeclaration',
- 'TSAbstractClassDeclaration',
- 'TSModuleDeclaration',
- ];
- const exportedDecls = ast.body.filter(({ type, id, declarations }) => includes(declTypes, type) && (
- id && id.name === exportedName || declarations && declarations.find((d) => d.id.name === exportedName)
- ));
- if (exportedDecls.length === 0) {
- // Export is not referencing any local declaration, must be re-exporting
- m.namespace.set('default', captureDoc(source, docStyleParsers, n));
- return;
- }
- if (
- isEsModuleInteropTrue // esModuleInterop is on in tsconfig
- && !m.namespace.has('default') // and default isn't added already
- ) {
- m.namespace.set('default', {}); // add default export
- }
- exportedDecls.forEach((decl) => {
- if (decl.type === 'TSModuleDeclaration') {
- if (decl.body && decl.body.type === 'TSModuleDeclaration') {
- m.namespace.set(decl.body.id.name, captureDoc(source, docStyleParsers, decl.body));
- } else if (decl.body && decl.body.body) {
- decl.body.body.forEach((moduleBlockNode) => {
- // Export-assignment exports all members in the namespace,
- // explicitly exported or not.
- const namespaceDecl = moduleBlockNode.type === 'ExportNamedDeclaration'
- ? moduleBlockNode.declaration
- : moduleBlockNode;
-
- if (!namespaceDecl) {
- // TypeScript can check this for us; we needn't
- } else if (namespaceDecl.type === 'VariableDeclaration') {
- namespaceDecl.declarations.forEach((d) => recursivePatternCapture(d.id, (id) => m.namespace.set(
- id.name,
- captureDoc(source, docStyleParsers, decl, namespaceDecl, moduleBlockNode),
- )),
- );
- } else {
- m.namespace.set(
- namespaceDecl.id.name,
- captureDoc(source, docStyleParsers, moduleBlockNode));
- }
- });
- }
- } else {
- // Export as default
- m.namespace.set('default', captureDoc(source, docStyleParsers, decl));
- }
- });
- }
- });
-
- if (
- isEsModuleInteropTrue // esModuleInterop is on in tsconfig
- && m.namespace.size > 0 // anything is exported
- && !m.namespace.has('default') // and default isn't added already
- ) {
- m.namespace.set('default', {}); // add default export
- }
-
- if (unambiguouslyESM) {
- m.parseGoal = 'Module';
- }
- return m;
- }
-}
diff --git a/src/rules/default.js b/src/rules/default.js
index cbaa49f1fc..0de787c33c 100644
--- a/src/rules/default.js
+++ b/src/rules/default.js
@@ -1,4 +1,4 @@
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import docsUrl from '../docsUrl';
module.exports = {
diff --git a/src/rules/export.js b/src/rules/export.js
index b1dc5ca9ea..197a0eb51c 100644
--- a/src/rules/export.js
+++ b/src/rules/export.js
@@ -1,4 +1,5 @@
-import ExportMapBuilder, { recursivePatternCapture } from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
+import recursivePatternCapture from '../exportMap/patternCapture';
import docsUrl from '../docsUrl';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
diff --git a/src/rules/named.js b/src/rules/named.js
index 043d72eabe..ed7e5e018b 100644
--- a/src/rules/named.js
+++ b/src/rules/named.js
@@ -1,5 +1,5 @@
import * as path from 'path';
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import docsUrl from '../docsUrl';
module.exports = {
diff --git a/src/rules/namespace.js b/src/rules/namespace.js
index e1ca2870b1..60a4220de2 100644
--- a/src/rules/namespace.js
+++ b/src/rules/namespace.js
@@ -1,5 +1,5 @@
import declaredScope from 'eslint-module-utils/declaredScope';
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import ExportMap from '../exportMap';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index b7b907b062..e65ff11a49 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -4,7 +4,7 @@
*/
import resolve from 'eslint-module-utils/resolve';
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import { isExternalModule } from '../core/importType';
import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import docsUrl from '../docsUrl';
diff --git a/src/rules/no-deprecated.js b/src/rules/no-deprecated.js
index 50072f3f85..b4299a51d4 100644
--- a/src/rules/no-deprecated.js
+++ b/src/rules/no-deprecated.js
@@ -1,5 +1,5 @@
import declaredScope from 'eslint-module-utils/declaredScope';
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import ExportMap from '../exportMap';
import docsUrl from '../docsUrl';
diff --git a/src/rules/no-named-as-default-member.js b/src/rules/no-named-as-default-member.js
index d594c58433..54bec64a2a 100644
--- a/src/rules/no-named-as-default-member.js
+++ b/src/rules/no-named-as-default-member.js
@@ -4,7 +4,7 @@
* @copyright 2016 Desmond Brand. All rights reserved.
* See LICENSE in root directory for full license.
*/
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
diff --git a/src/rules/no-named-as-default.js b/src/rules/no-named-as-default.js
index 3e73ff2f44..5b24f8e883 100644
--- a/src/rules/no-named-as-default.js
+++ b/src/rules/no-named-as-default.js
@@ -1,4 +1,4 @@
-import ExportMapBuilder from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
import importDeclaration from '../importDeclaration';
import docsUrl from '../docsUrl';
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 812efffbca..0ad330b486 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -13,7 +13,8 @@ import values from 'object.values';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
-import ExportMapBuilder, { recursivePatternCapture } from '../exportMapBuilder';
+import ExportMapBuilder from '../exportMap/builder';
+import recursivePatternCapture from '../exportMap/patternCapture';
import docsUrl from '../docsUrl';
let FileEnumerator;
diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
index 611a13055f..76003410d5 100644
--- a/tests/src/core/getExports.js
+++ b/tests/src/core/getExports.js
@@ -4,7 +4,7 @@ import sinon from 'sinon';
import eslintPkg from 'eslint/package.json';
import typescriptPkg from 'typescript/package.json';
import * as tsConfigLoader from 'tsconfig-paths/lib/tsconfig-loader';
-import ExportMapBuilder from '../../../src/exportMapBuilder';
+import ExportMapBuilder from '../../../src/exportMap/builder';
import * as fs from 'fs';
From f77ceb679d59ced5d9a633123385470a9eea10d9 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Sun, 7 Apr 2024 12:55:28 +1200
Subject: [PATCH 108/199] [actions] cancel in-progress runs on PR updates
---
.github/workflows/native-wsl.yml | 4 ++++
.github/workflows/node-4+.yml | 4 ++++
.github/workflows/packages.yml | 4 ++++
3 files changed, 12 insertions(+)
diff --git a/.github/workflows/native-wsl.yml b/.github/workflows/native-wsl.yml
index 893d2248d1..5e8318899e 100644
--- a/.github/workflows/native-wsl.yml
+++ b/.github/workflows/native-wsl.yml
@@ -2,6 +2,10 @@ name: Native and WSL
on: [push, pull_request]
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
jobs:
build:
runs-on: ${{ matrix.os }}
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
index 60fa609dbe..f2dad098ca 100644
--- a/.github/workflows/node-4+.yml
+++ b/.github/workflows/node-4+.yml
@@ -2,6 +2,10 @@ name: 'Tests: node.js'
on: [pull_request, push]
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
permissions:
contents: read
diff --git a/.github/workflows/packages.yml b/.github/workflows/packages.yml
index 213e1a43ce..f73f8e18ff 100644
--- a/.github/workflows/packages.yml
+++ b/.github/workflows/packages.yml
@@ -2,6 +2,10 @@ name: 'Tests: packages'
on: [pull_request, push]
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
permissions:
contents: read
From c0ac54b8a721c2b1c9048838acc4d6282f4fe7a7 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 25 Apr 2024 10:57:27 -0700
Subject: [PATCH 109/199] [Dev Deps] pin `find-babel-config` to v1.2.0, due to
a breaking change in v1.2.1
See https://github.com/tleunen/find-babel-config/issues/70#issuecomment-2077838243
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index 638942f97c..b9fa1eb35f 100644
--- a/package.json
+++ b/package.json
@@ -82,6 +82,7 @@
"eslint-plugin-eslint-plugin": "^2.3.0",
"eslint-plugin-import": "2.x",
"eslint-plugin-json": "^2.1.2",
+ "find-babel-config": "=1.2.0",
"fs-copy-file-sync": "^1.1.1",
"glob": "^7.2.3",
"in-publish": "^2.0.1",
From a3a7176f6bc8a5e614eda95df74c43c30e148022 Mon Sep 17 00:00:00 2001
From: Ankit Sardesai <ankit@makenotion.com>
Date: Tue, 23 Apr 2024 21:40:29 -0700
Subject: [PATCH 110/199] [New] `dynamic-import-chunkname`: Allow empty chunk
name when webpackMode: 'eager' is set; add suggestions to remove name in
eager mode'
---
CHANGELOG.md | 3 +
README.md | 2 +-
docs/rules/dynamic-import-chunkname.md | 9 +
src/rules/dynamic-import-chunkname.js | 51 ++++-
tests/src/rules/dynamic-import-chunkname.js | 221 ++++++++++++++++++--
5 files changed, 268 insertions(+), 18 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a07647c82d..c7cd6c4431 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
+- [`dynamic-import-chunkname`]: Allow empty chunk name when webpackMode: 'eager' is set; add suggestions to remove name in eager mode ([#3004], thanks [@amsardesai])
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1115,6 +1116,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
@@ -1701,6 +1703,7 @@ for info on changes for earlier releases.
[@aladdin-add]: https://github.com/aladdin-add
[@alex-page]: https://github.com/alex-page
[@alexgorbatchev]: https://github.com/alexgorbatchev
+[@amsardesai]: https://github.com/amsardesai
[@andreubotella]: https://github.com/andreubotella
[@AndrewLeedham]: https://github.com/AndrewLeedham
[@andyogo]: https://github.com/andyogo
diff --git a/README.md b/README.md
index d6f107d1c9..1fd113c7d0 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,7 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :- | :---- | :- | :- | :- | :- |
| [consistent-type-specifier-style](docs/rules/consistent-type-specifier-style.md) | Enforce or ban the use of inline type-only markers for named imports. | | | | 🔧 | | |
-| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | | | |
+| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | | 💡 | |
| [exports-last](docs/rules/exports-last.md) | Ensure all exports appear after other statements. | | | | | | |
| [extensions](docs/rules/extensions.md) | Ensure consistent use of file extension within the import path. | | | | | | |
| [first](docs/rules/first.md) | Ensure all imports appear before other statements. | | | | 🔧 | | |
diff --git a/docs/rules/dynamic-import-chunkname.md b/docs/rules/dynamic-import-chunkname.md
index dd526c8913..de554148ee 100644
--- a/docs/rules/dynamic-import-chunkname.md
+++ b/docs/rules/dynamic-import-chunkname.md
@@ -1,5 +1,7 @@
# import/dynamic-import-chunkname
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
+
<!-- end auto-generated rule header -->
This rule reports any dynamic imports without a webpackChunkName specified in a leading block comment in the proper format.
@@ -56,6 +58,13 @@ import(
// webpackChunkName: "someModule"
'someModule',
);
+
+// chunk names are disallowed when eager mode is set
+import(
+ /* webpackMode: "eager" */
+ /* webpackChunkName: "someModule" */
+ 'someModule',
+)
```
### valid
diff --git a/src/rules/dynamic-import-chunkname.js b/src/rules/dynamic-import-chunkname.js
index a62e5c6c12..a72b04d123 100644
--- a/src/rules/dynamic-import-chunkname.js
+++ b/src/rules/dynamic-import-chunkname.js
@@ -27,6 +27,7 @@ module.exports = {
},
},
}],
+ hasSuggestions: true,
},
create(context) {
@@ -36,8 +37,10 @@ module.exports = {
const paddedCommentRegex = /^ (\S[\s\S]+\S) $/;
const commentStyleRegex = /^( ((webpackChunkName: .+)|((webpackPrefetch|webpackPreload): (true|false|-?[0-9]+))|(webpackIgnore: (true|false))|((webpackInclude|webpackExclude): \/.*\/)|(webpackMode: ["'](lazy|lazy-once|eager|weak)["'])|(webpackExports: (['"]\w+['"]|\[(['"]\w+['"], *)+(['"]\w+['"]*)\]))),?)+ $/;
- const chunkSubstrFormat = ` webpackChunkName: ["']${webpackChunknameFormat}["'],? `;
+ const chunkSubstrFormat = `webpackChunkName: ["']${webpackChunknameFormat}["'],? `;
const chunkSubstrRegex = new RegExp(chunkSubstrFormat);
+ const eagerModeFormat = `webpackMode: ["']eager["'],? `;
+ const eagerModeRegex = new RegExp(eagerModeFormat);
function run(node, arg) {
const sourceCode = context.getSourceCode();
@@ -54,6 +57,7 @@ module.exports = {
}
let isChunknamePresent = false;
+ let isEagerModePresent = false;
for (const comment of leadingComments) {
if (comment.type !== 'Block') {
@@ -92,12 +96,55 @@ module.exports = {
return;
}
+ if (eagerModeRegex.test(comment.value)) {
+ isEagerModePresent = true;
+ }
+
if (chunkSubstrRegex.test(comment.value)) {
isChunknamePresent = true;
}
}
- if (!isChunknamePresent && !allowEmpty) {
+ if (isChunknamePresent && isEagerModePresent) {
+ context.report({
+ node,
+ message: 'dynamic imports using eager mode do not need a webpackChunkName',
+ suggest: [
+ {
+ desc: 'Remove webpackChunkName',
+ fix(fixer) {
+ for (const comment of leadingComments) {
+ if (chunkSubstrRegex.test(comment.value)) {
+ const replacement = comment.value.replace(chunkSubstrRegex, '').trim().replace(/,$/, '');
+ if (replacement === '') {
+ return fixer.remove(comment);
+ } else {
+ return fixer.replaceText(comment, `/* ${replacement} */`);
+ }
+ }
+ }
+ },
+ },
+ {
+ desc: 'Remove webpackMode',
+ fix(fixer) {
+ for (const comment of leadingComments) {
+ if (eagerModeRegex.test(comment.value)) {
+ const replacement = comment.value.replace(eagerModeRegex, '').trim().replace(/,$/, '');
+ if (replacement === '') {
+ return fixer.remove(comment);
+ } else {
+ return fixer.replaceText(comment, `/* ${replacement} */`);
+ }
+ }
+ }
+ },
+ },
+ ],
+ });
+ }
+
+ if (!isChunknamePresent && !allowEmpty && !isEagerModePresent) {
context.report({
node,
message:
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index c710507b26..6afd834ab0 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -26,8 +26,9 @@ const nonBlockCommentError = 'dynamic imports require a /* foo */ style comment,
const noPaddingCommentError = 'dynamic imports require a block comment padded with spaces - /* foo */';
const invalidSyntaxCommentError = 'dynamic imports require a "webpack" comment with valid syntax';
const commentFormatError = `dynamic imports require a "webpack" comment with valid syntax`;
-const chunkNameFormatError = `dynamic imports require a leading comment in the form /* webpackChunkName: ["']${commentFormat}["'],? */`;
-const pickyChunkNameFormatError = `dynamic imports require a leading comment in the form /* webpackChunkName: ["']${pickyCommentFormat}["'],? */`;
+const chunkNameFormatError = `dynamic imports require a leading comment in the form /*webpackChunkName: ["']${commentFormat}["'],? */`;
+const pickyChunkNameFormatError = `dynamic imports require a leading comment in the form /*webpackChunkName: ["']${pickyCommentFormat}["'],? */`;
+const eagerModeError = `dynamic imports using eager mode do not need a webpackChunkName`;
ruleTester.run('dynamic-import-chunkname', rule, {
valid: [
@@ -354,7 +355,6 @@ ruleTester.run('dynamic-import-chunkname', rule, {
},
{
code: `import(
- /* webpackChunkName: "someModule" */
/* webpackMode: "eager" */
'someModule'
)`,
@@ -412,7 +412,7 @@ ruleTester.run('dynamic-import-chunkname', rule, {
/* webpackPrefetch: true */
/* webpackPreload: true */
/* webpackIgnore: false */
- /* webpackMode: "eager" */
+ /* webpackMode: "lazy" */
/* webpackExports: ["default", "named"] */
'someModule'
)`,
@@ -981,6 +981,42 @@ ruleTester.run('dynamic-import-chunkname', rule, {
type: 'CallExpression',
}],
},
+ {
+ code: `import(
+ /* webpackChunkName: "someModule" */
+ /* webpackMode: "eager" */
+ 'someModule'
+ )`,
+ options,
+ parser,
+ output: `import(
+ /* webpackChunkName: "someModule" */
+ /* webpackMode: "eager" */
+ 'someModule'
+ )`,
+ errors: [{
+ message: eagerModeError,
+ type: 'CallExpression',
+ suggestions: [
+ {
+ desc: 'Remove webpackChunkName',
+ output: `import(
+
+ /* webpackMode: "eager" */
+ 'someModule'
+ )`,
+ },
+ {
+ desc: 'Remove webpackMode',
+ output: `import(
+ /* webpackChunkName: "someModule" */
+
+ 'someModule'
+ )`,
+ },
+ ],
+ }],
+ },
],
});
@@ -1213,15 +1249,6 @@ context('TypeScript', () => {
options,
parser: typescriptParser,
},
- {
- code: `import(
- /* webpackChunkName: "someModule" */
- /* webpackMode: "lazy" */
- 'someModule'
- )`,
- options,
- parser: typescriptParser,
- },
{
code: `import(
/* webpackChunkName: 'someModule', webpackMode: 'lazy' */
@@ -1242,7 +1269,7 @@ context('TypeScript', () => {
{
code: `import(
/* webpackChunkName: "someModule" */
- /* webpackMode: "eager" */
+ /* webpackMode: "lazy" */
'someModule'
)`,
options,
@@ -1299,13 +1326,21 @@ context('TypeScript', () => {
/* webpackPrefetch: true */
/* webpackPreload: true */
/* webpackIgnore: false */
- /* webpackMode: "eager" */
+ /* webpackMode: "lazy" */
/* webpackExports: ["default", "named"] */
'someModule'
)`,
options,
parser: typescriptParser,
},
+ {
+ code: `import(
+ /* webpackMode: "eager" */
+ 'someModule'
+ )`,
+ options,
+ parser: typescriptParser,
+ },
],
invalid: [
{
@@ -1752,6 +1787,162 @@ context('TypeScript', () => {
type: nodeType,
}],
},
+ {
+ code: `import(
+ /* webpackChunkName: "someModule", webpackMode: "eager" */
+ 'someModule'
+ )`,
+ options,
+ parser: typescriptParser,
+ output: `import(
+ /* webpackChunkName: "someModule", webpackMode: "eager" */
+ 'someModule'
+ )`,
+ errors: [{
+ message: eagerModeError,
+ type: nodeType,
+ suggestions: [
+ {
+ desc: 'Remove webpackChunkName',
+ output: `import(
+ /* webpackMode: "eager" */
+ 'someModule'
+ )`,
+ },
+ {
+ desc: 'Remove webpackMode',
+ output: `import(
+ /* webpackChunkName: "someModule" */
+ 'someModule'
+ )`,
+ },
+ ],
+ }],
+ },
+ {
+ code: `
+ import(
+ /* webpackMode: "eager", webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ options,
+ parser: typescriptParser,
+ output: `
+ import(
+ /* webpackMode: "eager", webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ errors: [{
+ message: eagerModeError,
+ type: nodeType,
+ suggestions: [
+ {
+ desc: 'Remove webpackChunkName',
+ output: `
+ import(
+ /* webpackMode: "eager" */
+ 'someModule'
+ )
+ `,
+ },
+ {
+ desc: 'Remove webpackMode',
+ output: `
+ import(
+ /* webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ },
+ ],
+ }],
+ },
+ {
+ code: `
+ import(
+ /* webpackMode: "eager", webpackPrefetch: true, webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ options,
+ parser: typescriptParser,
+ output: `
+ import(
+ /* webpackMode: "eager", webpackPrefetch: true, webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ errors: [{
+ message: eagerModeError,
+ type: nodeType,
+ suggestions: [
+ {
+ desc: 'Remove webpackChunkName',
+ output: `
+ import(
+ /* webpackMode: "eager", webpackPrefetch: true */
+ 'someModule'
+ )
+ `,
+ },
+ {
+ desc: 'Remove webpackMode',
+ output: `
+ import(
+ /* webpackPrefetch: true, webpackChunkName: "someModule" */
+ 'someModule'
+ )
+ `,
+ },
+ ],
+ }],
+ },
+ {
+ code: `
+ import(
+ /* webpackChunkName: "someModule" */
+ /* webpackMode: "eager" */
+ 'someModule'
+ )
+ `,
+ options,
+ parser: typescriptParser,
+ output: `
+ import(
+ /* webpackChunkName: "someModule" */
+ /* webpackMode: "eager" */
+ 'someModule'
+ )
+ `,
+ errors: [{
+ message: eagerModeError,
+ type: nodeType,
+ suggestions: [
+ {
+ desc: 'Remove webpackChunkName',
+ output: `
+ import(
+ ${''}
+ /* webpackMode: "eager" */
+ 'someModule'
+ )
+ `,
+ },
+ {
+ desc: 'Remove webpackMode',
+ output: `
+ import(
+ /* webpackChunkName: "someModule" */
+ ${''}
+ 'someModule'
+ )
+ `,
+ },
+ ],
+ }],
+ },
],
});
});
From 6554bd5c30976290024cecc44ef1e96746cf3cf7 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 23 May 2024 12:47:41 -0700
Subject: [PATCH 111/199] [meta] add `repository.directory` field
---
memo-parser/package.json | 3 ++-
resolvers/node/package.json | 3 ++-
resolvers/webpack/package.json | 3 ++-
utils/package.json | 3 ++-
4 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/memo-parser/package.json b/memo-parser/package.json
index 723005d21b..b89c3c5ada 100644
--- a/memo-parser/package.json
+++ b/memo-parser/package.json
@@ -12,7 +12,8 @@
},
"repository": {
"type": "git",
- "url": "git+https://github.com/import-js/eslint-plugin-import.git"
+ "url": "git+https://github.com/import-js/eslint-plugin-import.git",
+ "directory": "memo-parser"
},
"keywords": [
"eslint",
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
index bfaab40413..6f6999e6cb 100644
--- a/resolvers/node/package.json
+++ b/resolvers/node/package.json
@@ -13,7 +13,8 @@
},
"repository": {
"type": "git",
- "url": "https://github.com/import-js/eslint-plugin-import"
+ "url": "https://github.com/import-js/eslint-plugin-import",
+ "directory": "resolvers/node"
},
"keywords": [
"eslint",
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 3fa47d9362..7f8cb718f1 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -14,7 +14,8 @@
],
"repository": {
"type": "git",
- "url": "git+https://github.com/import-js/eslint-plugin-import.git"
+ "url": "git+https://github.com/import-js/eslint-plugin-import.git",
+ "directory": "resolvers/webpack"
},
"keywords": [
"eslint-plugin-import",
diff --git a/utils/package.json b/utils/package.json
index df4871790b..4704971505 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -12,7 +12,8 @@
},
"repository": {
"type": "git",
- "url": "git+https://github.com/import-js/eslint-plugin-import.git"
+ "url": "git+https://github.com/import-js/eslint-plugin-import.git",
+ "directory": "utils"
},
"keywords": [
"eslint-plugin-import",
From fc361a9998b14b9528d841d8349078a5af2da436 Mon Sep 17 00:00:00 2001
From: U812320 <francoisjulien.chabbey@mobi.ch>
Date: Mon, 3 Jun 2024 13:45:31 +0200
Subject: [PATCH 112/199] [Fix] `no-extraneous-dependencies`: allow wrong path
- If you pass only one path to a package.json file, then this path
should be correct
- If you pass multiple paths, there are some situations when those paths
point to a wrong path, this happens typically in a nx monorepo with husky
-- NX will run eslint in the projects folder, so we need to grab the
root package.json
-- Husky will run in the root folder, so one of the path given will be
an incorrect path, but we do not want throw there, otherwise the rull
will fail
---
CHANGELOG.md | 5 +++++
src/rules/no-extraneous-dependencies.js | 17 +++++++++++------
tests/src/rules/no-extraneous-dependencies.js | 9 +++++++++
3 files changed, 25 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c7cd6c4431..941cd6ef87 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
- [`dynamic-import-chunkname`]: Allow empty chunk name when webpackMode: 'eager' is set; add suggestions to remove name in eager mode ([#3004], thanks [@amsardesai])
+### Fixed
+- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
+
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
- [`no-unused-modules`]: add console message to help debug [#2866]
@@ -1116,6 +1119,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
@@ -1733,6 +1737,7 @@ for info on changes for earlier releases.
[@bradzacher]: https://github.com/bradzacher
[@brendo]: https://github.com/brendo
[@brettz9]: https://github.com/brettz9
+[@chabb]: https://github.com/chabb
[@Chamion]: https://github.com/Chamion
[@charlessuh]: https://github.com/charlessuh
[@charpeni]: https://github.com/charpeni
diff --git a/src/rules/no-extraneous-dependencies.js b/src/rules/no-extraneous-dependencies.js
index df97987901..0fe42f56f8 100644
--- a/src/rules/no-extraneous-dependencies.js
+++ b/src/rules/no-extraneous-dependencies.js
@@ -42,8 +42,11 @@ function extractDepFields(pkg) {
function getPackageDepFields(packageJsonPath, throwAtRead) {
if (!depFieldCache.has(packageJsonPath)) {
- const depFields = extractDepFields(readJSON(packageJsonPath, throwAtRead));
- depFieldCache.set(packageJsonPath, depFields);
+ const packageJson = readJSON(packageJsonPath, throwAtRead);
+ if (packageJson) {
+ const depFields = extractDepFields(packageJson);
+ depFieldCache.set(packageJsonPath, depFields);
+ }
}
return depFieldCache.get(packageJsonPath);
@@ -72,10 +75,12 @@ function getDependencies(context, packageDir) {
// use rule config to find package.json
paths.forEach((dir) => {
const packageJsonPath = path.join(dir, 'package.json');
- const _packageContent = getPackageDepFields(packageJsonPath, true);
- Object.keys(packageContent).forEach((depsKey) => {
- Object.assign(packageContent[depsKey], _packageContent[depsKey]);
- });
+ const _packageContent = getPackageDepFields(packageJsonPath, paths.length === 1);
+ if (_packageContent) {
+ Object.keys(packageContent).forEach((depsKey) => {
+ Object.assign(packageContent[depsKey], _packageContent[depsKey]);
+ });
+ }
});
} else {
const packageJsonPath = pkgUp({
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index cb0398ada2..4b221de353 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -26,6 +26,7 @@ const packageDirWithEmpty = path.join(__dirname, '../../files/empty');
const packageDirBundleDeps = path.join(__dirname, '../../files/bundled-dependencies/as-array-bundle-deps');
const packageDirBundledDepsAsObject = path.join(__dirname, '../../files/bundled-dependencies/as-object');
const packageDirBundledDepsRaceCondition = path.join(__dirname, '../../files/bundled-dependencies/race-condition');
+const emptyPackageDir = path.join(__dirname, '../../files/empty-folder');
const {
dependencies: deps,
@@ -104,6 +105,14 @@ ruleTester.run('no-extraneous-dependencies', rule, {
code: 'import leftpad from "left-pad";',
options: [{ packageDir: packageDirMonoRepoRoot }],
}),
+ test({
+ code: 'import leftpad from "left-pad";',
+ options: [{ packageDir: [emptyPackageDir, packageDirMonoRepoRoot] }],
+ }),
+ test({
+ code: 'import leftpad from "left-pad";',
+ options: [{ packageDir: [packageDirMonoRepoRoot, emptyPackageDir] }],
+ }),
test({
code: 'import react from "react";',
options: [{ packageDir: [packageDirMonoRepoRoot, packageDirMonoRepoWithNested] }],
From 09476d7dac1ab36668283f9626f85e2223652b37 Mon Sep 17 00:00:00 2001
From: silverwind <me@silverwind.io>
Date: Tue, 28 May 2024 22:27:21 +0200
Subject: [PATCH 113/199] [New] `no-unused-modules`: Add
`ignoreUnusedTypeExports` option
Fixes #2694
---
CHANGELOG.md | 3 ++
docs/rules/no-unused-modules.md | 15 ++++++-
src/rules/no-unused-modules.js | 35 ++++++++++-----
tests/src/rules/no-unused-modules.js | 67 ++++++++++++++++++++++++++++
4 files changed, 106 insertions(+), 14 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 941cd6ef87..b1d2a3425b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
- [`dynamic-import-chunkname`]: Allow empty chunk name when webpackMode: 'eager' is set; add suggestions to remove name in eager mode ([#3004], thanks [@amsardesai])
+- [`no-unused-modules`]: Add `ignoreUnusedTypeExports` option ([#3011], thanks [@silverwind])
### Fixed
- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
@@ -1120,6 +1121,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
+[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
@@ -1915,6 +1917,7 @@ for info on changes for earlier releases.
[@sergei-startsev]: https://github.com/sergei-startsev
[@sharmilajesupaul]: https://github.com/sharmilajesupaul
[@sheepsteak]: https://github.com/sheepsteak
+[@silverwind]: https://github.com/silverwind
[@silviogutierrez]: https://github.com/silviogutierrez
[@SimenB]: https://github.com/SimenB
[@simmo]: https://github.com/simmo
diff --git a/docs/rules/no-unused-modules.md b/docs/rules/no-unused-modules.md
index 53c2479272..359c341ea0 100644
--- a/docs/rules/no-unused-modules.md
+++ b/docs/rules/no-unused-modules.md
@@ -29,8 +29,9 @@ This rule takes the following option:
- **`missingExports`**: if `true`, files without any exports are reported (defaults to `false`)
- **`unusedExports`**: if `true`, exports without any static usage within other modules are reported (defaults to `false`)
- - `src`: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
- - `ignoreExports`: an array with files/paths for which unused exports will not be reported (e.g module entry points in a published package)
+ - **`ignoreUnusedTypeExports`**: if `true`, TypeScript type exports without any static usage within other modules are reported (defaults to `false` and has no effect unless `unusedExports` is `true`)
+ - **`src`**: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
+ - **`ignoreExports`**: an array with files/paths for which unused exports will not be reported (e.g module entry points in a published package)
### Example for missing exports
@@ -116,6 +117,16 @@ export function doAnything() {
export default 5 // will not be reported
```
+### Unused exports with `ignoreUnusedTypeExports` set to `true`
+
+The following will not be reported:
+
+```ts
+export type Foo = {}; // will not be reported
+export interface Foo = {}; // will not be reported
+export enum Foo {}; // will not be reported
+```
+
#### Important Note
Exports from files listed as a main file (`main`, `browser`, or `bin` fields in `package.json`) will be ignored by default. This only applies if the `package.json` is not set to `private: true`
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 0ad330b486..46fc93bfe0 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -83,28 +83,30 @@ const DEFAULT = 'default';
function forEachDeclarationIdentifier(declaration, cb) {
if (declaration) {
+ const isTypeDeclaration = declaration.type === TS_INTERFACE_DECLARATION
+ || declaration.type === TS_TYPE_ALIAS_DECLARATION
+ || declaration.type === TS_ENUM_DECLARATION;
+
if (
declaration.type === FUNCTION_DECLARATION
|| declaration.type === CLASS_DECLARATION
- || declaration.type === TS_INTERFACE_DECLARATION
- || declaration.type === TS_TYPE_ALIAS_DECLARATION
- || declaration.type === TS_ENUM_DECLARATION
+ || isTypeDeclaration
) {
- cb(declaration.id.name);
+ cb(declaration.id.name, isTypeDeclaration);
} else if (declaration.type === VARIABLE_DECLARATION) {
declaration.declarations.forEach(({ id }) => {
if (id.type === OBJECT_PATTERN) {
recursivePatternCapture(id, (pattern) => {
if (pattern.type === IDENTIFIER) {
- cb(pattern.name);
+ cb(pattern.name, false);
}
});
} else if (id.type === ARRAY_PATTERN) {
id.elements.forEach(({ name }) => {
- cb(name);
+ cb(name, false);
});
} else {
- cb(id.name);
+ cb(id.name, false);
}
});
}
@@ -443,6 +445,10 @@ module.exports = {
description: 'report exports without any usage',
type: 'boolean',
},
+ ignoreUnusedTypeExports: {
+ description: 'ignore type exports without any usage',
+ type: 'boolean',
+ },
},
anyOf: [
{
@@ -470,6 +476,7 @@ module.exports = {
ignoreExports = [],
missingExports,
unusedExports,
+ ignoreUnusedTypeExports,
} = context.options[0] || {};
if (unusedExports) {
@@ -502,11 +509,15 @@ module.exports = {
exportCount.set(IMPORT_NAMESPACE_SPECIFIER, namespaceImports);
};
- const checkUsage = (node, exportedValue) => {
+ const checkUsage = (node, exportedValue, isTypeExport) => {
if (!unusedExports) {
return;
}
+ if (isTypeExport && ignoreUnusedTypeExports) {
+ return;
+ }
+
if (ignoredFiles.has(file)) {
return;
}
@@ -935,14 +946,14 @@ module.exports = {
checkExportPresence(node);
},
ExportDefaultDeclaration(node) {
- checkUsage(node, IMPORT_DEFAULT_SPECIFIER);
+ checkUsage(node, IMPORT_DEFAULT_SPECIFIER, false);
},
ExportNamedDeclaration(node) {
node.specifiers.forEach((specifier) => {
- checkUsage(specifier, specifier.exported.name || specifier.exported.value);
+ checkUsage(specifier, specifier.exported.name || specifier.exported.value, false);
});
- forEachDeclarationIdentifier(node.declaration, (name) => {
- checkUsage(node, name);
+ forEachDeclarationIdentifier(node.declaration, (name, isTypeExport) => {
+ checkUsage(node, name, isTypeExport);
});
},
};
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index b09d5d759c..80bd70227e 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -38,6 +38,13 @@ const unusedExportsTypescriptOptions = [{
ignoreExports: undefined,
}];
+const unusedExportsTypescriptIgnoreUnusedTypesOptions = [{
+ unusedExports: true,
+ ignoreUnusedTypeExports: true,
+ src: [testFilePath('./no-unused-modules/typescript')],
+ ignoreExports: undefined,
+}];
+
const unusedExportsJsxOptions = [{
unusedExports: true,
src: [testFilePath('./no-unused-modules/jsx')],
@@ -1209,6 +1216,66 @@ context('TypeScript', function () {
});
});
+describe('ignoreUnusedTypeExports', () => {
+ getTSParsers().forEach((parser) => {
+ typescriptRuleTester.run('no-unused-modules', rule, {
+ valid: [
+ // unused vars should not report
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export interface c {};`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-c-unused.ts',
+ ),
+ }),
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export type d = {};`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-d-unused.ts',
+ ),
+ }),
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export enum e { f };`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-e-unused.ts',
+ ),
+ }),
+ // used vars should not report
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export interface c {};`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-c-used-as-type.ts',
+ ),
+ }),
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export type d = {};`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-d-used-as-type.ts',
+ ),
+ }),
+ test({
+ options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+ code: `export enum e { f };`,
+ parser,
+ filename: testFilePath(
+ './no-unused-modules/typescript/file-ts-e-used-as-type.ts',
+ ),
+ }),
+ ],
+ invalid: [],
+ });
+ });
+});
+
describe('correctly work with JSX only files', () => {
jsxRuleTester.run('no-unused-modules', rule, {
valid: [
From c387276efac8da06e0d8a4eae06989aa0e6631eb Mon Sep 17 00:00:00 2001
From: Mysak0CZ <michalmpacal@gmail.com>
Date: Fri, 23 Aug 2024 14:01:22 +0200
Subject: [PATCH 114/199] [utils] [fix] `parse`: also delete
parserOptions.projectService
---
utils/CHANGELOG.md | 5 +++++
utils/parse.js | 1 +
2 files changed, 6 insertions(+)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 3e2f5a8997..366a834bdb 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -8,6 +8,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [types] use shared config (thanks [@ljharb])
+### Fixed
+- `parse`: also delete `parserOptions.projectService` ([#3039], thanks [@Mysak0CZ])
+
## v2.8.1 - 2024-02-26
### Fixed
@@ -142,6 +145,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3039]: https://github.com/import-js/eslint-plugin-import/pull/3039
[#2963]: https://github.com/import-js/eslint-plugin-import/pull/2963
[#2755]: https://github.com/import-js/eslint-plugin-import/pull/2755
[#2714]: https://github.com/import-js/eslint-plugin-import/pull/2714
@@ -188,6 +192,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@manuth]: https://github.com/manuth
[@maxkomarychev]: https://github.com/maxkomarychev
[@mgwalker]: https://github.com/mgwalker
+[@Mysak0CZ]: https://github.com/Mysak0CZ
[@nicolo-ribaudo]: https://github.com/nicolo-ribaudo
[@pmcelhaney]: https://github.com/pmcelhaney
[@sergei-startsev]: https://github.com/sergei-startsev
diff --git a/utils/parse.js b/utils/parse.js
index 94aca1d0f8..75d527b008 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -134,6 +134,7 @@ exports.default = function parse(path, content, context) {
// only parse one file in isolate mode, which is much, much faster.
// https://github.com/import-js/eslint-plugin-import/issues/1408#issuecomment-509298962
delete parserOptions.EXPERIMENTAL_useProjectService;
+ delete parserOptions.projectService;
delete parserOptions.project;
delete parserOptions.projects;
From bab3a109dce63d0b4fdc4b876dc77f01c34aca4c Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 25 Aug 2024 15:15:43 -0700
Subject: [PATCH 115/199] [utils] [meta] add `exports`, `main`
In theory this should only be breaking if someone is requiring tsconfig.json
---
utils/CHANGELOG.md | 1 +
utils/package.json | 34 +++++++++++++++++++++++++++++++++-
2 files changed, 34 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 366a834bdb..ac6883b1c4 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -7,6 +7,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [types] use shared config (thanks [@ljharb])
+- [meta] add `exports`, `main`
### Fixed
- `parse`: also delete `parserOptions.projectService` ([#3039], thanks [@Mysak0CZ])
diff --git a/utils/package.json b/utils/package.json
index 4704971505..23c8b08e9c 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -5,15 +5,46 @@
"engines": {
"node": ">=4"
},
+ "main": false,
+ "exports": {
+ "./ModuleCache": "./ModuleCache.js",
+ "./ModuleCache.js": "./ModuleCache.js",
+ "./declaredScope": "./declaredScope.js",
+ "./declaredScope.js": "./declaredScope.js",
+ "./hash": "./hash.js",
+ "./hash.js": "./hash.js",
+ "./ignore": "./ignore.js",
+ "./ignore.js": "./ignore.js",
+ "./module-require": "./module-require.js",
+ "./module-require.js": "./module-require.js",
+ "./moduleVisitor": "./moduleVisitor.js",
+ "./moduleVisitor.js": "./moduleVisitor.js",
+ "./parse": "./parse.js",
+ "./parse.js": "./parse.js",
+ "./pkgDir": "./pkgDir.js",
+ "./pkgDir.js": "./pkgDir.js",
+ "./pkgUp": "./pkgUp.js",
+ "./pkgUp.js": "./pkgUp.js",
+ "./readPkgUp": "./readPkgUp.js",
+ "./readPkgUp.js": "./readPkgUp.js",
+ "./resolve": "./resolve.js",
+ "./resolve.js": "./resolve.js",
+ "./unambiguous": "./unambiguous.js",
+ "./unambiguous.js": "./unambiguous.js",
+ "./visit": "./visit.js",
+ "./visit.js": "./visit.js",
+ "./package.json": "./package.json"
+ },
"scripts": {
"prepublishOnly": "cp ../{LICENSE,.npmrc} ./",
"tsc": "tsc -p .",
+ "posttsc": "attw -P .",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/import-js/eslint-plugin-import.git",
- "directory": "utils"
+ "directory": "utils"
},
"keywords": [
"eslint-plugin-import",
@@ -31,6 +62,7 @@
"debug": "^3.2.7"
},
"devDependencies": {
+ "@arethetypeswrong/cli": "^0.15.4",
"@ljharb/tsconfig": "^0.2.0",
"@types/debug": "^4.1.12",
"@types/eslint": "^8.56.3",
From 9b1a3b96caa656fe94bda709c364c7e230028432 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 25 Aug 2024 16:22:22 -0700
Subject: [PATCH 116/199] [utils] v2.8.2
---
utils/CHANGELOG.md | 10 +++++++---
utils/package.json | 2 +-
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index ac6883b1c4..43bd0e022b 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,13 +5,17 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
-### Changed
-- [types] use shared config (thanks [@ljharb])
-- [meta] add `exports`, `main`
+## v2.8.2 - 2024-08-25
### Fixed
- `parse`: also delete `parserOptions.projectService` ([#3039], thanks [@Mysak0CZ])
+### Changed
+- [types] use shared config (thanks [@ljharb])
+- [meta] add `exports`, `main`
+- [meta] add `repository.directory` field
+- [refactor] avoid hoisting
+
## v2.8.1 - 2024-02-26
### Fixed
diff --git a/utils/package.json b/utils/package.json
index 23c8b08e9c..6d69e2414a 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.8.1",
+ "version": "2.8.2",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From bdff75d51fc73895f9e1697a02765daf12815714 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Sun, 25 Aug 2024 19:00:48 -0700
Subject: [PATCH 117/199] [Deps] update `array-includes`,
`array.prototype.findlastindex`, `eslint-module-utils`, `hasown`,
`is-core-module`, `object.fromentries`, `object.groupby`, `object.values`
---
package.json | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/package.json b/package.json
index b9fa1eb35f..de0055a09a 100644
--- a/package.json
+++ b/package.json
@@ -105,21 +105,21 @@
"eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8"
},
"dependencies": {
- "array-includes": "^3.1.7",
- "array.prototype.findlastindex": "^1.2.4",
+ "array-includes": "^3.1.8",
+ "array.prototype.findlastindex": "^1.2.5",
"array.prototype.flat": "^1.3.2",
"array.prototype.flatmap": "^1.3.2",
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.8.0",
- "hasown": "^2.0.1",
- "is-core-module": "^2.13.1",
+ "eslint-module-utils": "^2.8.2",
+ "hasown": "^2.0.2",
+ "is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
- "object.fromentries": "^2.0.7",
- "object.groupby": "^1.0.2",
- "object.values": "^1.1.7",
+ "object.fromentries": "^2.0.8",
+ "object.groupby": "^1.0.3",
+ "object.values": "^1.2.0",
"semver": "^6.3.1",
"tsconfig-paths": "^3.15.0"
}
From db8b95d7a5768c0ccd372b6b5228287a182c7679 Mon Sep 17 00:00:00 2001
From: Federico Brigante <me@fregante.com>
Date: Sun, 14 Jul 2024 13:45:26 +0000
Subject: [PATCH 118/199] [resolvers/webpack] [refactor] simplify loop
---
resolvers/webpack/CHANGELOG.md | 5 ++++-
resolvers/webpack/index.js | 31 ++++++++++++++++++-------------
resolvers/webpack/package.json | 1 -
3 files changed, 22 insertions(+), 15 deletions(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 4fed046b46..cd49cc3f4e 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,11 +5,12 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+- [refactor] simplify loop ([#3029], thanks [@fregante])
+
## 0.13.8 - 2023-10-22
- [refactor] use `hasown` instead of `has`
- [deps] update `array.prototype.find`, `is-core-module`, `resolve`
-
## 0.13.7 - 2023-08-19
- [fix] use the `dirname` of the `configPath` as `basedir` ([#2859])
@@ -178,6 +179,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- `interpret` configs (such as `.babel.js`). Thanks to [@gausie] for the initial PR ([#164], ages ago! 😅) and [@jquense] for tests ([#278]).
+[#3029]: https://github.com/import-js/eslint-plugin-import/pull/3029
[#2287]: https://github.com/import-js/eslint-plugin-import/pull/2287
[#2023]: https://github.com/import-js/eslint-plugin-import/pull/2023
[#1967]: https://github.com/import-js/eslint-plugin-import/pull/1967
@@ -222,6 +224,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
[@benmvp]: https://github.com/benmvp
[@daltones]: https://github.com/daltones
[@echenley]: https://github.com/echenley
+[@fregante]: https://github.com/fregante
[@gausie]: https://github.com/gausie
[@grahamb]: https://github.com/grahamb
[@graingert]: https://github.com/graingert
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index da16eda593..eabe3cf338 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -3,7 +3,6 @@
const findRoot = require('find-root');
const path = require('path');
const isEqual = require('lodash/isEqual');
-const find = require('array.prototype.find');
const interpret = require('interpret');
const fs = require('fs');
const isCore = require('is-core-module');
@@ -293,17 +292,20 @@ const MAX_CACHE = 10;
const _cache = [];
function getResolveSync(configPath, webpackConfig, cwd) {
const cacheKey = { configPath, webpackConfig };
- let cached = find(_cache, function (entry) { return isEqual(entry.key, cacheKey); });
- if (!cached) {
- cached = {
- key: cacheKey,
- value: createResolveSync(configPath, webpackConfig, cwd),
- };
- // put in front and pop last item
- if (_cache.unshift(cached) > MAX_CACHE) {
- _cache.pop();
+ for (let i = 0; i < _cache.length; i++) {
+ if (isEqual(_cache[i].key, cacheKey)) {
+ return _cache[i].value;
}
}
+
+ const cached = {
+ key: cacheKey,
+ value: createResolveSync(configPath, webpackConfig, cwd),
+ };
+ // put in front and pop last item
+ if (_cache.unshift(cached) > MAX_CACHE) {
+ _cache.pop();
+ }
return cached.value;
}
@@ -409,9 +411,12 @@ exports.resolve = function (source, file, settings) {
if (typeof configIndex !== 'undefined' && webpackConfig.length > configIndex) {
webpackConfig = webpackConfig[configIndex];
} else {
- webpackConfig = find(webpackConfig, function findFirstWithResolve(config) {
- return !!config.resolve;
- });
+ for (let i = 0; i < webpackConfig.length; i++) {
+ if (webpackConfig[i].resolve) {
+ webpackConfig = webpackConfig[i];
+ break;
+ }
+ }
}
}
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 7f8cb718f1..38465bcdee 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -31,7 +31,6 @@
},
"homepage": "https://github.com/import-js/eslint-plugin-import/tree/HEAD/resolvers/webpack",
"dependencies": {
- "array.prototype.find": "^2.2.2",
"debug": "^3.2.7",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
From 19dbc33ecf09c774db35f362b05caaec027d2e18 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 26 Aug 2024 15:23:07 -0700
Subject: [PATCH 119/199] [resolvers/webpack] [refactor] misc cleanup
---
resolvers/webpack/index.js | 66 ++++++++++++++++++++------------------
1 file changed, 34 insertions(+), 32 deletions(-)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index eabe3cf338..83297cd185 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -4,12 +4,15 @@ const findRoot = require('find-root');
const path = require('path');
const isEqual = require('lodash/isEqual');
const interpret = require('interpret');
-const fs = require('fs');
+const existsSync = require('fs').existsSync;
const isCore = require('is-core-module');
const resolve = require('resolve/sync');
const semver = require('semver');
const hasOwn = require('hasown');
const isRegex = require('is-regex');
+const isArray = Array.isArray;
+const keys = Object.keys;
+const assign = Object.assign;
const log = require('debug')('eslint-plugin-import:resolver:webpack');
@@ -19,7 +22,7 @@ function registerCompiler(moduleDescriptor) {
if (moduleDescriptor) {
if (typeof moduleDescriptor === 'string') {
require(moduleDescriptor);
- } else if (!Array.isArray(moduleDescriptor)) {
+ } else if (!isArray(moduleDescriptor)) {
moduleDescriptor.register(require(moduleDescriptor.module));
} else {
for (let i = 0; i < moduleDescriptor.length; i++) {
@@ -35,42 +38,34 @@ function registerCompiler(moduleDescriptor) {
}
function findConfigPath(configPath, packageDir) {
- const extensions = Object.keys(interpret.extensions).sort(function (a, b) {
+ const extensions = keys(interpret.extensions).sort(function (a, b) {
return a === '.js' ? -1 : b === '.js' ? 1 : a.length - b.length;
});
let extension;
if (configPath) {
- // extensions is not reused below, so safe to mutate it here.
- extensions.reverse();
- extensions.forEach(function (maybeExtension) {
- if (extension) {
- return;
- }
-
- if (configPath.substr(-maybeExtension.length) === maybeExtension) {
+ for (let i = extensions.length - 1; i >= 0 && !extension; i--) {
+ const maybeExtension = extensions[i];
+ if (configPath.slice(-maybeExtension.length) === maybeExtension) {
extension = maybeExtension;
}
- });
+ }
// see if we've got an absolute path
if (!path.isAbsolute(configPath)) {
configPath = path.join(packageDir, configPath);
}
} else {
- extensions.forEach(function (maybeExtension) {
- if (extension) {
- return;
- }
-
+ for (let i = 0; i < extensions.length && !extension; i++) {
+ const maybeExtension = extensions[i];
const maybePath = path.resolve(
path.join(packageDir, 'webpack.config' + maybeExtension)
);
- if (fs.existsSync(maybePath)) {
+ if (existsSync(maybePath)) {
configPath = maybePath;
extension = maybeExtension;
}
- });
+ }
}
registerCompiler(interpret.extensions[extension]);
@@ -84,7 +79,7 @@ function findExternal(source, externals, context, resolveSync) {
if (typeof externals === 'string') { return source === externals; }
// array: recurse
- if (Array.isArray(externals)) {
+ if (isArray(externals)) {
return externals.some(function (e) { return findExternal(source, e, context, resolveSync); });
}
@@ -138,8 +133,9 @@ function findExternal(source, externals, context, resolveSync) {
// else, vanilla object
for (const key in externals) {
- if (!hasOwn(externals, key)) { continue; }
- if (source === key) { return true; }
+ if (hasOwn(externals, key) && source === key) {
+ return true;
+ }
}
return false;
}
@@ -160,15 +156,20 @@ const webpack2DefaultResolveConfig = {
function createWebpack2ResolveSync(webpackRequire, resolveConfig) {
const EnhancedResolve = webpackRequire('enhanced-resolve');
- return EnhancedResolve.create.sync(Object.assign({}, webpack2DefaultResolveConfig, resolveConfig));
+ return EnhancedResolve.create.sync(assign({}, webpack2DefaultResolveConfig, resolveConfig));
}
/**
* webpack 1 defaults: https://webpack.github.io/docs/configuration.html#resolve-packagemains
- * @type {Array}
+ * @type {string[]}
*/
const webpack1DefaultMains = [
- 'webpack', 'browser', 'web', 'browserify', ['jam', 'main'], 'main',
+ 'webpack',
+ 'browser',
+ 'web',
+ 'browserify',
+ ['jam', 'main'],
+ 'main',
];
/* eslint-disable */
@@ -176,8 +177,9 @@ const webpack1DefaultMains = [
function makeRootPlugin(ModulesInRootPlugin, name, root) {
if (typeof root === 'string') {
return new ModulesInRootPlugin(name, root);
- } else if (Array.isArray(root)) {
- return function() {
+ }
+ if (isArray(root)) {
+ return function () {
root.forEach(function (root) {
this.apply(new ModulesInRootPlugin(name, root));
}, this);
@@ -236,7 +238,7 @@ function createWebpack1ResolveSync(webpackRequire, resolveConfig, plugins) {
if (
plugin.constructor
&& plugin.constructor.name === 'ResolverPlugin'
- && Array.isArray(plugin.plugins)
+ && isArray(plugin.plugins)
) {
resolvePlugins.push.apply(resolvePlugins, plugin.plugins);
}
@@ -313,9 +315,9 @@ function getResolveSync(configPath, webpackConfig, cwd) {
* Find the full path to 'source', given 'file' as a full reference path.
*
* resolveImport('./foo', '/Users/ben/bar.js') => '/Users/ben/foo.js'
- * @param {string} source - the module to resolve; i.e './some-module'
- * @param {string} file - the importing file's full path; i.e. '/usr/local/bin/file.js'
- * @param {object} settings - the webpack config file name, as well as cwd
+ * @param {string} source - the module to resolve; i.e './some-module'
+ * @param {string} file - the importing file's full path; i.e. '/usr/local/bin/file.js'
+ * @param {object} settings - the webpack config file name, as well as cwd
* @example
* options: {
* // Path to the webpack config
@@ -399,7 +401,7 @@ exports.resolve = function (source, file, settings) {
webpackConfig = webpackConfig(env, argv);
}
- if (Array.isArray(webpackConfig)) {
+ if (isArray(webpackConfig)) {
webpackConfig = webpackConfig.map((cfg) => {
if (typeof cfg === 'function') {
return cfg(env, argv);
From 98a0991aa248216fb904cc88d11aa9070ccb6249 Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Mon, 8 Apr 2024 20:50:56 +0300
Subject: [PATCH 120/199] [New] [Refactor] `no-cycle`: use scc algorithm to
optimize; add `skipErrorMessagePath` for faster error messages
---
CHANGELOG.md | 2 +
package.json | 1 +
src/rules/no-cycle.js | 21 +++++
src/scc.js | 86 +++++++++++++++++
tests/src/rules/no-cycle.js | 28 +++++-
tests/src/scc.js | 179 ++++++++++++++++++++++++++++++++++++
6 files changed, 316 insertions(+), 1 deletion(-)
create mode 100644 src/scc.js
create mode 100644 tests/src/scc.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b1d2a3425b..0ba781c235 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
+- [`no-cycle`]: use scc algorithm to optimize ([#2998], thanks [@soryy708])
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1123,6 +1124,7 @@ for info on changes for earlier releases.
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
+[#2998]: https://github.com/import-js/eslint-plugin-import/pull/2998
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
diff --git a/package.json b/package.json
index de0055a09a..2aaa786538 100644
--- a/package.json
+++ b/package.json
@@ -105,6 +105,7 @@
"eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8"
},
"dependencies": {
+ "@rtsao/scc": "^1.1.0",
"array-includes": "^3.1.8",
"array.prototype.findlastindex": "^1.2.5",
"array.prototype.flat": "^1.3.2",
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index e65ff11a49..be8c288dd4 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -5,6 +5,7 @@
import resolve from 'eslint-module-utils/resolve';
import ExportMapBuilder from '../exportMap/builder';
+import StronglyConnectedComponentsBuilder from '../scc';
import { isExternalModule } from '../core/importType';
import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import docsUrl from '../docsUrl';
@@ -47,6 +48,11 @@ module.exports = {
type: 'boolean',
default: false,
},
+ disableScc: {
+ description: 'When true, don\'t calculate a strongly-connected-components graph. SCC is used to reduce the time-complexity of cycle detection, but adds overhead.',
+ type: 'boolean',
+ default: false,
+ },
})],
},
@@ -62,6 +68,8 @@ module.exports = {
context,
);
+ const scc = options.disableScc ? {} : StronglyConnectedComponentsBuilder.get(myPath, context);
+
function checkSourceValue(sourceNode, importer) {
if (ignoreModule(sourceNode.value)) {
return; // ignore external modules
@@ -98,6 +106,16 @@ module.exports = {
return; // no-self-import territory
}
+ /* If we're in the same Strongly Connected Component,
+ * Then there exists a path from each node in the SCC to every other node in the SCC,
+ * Then there exists at least one path from them to us and from us to them,
+ * Then we have a cycle between us.
+ */
+ const hasDependencyCycle = options.disableScc || scc[myPath] === scc[imported.path];
+ if (!hasDependencyCycle) {
+ return;
+ }
+
const untraversed = [{ mget: () => imported, route: [] }];
function detectCycle({ mget, route }) {
const m = mget();
@@ -106,6 +124,9 @@ module.exports = {
traversed.add(m.path);
for (const [path, { getter, declarations }] of m.imports) {
+ // If we're in different SCCs, we can't have a circular dependency
+ if (!options.disableScc && scc[myPath] !== scc[path]) { continue; }
+
if (traversed.has(path)) { continue; }
const toTraverse = [...declarations].filter(({ source, isOnlyImportingTypes }) => !ignoreModule(source.value)
// Ignore only type imports
diff --git a/src/scc.js b/src/scc.js
new file mode 100644
index 0000000000..44c818bbe1
--- /dev/null
+++ b/src/scc.js
@@ -0,0 +1,86 @@
+import calculateScc from '@rtsao/scc';
+import { hashObject } from 'eslint-module-utils/hash';
+import resolve from 'eslint-module-utils/resolve';
+import ExportMapBuilder from './exportMap/builder';
+import childContext from './exportMap/childContext';
+
+let cache = new Map();
+
+export default class StronglyConnectedComponentsBuilder {
+ static clearCache() {
+ cache = new Map();
+ }
+
+ static get(source, context) {
+ const path = resolve(source, context);
+ if (path == null) { return null; }
+ return StronglyConnectedComponentsBuilder.for(childContext(path, context));
+ }
+
+ static for(context) {
+ const cacheKey = context.cacheKey || hashObject(context).digest('hex');
+ if (cache.has(cacheKey)) {
+ return cache.get(cacheKey);
+ }
+ const scc = StronglyConnectedComponentsBuilder.calculate(context);
+ cache.set(cacheKey, scc);
+ return scc;
+ }
+
+ static calculate(context) {
+ const exportMap = ExportMapBuilder.for(context);
+ const adjacencyList = this.exportMapToAdjacencyList(exportMap);
+ const calculatedScc = calculateScc(adjacencyList);
+ return StronglyConnectedComponentsBuilder.calculatedSccToPlainObject(calculatedScc);
+ }
+
+ /** @returns {Map<string, Set<string>>} for each dep, what are its direct deps */
+ static exportMapToAdjacencyList(initialExportMap) {
+ const adjacencyList = new Map();
+ // BFS
+ function visitNode(exportMap) {
+ if (!exportMap) {
+ return;
+ }
+ exportMap.imports.forEach((v, importedPath) => {
+ const from = exportMap.path;
+ const to = importedPath;
+
+ // Ignore type-only imports, because we care only about SCCs of value imports
+ const toTraverse = [...v.declarations].filter(({ isOnlyImportingTypes }) => !isOnlyImportingTypes);
+ if (toTraverse.length === 0) { return; }
+
+ if (!adjacencyList.has(from)) {
+ adjacencyList.set(from, new Set());
+ }
+
+ if (adjacencyList.get(from).has(to)) {
+ return; // prevent endless loop
+ }
+ adjacencyList.get(from).add(to);
+ visitNode(v.getter());
+ });
+ }
+ visitNode(initialExportMap);
+ // Fill gaps
+ adjacencyList.forEach((values) => {
+ values.forEach((value) => {
+ if (!adjacencyList.has(value)) {
+ adjacencyList.set(value, new Set());
+ }
+ });
+ });
+ return adjacencyList;
+ }
+
+ /** @returns {Record<string, number>} for each key, its SCC's index */
+ static calculatedSccToPlainObject(sccs) {
+ const obj = {};
+ sccs.forEach((scc, index) => {
+ scc.forEach((node) => {
+ obj[node] = index;
+ });
+ });
+ return obj;
+ }
+}
diff --git a/tests/src/rules/no-cycle.js b/tests/src/rules/no-cycle.js
index d2adbf61f9..efc0fb6eb9 100644
--- a/tests/src/rules/no-cycle.js
+++ b/tests/src/rules/no-cycle.js
@@ -17,7 +17,7 @@ const testVersion = (specifier, t) => _testVersion(specifier, () => Object.assig
const testDialects = ['es6'];
-ruleTester.run('no-cycle', rule, {
+const cases = {
valid: [].concat(
// this rule doesn't care if the cycle length is 0
test({ code: 'import foo from "./foo.js"' }),
@@ -290,4 +290,30 @@ ruleTester.run('no-cycle', rule, {
],
}),
),
+};
+
+ruleTester.run('no-cycle', rule, {
+ valid: flatMap(cases.valid, (testCase) => [
+ testCase,
+ {
+ ...testCase,
+ code: `${testCase.code} // disableScc=true`,
+ options: [{
+ ...testCase.options && testCase.options[0] || {},
+ disableScc: true,
+ }],
+ },
+ ]),
+
+ invalid: flatMap(cases.invalid, (testCase) => [
+ testCase,
+ {
+ ...testCase,
+ code: `${testCase.code} // disableScc=true`,
+ options: [{
+ ...testCase.options && testCase.options[0] || {},
+ disableScc: true,
+ }],
+ },
+ ]),
});
diff --git a/tests/src/scc.js b/tests/src/scc.js
new file mode 100644
index 0000000000..376b783ce1
--- /dev/null
+++ b/tests/src/scc.js
@@ -0,0 +1,179 @@
+import sinon from 'sinon';
+import { expect } from 'chai';
+import StronglyConnectedComponentsBuilder from '../../src/scc';
+import ExportMapBuilder from '../../src/exportMap/builder';
+
+function exportMapFixtureBuilder(path, imports, isOnlyImportingTypes = false) {
+ return {
+ path,
+ imports: new Map(imports.map((imp) => [imp.path, { getter: () => imp, declarations: [{ isOnlyImportingTypes }] }])),
+ };
+}
+
+describe('Strongly Connected Components Builder', () => {
+ afterEach(() => ExportMapBuilder.for.restore());
+ afterEach(() => StronglyConnectedComponentsBuilder.clearCache());
+
+ describe('When getting an SCC', () => {
+ const source = '';
+ const context = {
+ settings: {},
+ parserOptions: {},
+ parserPath: '',
+ };
+
+ describe('Given two files', () => {
+ describe('When they don\'t value-cycle', () => {
+ it('Should return foreign SCCs', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [exportMapFixtureBuilder('bar.js', [])]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 1, 'bar.js': 0 });
+ });
+ });
+
+ describe('When they do value-cycle', () => {
+ it('Should return same SCC', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('foo.js', [exportMapFixtureBuilder('bar.js', [])]),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 0, 'bar.js': 0 });
+ });
+ });
+
+ describe('When they type-cycle', () => {
+ it('Should return foreign SCCs', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('foo.js', []),
+ ], true),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 1, 'bar.js': 0 });
+ });
+ });
+ });
+
+ describe('Given three files', () => {
+ describe('When they form a line', () => {
+ describe('When A -> B -> C', () => {
+ it('Should return foreign SCCs', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('buzz.js', []),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 2, 'bar.js': 1, 'buzz.js': 0 });
+ });
+ });
+
+ describe('When A -> B <-> C', () => {
+ it('Should return 2 SCCs, A on its own', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('buzz.js', [
+ exportMapFixtureBuilder('bar.js', []),
+ ]),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 1, 'bar.js': 0, 'buzz.js': 0 });
+ });
+ });
+
+ describe('When A <-> B -> C', () => {
+ it('Should return 2 SCCs, C on its own', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('buzz.js', []),
+ exportMapFixtureBuilder('foo.js', []),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 1, 'bar.js': 1, 'buzz.js': 0 });
+ });
+ });
+
+ describe('When A <-> B <-> C', () => {
+ it('Should return same SCC', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('foo.js', []),
+ exportMapFixtureBuilder('buzz.js', [
+ exportMapFixtureBuilder('bar.js', []),
+ ]),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 0, 'bar.js': 0, 'buzz.js': 0 });
+ });
+ });
+ });
+
+ describe('When they form a loop', () => {
+ it('Should return same SCC', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('buzz.js', [
+ exportMapFixtureBuilder('foo.js', []),
+ ]),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 0, 'bar.js': 0, 'buzz.js': 0 });
+ });
+ });
+
+ describe('When they form a Y', () => {
+ it('Should return 3 distinct SCCs', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', []),
+ exportMapFixtureBuilder('buzz.js', []),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 2, 'bar.js': 0, 'buzz.js': 1 });
+ });
+ });
+
+ describe('When they form a Mercedes', () => {
+ it('Should return 1 SCC', () => {
+ sinon.stub(ExportMapBuilder, 'for').returns(
+ exportMapFixtureBuilder('foo.js', [
+ exportMapFixtureBuilder('bar.js', [
+ exportMapFixtureBuilder('foo.js', []),
+ exportMapFixtureBuilder('buzz.js', []),
+ ]),
+ exportMapFixtureBuilder('buzz.js', [
+ exportMapFixtureBuilder('foo.js', []),
+ exportMapFixtureBuilder('bar.js', []),
+ ]),
+ ]),
+ );
+ const actual = StronglyConnectedComponentsBuilder.for(source, context);
+ expect(actual).to.deep.equal({ 'foo.js': 0, 'bar.js': 0, 'buzz.js': 0 });
+ });
+ });
+ });
+ });
+});
From 4bdf61af182dc1793e229d6f0da2a0e7472f86e6 Mon Sep 17 00:00:00 2001
From: yesl-kim <yesl00k624@gmail.com>
Date: Sun, 11 Aug 2024 17:34:29 +0900
Subject: [PATCH 121/199] [Fix] `no-duplicates`: Removing duplicates breaks in
TypeScript
Fixes #3016. Fixes #2792.
---
CHANGELOG.md | 3 +++
src/rules/no-duplicates.js | 16 ++++++++++++++--
tests/src/rules/no-duplicates.js | 18 ++++++++++++++++++
3 files changed, 35 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0ba781c235..667d9fffb3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
- [`no-cycle`]: use scc algorithm to optimize ([#2998], thanks [@soryy708])
+- [`no-duplicates`]: Removing duplicates breaks in TypeScript ([#3033], thanks [@yesl-kim])
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1121,6 +1122,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
@@ -1962,6 +1964,7 @@ for info on changes for earlier releases.
[@wtgtybhertgeghgtwtg]: https://github.com/wtgtybhertgeghgtwtg
[@xM8WVqaG]: https://github.com/xM8WVqaG
[@xpl]: https://github.com/xpl
+[@yesl-kim]: https://github.com/yesl-kim
[@yndajas]: https://github.com/yndajas
[@yordis]: https://github.com/yordis
[@Zamiell]: https://github.com/Zamiell
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 033e854e03..d9fb1a1309 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -132,6 +132,7 @@ function getFix(first, rest, sourceCode, context) {
const shouldAddDefault = getDefaultImportName(first) == null && defaultImportNames.size === 1;
const shouldAddSpecifiers = specifiers.length > 0;
const shouldRemoveUnnecessary = unnecessaryImports.length > 0;
+ const preferInline = context.options[0] && context.options[0]['prefer-inline'];
if (!(shouldAddDefault || shouldAddSpecifiers || shouldRemoveUnnecessary)) {
return undefined;
@@ -157,8 +158,7 @@ function getFix(first, rest, sourceCode, context) {
([result, needsComma, existingIdentifiers], specifier) => {
const isTypeSpecifier = specifier.importNode.importKind === 'type';
- const preferInline = context.options[0] && context.options[0]['prefer-inline'];
- // a user might set prefer-inline but not have a supporting TypeScript version. Flow does not support inline types so this should fail in that case as well.
+ // a user might set prefer-inline but not have a supporting TypeScript version. Flow does not support inline types so this should fail in that case as well.
if (preferInline && (!typescriptPkg || !semver.satisfies(typescriptPkg.version, '>= 4.5'))) {
throw new Error('Your version of TypeScript does not support inline type imports.');
}
@@ -186,6 +186,18 @@ function getFix(first, rest, sourceCode, context) {
const fixes = [];
+ if (shouldAddSpecifiers && preferInline && first.importKind === 'type') {
+ // `import type {a} from './foo'` → `import {type a} from './foo'`
+ const typeIdentifierToken = tokens.find((token) => token.type === 'Identifier' && token.value === 'type');
+ fixes.push(fixer.removeRange([typeIdentifierToken.range[0], typeIdentifierToken.range[1] + 1]));
+
+ tokens
+ .filter((token) => firstExistingIdentifiers.has(token.value))
+ .forEach((identifier) => {
+ fixes.push(fixer.replaceTextRange([identifier.range[0], identifier.range[1]], `type ${identifier.value}`));
+ });
+ }
+
if (shouldAddDefault && openBrace == null && shouldAddSpecifiers) {
// `import './foo'` → `import def, {...} from './foo'`
fixes.push(
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index f83221105a..e682f22354 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -704,6 +704,24 @@ context('TypeScript', function () {
},
],
}),
+ test({
+ code: "import type {x} from 'foo'; import {type y} from 'foo'",
+ ...parserConfig,
+ options: [{ 'prefer-inline': true }],
+ output: `import {type x,type y} from 'foo'; `,
+ errors: [
+ {
+ line: 1,
+ column: 22,
+ message: "'foo' imported multiple times.",
+ },
+ {
+ line: 1,
+ column: 50,
+ message: "'foo' imported multiple times.",
+ },
+ ],
+ }),
test({
code: "import {type x} from 'foo'; import type {y} from 'foo'",
...parserConfig,
From 6407c1ce2ad16f6116bd8927fc4ba1d2fef56880 Mon Sep 17 00:00:00 2001
From: Bryan Lee <38807139+liby@users.noreply.github.com>
Date: Tue, 28 Sep 2021 11:26:25 +0800
Subject: [PATCH 122/199] [Docs] `order`: update the description of the
`pathGroupsExcludedImportTypes` option
---
CHANGELOG.md | 2 ++
docs/rules/order.md | 26 ++------------------------
2 files changed, 4 insertions(+), 24 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 667d9fffb3..7752473019 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,6 +26,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [actions] migrate OSX tests to GHA ([ljharb#37], thanks [@aks-])
- [Refactor] `exportMapBuilder`: avoid hoisting ([#2989], thanks [@soryy708])
- [Refactor] `ExportMap`: extract "builder" logic to separate files ([#2991], thanks [@soryy708])
+- [Docs] [`order`]: update the description of the `pathGroupsExcludedImportTypes` option ([#3036], thanks [@liby])
## [2.29.1] - 2023-12-14
@@ -1122,6 +1123,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 24692f2d21..67849bb7ed 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -193,7 +193,7 @@ Example:
### `pathGroupsExcludedImportTypes: [array]`
This defines import types that are not handled by configured pathGroups.
-This is mostly needed when you want to handle path groups that look like external imports.
+If you have added path groups with patterns that look like `"builtin"` or `"external"` imports, you have to remove this group (`"builtin"` and/or `"external"`) from the default exclusion list (e.g., `["builtin", "external", "object"]`, etc) to sort these path groups correctly.
Example:
@@ -212,29 +212,7 @@ Example:
}
```
-You can also use `patterns`(e.g., `react`, `react-router-dom`, etc).
-
-Example:
-
-```json
-{
- "import/order": [
- "error",
- {
- "pathGroups": [
- {
- "pattern": "react",
- "group": "builtin",
- "position": "before"
- }
- ],
- "pathGroupsExcludedImportTypes": ["react"]
- }
- ]
-}
-```
-
-The default value is `["builtin", "external", "object"]`.
+[Import Type](https://github.com/import-js/eslint-plugin-import/blob/HEAD/src/core/importType.js#L90) is resolved as a fixed string in predefined set, it can't be a `patterns`(e.g., `react`, `react-router-dom`, etc). See [#2156] for details.
### `newlines-between: [ignore|always|always-and-inside-groups|never]`
From b340f1f321f1804f6db9d024e42d743f96f48126 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 29 Aug 2024 10:32:30 -0700
Subject: [PATCH 123/199] [meta] no need to ship contrib docs
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index 2aaa786538..b0ddaf8168 100644
--- a/package.json
+++ b/package.json
@@ -11,6 +11,7 @@
},
"files": [
"*.md",
+ "!{CONTRIBUTING,RELEASE}.md",
"LICENSE",
"docs",
"lib",
From 806e3c2ccc65456a2d8532d575c9f443355bda82 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Tue, 18 Jun 2024 07:10:18 -0500
Subject: [PATCH 124/199] [New] add support for Flat Config
This change adds support for ESLint's new Flat config system. It maintains backwards compatibility with `eslintrc`-style configs as well.
To achieve this, we're now dynamically creating flat configs on a new `flatConfigs` export.
Usage
```js
import importPlugin from 'eslint-plugin-import';
import js from '@eslint/js';
import tsParser from '@typescript-eslint/parser';
export default [
js.configs.recommended,
importPlugin.flatConfigs.recommended,
importPlugin.flatConfigs.react,
importPlugin.flatConfigs.typescript,
{
files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
languageOptions: {
parser: tsParser,
ecmaVersion: 'latest',
sourceType: 'module',
},
ignores: ['eslint.config.js'],
rules: {
'no-unused-vars': 'off',
'import/no-dynamic-require': 'warn',
'import/no-nodejs-modules': 'warn',
},
},
];
```
---
.editorconfig | 1 +
.eslintignore | 1 +
CHANGELOG.md | 3 +
README.md | 31 +++-
config/flat/errors.js | 14 ++
config/flat/react.js | 19 +++
config/flat/recommended.js | 26 ++++
config/flat/warnings.js | 11 ++
config/react.js | 2 -
config/typescript.js | 2 +-
examples/flat/eslint.config.mjs | 25 +++
examples/flat/package.json | 17 +++
examples/flat/src/exports-unused.ts | 12 ++
examples/flat/src/exports.ts | 12 ++
examples/flat/src/imports.ts | 7 +
examples/flat/src/jsx.tsx | 3 +
examples/flat/tsconfig.json | 14 ++
examples/legacy/.eslintrc.cjs | 24 +++
examples/legacy/package.json | 16 ++
examples/legacy/src/exports-unused.ts | 12 ++
examples/legacy/src/exports.ts | 12 ++
examples/legacy/src/imports.ts | 7 +
examples/legacy/src/jsx.tsx | 3 +
examples/legacy/tsconfig.json | 14 ++
package.json | 3 +
src/core/fsWalk.js | 48 ++++++
src/index.js | 31 ++++
src/rules/no-unused-modules.js | 210 ++++++++++++++++++++------
utils/ignore.js | 10 +-
29 files changed, 541 insertions(+), 49 deletions(-)
create mode 100644 config/flat/errors.js
create mode 100644 config/flat/react.js
create mode 100644 config/flat/recommended.js
create mode 100644 config/flat/warnings.js
create mode 100644 examples/flat/eslint.config.mjs
create mode 100644 examples/flat/package.json
create mode 100644 examples/flat/src/exports-unused.ts
create mode 100644 examples/flat/src/exports.ts
create mode 100644 examples/flat/src/imports.ts
create mode 100644 examples/flat/src/jsx.tsx
create mode 100644 examples/flat/tsconfig.json
create mode 100644 examples/legacy/.eslintrc.cjs
create mode 100644 examples/legacy/package.json
create mode 100644 examples/legacy/src/exports-unused.ts
create mode 100644 examples/legacy/src/exports.ts
create mode 100644 examples/legacy/src/imports.ts
create mode 100644 examples/legacy/src/jsx.tsx
create mode 100644 examples/legacy/tsconfig.json
create mode 100644 src/core/fsWalk.js
diff --git a/.editorconfig b/.editorconfig
index e2bfac523f..b7b8d09991 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -7,3 +7,4 @@ insert_final_newline = true
indent_style = space
indent_size = 2
end_of_line = lf
+quote_type = single
diff --git a/.eslintignore b/.eslintignore
index 9d22006820..3516f09b9c 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -7,6 +7,7 @@ tests/files/with-syntax-error
tests/files/just-json-files/invalid.json
tests/files/typescript-d-ts/
resolvers/webpack/test/files
+examples
# we want to ignore "tests/files" here, but unfortunately doing so would
# interfere with unit test and fail it for some reason.
# tests/files
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7752473019..05d623f410 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
- [`dynamic-import-chunkname`]: Allow empty chunk name when webpackMode: 'eager' is set; add suggestions to remove name in eager mode ([#3004], thanks [@amsardesai])
- [`no-unused-modules`]: Add `ignoreUnusedTypeExports` option ([#3011], thanks [@silverwind])
+- add support for Flat Config ([#3018], thanks [@michaelfaith])
### Fixed
- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
@@ -1125,6 +1126,7 @@ for info on changes for earlier releases.
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
+[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
@@ -1874,6 +1876,7 @@ for info on changes for earlier releases.
[@meowtec]: https://github.com/meowtec
[@mgwalker]: https://github.com/mgwalker
[@mhmadhamster]: https://github.com/MhMadHamster
+[@michaelfaith]: https://github.com/michaelfaith
[@MikeyBeLike]: https://github.com/MikeyBeLike
[@minervabot]: https://github.com/minervabot
[@mpint]: https://github.com/mpint
diff --git a/README.md b/README.md
index 1fd113c7d0..bf563f4d7b 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,8 @@ The maintainers of `eslint-plugin-import` and thousands of other packages are wo
npm install eslint-plugin-import --save-dev
```
+### Config - Legacy (`.eslintrc`)
+
All rules are off by default. However, you may configure them manually
in your `.eslintrc.(yml|json|js)`, or extend one of the canned configs:
@@ -123,7 +125,7 @@ plugins:
- import
rules:
- import/no-unresolved: [2, {commonjs: true, amd: true}]
+ import/no-unresolved: [2, { commonjs: true, amd: true }]
import/named: 2
import/namespace: 2
import/default: 2
@@ -131,6 +133,33 @@ rules:
# etc...
```
+### Config - Flat (`eslint.config.js`)
+
+All rules are off by default. However, you may configure them manually
+in your `eslint.config.(js|cjs|mjs)`, or extend one of the canned configs:
+
+```js
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+
+export default [
+ js.configs.recommended,
+ importPlugin.flatConfigs.recommended,
+ {
+ files: ['**/*.{js,mjs,cjs}'],
+ languageOptions: {
+ ecmaVersion: 'latest',
+ sourceType: 'module',
+ },
+ rules: {
+ 'no-unused-vars': 'off',
+ 'import/no-dynamic-require': 'warn',
+ 'import/no-nodejs-modules': 'warn',
+ },
+ },
+];
+```
+
## TypeScript
You may use the following snippet or assemble your own config using the granular settings described below it.
diff --git a/config/flat/errors.js b/config/flat/errors.js
new file mode 100644
index 0000000000..98c19f824d
--- /dev/null
+++ b/config/flat/errors.js
@@ -0,0 +1,14 @@
+/**
+ * unopinionated config. just the things that are necessarily runtime errors
+ * waiting to happen.
+ * @type {Object}
+ */
+module.exports = {
+ rules: {
+ 'import/no-unresolved': 2,
+ 'import/named': 2,
+ 'import/namespace': 2,
+ 'import/default': 2,
+ 'import/export': 2,
+ },
+};
diff --git a/config/flat/react.js b/config/flat/react.js
new file mode 100644
index 0000000000..0867471422
--- /dev/null
+++ b/config/flat/react.js
@@ -0,0 +1,19 @@
+/**
+ * Adds `.jsx` as an extension, and enables JSX parsing.
+ *
+ * Even if _you_ aren't using JSX (or .jsx) directly, if your dependencies
+ * define jsnext:main and have JSX internally, you may run into problems
+ * if you don't enable these settings at the top level.
+ */
+module.exports = {
+ settings: {
+ 'import/extensions': ['.js', '.jsx', '.mjs', '.cjs'],
+ },
+ languageOptions: {
+ parserOptions: {
+ ecmaFeatures: {
+ jsx: true,
+ },
+ },
+ },
+};
diff --git a/config/flat/recommended.js b/config/flat/recommended.js
new file mode 100644
index 0000000000..11bc1f52a4
--- /dev/null
+++ b/config/flat/recommended.js
@@ -0,0 +1,26 @@
+/**
+ * The basics.
+ * @type {Object}
+ */
+module.exports = {
+ rules: {
+ // analysis/correctness
+ 'import/no-unresolved': 'error',
+ 'import/named': 'error',
+ 'import/namespace': 'error',
+ 'import/default': 'error',
+ 'import/export': 'error',
+
+ // red flags (thus, warnings)
+ 'import/no-named-as-default': 'warn',
+ 'import/no-named-as-default-member': 'warn',
+ 'import/no-duplicates': 'warn',
+ },
+
+ // need all these for parsing dependencies (even if _your_ code doesn't need
+ // all of them)
+ languageOptions: {
+ ecmaVersion: 2018,
+ sourceType: 'module',
+ },
+};
diff --git a/config/flat/warnings.js b/config/flat/warnings.js
new file mode 100644
index 0000000000..e788ff9cde
--- /dev/null
+++ b/config/flat/warnings.js
@@ -0,0 +1,11 @@
+/**
+ * more opinionated config.
+ * @type {Object}
+ */
+module.exports = {
+ rules: {
+ 'import/no-named-as-default': 1,
+ 'import/no-named-as-default-member': 1,
+ 'import/no-duplicates': 1,
+ },
+};
diff --git a/config/react.js b/config/react.js
index 68555512d7..1ae8e1a51a 100644
--- a/config/react.js
+++ b/config/react.js
@@ -6,7 +6,6 @@
* if you don't enable these settings at the top level.
*/
module.exports = {
-
settings: {
'import/extensions': ['.js', '.jsx'],
},
@@ -14,5 +13,4 @@ module.exports = {
parserOptions: {
ecmaFeatures: { jsx: true },
},
-
};
diff --git a/config/typescript.js b/config/typescript.js
index ff7d0795c8..d5eb57a465 100644
--- a/config/typescript.js
+++ b/config/typescript.js
@@ -9,7 +9,7 @@
// `.ts`/`.tsx`/`.js`/`.jsx` implementation.
const typeScriptExtensions = ['.ts', '.cts', '.mts', '.tsx'];
-const allExtensions = [...typeScriptExtensions, '.js', '.jsx'];
+const allExtensions = [...typeScriptExtensions, '.js', '.jsx', '.mjs', '.cjs'];
module.exports = {
settings: {
diff --git a/examples/flat/eslint.config.mjs b/examples/flat/eslint.config.mjs
new file mode 100644
index 0000000000..370514a65b
--- /dev/null
+++ b/examples/flat/eslint.config.mjs
@@ -0,0 +1,25 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import tsParser from '@typescript-eslint/parser';
+
+export default [
+ js.configs.recommended,
+ importPlugin.flatConfigs.recommended,
+ importPlugin.flatConfigs.react,
+ importPlugin.flatConfigs.typescript,
+ {
+ files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
+ languageOptions: {
+ parser: tsParser,
+ ecmaVersion: 'latest',
+ sourceType: 'module',
+ },
+ ignores: ['eslint.config.mjs', '**/exports-unused.ts'],
+ rules: {
+ 'no-unused-vars': 'off',
+ 'import/no-dynamic-require': 'warn',
+ 'import/no-nodejs-modules': 'warn',
+ 'import/no-unused-modules': ['warn', { unusedExports: true }],
+ },
+ },
+];
diff --git a/examples/flat/package.json b/examples/flat/package.json
new file mode 100644
index 0000000000..0894d29f28
--- /dev/null
+++ b/examples/flat/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "flat",
+ "version": "1.0.0",
+ "main": "index.js",
+ "scripts": {
+ "lint": "cross-env ESLINT_USE_FLAT_CONFIG=true eslint src --report-unused-disable-directives"
+ },
+ "devDependencies": {
+ "@eslint/js": "^9.5.0",
+ "@types/node": "^20.14.5",
+ "@typescript-eslint/parser": "^7.13.1",
+ "cross-env": "^7.0.3",
+ "eslint": "^8.57.0",
+ "eslint-plugin-import": "file:../..",
+ "typescript": "^5.4.5"
+ }
+}
diff --git a/examples/flat/src/exports-unused.ts b/examples/flat/src/exports-unused.ts
new file mode 100644
index 0000000000..af8061ec2b
--- /dev/null
+++ b/examples/flat/src/exports-unused.ts
@@ -0,0 +1,12 @@
+export type ScalarType = string | number;
+export type ObjType = {
+ a: ScalarType;
+ b: ScalarType;
+};
+
+export const a = 13;
+export const b = 18;
+
+const defaultExport: ObjType = { a, b };
+
+export default defaultExport;
diff --git a/examples/flat/src/exports.ts b/examples/flat/src/exports.ts
new file mode 100644
index 0000000000..af8061ec2b
--- /dev/null
+++ b/examples/flat/src/exports.ts
@@ -0,0 +1,12 @@
+export type ScalarType = string | number;
+export type ObjType = {
+ a: ScalarType;
+ b: ScalarType;
+};
+
+export const a = 13;
+export const b = 18;
+
+const defaultExport: ObjType = { a, b };
+
+export default defaultExport;
diff --git a/examples/flat/src/imports.ts b/examples/flat/src/imports.ts
new file mode 100644
index 0000000000..643219ae42
--- /dev/null
+++ b/examples/flat/src/imports.ts
@@ -0,0 +1,7 @@
+//import c from './exports';
+import { a, b } from './exports';
+import type { ScalarType, ObjType } from './exports';
+
+import path from 'path';
+import fs from 'node:fs';
+import console from 'console';
diff --git a/examples/flat/src/jsx.tsx b/examples/flat/src/jsx.tsx
new file mode 100644
index 0000000000..970d53cb84
--- /dev/null
+++ b/examples/flat/src/jsx.tsx
@@ -0,0 +1,3 @@
+const Components = () => {
+ return <></>;
+};
diff --git a/examples/flat/tsconfig.json b/examples/flat/tsconfig.json
new file mode 100644
index 0000000000..e100bfc980
--- /dev/null
+++ b/examples/flat/tsconfig.json
@@ -0,0 +1,14 @@
+{
+ "compilerOptions": {
+ "jsx": "react-jsx",
+ "lib": ["ESNext"],
+ "target": "ESNext",
+ "module": "ESNext",
+ "rootDir": "./",
+ "moduleResolution": "Bundler",
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true,
+ "strict": true,
+ "skipLibCheck": true
+ }
+}
diff --git a/examples/legacy/.eslintrc.cjs b/examples/legacy/.eslintrc.cjs
new file mode 100644
index 0000000000..e3cec097f0
--- /dev/null
+++ b/examples/legacy/.eslintrc.cjs
@@ -0,0 +1,24 @@
+module.exports = {
+ root: true,
+ env: { es2022: true },
+ extends: [
+ 'eslint:recommended',
+ 'plugin:import/recommended',
+ 'plugin:import/react',
+ 'plugin:import/typescript',
+ ],
+ settings: {},
+ ignorePatterns: ['.eslintrc.cjs', '**/exports-unused.ts'],
+ parser: '@typescript-eslint/parser',
+ parserOptions: {
+ ecmaVersion: 'latest',
+ sourceType: 'module',
+ },
+ plugins: ['import'],
+ rules: {
+ 'no-unused-vars': 'off',
+ 'import/no-dynamic-require': 'warn',
+ 'import/no-nodejs-modules': 'warn',
+ 'import/no-unused-modules': ['warn', { unusedExports: true }],
+ },
+};
diff --git a/examples/legacy/package.json b/examples/legacy/package.json
new file mode 100644
index 0000000000..e3ca094887
--- /dev/null
+++ b/examples/legacy/package.json
@@ -0,0 +1,16 @@
+{
+ "name": "legacy",
+ "version": "1.0.0",
+ "main": "index.js",
+ "scripts": {
+ "lint": "cross-env ESLINT_USE_FLAT_CONFIG=false eslint src --ext js,jsx,ts,tsx --report-unused-disable-directives"
+ },
+ "devDependencies": {
+ "@types/node": "^20.14.5",
+ "@typescript-eslint/parser": "^7.13.1",
+ "cross-env": "^7.0.3",
+ "eslint": "^8.57.0",
+ "eslint-plugin-import": "file:../..",
+ "typescript": "^5.4.5"
+ }
+}
diff --git a/examples/legacy/src/exports-unused.ts b/examples/legacy/src/exports-unused.ts
new file mode 100644
index 0000000000..af8061ec2b
--- /dev/null
+++ b/examples/legacy/src/exports-unused.ts
@@ -0,0 +1,12 @@
+export type ScalarType = string | number;
+export type ObjType = {
+ a: ScalarType;
+ b: ScalarType;
+};
+
+export const a = 13;
+export const b = 18;
+
+const defaultExport: ObjType = { a, b };
+
+export default defaultExport;
diff --git a/examples/legacy/src/exports.ts b/examples/legacy/src/exports.ts
new file mode 100644
index 0000000000..af8061ec2b
--- /dev/null
+++ b/examples/legacy/src/exports.ts
@@ -0,0 +1,12 @@
+export type ScalarType = string | number;
+export type ObjType = {
+ a: ScalarType;
+ b: ScalarType;
+};
+
+export const a = 13;
+export const b = 18;
+
+const defaultExport: ObjType = { a, b };
+
+export default defaultExport;
diff --git a/examples/legacy/src/imports.ts b/examples/legacy/src/imports.ts
new file mode 100644
index 0000000000..643219ae42
--- /dev/null
+++ b/examples/legacy/src/imports.ts
@@ -0,0 +1,7 @@
+//import c from './exports';
+import { a, b } from './exports';
+import type { ScalarType, ObjType } from './exports';
+
+import path from 'path';
+import fs from 'node:fs';
+import console from 'console';
diff --git a/examples/legacy/src/jsx.tsx b/examples/legacy/src/jsx.tsx
new file mode 100644
index 0000000000..970d53cb84
--- /dev/null
+++ b/examples/legacy/src/jsx.tsx
@@ -0,0 +1,3 @@
+const Components = () => {
+ return <></>;
+};
diff --git a/examples/legacy/tsconfig.json b/examples/legacy/tsconfig.json
new file mode 100644
index 0000000000..e100bfc980
--- /dev/null
+++ b/examples/legacy/tsconfig.json
@@ -0,0 +1,14 @@
+{
+ "compilerOptions": {
+ "jsx": "react-jsx",
+ "lib": ["ESNext"],
+ "target": "ESNext",
+ "module": "ESNext",
+ "rootDir": "./",
+ "moduleResolution": "Bundler",
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true,
+ "strict": true,
+ "skipLibCheck": true
+ }
+}
diff --git a/package.json b/package.json
index b0ddaf8168..f9a95fabb4 100644
--- a/package.json
+++ b/package.json
@@ -31,6 +31,9 @@
"test": "npm run tests-only",
"test-compiled": "npm run prepublish && BABEL_ENV=testCompiled mocha --compilers js:babel-register tests/src",
"test-all": "node --require babel-register ./scripts/testAll",
+ "test-examples": "npm run build && npm run test-example:legacy && npm run test-example:flat",
+ "test-example:legacy": "cd examples/legacy && npm install && npm run lint",
+ "test-example:flat": "cd examples/flat && npm install && npm run lint",
"prepublishOnly": "safe-publish-latest && npm run build",
"prepublish": "not-in-publish || npm run prepublishOnly",
"preupdate:eslint-docs": "npm run build",
diff --git a/src/core/fsWalk.js b/src/core/fsWalk.js
new file mode 100644
index 0000000000..fa112590f1
--- /dev/null
+++ b/src/core/fsWalk.js
@@ -0,0 +1,48 @@
+/**
+ * This is intended to provide similar capability as the sync api from @nodelib/fs.walk, until `eslint-plugin-import`
+ * is willing to modernize and update their minimum node version to at least v16. I intentionally made the
+ * shape of the API (for the part we're using) the same as @nodelib/fs.walk so that that can be swapped in
+ * when the repo is ready for it.
+ */
+
+import path from 'path';
+import { readdirSync } from 'fs';
+
+/** @typedef {{ name: string, path: string, dirent: import('fs').Dirent }} Entry */
+
+/**
+ * Do a comprehensive walk of the provided src directory, and collect all entries. Filter out
+ * any directories or entries using the optional filter functions.
+ * @param {string} root - path to the root of the folder we're walking
+ * @param {{ deepFilter?: (entry: Entry) => boolean, entryFilter?: (entry: Entry) => boolean }} options
+ * @param {Entry} currentEntry - entry for the current directory we're working in
+ * @param {Entry[]} existingEntries - list of all entries so far
+ * @returns {Entry[]} an array of directory entries
+ */
+export function walkSync(root, options, currentEntry, existingEntries) {
+ // Extract the filter functions. Default to evaluating true, if no filter passed in.
+ const { deepFilter = () => true, entryFilter = () => true } = options;
+
+ let entryList = existingEntries || [];
+ const currentRelativePath = currentEntry ? currentEntry.path : '.';
+ const fullPath = currentEntry ? path.join(root, currentEntry.path) : root;
+
+ const dirents = readdirSync(fullPath, { withFileTypes: true });
+ dirents.forEach((dirent) => {
+ /** @type {Entry} */
+ const entry = {
+ name: dirent.name,
+ path: path.join(currentRelativePath, dirent.name),
+ dirent,
+ };
+
+ if (dirent.isDirectory() && deepFilter(entry)) {
+ entryList.push(entry);
+ entryList = walkSync(root, options, entry, entryList);
+ } else if (dirent.isFile() && entryFilter(entry)) {
+ entryList.push(entry);
+ }
+ });
+
+ return entryList;
+}
diff --git a/src/index.js b/src/index.js
index feafba9003..0ab82ebee8 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,3 +1,5 @@
+import { name, version } from '../package.json';
+
export const rules = {
'no-unresolved': require('./rules/no-unresolved'),
named: require('./rules/named'),
@@ -69,3 +71,32 @@ export const configs = {
electron: require('../config/electron'),
typescript: require('../config/typescript'),
};
+
+// Base Plugin Object
+const importPlugin = {
+ meta: { name, version },
+ rules,
+};
+
+// Create flat configs (Only ones that declare plugins and parser options need to be different from the legacy config)
+const createFlatConfig = (baseConfig, configName) => ({
+ ...baseConfig,
+ name: `import/${configName}`,
+ plugins: { import: importPlugin },
+});
+
+export const flatConfigs = {
+ recommended: createFlatConfig(
+ require('../config/flat/recommended'),
+ 'recommended',
+ ),
+
+ errors: createFlatConfig(require('../config/flat/errors'), 'errors'),
+ warnings: createFlatConfig(require('../config/flat/warnings'), 'warnings'),
+
+ // useful stuff for folks using various environments
+ react: require('../config/flat/react'),
+ 'react-native': configs['react-native'],
+ electron: configs.electron,
+ typescript: configs.typescript,
+};
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 46fc93bfe0..702f2f8899 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -7,61 +7,177 @@
import { getFileExtensions } from 'eslint-module-utils/ignore';
import resolve from 'eslint-module-utils/resolve';
import visit from 'eslint-module-utils/visit';
-import { dirname, join } from 'path';
+import { dirname, join, resolve as resolvePath } from 'path';
import readPkgUp from 'eslint-module-utils/readPkgUp';
import values from 'object.values';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
+import { walkSync } from '../core/fsWalk';
import ExportMapBuilder from '../exportMap/builder';
import recursivePatternCapture from '../exportMap/patternCapture';
import docsUrl from '../docsUrl';
-let FileEnumerator;
-let listFilesToProcess;
+/**
+ * Attempt to load the internal `FileEnumerator` class, which has existed in a couple
+ * of different places, depending on the version of `eslint`. Try requiring it from both
+ * locations.
+ * @returns Returns the `FileEnumerator` class if its requirable, otherwise `undefined`.
+ */
+function requireFileEnumerator() {
+ let FileEnumerator;
-try {
- ({ FileEnumerator } = require('eslint/use-at-your-own-risk'));
-} catch (e) {
+ // Try getting it from the eslint private / deprecated api
try {
- // has been moved to eslint/lib/cli-engine/file-enumerator in version 6
- ({ FileEnumerator } = require('eslint/lib/cli-engine/file-enumerator'));
+ ({ FileEnumerator } = require('eslint/use-at-your-own-risk'));
} catch (e) {
+ // Absorb this if it's MODULE_NOT_FOUND
+ if (e.code !== 'MODULE_NOT_FOUND') {
+ throw e;
+ }
+
+ // If not there, then try getting it from eslint/lib/cli-engine/file-enumerator (moved there in v6)
try {
- // eslint/lib/util/glob-util has been moved to eslint/lib/util/glob-utils with version 5.3
- const { listFilesToProcess: originalListFilesToProcess } = require('eslint/lib/util/glob-utils');
-
- // Prevent passing invalid options (extensions array) to old versions of the function.
- // https://github.com/eslint/eslint/blob/v5.16.0/lib/util/glob-utils.js#L178-L280
- // https://github.com/eslint/eslint/blob/v5.2.0/lib/util/glob-util.js#L174-L269
- listFilesToProcess = function (src, extensions) {
- return originalListFilesToProcess(src, {
- extensions,
- });
- };
+ ({ FileEnumerator } = require('eslint/lib/cli-engine/file-enumerator'));
} catch (e) {
- const { listFilesToProcess: originalListFilesToProcess } = require('eslint/lib/util/glob-util');
+ // Absorb this if it's MODULE_NOT_FOUND
+ if (e.code !== 'MODULE_NOT_FOUND') {
+ throw e;
+ }
+ }
+ }
+ return FileEnumerator;
+}
+
+/**
+ *
+ * @param FileEnumerator the `FileEnumerator` class from `eslint`'s internal api
+ * @param {string} src path to the src root
+ * @param {string[]} extensions list of supported extensions
+ * @returns {{ filename: string, ignored: boolean }[]} list of files to operate on
+ */
+function listFilesUsingFileEnumerator(FileEnumerator, src, extensions) {
+ const e = new FileEnumerator({
+ extensions,
+ });
+
+ return Array.from(
+ e.iterateFiles(src),
+ ({ filePath, ignored }) => ({ filename: filePath, ignored }),
+ );
+}
- listFilesToProcess = function (src, extensions) {
- const patterns = src.concat(flatMap(src, (pattern) => extensions.map((extension) => (/\*\*|\*\./).test(pattern) ? pattern : `${pattern}/**/*${extension}`)));
+/**
+ * Attempt to require old versions of the file enumeration capability from v6 `eslint` and earlier, and use
+ * those functions to provide the list of files to operate on
+ * @param {string} src path to the src root
+ * @param {string[]} extensions list of supported extensions
+ * @returns {string[]} list of files to operate on
+ */
+function listFilesWithLegacyFunctions(src, extensions) {
+ try {
+ // eslint/lib/util/glob-util has been moved to eslint/lib/util/glob-utils with version 5.3
+ const { listFilesToProcess: originalListFilesToProcess } = require('eslint/lib/util/glob-utils');
+ // Prevent passing invalid options (extensions array) to old versions of the function.
+ // https://github.com/eslint/eslint/blob/v5.16.0/lib/util/glob-utils.js#L178-L280
+ // https://github.com/eslint/eslint/blob/v5.2.0/lib/util/glob-util.js#L174-L269
- return originalListFilesToProcess(patterns);
- };
+ return originalListFilesToProcess(src, {
+ extensions,
+ });
+ } catch (e) {
+ // Absorb this if it's MODULE_NOT_FOUND
+ if (e.code !== 'MODULE_NOT_FOUND') {
+ throw e;
}
+
+ // Last place to try (pre v5.3)
+ const {
+ listFilesToProcess: originalListFilesToProcess,
+ } = require('eslint/lib/util/glob-util');
+ const patterns = src.concat(
+ flatMap(
+ src,
+ (pattern) => extensions.map((extension) => (/\*\*|\*\./).test(pattern) ? pattern : `${pattern}/**/*${extension}`),
+ ),
+ );
+
+ return originalListFilesToProcess(patterns);
}
}
-if (FileEnumerator) {
- listFilesToProcess = function (src, extensions) {
- const e = new FileEnumerator({
- extensions,
+/**
+ * Given a source root and list of supported extensions, use fsWalk and the
+ * new `eslint` `context.session` api to build the list of files we want to operate on
+ * @param {string[]} srcPaths array of source paths (for flat config this should just be a singular root (e.g. cwd))
+ * @param {string[]} extensions list of supported extensions
+ * @param {{ isDirectoryIgnored: (path: string) => boolean, isFileIgnored: (path: string) => boolean }} session eslint context session object
+ * @returns {string[]} list of files to operate on
+ */
+function listFilesWithModernApi(srcPaths, extensions, session) {
+ /** @type {string[]} */
+ const files = [];
+
+ for (let i = 0; i < srcPaths.length; i++) {
+ const src = srcPaths[i];
+ // Use walkSync along with the new session api to gather the list of files
+ const entries = walkSync(src, {
+ deepFilter(entry) {
+ const fullEntryPath = resolvePath(src, entry.path);
+
+ // Include the directory if it's not marked as ignore by eslint
+ return !session.isDirectoryIgnored(fullEntryPath);
+ },
+ entryFilter(entry) {
+ const fullEntryPath = resolvePath(src, entry.path);
+
+ // Include the file if it's not marked as ignore by eslint and its extension is included in our list
+ return (
+ !session.isFileIgnored(fullEntryPath)
+ && extensions.find((extension) => entry.path.endsWith(extension))
+ );
+ },
});
- return Array.from(e.iterateFiles(src), ({ filePath, ignored }) => ({
- ignored,
- filename: filePath,
- }));
- };
+ // Filter out directories and map entries to their paths
+ files.push(
+ ...entries
+ .filter((entry) => !entry.dirent.isDirectory())
+ .map((entry) => entry.path),
+ );
+ }
+ return files;
+}
+
+/**
+ * Given a src pattern and list of supported extensions, return a list of files to process
+ * with this rule.
+ * @param {string} src - file, directory, or glob pattern of files to act on
+ * @param {string[]} extensions - list of supported file extensions
+ * @param {import('eslint').Rule.RuleContext} context - the eslint context object
+ * @returns {string[] | { filename: string, ignored: boolean }[]} the list of files that this rule will evaluate.
+ */
+function listFilesToProcess(src, extensions, context) {
+ // If the context object has the new session functions, then prefer those
+ // Otherwise, fallback to using the deprecated `FileEnumerator` for legacy support.
+ // https://github.com/eslint/eslint/issues/18087
+ if (
+ context.session
+ && context.session.isFileIgnored
+ && context.session.isDirectoryIgnored
+ ) {
+ return listFilesWithModernApi(src, extensions, context.session);
+ }
+
+ // Fallback to og FileEnumerator
+ const FileEnumerator = requireFileEnumerator();
+
+ // If we got the FileEnumerator, then let's go with that
+ if (FileEnumerator) {
+ return listFilesUsingFileEnumerator(FileEnumerator, src, extensions);
+ }
+ // If not, then we can try even older versions of this capability (listFilesToProcess)
+ return listFilesWithLegacyFunctions(src, extensions);
}
const EXPORT_DEFAULT_DECLARATION = 'ExportDefaultDeclaration';
@@ -163,6 +279,7 @@ const exportList = new Map();
const visitorKeyMap = new Map();
+/** @type {Set<string>} */
const ignoredFiles = new Set();
const filesOutsideSrc = new Set();
@@ -172,22 +289,30 @@ const isNodeModule = (path) => (/\/(node_modules)\//).test(path);
* read all files matching the patterns in src and ignoreExports
*
* return all files matching src pattern, which are not matching the ignoreExports pattern
+ * @type {(src: string, ignoreExports: string, context: import('eslint').Rule.RuleContext) => Set<string>}
*/
-const resolveFiles = (src, ignoreExports, context) => {
+function resolveFiles(src, ignoreExports, context) {
const extensions = Array.from(getFileExtensions(context.settings));
- const srcFileList = listFilesToProcess(src, extensions);
+ const srcFileList = listFilesToProcess(src, extensions, context);
// prepare list of ignored files
- const ignoredFilesList = listFilesToProcess(ignoreExports, extensions);
- ignoredFilesList.forEach(({ filename }) => ignoredFiles.add(filename));
+ const ignoredFilesList = listFilesToProcess(ignoreExports, extensions, context);
+
+ // The modern api will return a list of file paths, rather than an object
+ if (ignoredFilesList.length && typeof ignoredFilesList[0] === 'string') {
+ ignoredFilesList.forEach((filename) => ignoredFiles.add(filename));
+ } else {
+ ignoredFilesList.forEach(({ filename }) => ignoredFiles.add(filename));
+ }
// prepare list of source files, don't consider files from node_modules
+ const resolvedFiles = srcFileList.length && typeof srcFileList[0] === 'string'
+ ? srcFileList.filter((filePath) => !isNodeModule(filePath))
+ : flatMap(srcFileList, ({ filename }) => isNodeModule(filename) ? [] : filename);
- return new Set(
- flatMap(srcFileList, ({ filename }) => isNodeModule(filename) ? [] : filename),
- );
-};
+ return new Set(resolvedFiles);
+}
/**
* parse all source files and build up 2 maps containing the existing imports and exports
@@ -226,7 +351,7 @@ const prepareImportsAndExports = (srcFiles, context) => {
} else {
exports.set(key, { whereUsed: new Set() });
}
- const reexport = value.getImport();
+ const reexport = value.getImport();
if (!reexport) {
return;
}
@@ -329,6 +454,7 @@ const getSrc = (src) => {
* prepare the lists of existing imports and exports - should only be executed once at
* the start of a new eslint run
*/
+/** @type {Set<string>} */
let srcFiles;
let lastPrepareKey;
const doPreparation = (src, ignoreExports, context) => {
diff --git a/utils/ignore.js b/utils/ignore.js
index 56f2ef7239..a42d4ceb1f 100644
--- a/utils/ignore.js
+++ b/utils/ignore.js
@@ -14,7 +14,7 @@ const log = require('debug')('eslint-plugin-import:utils:ignore');
function makeValidExtensionSet(settings) {
// start with explicit JS-parsed extensions
/** @type {Set<import('./types').Extension>} */
- const exts = new Set(settings['import/extensions'] || ['.js']);
+ const exts = new Set(settings['import/extensions'] || ['.js', '.mjs', '.cjs']);
// all alternate parser extensions are also valid
if ('import/parsers' in settings) {
@@ -52,9 +52,13 @@ exports.hasValidExtension = hasValidExtension;
/** @type {import('./ignore').default} */
exports.default = function ignore(path, context) {
// check extension whitelist first (cheap)
- if (!hasValidExtension(path, context)) { return true; }
+ if (!hasValidExtension(path, context)) {
+ return true;
+ }
- if (!('import/ignore' in context.settings)) { return false; }
+ if (!('import/ignore' in context.settings)) {
+ return false;
+ }
const ignoreStrings = context.settings['import/ignore'];
for (let i = 0; i < ignoreStrings.length; i++) {
From ee1ea025a6843fe4380927832a31761f1f4ae339 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E1=84=80=E1=85=B5=E1=86=B7=E1=84=89=E1=85=A1=E1=86=BC?=
=?UTF-8?q?=E1=84=83=E1=85=AE?= <puki4416@gmail.com>
Date: Sat, 13 Jan 2024 01:42:54 +0900
Subject: [PATCH 125/199] [Fix] `newline-after-import`: fix considerComments
option when require
---
CHANGELOG.md | 3 ++
src/rules/newline-after-import.js | 20 +++++++++----
tests/src/rules/newline-after-import.js | 38 +++++++++++++++++++++----
3 files changed, 50 insertions(+), 11 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 05d623f410..2d0ff1a912 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-extraneous-dependencies`]: allow wrong path ([#3012], thanks [@chabb])
- [`no-cycle`]: use scc algorithm to optimize ([#2998], thanks [@soryy708])
- [`no-duplicates`]: Removing duplicates breaks in TypeScript ([#3033], thanks [@yesl-kim])
+- [`newline-after-import`]: fix considerComments option when require ([#2952], thanks [@developer-bandi])
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1136,6 +1137,7 @@ for info on changes for earlier releases.
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
[#2985]: https://github.com/import-js/eslint-plugin-import/pull/2985
[#2982]: https://github.com/import-js/eslint-plugin-import/pull/2982
+[#2952]: https://github.com/import-js/eslint-plugin-import/pull/2952
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
@@ -1742,6 +1744,7 @@ for info on changes for earlier releases.
[@bicstone]: https://github.com/bicstone
[@Blasz]: https://github.com/Blasz
[@bmish]: https://github.com/bmish
+[@developer-bandi]: https://github.com/developer-bandi
[@borisyankov]: https://github.com/borisyankov
[@bradennapier]: https://github.com/bradennapier
[@bradzacher]: https://github.com/bradzacher
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index a33bb615b9..d10b87d78c 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -124,7 +124,7 @@ module.exports = {
}
}
- function commentAfterImport(node, nextComment) {
+ function commentAfterImport(node, nextComment, type) {
const lineDifference = getLineDifference(node, nextComment);
const EXPECTED_LINE_DIFFERENCE = options.count + 1;
@@ -140,7 +140,7 @@ module.exports = {
line: node.loc.end.line,
column,
},
- message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after import statement not followed by another import.`,
+ message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} after ${type} statement not followed by another ${type}.`,
fix: options.exactCount && EXPECTED_LINE_DIFFERENCE < lineDifference ? undefined : (fixer) => fixer.insertTextAfter(
node,
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference),
@@ -178,7 +178,7 @@ module.exports = {
}
if (nextComment && typeof nextComment !== 'undefined') {
- commentAfterImport(node, nextComment);
+ commentAfterImport(node, nextComment, 'import');
} else if (nextNode && nextNode.type !== 'ImportDeclaration' && (nextNode.type !== 'TSImportEqualsDeclaration' || nextNode.isExport)) {
checkForNewLine(node, nextNode, 'import');
}
@@ -215,8 +215,18 @@ module.exports = {
|| !containsNodeOrEqual(nextStatement, nextRequireCall)
)
) {
-
- checkForNewLine(statementWithRequireCall, nextStatement, 'require');
+ let nextComment;
+ if (typeof statementWithRequireCall.parent.comments !== 'undefined' && options.considerComments) {
+ const endLine = node.loc.end.line;
+ nextComment = statementWithRequireCall.parent.comments.find((o) => o.loc.start.line >= endLine && o.loc.start.line <= endLine + options.count + 1);
+ }
+
+ if (nextComment && typeof nextComment !== 'undefined') {
+
+ commentAfterImport(statementWithRequireCall, nextComment, 'require');
+ } else {
+ checkForNewLine(statementWithRequireCall, nextStatement, 'require');
+ }
}
});
},
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index 6a8fb83e40..b78e891a35 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -8,6 +8,7 @@ import { getTSParsers, parsers, testVersion } from '../utils';
const IMPORT_ERROR_MESSAGE = 'Expected 1 empty line after import statement not followed by another import.';
const IMPORT_ERROR_MESSAGE_MULTIPLE = (count) => `Expected ${count} empty lines after import statement not followed by another import.`;
const REQUIRE_ERROR_MESSAGE = 'Expected 1 empty line after require statement not followed by another require.';
+const REQUIRE_ERROR_MESSAGE_MULTIPLE = (count) => `Expected ${count} empty lines after require statement not followed by another require.`;
const ruleTester = new RuleTester();
@@ -202,7 +203,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
options: [{ count: 4, exactCount: true }],
},
{
- code: `var foo = require('foo-module');\n\n\n\n// Some random comment\nvar foo = 'bar';`,
+ code: `var foo = require('foo-module');\n\n\n\n\n// Some random comment\nvar foo = 'bar';`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ count: 4, exactCount: true, considerComments: true }],
},
@@ -394,6 +395,19 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
`,
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
+ {
+ code: `var foo = require('foo-module');\n\n\n// Some random comment\nvar foo = 'bar';`,
+ options: [{ count: 2, considerComments: true }],
+ },
+ {
+ code: `var foo = require('foo-module');\n\n\n/**\n * Test comment\n */\nvar foo = 'bar';`,
+ options: [{ count: 2, considerComments: true }],
+ },
+ {
+ code: `const foo = require('foo');\n\n\n// some random comment\nconst bar = function() {};`,
+ options: [{ count: 2, exactCount: true, considerComments: true }],
+ parserOptions: { ecmaVersion: 2015 },
+ },
),
invalid: [].concat(
@@ -825,7 +839,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
errors: [{
line: 1,
column: 1,
- message: 'Expected 2 empty lines after require statement not followed by another require.',
+ message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015 },
},
@@ -836,7 +850,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
errors: [{
line: 1,
column: 1,
- message: 'Expected 2 empty lines after require statement not followed by another require.',
+ message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015 },
},
@@ -852,14 +866,26 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
parserOptions: { ecmaVersion: 2015, considerComments: true, sourceType: 'module' },
},
{
- code: `const foo = require('foo');\n\n\n// some random comment\nconst bar = function() {};`,
- options: [{ count: 2, exactCount: true, considerComments: true }],
+ code: `var foo = require('foo-module');\nvar foo = require('foo-module');\n\n// Some random comment\nvar foo = 'bar';`,
+ output: `var foo = require('foo-module');\nvar foo = require('foo-module');\n\n\n// Some random comment\nvar foo = 'bar';`,
+ errors: [{
+ line: 2,
+ column: 1,
+ message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
+ }],
+ parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+ options: [{ considerComments: true, count: 2 }],
+ },
+ {
+ code: `var foo = require('foo-module');\n\n/**\n * Test comment\n */\nvar foo = 'bar';`,
+ output: `var foo = require('foo-module');\n\n\n/**\n * Test comment\n */\nvar foo = 'bar';`,
errors: [{
line: 1,
column: 1,
- message: 'Expected 2 empty lines after require statement not followed by another require.',
+ message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015 },
+ options: [{ considerComments: true, count: 2 }],
},
),
});
From 32a2b8986961639cc9c19ebac1f1f0640fb78ef5 Mon Sep 17 00:00:00 2001
From: Mihkel Eidast <mihkel_eidast@trimble.com>
Date: Tue, 26 Sep 2023 14:13:04 +0300
Subject: [PATCH 126/199] [Fix] `order`: do not compare first path segment for
relative paths (#2682)
---
CHANGELOG.md | 4 ++++
src/rules/order.js | 6 ++++++
tests/src/rules/order.js | 28 ++++++++++++++++++++++++++++
3 files changed, 38 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2d0ff1a912..92431a1563 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-cycle`]: use scc algorithm to optimize ([#2998], thanks [@soryy708])
- [`no-duplicates`]: Removing duplicates breaks in TypeScript ([#3033], thanks [@yesl-kim])
- [`newline-after-import`]: fix considerComments option when require ([#2952], thanks [@developer-bandi])
+- [`order`]: do not compare first path segment for relative paths ([#2682]) ([#2885], thanks [@mihkeleidast])
### Changed
- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
@@ -1141,6 +1142,7 @@ for info on changes for earlier releases.
[#2944]: https://github.com/import-js/eslint-plugin-import/pull/2944
[#2942]: https://github.com/import-js/eslint-plugin-import/pull/2942
[#2919]: https://github.com/import-js/eslint-plugin-import/pull/2919
+[#2885]: https://github.com/import-js/eslint-plugin-import/pull/2885
[#2884]: https://github.com/import-js/eslint-plugin-import/pull/2884
[#2866]: https://github.com/import-js/eslint-plugin-import/pull/2866
[#2854]: https://github.com/import-js/eslint-plugin-import/pull/2854
@@ -1486,6 +1488,7 @@ for info on changes for earlier releases.
[#2930]: https://github.com/import-js/eslint-plugin-import/issues/2930
[#2687]: https://github.com/import-js/eslint-plugin-import/issues/2687
[#2684]: https://github.com/import-js/eslint-plugin-import/issues/2684
+[#2682]: https://github.com/import-js/eslint-plugin-import/issues/2682
[#2674]: https://github.com/import-js/eslint-plugin-import/issues/2674
[#2668]: https://github.com/import-js/eslint-plugin-import/issues/2668
[#2666]: https://github.com/import-js/eslint-plugin-import/issues/2666
@@ -1880,6 +1883,7 @@ for info on changes for earlier releases.
[@mgwalker]: https://github.com/mgwalker
[@mhmadhamster]: https://github.com/MhMadHamster
[@michaelfaith]: https://github.com/michaelfaith
+[@mihkeleidast]: https://github.com/mihkeleidast
[@MikeyBeLike]: https://github.com/MikeyBeLike
[@minervabot]: https://github.com/minervabot
[@mpint]: https://github.com/mpint
diff --git a/src/rules/order.js b/src/rules/order.js
index 7071513bf3..1b25273c65 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -302,6 +302,12 @@ function getSorter(alphabetizeOptions) {
const b = B.length;
for (let i = 0; i < Math.min(a, b); i++) {
+ // Skip comparing the first path segment, if they are relative segments for both imports
+ if (i === 0 && ((A[i] === '.' || A[i] === '..') && (B[i] === '.' || B[i] === '..'))) {
+ // If one is sibling and the other parent import, no need to compare at all, since the paths belong in different groups
+ if (A[i] !== B[i]) { break; }
+ continue;
+ }
result = compareString(A[i], B[i]);
if (result) { break; }
}
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index a6a8735a6f..c2d659f839 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -169,6 +169,34 @@ ruleTester.run('order', rule, {
['sibling', 'parent', 'external'],
] }],
}),
+ // Grouping import types and alphabetize
+ test({
+ code: `
+ import async from 'async';
+ import fs from 'fs';
+ import path from 'path';
+
+ import index from '.';
+ import relParent3 from '../';
+ import relParent1 from '../foo';
+ import sibling from './foo';
+ `,
+ options: [{ groups: [
+ ['builtin', 'external'],
+ ], alphabetize: { order: 'asc', caseInsensitive: true } }],
+ }),
+ test({
+ code: `
+ import { fooz } from '../baz.js'
+ import { foo } from './bar.js'
+ `,
+ options: [{
+ alphabetize: { order: 'asc', caseInsensitive: true },
+ groups: ['builtin', 'external', 'internal', ['parent', 'sibling', 'index'], 'object'],
+ 'newlines-between': 'always',
+ warnOnUnassignedImports: true,
+ }],
+ }),
// Omitted types should implicitly be considered as the last type
test({
code: `
From 038c26cade3c85c823ba2eafd52bb91ae458f2b2 Mon Sep 17 00:00:00 2001
From: jwbth <33615628+jwbth@users.noreply.github.com>
Date: Thu, 28 Mar 2024 22:38:13 +0400
Subject: [PATCH 127/199] [readme] Clarify how to install the plugin
The markup was misleading, as it put several alternatives into one block of code while not making it clear where the alternatives begin and end, forcing the reader to think hard about it.
Also converted most yaml examples to jsonc.
Co-authored-by: jwbth <33615628+jwbth@users.noreply.github.com>
Co-authored-by: Jordan Harband <ljharb@gmail.com>
---
CHANGELOG.md | 3 +
README.md | 176 ++++++++++++++++++++++++++++++++-------------------
2 files changed, 115 insertions(+), 64 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 92431a1563..9022dc887b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -30,6 +30,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Refactor] `exportMapBuilder`: avoid hoisting ([#2989], thanks [@soryy708])
- [Refactor] `ExportMap`: extract "builder" logic to separate files ([#2991], thanks [@soryy708])
- [Docs] [`order`]: update the description of the `pathGroupsExcludedImportTypes` option ([#3036], thanks [@liby])
+- [readme] Clarify how to install the plugin ([#2993], thanks [@jwbth])
## [2.29.1] - 2023-12-14
@@ -1133,6 +1134,7 @@ for info on changes for earlier releases.
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
[#2998]: https://github.com/import-js/eslint-plugin-import/pull/2998
+[#2993]: https://github.com/import-js/eslint-plugin-import/pull/2993
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
[#2987]: https://github.com/import-js/eslint-plugin-import/pull/2987
@@ -1835,6 +1837,7 @@ for info on changes for earlier releases.
[@jseminck]: https://github.com/jseminck
[@julien1619]: https://github.com/julien1619
[@justinanastos]: https://github.com/justinanastos
+[@jwbth]: https://github.com/jwbth
[@k15a]: https://github.com/k15a
[@kentcdodds]: https://github.com/kentcdodds
[@kevin940726]: https://github.com/kevin940726
diff --git a/README.md b/README.md
index bf563f4d7b..8cc723423f 100644
--- a/README.md
+++ b/README.md
@@ -108,35 +108,37 @@ npm install eslint-plugin-import --save-dev
### Config - Legacy (`.eslintrc`)
-All rules are off by default. However, you may configure them manually
-in your `.eslintrc.(yml|json|js)`, or extend one of the canned configs:
+All rules are off by default. However, you may extend one of the preset configs, or configure them manually in your `.eslintrc.(yml|json|js)`.
-```yaml
----
-extends:
- - eslint:recommended
- - plugin:import/recommended
- # alternatively, 'recommended' is the combination of these two rule sets:
- - plugin:import/errors
- - plugin:import/warnings
-
-# or configure manually:
-plugins:
- - import
-
-rules:
- import/no-unresolved: [2, { commonjs: true, amd: true }]
- import/named: 2
- import/namespace: 2
- import/default: 2
- import/export: 2
- # etc...
+ - Extending a preset config:
+
+```jsonc
+{
+ "extends": [
+ "eslint:recommended",
+ "plugin:import/recommended",
+ ],
+}
+```
+
+ - Configuring manually:
+
+```jsonc
+{
+ "rules": {
+ "import/no-unresolved": ["error", { "commonjs": true, "amd": true }]
+ "import/named": "error",
+ "import/namespace": "error",
+ "import/default": "error",
+ "import/export": "error",
+ // etc...
+ },
+},
```
### Config - Flat (`eslint.config.js`)
-All rules are off by default. However, you may configure them manually
-in your `eslint.config.(js|cjs|mjs)`, or extend one of the canned configs:
+All rules are off by default. However, you may configure them manually in your `eslint.config.(js|cjs|mjs)`, or extend one of the preset configs:
```js
import importPlugin from 'eslint-plugin-import';
@@ -166,18 +168,23 @@ You may use the following snippet or assemble your own config using the granular
Make sure you have installed [`@typescript-eslint/parser`] and [`eslint-import-resolver-typescript`] which are used in the following configuration.
-```yaml
-extends:
- - eslint:recommended
- - plugin:import/recommended
-# the following lines do the trick
- - plugin:import/typescript
-settings:
- import/resolver:
- # You will also need to install and configure the TypeScript resolver
- # See also https://github.com/import-js/eslint-import-resolver-typescript#configuration
- typescript: true
- node: true
+```jsonc
+{
+ "extends": [
+ "eslint:recommended",
+ "plugin:import/recommended",
+// the following lines do the trick
+ "plugin:import/typescript",
+ ],
+ "settings": {
+ "import/resolver": {
+ // You will also need to install and configure the TypeScript resolver
+ // See also https://github.com/import-js/eslint-import-resolver-typescript#configuration
+ "typescript": true,
+ "node": true,
+ },
+ },
+}
```
[`@typescript-eslint/parser`]: https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser
@@ -206,6 +213,16 @@ You can reference resolvers in several ways (in order of precedence):
- as a conventional `eslint-import-resolver` name, like `eslint-import-resolver-foo`:
+ ```jsonc
+// .eslintrc
+{
+ "settings": {
+ // uses 'eslint-import-resolver-foo':
+ "import/resolver": "foo",
+ },
+}
+```
+
```yaml
# .eslintrc.yml
settings:
@@ -226,6 +243,15 @@ module.exports = {
- with a full npm module name, like `my-awesome-npm-module`:
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/resolver": "my-awesome-npm-module",
+ },
+}
+```
+
```yaml
# .eslintrc.yml
settings:
@@ -321,11 +347,15 @@ In practice, this means rules other than [`no-unresolved`](./docs/rules/no-unres
`no-unresolved` has its own [`ignore`](./docs/rules/no-unresolved.md#ignore) setting.
-```yaml
-settings:
- import/ignore:
- - \.coffee$ # fraught with parse errors
- - \.(scss|less|css)$ # can't parse unprocessed CSS modules, either
+```jsonc
+{
+ "settings": {
+ "import/ignore": [
+ "\.coffee$", // fraught with parse errors
+ "\.(scss|less|css)$", // can't parse unprocessed CSS modules, either
+ ],
+ },
+}
```
### `import/core-modules`
@@ -344,10 +374,13 @@ import 'electron' // without extra config, will be flagged as unresolved!
that would otherwise be unresolved. To avoid this, you may provide `electron` as a
core module:
-```yaml
-# .eslintrc.yml
-settings:
- import/core-modules: [ electron ]
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/core-modules": ["electron"],
+ },
+}
```
In Electron's specific case, there is a shared config named `electron`
@@ -380,11 +413,15 @@ dependency parser will require and use the map key as the parser instead of the
configured ESLint parser. This is useful if you're inter-op-ing with TypeScript
directly using webpack, for example:
-```yaml
-# .eslintrc.yml
-settings:
- import/parsers:
- "@typescript-eslint/parser": [ .ts, .tsx ]
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/parsers": {
+ "@typescript-eslint/parser": [".ts", ".tsx"],
+ },
+ },
+}
```
In this case, [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
@@ -414,20 +451,28 @@ For long-lasting processes, like [`eslint_d`] or [`eslint-loader`], however, it'
If you never use [`eslint_d`] or [`eslint-loader`], you may set the cache lifetime to `Infinity` and everything should be fine:
-```yaml
-# .eslintrc.yml
-settings:
- import/cache:
- lifetime: ∞ # or Infinity
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/cache": {
+ "lifetime": "∞", // or Infinity, in a JS config
+ },
+ },
+}
```
Otherwise, set some integer, and cache entries will be evicted after that many seconds have elapsed:
-```yaml
-# .eslintrc.yml
-settings:
- import/cache:
- lifetime: 5 # 30 is the default
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/cache": {
+ "lifetime": 5, // 30 is the default
+ },
+ },
+}
```
[`eslint_d`]: https://www.npmjs.com/package/eslint_d
@@ -441,10 +486,13 @@ By default, any package referenced from [`import/external-module-folders`](#impo
For example, if your packages in a monorepo are all in `@scope`, you can configure `import/internal-regex` like this
-```yaml
-# .eslintrc.yml
-settings:
- import/internal-regex: ^@scope/
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/internal-regex": "^@scope/",
+ },
+}
```
## SublimeLinter-eslint
From 8bdb32bc8be5364f4adeb781b2321ea62c9ab46e Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Tue, 3 Sep 2024 08:27:44 +1200
Subject: [PATCH 128/199] [Test] add explicit marker for trailing whitespace in
cases
---
tests/src/rules/dynamic-import-chunkname.js | 4 ++--
tests/src/rules/no-duplicates.js | 10 +++++-----
tests/src/rules/no-import-module-exports.js | 6 +++---
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index 6afd834ab0..81e018af76 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -1001,7 +1001,7 @@ ruleTester.run('dynamic-import-chunkname', rule, {
{
desc: 'Remove webpackChunkName',
output: `import(
-
+ ${''}
/* webpackMode: "eager" */
'someModule'
)`,
@@ -1010,7 +1010,7 @@ ruleTester.run('dynamic-import-chunkname', rule, {
desc: 'Remove webpackMode',
output: `import(
/* webpackChunkName: "someModule" */
-
+ ${''}
'someModule'
)`,
},
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index e682f22354..c46f9df85d 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -455,28 +455,28 @@ import {x,y} from './foo'
import {
BULK_ACTIONS_ENABLED
} from '../constants';
-
+ ${''}
const TestComponent = () => {
return <div>
</div>;
}
-
+ ${''}
export default TestComponent;
`,
output: `
import {
DEFAULT_FILTER_KEYS,
BULK_DISABLED,
-
+ ${''}
BULK_ACTIONS_ENABLED
} from '../constants';
import React from 'react';
-
+ ${''}
const TestComponent = () => {
return <div>
</div>;
}
-
+ ${''}
export default TestComponent;
`,
errors: ["'../constants' imported multiple times.", "'../constants' imported multiple times."],
diff --git a/tests/src/rules/no-import-module-exports.js b/tests/src/rules/no-import-module-exports.js
index c2bf7ed132..aa927857e0 100644
--- a/tests/src/rules/no-import-module-exports.js
+++ b/tests/src/rules/no-import-module-exports.js
@@ -74,13 +74,13 @@ ruleTester.run('no-import-module-exports', rule, {
import fs from 'fs/promises';
const subscriptions = new Map();
-
+ ${''}
export default async (client) => {
/**
* loads all modules and their subscriptions
*/
const modules = await fs.readdir('./src/modules');
-
+ ${''}
await Promise.all(
modules.map(async (moduleName) => {
// Loads the module
@@ -97,7 +97,7 @@ ruleTester.run('no-import-module-exports', rule, {
}
})
);
-
+ ${''}
/**
* Setting up all events.
* binds all events inside the subscriptions map to call all functions provided
From a3015ebd1bb6251990aee79e292d7116e9f191ff Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Tue, 3 Sep 2024 13:19:35 +1200
Subject: [PATCH 129/199] [Test] `namespace`: ensure valid case is actually
included
---
tests/src/rules/namespace.js | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/tests/src/rules/namespace.js b/tests/src/rules/namespace.js
index 1475ae9b7d..3f768a5717 100644
--- a/tests/src/rules/namespace.js
+++ b/tests/src/rules/namespace.js
@@ -336,10 +336,10 @@ const invalid = [].concat(
test({ parser, code: `import { b } from "./${folder}/a"; console.log(b.c.d.e)` }),
test({ parser, code: `import * as a from "./${folder}/a"; console.log(a.b.c.d.e.f)` }),
test({ parser, code: `import * as a from "./${folder}/a"; var {b:{c:{d:{e}}}} = a` }),
- test({ parser, code: `import { b } from "./${folder}/a"; var {c:{d:{e}}} = b` }));
-
- // deep namespaces should include explicitly exported defaults
- test({ parser, code: `import * as a from "./${folder}/a"; console.log(a.b.default)` }),
+ test({ parser, code: `import { b } from "./${folder}/a"; var {c:{d:{e}}} = b` }),
+ // deep namespaces should include explicitly exported defaults
+ test({ parser, code: `import * as a from "./${folder}/a"; console.log(a.b.default)` }),
+ );
invalid.push(
test({
@@ -371,7 +371,8 @@ const invalid = [].concat(
parser,
code: `import * as a from "./${folder}/a"; var {b:{c:{ e }}} = a`,
errors: ["'e' not found in deeply imported namespace 'a.b.c'."],
- }));
+ }),
+ );
});
ruleTester.run('namespace', rule, { valid, invalid });
From 0a58d7572c8267203182043608d56ead1c50f4ce Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 2 Sep 2024 23:05:07 -0700
Subject: [PATCH 130/199] [resolvers/webpack] v0.13.9
---
resolvers/webpack/CHANGELOG.md | 3 +++
resolvers/webpack/package.json | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index cd49cc3f4e..79b2837e3d 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -5,7 +5,10 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## 0.13.9 - 2024-09-02
- [refactor] simplify loop ([#3029], thanks [@fregante])
+- [meta] add `repository.directory` field
+- [refactor] avoid hoisting, misc cleanup
## 0.13.8 - 2023-10-22
- [refactor] use `hasown` instead of `has`
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 38465bcdee..60e5c900f0 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.8",
+ "version": "0.13.9",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 9d194a6e4690cc8afed68cb7736a81dd3a919135 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 2 Sep 2024 23:07:55 -0700
Subject: [PATCH 131/199] [utils] v2.9.0
---
utils/CHANGELOG.md | 7 +++++++
utils/package.json | 2 +-
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 43bd0e022b..27102bc73a 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,11 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.9.0 - 2024-09-02
+
+### New
+- add support for Flat Config ([#3018], thanks [@michaelfaith])
+
## v2.8.2 - 2024-08-25
### Fixed
@@ -151,6 +156,7 @@ Yanked due to critical issue with cache key resulting from #839.
- `unambiguous.test()` regex is now properly in multiline mode
[#3039]: https://github.com/import-js/eslint-plugin-import/pull/3039
+[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
[#2963]: https://github.com/import-js/eslint-plugin-import/pull/2963
[#2755]: https://github.com/import-js/eslint-plugin-import/pull/2755
[#2714]: https://github.com/import-js/eslint-plugin-import/pull/2714
@@ -197,6 +203,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@manuth]: https://github.com/manuth
[@maxkomarychev]: https://github.com/maxkomarychev
[@mgwalker]: https://github.com/mgwalker
+[@michaelfaith]: https://github.com/michaelfaith
[@Mysak0CZ]: https://github.com/Mysak0CZ
[@nicolo-ribaudo]: https://github.com/nicolo-ribaudo
[@pmcelhaney]: https://github.com/pmcelhaney
diff --git a/utils/package.json b/utils/package.json
index 6d69e2414a..fe3541ada3 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.8.2",
+ "version": "2.9.0",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From 990229879c6790d64f3673ac59b0c9a9736f79fe Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 2 Sep 2024 23:09:11 -0700
Subject: [PATCH 132/199] [Deps] update `eslint-module-utils`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index f9a95fabb4..72c4a8259a 100644
--- a/package.json
+++ b/package.json
@@ -117,7 +117,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.8.2",
+ "eslint-module-utils": "^2.9.0",
"hasown": "^2.0.2",
"is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
From 18787d3e6966028983af81a878d1a505893932d4 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 2 Sep 2024 23:09:39 -0700
Subject: [PATCH 133/199] Bump to 2.30.0
---
CHANGELOG.md | 5 ++++-
package.json | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9022dc887b..cf97fff94d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.30.0] - 2024-09-02
+
### Added
- [`dynamic-import-chunkname`]: add `allowEmpty` option to allow empty leading comments ([#2942], thanks [@JiangWeixian])
- [`dynamic-import-chunkname`]: Allow empty chunk name when webpackMode: 'eager' is set; add suggestions to remove name in eager mode ([#3004], thanks [@amsardesai])
@@ -1615,7 +1617,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.1...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.30.0...HEAD
+[2.30.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.1...v2.30.0
[2.29.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.0...v2.29.1
[2.29.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...v2.29.0
[2.28.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.0...v2.28.1
diff --git a/package.json b/package.json
index 72c4a8259a..be150064d6 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.29.1",
+ "version": "2.30.0",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 186f248357437ef46889f3eab7fda8e6030ba874 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Thu, 5 Sep 2024 06:29:19 -0500
Subject: [PATCH 134/199] [Fix] `ExportMap` / flat config: include
`languageOptions` in context
This change fixes a bug with flat config support.
There is a function called `childContext` that's used by the ExportBuilder to "cleanse" the context object.
This function wasn't including the new `languageOptions` object, which contains the parser.
So by the time this cleansed context made it to the parse function, `languageOptions` wasn't there anymore.
Since `parserPath` was still being included in non-flat config scenarios, the parse function made it through ok and used `parserPath`.
However, once you shift to flat config, `parserPath` is no longer defined, and the actual parser object needs to be there.
Fixes #3051
---
CHANGELOG.md | 4 +++
src/exportMap/childContext.js | 3 +-
tests/src/exportMap/childContext.js | 51 +++++++++++++++++++++++++++++
3 files changed, 57 insertions(+), 1 deletion(-)
create mode 100644 tests/src/exportMap/childContext.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cf97fff94d..4efcdb5bc0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Fixed
+- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
+
## [2.30.0] - 2024-09-02
### Added
@@ -1129,6 +1132,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
diff --git a/src/exportMap/childContext.js b/src/exportMap/childContext.js
index 5f82b8e575..3534c59138 100644
--- a/src/exportMap/childContext.js
+++ b/src/exportMap/childContext.js
@@ -10,7 +10,7 @@ let prevSettings = '';
* also calculate a cacheKey, where parts of the cacheKey hash are memoized
*/
export default function childContext(path, context) {
- const { settings, parserOptions, parserPath } = context;
+ const { settings, parserOptions, parserPath, languageOptions } = context;
if (JSON.stringify(settings) !== prevSettings) {
settingsHash = hashObject({ settings }).digest('hex');
@@ -28,5 +28,6 @@ export default function childContext(path, context) {
parserOptions,
parserPath,
path,
+ languageOptions,
};
}
diff --git a/tests/src/exportMap/childContext.js b/tests/src/exportMap/childContext.js
new file mode 100644
index 0000000000..06fa04afec
--- /dev/null
+++ b/tests/src/exportMap/childContext.js
@@ -0,0 +1,51 @@
+import { expect } from 'chai';
+
+import childContext from '../../../src/exportMap/childContext';
+
+describe('childContext', () => {
+ const settings = {
+ setting1: true,
+ setting2: false,
+ };
+ const parserOptions = {
+ ecmaVersion: 'latest',
+ sourceType: 'module',
+ };
+ const parserPath = 'path/to/parser';
+ const path = 'path/to/src/file';
+ const languageOptions = {
+ ecmaVersion: 2024,
+ sourceType: 'module',
+ parser: {},
+ };
+
+ // https://github.com/import-js/eslint-plugin-import/issues/3051
+ it('should pass context properties through, if present', () => {
+ const mockContext = {
+ settings,
+ parserOptions,
+ parserPath,
+ languageOptions,
+ };
+
+ const result = childContext(path, mockContext);
+
+ expect(result.settings).to.deep.equal(settings);
+ expect(result.parserOptions).to.deep.equal(parserOptions);
+ expect(result.parserPath).to.equal(parserPath);
+ expect(result.languageOptions).to.deep.equal(languageOptions);
+ });
+
+ it('should add path and cacheKey to context', () => {
+ const mockContext = {
+ settings,
+ parserOptions,
+ parserPath,
+ };
+
+ const result = childContext(path, mockContext);
+
+ expect(result.path).to.equal(path);
+ expect(result.cacheKey).to.be.a('string');
+ });
+});
From 6012bd7f3eddb84aed4be9c3a95b3827f6ef9540 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 5 Sep 2024 11:18:52 -0700
Subject: [PATCH 135/199] [meta] fix links in old changelog entries
---
CHANGELOG.md | 19 ++++++-------------
1 file changed, 6 insertions(+), 13 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4efcdb5bc0..88fd1dbc27 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -65,7 +65,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-duplicates`]: remove duplicate identifiers in duplicate imports ([#2577], thanks [@joe-matsec])
- [`consistent-type-specifier-style`]: fix accidental removal of comma in certain cases ([#2754], thanks [@bradzacher])
- [Perf] `ExportMap`: Improve `ExportMap.for` performance on larger codebases ([#2756], thanks [@leipert])
-- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#1820], thanks [@andyogo])
+- [`no-extraneous-dependencies`]/TypeScript: do not error when importing inline type from dev dependencies ([#2735], thanks [@andyogo])
- [`newline-after-import`]/TypeScript: do not error when re-exporting a namespaced import ([#2832], thanks [@laurens-dg])
- [`order`]: partial fix for [#2687] (thanks [@ljharb])
- [`no-duplicates`]: Detect across type and regular imports ([#2835], thanks [@benkrejci])
@@ -321,7 +321,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-webpack-loader-syntax`]/TypeScript: avoid crash on missing name ([#1947], thanks [@leonardodino])
- [`no-extraneous-dependencies`]: Add package.json cache ([#1948], thanks [@fa93hws])
- [`prefer-default-export`]: handle empty array destructuring ([#1965], thanks [@ljharb])
-- [`no-unused-modules`]: make type imports mark a module as used (fixes #1924) ([#1974], thanks [@cherryblossom000])
+- [`no-unused-modules`]: make type imports mark a module as used (fixes [#1924]) ([#1974], thanks [@cherryblossom000])
- [`no-cycle`]: fix perf regression ([#1944], thanks [@Blasz])
- [`first`]: fix handling of `import = require` ([#1963], thanks [@MatthiasKunnen])
- [`no-cycle`]/[`extensions`]: fix isExternalModule usage ([#1696], thanks [@paztis])
@@ -349,7 +349,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`dynamic-import-chunkname`]: allow single quotes to match Webpack support ([#1848], thanks [@straub])
### Changed
-- [`export`]: add tests for a name collision with `export * from` ([#1704], thanks @tomprats)
+- [`export`]: add tests for a name collision with `export * from` ([#1704], thanks [@tomprats])
## [2.22.0] - 2020-06-26
@@ -1473,10 +1473,7 @@ for info on changes for earlier releases.
[#297]: https://github.com/import-js/eslint-plugin-import/pull/297
[#296]: https://github.com/import-js/eslint-plugin-import/pull/296
[#290]: https://github.com/import-js/eslint-plugin-import/pull/290
-[#289]: https://github.com/import-js/eslint-plugin-import/pull/289
[#288]: https://github.com/import-js/eslint-plugin-import/pull/288
-[#287]: https://github.com/import-js/eslint-plugin-import/pull/287
-[#278]: https://github.com/import-js/eslint-plugin-import/pull/278
[#261]: https://github.com/import-js/eslint-plugin-import/pull/261
[#256]: https://github.com/import-js/eslint-plugin-import/pull/256
[#254]: https://github.com/import-js/eslint-plugin-import/pull/254
@@ -1488,7 +1485,6 @@ for info on changes for earlier releases.
[#239]: https://github.com/import-js/eslint-plugin-import/pull/239
[#228]: https://github.com/import-js/eslint-plugin-import/pull/228
[#211]: https://github.com/import-js/eslint-plugin-import/pull/211
-[#164]: https://github.com/import-js/eslint-plugin-import/pull/164
[#157]: https://github.com/import-js/eslint-plugin-import/pull/157
[ljharb#37]: https://github.com/ljharb/eslint-plugin-import/pull/37
@@ -1601,7 +1597,6 @@ for info on changes for earlier releases.
[#313]: https://github.com/import-js/eslint-plugin-import/issues/313
[#311]: https://github.com/import-js/eslint-plugin-import/issues/311
[#306]: https://github.com/import-js/eslint-plugin-import/issues/306
-[#286]: https://github.com/import-js/eslint-plugin-import/issues/286
[#283]: https://github.com/import-js/eslint-plugin-import/issues/283
[#281]: https://github.com/import-js/eslint-plugin-import/issues/281
[#275]: https://github.com/import-js/eslint-plugin-import/issues/275
@@ -1651,10 +1646,9 @@ for info on changes for earlier releases.
[2.22.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.21.1...v2.22.0
[2.21.2]: https://github.com/import-js/eslint-plugin-import/compare/v2.21.1...v2.21.2
[2.21.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.21.0...v2.21.1
-[2.21.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.20.2...v2.21.0
-[2.20.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.20.1...v2.20.2
-[2.20.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.20.0...v2.20.1
-[2.19.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.19.1...v2.20.0
+[2.21.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.20.1...v2.21.0
+[2.20.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.20.0...v2.20.1
+[2.20.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.19.1...v2.20.0
[2.19.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.19.0...v2.19.1
[2.19.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.18.2...v2.19.0
[2.18.2]: https://github.com/import-js/eslint-plugin-import/compare/v2.18.1...v2.18.2
@@ -1966,7 +1960,6 @@ for info on changes for earlier releases.
[@sveyret]: https://github.com/sveyret
[@swernerx]: https://github.com/swernerx
[@syymza]: https://github.com/syymza
-[@taion]: https://github.com/taion
[@TakeScoop]: https://github.com/TakeScoop
[@tapayne88]: https://github.com/tapayne88
[@Taranys]: https://github.com/Taranys
From 1079e70f36a73c65ea0e69d079654656bf5cc4ba Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Wed, 4 Sep 2024 04:03:47 -0500
Subject: [PATCH 136/199] [utils] [new] add context compatibility helpers
This change adds helper functions to `eslint-module-utils` in order to add eslint v9 support to `eslint-plugin-import` in a backwards compatible way.
Contributes to #2996
---
utils/CHANGELOG.md | 4 +++
utils/contextCompat.d.ts | 38 +++++++++++++++++++++
utils/contextCompat.js | 72 ++++++++++++++++++++++++++++++++++++++++
utils/package.json | 1 +
utils/resolve.js | 3 +-
5 files changed, 117 insertions(+), 1 deletion(-)
create mode 100644 utils/contextCompat.d.ts
create mode 100644 utils/contextCompat.js
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 27102bc73a..df6b727ad4 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### New
+- add context compatibility helpers ([#3049], thanks [@michaelfaith])
+
## v2.9.0 - 2024-09-02
### New
@@ -155,6 +158,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3049]: https://github.com/import-js/eslint-plugin-import/pull/3049
[#3039]: https://github.com/import-js/eslint-plugin-import/pull/3039
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
[#2963]: https://github.com/import-js/eslint-plugin-import/pull/2963
diff --git a/utils/contextCompat.d.ts b/utils/contextCompat.d.ts
new file mode 100644
index 0000000000..43fe0a91b8
--- /dev/null
+++ b/utils/contextCompat.d.ts
@@ -0,0 +1,38 @@
+import { Scope, SourceCode, Rule } from 'eslint';
+import * as ESTree from 'estree';
+
+type LegacyContext = {
+ getFilename: () => string,
+ getPhysicalFilename: () => string,
+ getSourceCode: () => SourceCode,
+ getScope: never,
+ getAncestors: never,
+ getDeclaredVariables: never,
+};
+
+type NewContext = {
+ filename: string,
+ sourceCode: SourceCode,
+ getPhysicalFilename?: () => string,
+ getScope: () => Scope.Scope,
+ getAncestors: () => ESTree.Node[],
+ getDeclaredVariables: (node: ESTree.Node) => Scope.Variable[],
+};
+
+export type Context = LegacyContext | NewContext | Rule.RuleContext;
+
+declare function getAncestors(context: Context, node: ESTree.Node): ESTree.Node[];
+declare function getDeclaredVariables(context: Context, node: ESTree.Node): Scope.Variable[];
+declare function getFilename(context: Context): string;
+declare function getPhysicalFilename(context: Context): string;
+declare function getScope(context: Context, node: ESTree.Node): Scope.Scope;
+declare function getSourceCode(context: Context): SourceCode;
+
+export {
+ getAncestors,
+ getDeclaredVariables,
+ getFilename,
+ getPhysicalFilename,
+ getScope,
+ getSourceCode,
+};
diff --git a/utils/contextCompat.js b/utils/contextCompat.js
new file mode 100644
index 0000000000..b1bdc598ef
--- /dev/null
+++ b/utils/contextCompat.js
@@ -0,0 +1,72 @@
+'use strict';
+
+exports.__esModule = true;
+
+/** @type {import('./contextCompat').getAncestors} */
+function getAncestors(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getAncestors) {
+ return sourceCode.getAncestors(node);
+ }
+
+ return context.getAncestors();
+}
+
+/** @type {import('./contextCompat').getDeclaredVariables} */
+function getDeclaredVariables(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getDeclaredVariables) {
+ return sourceCode.getDeclaredVariables(node);
+ }
+
+ return context.getDeclaredVariables(node);
+}
+
+/** @type {import('./contextCompat').getFilename} */
+function getFilename(context) {
+ if ('filename' in context) {
+ return context.filename;
+ }
+
+ return context.getFilename();
+}
+
+/** @type {import('./contextCompat').getPhysicalFilename} */
+function getPhysicalFilename(context) {
+ if (context.getPhysicalFilename) {
+ return context.getPhysicalFilename();
+ }
+
+ return getFilename(context);
+}
+
+/** @type {import('./contextCompat').getScope} */
+function getScope(context, node) {
+ const sourceCode = getSourceCode(context);
+
+ if (sourceCode && sourceCode.getScope) {
+ return sourceCode.getScope(node);
+ }
+
+ return context.getScope();
+}
+
+/** @type {import('./contextCompat').getSourceCode} */
+function getSourceCode(context) {
+ if ('sourceCode' in context) {
+ return context.sourceCode;
+ }
+
+ return context.getSourceCode();
+}
+
+module.exports = {
+ getAncestors,
+ getDeclaredVariables,
+ getFilename,
+ getPhysicalFilename,
+ getScope,
+ getSourceCode,
+};
diff --git a/utils/package.json b/utils/package.json
index fe3541ada3..d5968f7e9d 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -7,6 +7,7 @@
},
"main": false,
"exports": {
+ "./contextCompat": "./contextCompat.js",
"./ModuleCache": "./ModuleCache.js",
"./ModuleCache.js": "./ModuleCache.js",
"./declaredScope": "./declaredScope.js",
diff --git a/utils/resolve.js b/utils/resolve.js
index 5a3084351e..b332d2ec2c 100644
--- a/utils/resolve.js
+++ b/utils/resolve.js
@@ -5,6 +5,7 @@ exports.__esModule = true;
const fs = require('fs');
const Module = require('module');
const path = require('path');
+const { getPhysicalFilename } = require('./contextCompat');
const hashObject = require('./hash').hashObject;
const ModuleCache = require('./ModuleCache').default;
@@ -229,7 +230,7 @@ const erroredContexts = new Set();
*/
function resolve(p, context) {
try {
- return relative(p, context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(), context.settings);
+ return relative(p, getPhysicalFilename(context), context.settings);
} catch (err) {
if (!erroredContexts.has(context)) {
// The `err.stack` string starts with `err.name` followed by colon and `err.message`.
From 756fe8e3c8d776ba0f395665e122e28c3b90fbf6 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 5 Sep 2024 15:52:35 -0700
Subject: [PATCH 137/199] [utils] v2.10.0
---
utils/CHANGELOG.md | 2 ++
utils/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index df6b727ad4..089219e7d6 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.10.0 - 2024-09-05
+
### New
- add context compatibility helpers ([#3049], thanks [@michaelfaith])
diff --git a/utils/package.json b/utils/package.json
index d5968f7e9d..f7afde88f9 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.9.0",
+ "version": "2.10.0",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From a7b43480ca3802b8be104717c81dbd57c766cf93 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 5 Sep 2024 14:19:37 -0700
Subject: [PATCH 138/199] [Refactor] use `contextCompat` helpers
---
package.json | 2 +-
src/core/packagePath.js | 3 ++-
src/rules/consistent-type-specifier-style.js | 4 +++-
src/rules/dynamic-import-chunkname.js | 4 +++-
src/rules/first.js | 6 ++++--
src/rules/named.js | 6 ++++--
src/rules/newline-after-import.js | 4 +++-
src/rules/no-absolute-path.js | 5 +++--
src/rules/no-amd.js | 4 +++-
src/rules/no-commonjs.js | 6 ++++--
src/rules/no-cycle.js | 6 ++++--
src/rules/no-default-export.js | 6 ++++--
src/rules/no-duplicates.js | 3 ++-
src/rules/no-empty-named-blocks.js | 4 +++-
src/rules/no-extraneous-dependencies.js | 8 ++++---
src/rules/no-import-module-exports.js | 7 ++++---
src/rules/no-mutable-exports.js | 6 ++++--
src/rules/no-namespace.js | 6 ++++--
src/rules/no-relative-packages.js | 3 ++-
src/rules/no-relative-parent-imports.js | 7 ++++---
src/rules/no-restricted-paths.js | 7 ++++---
src/rules/no-self-import.js | 4 +++-
src/rules/no-unassigned-import.js | 3 ++-
src/rules/no-unused-modules.js | 3 ++-
src/rules/no-useless-path-segments.js | 3 ++-
src/rules/order.js | 22 +++++++++++++-------
26 files changed, 93 insertions(+), 49 deletions(-)
diff --git a/package.json b/package.json
index be150064d6..90b9df4da8 100644
--- a/package.json
+++ b/package.json
@@ -117,7 +117,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.9.0",
+ "eslint-module-utils": "^2.10.0",
"hasown": "^2.0.2",
"is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
diff --git a/src/core/packagePath.js b/src/core/packagePath.js
index 142f44aa4d..f45f543260 100644
--- a/src/core/packagePath.js
+++ b/src/core/packagePath.js
@@ -1,4 +1,5 @@
import { dirname } from 'path';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import pkgUp from 'eslint-module-utils/pkgUp';
import readPkgUp from 'eslint-module-utils/readPkgUp';
@@ -8,7 +9,7 @@ export function getFilePackagePath(filePath) {
}
export function getContextPackagePath(context) {
- return getFilePackagePath(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
+ return getFilePackagePath(getPhysicalFilename(context));
}
export function getFilePackageName(filePath) {
diff --git a/src/rules/consistent-type-specifier-style.js b/src/rules/consistent-type-specifier-style.js
index 9119976b19..ee5ff9fbc6 100644
--- a/src/rules/consistent-type-specifier-style.js
+++ b/src/rules/consistent-type-specifier-style.js
@@ -1,3 +1,5 @@
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
function isComma(token) {
@@ -55,7 +57,7 @@ module.exports = {
},
create(context) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
if (context.options[0] === 'prefer-inline') {
return {
diff --git a/src/rules/dynamic-import-chunkname.js b/src/rules/dynamic-import-chunkname.js
index a72b04d123..12a7650082 100644
--- a/src/rules/dynamic-import-chunkname.js
+++ b/src/rules/dynamic-import-chunkname.js
@@ -1,4 +1,6 @@
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
import vm from 'vm';
+
import docsUrl from '../docsUrl';
module.exports = {
@@ -43,7 +45,7 @@ module.exports = {
const eagerModeRegex = new RegExp(eagerModeFormat);
function run(node, arg) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const leadingComments = sourceCode.getCommentsBefore
? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
: sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.
diff --git a/src/rules/first.js b/src/rules/first.js
index f8cc273a31..e7df26ac92 100644
--- a/src/rules/first.js
+++ b/src/rules/first.js
@@ -1,3 +1,5 @@
+import { getDeclaredVariables, getSourceCode } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
function getImportValue(node) {
@@ -38,7 +40,7 @@ module.exports = {
}
const absoluteFirst = context.options[0] === 'absolute-first';
const message = 'Import in body of module; reorder to top.';
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const originSourceCode = sourceCode.getText();
let nonImportCount = 0;
let anyExpressions = false;
@@ -66,7 +68,7 @@ module.exports = {
}
}
if (nonImportCount > 0) {
- for (const variable of context.getDeclaredVariables(node)) {
+ for (const variable of getDeclaredVariables(context, node)) {
if (!shouldSort) { break; }
const references = variable.references;
if (references.length) {
diff --git a/src/rules/named.js b/src/rules/named.js
index ed7e5e018b..ab5f3103f2 100644
--- a/src/rules/named.js
+++ b/src/rules/named.js
@@ -1,4 +1,6 @@
import * as path from 'path';
+import { getFilename, getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+
import ExportMapBuilder from '../exportMap/builder';
import docsUrl from '../docsUrl';
@@ -67,7 +69,7 @@ module.exports = {
if (!deepLookup.found) {
if (deepLookup.path.length > 1) {
const deepPath = deepLookup.path
- .map((i) => path.relative(path.dirname(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename()), i.path))
+ .map((i) => path.relative(path.dirname(getPhysicalFilename(context)), i.path))
.join(' -> ');
context.report(im[key], `${name} not found via ${deepPath}`);
@@ -121,7 +123,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(getFilename(context)), i.path))
.join(' -> ');
context.report(im.key, `${im.key.name} not found via ${deepPath}`);
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index d10b87d78c..bf550bad95 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -3,6 +3,8 @@
* @author Radek Benkel
*/
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+
import isStaticRequire from '../core/staticRequire';
import docsUrl from '../docsUrl';
@@ -193,7 +195,7 @@ module.exports = {
}
},
'Program:exit'() {
- log('exit processing for', context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
+ log('exit processing for', getPhysicalFilename(context));
const scopeBody = getScopeBody(context.getScope());
log('got scope:', scopeBody);
diff --git a/src/rules/no-absolute-path.js b/src/rules/no-absolute-path.js
index 04f67383f2..0dbd8cb86c 100644
--- a/src/rules/no-absolute-path.js
+++ b/src/rules/no-absolute-path.js
@@ -1,5 +1,7 @@
import path from 'path';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
+
import { isAbsolute } from '../core/importType';
import docsUrl from '../docsUrl';
@@ -22,9 +24,8 @@ module.exports = {
node: source,
message: 'Do not import modules using an absolute path',
fix(fixer) {
- const resolvedContext = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
// node.js and web imports work with posix style paths ("/")
- let relativePath = path.posix.relative(path.dirname(resolvedContext), source.value);
+ let relativePath = path.posix.relative(path.dirname(getPhysicalFilename(context)), source.value);
if (!relativePath.startsWith('.')) {
relativePath = `./${relativePath}`;
}
diff --git a/src/rules/no-amd.js b/src/rules/no-amd.js
index 5edfe3e698..05ed0a5210 100644
--- a/src/rules/no-amd.js
+++ b/src/rules/no-amd.js
@@ -3,6 +3,8 @@
* @author Jamund Ferguson
*/
+import { getScope } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
//------------------------------------------------------------------------------
@@ -23,7 +25,7 @@ module.exports = {
create(context) {
return {
CallExpression(node) {
- if (context.getScope().type !== 'module') { return; }
+ if (getScope(context, node).type !== 'module') { return; }
if (node.callee.type !== 'Identifier') { return; }
if (node.callee.name !== 'require' && node.callee.name !== 'define') { return; }
diff --git a/src/rules/no-commonjs.js b/src/rules/no-commonjs.js
index dde509222b..33b77da597 100644
--- a/src/rules/no-commonjs.js
+++ b/src/rules/no-commonjs.js
@@ -3,6 +3,8 @@
* @author Jamund Ferguson
*/
+import { getScope } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
const EXPORT_MESSAGE = 'Expected "export" or "export default"';
@@ -107,7 +109,7 @@ module.exports = {
// exports.
if (node.object.name === 'exports') {
- const isInScope = context.getScope()
+ const isInScope = getScope(context, node)
.variables
.some((variable) => variable.name === 'exports');
if (!isInScope) {
@@ -117,7 +119,7 @@ module.exports = {
},
CallExpression(call) {
- if (!validateScope(context.getScope())) { return; }
+ if (!validateScope(getScope(context, call))) { return; }
if (call.callee.type !== 'Identifier') { return; }
if (call.callee.name !== 'require') { return; }
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index be8c288dd4..d7c748d807 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -3,11 +3,13 @@
* @author Ben Mosher
*/
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import resolve from 'eslint-module-utils/resolve';
+
import ExportMapBuilder from '../exportMap/builder';
import StronglyConnectedComponentsBuilder from '../scc';
import { isExternalModule } from '../core/importType';
-import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import docsUrl from '../docsUrl';
const traversed = new Set();
@@ -57,7 +59,7 @@ module.exports = {
},
create(context) {
- const myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const myPath = getPhysicalFilename(context);
if (myPath === '<text>') { return {}; } // can't cycle-check a non-file
const options = context.options[0] || {};
diff --git a/src/rules/no-default-export.js b/src/rules/no-default-export.js
index dabbae543a..fcb4f1b2fd 100644
--- a/src/rules/no-default-export.js
+++ b/src/rules/no-default-export.js
@@ -1,3 +1,5 @@
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
module.exports = {
@@ -22,7 +24,7 @@ module.exports = {
return {
ExportDefaultDeclaration(node) {
- const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
+ const { loc } = getSourceCode(context).getFirstTokens(node)[1] || {};
context.report({ node, message: preferNamed, loc });
},
@@ -30,7 +32,7 @@ module.exports = {
node.specifiers
.filter((specifier) => (specifier.exported.name || specifier.exported.value) === 'default')
.forEach((specifier) => {
- const { loc } = context.getSourceCode().getFirstTokens(node)[1] || {};
+ const { loc } = getSourceCode(context).getFirstTokens(node)[1] || {};
if (specifier.type === 'ExportDefaultSpecifier') {
context.report({ node, message: preferNamed, loc });
} else if (specifier.type === 'ExportSpecifier') {
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index d9fb1a1309..32557802fa 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -1,3 +1,4 @@
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
import resolve from 'eslint-module-utils/resolve';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
@@ -260,7 +261,7 @@ function checkImports(imported, context) {
if (nodes.length > 1) {
const message = `'${module}' imported multiple times.`;
const [first, ...rest] = nodes;
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const fix = getFix(first, rest, sourceCode, context);
context.report({
diff --git a/src/rules/no-empty-named-blocks.js b/src/rules/no-empty-named-blocks.js
index 3ec1501b8f..d68ecee38b 100644
--- a/src/rules/no-empty-named-blocks.js
+++ b/src/rules/no-empty-named-blocks.js
@@ -1,3 +1,5 @@
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
function getEmptyBlockRange(tokens, index) {
@@ -72,7 +74,7 @@ module.exports = {
fix(fixer) {
// Remove the empty block and the 'from' token, leaving the import only for its side
// effects, e.g. `import 'mod'`
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const fromToken = program.tokens.find((t) => t.value === 'from');
const importToken = program.tokens.find((t) => t.value === 'import');
const hasSpaceAfterFrom = sourceCode.isSpaceBetween(fromToken, sourceCode.getTokenAfter(fromToken));
diff --git a/src/rules/no-extraneous-dependencies.js b/src/rules/no-extraneous-dependencies.js
index 0fe42f56f8..bf0a1ed477 100644
--- a/src/rules/no-extraneous-dependencies.js
+++ b/src/rules/no-extraneous-dependencies.js
@@ -1,9 +1,11 @@
import path from 'path';
import fs from 'fs';
-import pkgUp from 'eslint-module-utils/pkgUp';
import minimatch from 'minimatch';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+import pkgUp from 'eslint-module-utils/pkgUp';
import resolve from 'eslint-module-utils/resolve';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
+
import importType from '../core/importType';
import { getFilePackageName } from '../core/packagePath';
import docsUrl from '../docsUrl';
@@ -84,7 +86,7 @@ function getDependencies(context, packageDir) {
});
} else {
const packageJsonPath = pkgUp({
- cwd: context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(),
+ cwd: getPhysicalFilename(context),
normalize: false,
});
@@ -283,7 +285,7 @@ module.exports = {
create(context) {
const options = context.options[0] || {};
- const filename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const filename = getPhysicalFilename(context);
const deps = getDependencies(context, options.packageDir) || extractDepFields({});
const depsOptions = {
diff --git a/src/rules/no-import-module-exports.js b/src/rules/no-import-module-exports.js
index bc4605c39d..bf6fba61bd 100644
--- a/src/rules/no-import-module-exports.js
+++ b/src/rules/no-import-module-exports.js
@@ -1,9 +1,10 @@
import minimatch from 'minimatch';
import path from 'path';
+import { getPhysicalFilename, getSourceCode } from 'eslint-module-utils/contextCompat';
import pkgUp from 'eslint-module-utils/pkgUp';
function getEntryPoint(context) {
- const pkgPath = pkgUp({ cwd: context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename() });
+ const pkgPath = pkgUp({ cwd: getPhysicalFilename(context) });
try {
return require.resolve(path.dirname(pkgPath));
} catch (error) {
@@ -14,7 +15,7 @@ function getEntryPoint(context) {
}
function findScope(context, identifier) {
- const { scopeManager } = context.getSourceCode();
+ const { scopeManager } = getSourceCode(context);
return scopeManager && scopeManager.scopes.slice().reverse().find((scope) => scope.variables.some((variable) => variable.identifiers.some((node) => node.name === identifier)));
}
@@ -50,7 +51,7 @@ module.exports = {
let alreadyReported = false;
function report(node) {
- const fileName = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const fileName = getPhysicalFilename(context);
const isEntryPoint = entryPoint === fileName;
const isIdentifier = node.object.type === 'Identifier';
const hasKeywords = (/^(module|exports)$/).test(node.object.name);
diff --git a/src/rules/no-mutable-exports.js b/src/rules/no-mutable-exports.js
index 433d64e167..c3d18b2c99 100644
--- a/src/rules/no-mutable-exports.js
+++ b/src/rules/no-mutable-exports.js
@@ -1,3 +1,5 @@
+import { getScope } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
module.exports = {
@@ -32,7 +34,7 @@ module.exports = {
}
function handleExportDefault(node) {
- const scope = context.getScope();
+ const scope = getScope(context, node);
if (node.declaration.name) {
checkDeclarationsInScope(scope, node.declaration.name);
@@ -40,7 +42,7 @@ module.exports = {
}
function handleExportNamed(node) {
- const scope = context.getScope();
+ const scope = getScope(context, node);
if (node.declaration) {
checkDeclaration(node.declaration);
diff --git a/src/rules/no-namespace.js b/src/rules/no-namespace.js
index 3c6617a41c..7ab60bd215 100644
--- a/src/rules/no-namespace.js
+++ b/src/rules/no-namespace.js
@@ -4,6 +4,8 @@
*/
import minimatch from 'minimatch';
+import { getScope, getSourceCode } from 'eslint-module-utils/contextCompat';
+
import docsUrl from '../docsUrl';
/**
@@ -108,7 +110,7 @@ module.exports = {
return;
}
- const scopeVariables = context.getScope().variables;
+ const scopeVariables = getScope(context, node).variables;
const namespaceVariable = scopeVariables.find((variable) => variable.defs[0].node === node);
const namespaceReferences = namespaceVariable.references;
const namespaceIdentifiers = namespaceReferences.map((reference) => reference.identifier);
@@ -118,7 +120,7 @@ module.exports = {
node,
message: `Unexpected namespace import.`,
fix: canFix && ((fixer) => {
- const scopeManager = context.getSourceCode().scopeManager;
+ const { scopeManager } = getSourceCode(context);
const fixes = [];
// Pass 1: Collect variable names that are already in scope for each reference we want
diff --git a/src/rules/no-relative-packages.js b/src/rules/no-relative-packages.js
index 1d215519fd..ebc280ff9b 100644
--- a/src/rules/no-relative-packages.js
+++ b/src/rules/no-relative-packages.js
@@ -1,6 +1,7 @@
import path from 'path';
import readPkgUp from 'eslint-module-utils/readPkgUp';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import resolve from 'eslint-module-utils/resolve';
import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import importType from '../core/importType';
@@ -26,7 +27,7 @@ function checkImportForRelativePackage(context, importPath, node) {
}
const resolvedImport = resolve(importPath, context);
- const resolvedContext = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const resolvedContext = getPhysicalFilename(context);
if (!resolvedImport || !resolvedContext) {
return;
diff --git a/src/rules/no-relative-parent-imports.js b/src/rules/no-relative-parent-imports.js
index decd2ef7d2..94972d3ddf 100644
--- a/src/rules/no-relative-parent-imports.js
+++ b/src/rules/no-relative-parent-imports.js
@@ -1,9 +1,10 @@
-import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
-import docsUrl from '../docsUrl';
import { basename, dirname, relative } from 'path';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor';
import resolve from 'eslint-module-utils/resolve';
import importType from '../core/importType';
+import docsUrl from '../docsUrl';
module.exports = {
meta: {
@@ -17,7 +18,7 @@ module.exports = {
},
create: function noRelativePackages(context) {
- const myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const myPath = getPhysicalFilename(context);
if (myPath === '<text>') { return {}; } // can't check a non-file
function checkSourceValue(sourceNode) {
diff --git a/src/rules/no-restricted-paths.js b/src/rules/no-restricted-paths.js
index 75952dd058..2e1bc608c6 100644
--- a/src/rules/no-restricted-paths.js
+++ b/src/rules/no-restricted-paths.js
@@ -1,11 +1,12 @@
import path from 'path';
-
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import resolve from 'eslint-module-utils/resolve';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
import isGlob from 'is-glob';
import { Minimatch } from 'minimatch';
-import docsUrl from '../docsUrl';
+
import importType from '../core/importType';
+import docsUrl from '../docsUrl';
const containsPath = (filepath, target) => {
const relative = path.relative(target, filepath);
@@ -85,7 +86,7 @@ module.exports = {
const options = context.options[0] || {};
const restrictedPaths = options.zones || [];
const basePath = options.basePath || process.cwd();
- const currentFilename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const currentFilename = getPhysicalFilename(context);
const matchingZones = restrictedPaths.filter(
(zone) => [].concat(zone.target)
.map((target) => path.resolve(basePath, target))
diff --git a/src/rules/no-self-import.js b/src/rules/no-self-import.js
index 0ba0f66694..99c5342709 100644
--- a/src/rules/no-self-import.js
+++ b/src/rules/no-self-import.js
@@ -3,12 +3,14 @@
* @author Gio d'Amelio
*/
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import resolve from 'eslint-module-utils/resolve';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
+
import docsUrl from '../docsUrl';
function isImportingSelf(context, node, requireName) {
- const filePath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const filePath = getPhysicalFilename(context);
// If the input is from stdin, this test can't fail
if (filePath !== '<text>' && filePath === resolve(requireName, context)) {
diff --git a/src/rules/no-unassigned-import.js b/src/rules/no-unassigned-import.js
index 0af9f2e9f3..fec232afef 100644
--- a/src/rules/no-unassigned-import.js
+++ b/src/rules/no-unassigned-import.js
@@ -1,5 +1,6 @@
import path from 'path';
import minimatch from 'minimatch';
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import isStaticRequire from '../core/staticRequire';
import docsUrl from '../docsUrl';
@@ -31,7 +32,7 @@ function testIsAllow(globs, filename, source) {
function create(context) {
const options = context.options[0] || {};
- const filename = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const filename = getPhysicalFilename(context);
const isAllow = (source) => testIsAllow(options.allow, filename, source);
return {
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 702f2f8899..358726299d 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -4,6 +4,7 @@
* @author René Fermann
*/
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import { getFileExtensions } from 'eslint-module-utils/ignore';
import resolve from 'eslint-module-utils/resolve';
import visit from 'eslint-module-utils/visit';
@@ -609,7 +610,7 @@ module.exports = {
doPreparation(src, ignoreExports, context);
}
- const file = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+ const file = getPhysicalFilename(context);
const checkExportPresence = (node) => {
if (!missingExports) {
diff --git a/src/rules/no-useless-path-segments.js b/src/rules/no-useless-path-segments.js
index 390a7546d3..2d8dd35269 100644
--- a/src/rules/no-useless-path-segments.js
+++ b/src/rules/no-useless-path-segments.js
@@ -3,6 +3,7 @@
* @author Thomas Grainger
*/
+import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import { getFileExtensions } from 'eslint-module-utils/ignore';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
import resolve from 'eslint-module-utils/resolve';
@@ -60,7 +61,7 @@ module.exports = {
},
create(context) {
- const currentDir = path.dirname(context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
+ const currentDir = path.dirname(getPhysicalFilename(context));
const options = context.options[0];
function checkSourceValue(source) {
diff --git a/src/rules/order.js b/src/rules/order.js
index 1b25273c65..23821830ff 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -3,6 +3,7 @@
import minimatch from 'minimatch';
import includes from 'array-includes';
import groupBy from 'object.groupby';
+import { getSourceCode } from 'eslint-module-utils/contextCompat';
import importType from '../core/importType';
import isStaticRequire from '../core/staticRequire';
@@ -199,7 +200,7 @@ function makeImportDescription(node) {
}
function fixOutOfOrder(context, firstNode, secondNode, order) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const firstRoot = findRootNode(firstNode.node);
const firstRootStart = findStartOfLineWithComments(sourceCode, firstRoot);
@@ -499,7 +500,10 @@ function convertPathGroupsForRanks(pathGroups) {
function fixNewLineAfterImport(context, previousImport) {
const prevRoot = findRootNode(previousImport.node);
const tokensToEndOfLine = takeTokensAfterWhile(
- context.getSourceCode(), prevRoot, commentOnSameLineAs(prevRoot));
+ getSourceCode(context),
+ prevRoot,
+ commentOnSameLineAs(prevRoot),
+ );
let endOfLine = prevRoot.range[1];
if (tokensToEndOfLine.length > 0) {
@@ -509,7 +513,7 @@ function fixNewLineAfterImport(context, previousImport) {
}
function removeNewLineAfterImport(context, currentImport, previousImport) {
- const sourceCode = context.getSourceCode();
+ const sourceCode = getSourceCode(context);
const prevRoot = findRootNode(previousImport.node);
const currRoot = findRootNode(currentImport.node);
const rangeToRemove = [
@@ -524,7 +528,7 @@ function removeNewLineAfterImport(context, currentImport, previousImport) {
function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, distinctGroup) {
const getNumberOfEmptyLinesBetween = (currentImport, previousImport) => {
- const linesBetweenImports = context.getSourceCode().lines.slice(
+ const linesBetweenImports = getSourceCode(context).lines.slice(
previousImport.node.loc.end.line,
currentImport.node.loc.start.line - 1,
);
@@ -720,22 +724,24 @@ module.exports = {
}
},
TSImportEqualsDeclaration: function handleImports(node) {
- let displayName;
- let value;
- let type;
// skip "export import"s
if (node.isExport) {
return;
}
+
+ let displayName;
+ let value;
+ let type;
if (node.moduleReference.type === 'TSExternalModuleReference') {
value = node.moduleReference.expression.value;
displayName = value;
type = 'import';
} else {
value = '';
- displayName = context.getSourceCode().getText(node.moduleReference);
+ displayName = getSourceCode(context).getText(node.moduleReference);
type = 'import:object';
}
+
registerNode(
context,
{
From c02518b0a8fd7ae2400591e80f079ad9fcc4ad6e Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 6 Sep 2024 12:37:27 +1200
Subject: [PATCH 139/199] [Refactor] migrate some more places to contextCompat
helpers
---
src/importDeclaration.js | 6 ++++--
src/rules/namespace.js | 2 +-
src/rules/newline-after-import.js | 6 +++---
src/rules/no-named-as-default-member.js | 2 +-
src/rules/no-named-as-default.js | 2 +-
5 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/src/importDeclaration.js b/src/importDeclaration.js
index 0d5e1870a7..49446b2603 100644
--- a/src/importDeclaration.js
+++ b/src/importDeclaration.js
@@ -1,4 +1,6 @@
-export default function importDeclaration(context) {
- const ancestors = context.getAncestors();
+import { getAncestors } from 'eslint-module-utils/contextCompat';
+
+export default function importDeclaration(context, node) {
+ const ancestors = getAncestors(context, node);
return ancestors[ancestors.length - 1];
}
diff --git a/src/rules/namespace.js b/src/rules/namespace.js
index 60a4220de2..6feee0d23a 100644
--- a/src/rules/namespace.js
+++ b/src/rules/namespace.js
@@ -87,7 +87,7 @@ module.exports = {
// same as above, but does not add names to local map
ExportNamespaceSpecifier(namespace) {
- const declaration = importDeclaration(context);
+ const declaration = importDeclaration(context, namespace);
const imports = ExportMapBuilder.get(declaration.source.value, context);
if (imports == null) { return null; }
diff --git a/src/rules/newline-after-import.js b/src/rules/newline-after-import.js
index bf550bad95..c645d2bc6f 100644
--- a/src/rules/newline-after-import.js
+++ b/src/rules/newline-after-import.js
@@ -3,7 +3,7 @@
* @author Radek Benkel
*/
-import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
+import { getPhysicalFilename, getScope } from 'eslint-module-utils/contextCompat';
import isStaticRequire from '../core/staticRequire';
import docsUrl from '../docsUrl';
@@ -194,9 +194,9 @@ module.exports = {
requireCalls.push(node);
}
},
- 'Program:exit'() {
+ 'Program:exit'(node) {
log('exit processing for', getPhysicalFilename(context));
- const scopeBody = getScopeBody(context.getScope());
+ const scopeBody = getScopeBody(getScope(context, node));
log('got scope:', scopeBody);
requireCalls.forEach((node, index) => {
diff --git a/src/rules/no-named-as-default-member.js b/src/rules/no-named-as-default-member.js
index 54bec64a2a..c6abc46a81 100644
--- a/src/rules/no-named-as-default-member.js
+++ b/src/rules/no-named-as-default-member.js
@@ -35,7 +35,7 @@ module.exports = {
return {
ImportDefaultSpecifier(node) {
- const declaration = importDeclaration(context);
+ const declaration = importDeclaration(context, node);
const exportMap = ExportMapBuilder.get(declaration.source.value, context);
if (exportMap == null) { return; }
diff --git a/src/rules/no-named-as-default.js b/src/rules/no-named-as-default.js
index 5b24f8e883..c5adc7afe8 100644
--- a/src/rules/no-named-as-default.js
+++ b/src/rules/no-named-as-default.js
@@ -18,7 +18,7 @@ module.exports = {
// #566: default is a valid specifier
if (defaultSpecifier[nameKey].name === 'default') { return; }
- const declaration = importDeclaration(context);
+ const declaration = importDeclaration(context, defaultSpecifier);
const imports = ExportMapBuilder.get(declaration.source.value, context);
if (imports == null) { return; }
From df9f33377dddda118a3fa5f77b2825f30eff7e41 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 6 Sep 2024 12:37:27 +1200
Subject: [PATCH 140/199] [Tests] `no-empty-named-blocks`: add a `message`
---
tests/src/rules/no-empty-named-blocks.js | 1 +
1 file changed, 1 insertion(+)
diff --git a/tests/src/rules/no-empty-named-blocks.js b/tests/src/rules/no-empty-named-blocks.js
index f65e5a2045..87965a1407 100644
--- a/tests/src/rules/no-empty-named-blocks.js
+++ b/tests/src/rules/no-empty-named-blocks.js
@@ -10,6 +10,7 @@ function generateSuggestionsTestCases(cases, parser) {
code,
parser,
errors: [{
+ message: 'Unexpected empty named import block',
suggestions: [
{
desc: 'Remove unused import',
From 5d507c7876d3fc9d64c55ba6612dc45fb3ec3dfe Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 6 Sep 2024 13:27:26 +1200
Subject: [PATCH 141/199] [Tests] remove more duplicates
---
tests/src/rules/no-cycle.js | 10 ----------
tests/src/rules/no-extraneous-dependencies.js | 11 -----------
tests/src/rules/no-unresolved.js | 9 ---------
3 files changed, 30 deletions(-)
diff --git a/tests/src/rules/no-cycle.js b/tests/src/rules/no-cycle.js
index efc0fb6eb9..d005727e31 100644
--- a/tests/src/rules/no-cycle.js
+++ b/tests/src/rules/no-cycle.js
@@ -232,16 +232,6 @@ const cases = {
errors: [error(`Dependency cycle via ./depth-two:1=>./depth-one:1`)],
parser: parsers.BABEL_OLD,
}),
- test({
- code: `import { foo } from "./${testDialect}/depth-two"`,
- options: [{ maxDepth: Infinity }],
- errors: [error(`Dependency cycle via ./depth-one:1`)],
- }),
- test({
- code: `import { foo } from "./${testDialect}/depth-two"`,
- options: [{ maxDepth: '∞' }],
- errors: [error(`Dependency cycle via ./depth-one:1`)],
- }),
test({
code: `function bar(){ return import("./${testDialect}/depth-one"); } // #2265 5`,
errors: [error(`Dependency cycle detected.`)],
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index 4b221de353..dd01c141d3 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -43,11 +43,9 @@ ruleTester.run('no-extraneous-dependencies', rule, {
test({ code: `export { foo } from "${pkg}"` }),
test({ code: `export * from "${pkg}"` }),
]),
- test({ code: 'import "eslint"' }),
test({ code: 'import "eslint/lib/api"' }),
test({ code: 'import "fs"' }),
test({ code: 'import "./foo"' }),
- test({ code: 'import "@org/package"' }),
test({ code: 'import "electron"', settings: { 'import/core-modules': ['electron'] } }),
test({
@@ -386,15 +384,6 @@ ruleTester.run('no-extraneous-dependencies', rule, {
}],
}),
- test({
- code: 'import "not-a-dependency"',
- filename: path.join(packageDirMonoRepoRoot, 'foo.js'),
- options: [{ packageDir: packageDirMonoRepoRoot }],
- errors: [{
- message: `'not-a-dependency' should be listed in the project's dependencies. Run 'npm i -S not-a-dependency' to add it`,
- }],
- }),
-
test({
code: 'import "esm-package-not-in-pkg-json/esm-module";',
errors: [{
diff --git a/tests/src/rules/no-unresolved.js b/tests/src/rules/no-unresolved.js
index 04a53d887b..9bf1a42d4a 100644
--- a/tests/src/rules/no-unresolved.js
+++ b/tests/src/rules/no-unresolved.js
@@ -136,15 +136,6 @@ function runResolverTests(resolver) {
],
}),
- rest({
- code: "import bar from './baz';",
- errors: [
- {
- message: "Unable to resolve path to module './baz'.",
- type: 'Literal',
- },
- ],
- }),
rest({
code: "import bar from './baz';",
errors: [
From 4944f2830bcd0345e89da25c809d726d6c98b7f0 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 6 Sep 2024 17:28:04 +1200
Subject: [PATCH 142/199] [utils] [new] `declaredScope`: take a `node` for
modern eslint versions
---
utils/CHANGELOG.md | 3 +++
utils/declaredScope.d.ts | 4 +++-
utils/declaredScope.js | 6 ++++--
3 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 089219e7d6..00067e1867 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### New
+- `declaredScope`: take a `node` for modern eslint versions (thanks [@michaelfaith])
+
## v2.10.0 - 2024-09-05
### New
diff --git a/utils/declaredScope.d.ts b/utils/declaredScope.d.ts
index e37200d870..90053e8e70 100644
--- a/utils/declaredScope.d.ts
+++ b/utils/declaredScope.d.ts
@@ -1,8 +1,10 @@
import { Rule, Scope } from 'eslint';
+import * as ESTree from 'estree';
declare function declaredScope(
context: Rule.RuleContext,
- name: string
+ name: string,
+ node?: ESTree.Node,
): Scope.Scope['type'] | undefined;
export default declaredScope;
diff --git a/utils/declaredScope.js b/utils/declaredScope.js
index 0f0a3d9458..aa3e38b47a 100644
--- a/utils/declaredScope.js
+++ b/utils/declaredScope.js
@@ -2,9 +2,11 @@
exports.__esModule = true;
+const { getScope } = require('./contextCompat');
+
/** @type {import('./declaredScope').default} */
-exports.default = function declaredScope(context, name) {
- const references = context.getScope().references;
+exports.default = function declaredScope(context, name, node) {
+ const references = (node ? getScope(context, node) : context.getScope()).references;
const reference = references.find((x) => x.identifier.name === name);
if (!reference || !reference.resolved) { return undefined; }
return reference.resolved.scope.type;
From 107e30dd3a048c189d601958a0b6005ba6695319 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 5 Sep 2024 22:41:26 -0700
Subject: [PATCH 143/199] [utils] v2.11.0
---
utils/CHANGELOG.md | 2 ++
utils/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 00067e1867..6b2a5e5e19 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.11.0 - 2024-09-05
+
### New
- `declaredScope`: take a `node` for modern eslint versions (thanks [@michaelfaith])
diff --git a/utils/package.json b/utils/package.json
index f7afde88f9..df63ac1683 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.10.0",
+ "version": "2.11.0",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From a9018a86b78dc1e539269b77f1b14d93315b343c Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 6 Sep 2024 14:35:41 +1200
Subject: [PATCH 144/199] [Refactor] `namespace`, `no-deprecated`: update
`declaredScope` to use new `getScope` when possible
---
package.json | 2 +-
src/rules/namespace.js | 4 ++--
src/rules/no-deprecated.js | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/package.json b/package.json
index 90b9df4da8..5888c28eaa 100644
--- a/package.json
+++ b/package.json
@@ -117,7 +117,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.10.0",
+ "eslint-module-utils": "^2.11.0",
"hasown": "^2.0.2",
"is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
diff --git a/src/rules/namespace.js b/src/rules/namespace.js
index 6feee0d23a..b2de7f225f 100644
--- a/src/rules/namespace.js
+++ b/src/rules/namespace.js
@@ -110,7 +110,7 @@ module.exports = {
MemberExpression(dereference) {
if (dereference.object.type !== 'Identifier') { return; }
if (!namespaces.has(dereference.object.name)) { return; }
- if (declaredScope(context, dereference.object.name) !== 'module') { return; }
+ if (declaredScope(context, dereference.object.name, dereference) !== 'module') { return; }
if (dereference.parent.type === 'AssignmentExpression' && dereference.parent.left === dereference) {
context.report(
@@ -158,7 +158,7 @@ module.exports = {
if (!namespaces.has(init.name)) { return; }
// check for redefinition in intermediate scopes
- if (declaredScope(context, init.name) !== 'module') { return; }
+ if (declaredScope(context, init.name, init) !== 'module') { return; }
// DFS traverse child namespaces
function testKey(pattern, namespace, path = [init.name]) {
diff --git a/src/rules/no-deprecated.js b/src/rules/no-deprecated.js
index b4299a51d4..9559046b98 100644
--- a/src/rules/no-deprecated.js
+++ b/src/rules/no-deprecated.js
@@ -98,7 +98,7 @@ module.exports = {
if (!deprecated.has(node.name)) { return; }
- if (declaredScope(context, node.name) !== 'module') { return; }
+ if (declaredScope(context, node.name, node) !== 'module') { return; }
context.report({
node,
message: message(deprecated.get(node.name)),
@@ -109,7 +109,7 @@ module.exports = {
if (dereference.object.type !== 'Identifier') { return; }
if (!namespaces.has(dereference.object.name)) { return; }
- if (declaredScope(context, dereference.object.name) !== 'module') { return; }
+ if (declaredScope(context, dereference.object.name, dereference) !== 'module') { return; }
// go deep
let namespace = namespaces.get(dereference.object.name);
From 95849c88d798de5166252de7254b41f9735e8d6b Mon Sep 17 00:00:00 2001
From: Manuel Thalmann <m@nuth.ch>
Date: Fri, 30 Aug 2024 18:19:23 +0200
Subject: [PATCH 145/199] [New] `order`: allow validating named imports
---
CHANGELOG.md | 4 +
docs/rules/order.md | 72 +++++++
package.json | 1 +
src/rules/order.js | 409 ++++++++++++++++++++++++++++++++----
tests/src/rules/order.js | 438 +++++++++++++++++++++++++++++++++++++++
5 files changed, 880 insertions(+), 44 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 88fd1dbc27..89c752b4ed 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Added
+- [`order`]: allow validating named imports ([#3043], thanks [@manuth])
+
### Fixed
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
@@ -1133,6 +1136,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
+[#3043]: https://github.com/import-js/eslint-plugin-import/pull/3043
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 67849bb7ed..6762799534 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -285,6 +285,78 @@ import index from './';
import sibling from './foo';
```
+### `named: true|false|{ enabled: true|false, import: true|false, export: true|false, require: true|false, cjsExports: true|false, types: mixed|types-first|types-last }`
+
+Enforce ordering of names within imports and exports:
+
+ - If set to `true`, named imports must be ordered according to the `alphabetize` options
+ - If set to `false`, named imports can occur in any order
+
+`enabled` enables the named ordering for all expressions by default.
+Use `import`, `export` and `require` and `cjsExports` to override the enablement for the following kind of expressions:
+
+ - `import`:
+
+ ```ts
+ import { Readline } from "readline";
+ ```
+
+ - `export`:
+
+ ```ts
+ export { Readline };
+ // and
+ export { Readline } from "readline";
+ ```
+
+ - `require`
+
+ ```ts
+ const { Readline } = require("readline");
+ ```
+
+ - `cjsExports`
+
+ ```ts
+ module.exports.Readline = Readline;
+ // and
+ module.exports = { Readline };
+ ```
+
+The `types` option allows you to specify the order of `import`s and `export`s of `type` specifiers.
+Following values are possible:
+
+ - `types-first`: forces `type` specifiers to occur first
+ - `types-last`: forces value specifiers to occur first
+ - `mixed`: sorts all specifiers in alphabetical order
+
+The default value is `false`.
+
+Example setting:
+
+```ts
+{
+ named: true,
+ alphabetize: {
+ order: 'asc'
+ }
+}
+```
+
+This will fail the rule check:
+
+```ts
+/* eslint import/order: ["error", {"named": true, "alphabetize": {"order": "asc"}}] */
+import { compose, apply } from 'xcompose';
+```
+
+While this will pass:
+
+```ts
+/* eslint import/order: ["error", {"named": true, "alphabetize": {"order": "asc"}}] */
+import { apply, compose } from 'xcompose';
+```
+
### `alphabetize: {order: asc|desc|ignore, orderImportKind: asc|desc|ignore, caseInsensitive: true|false}`
Sort the order within each group in alphabetical manner based on **import path**:
diff --git a/package.json b/package.json
index 5888c28eaa..eda679b819 100644
--- a/package.json
+++ b/package.json
@@ -126,6 +126,7 @@
"object.groupby": "^1.0.3",
"object.values": "^1.2.0",
"semver": "^6.3.1",
+ "string.prototype.trimend": "^1.0.8",
"tsconfig-paths": "^3.15.0"
}
}
diff --git a/src/rules/order.js b/src/rules/order.js
index 23821830ff..d6f25ddd33 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -3,20 +3,25 @@
import minimatch from 'minimatch';
import includes from 'array-includes';
import groupBy from 'object.groupby';
-import { getSourceCode } from 'eslint-module-utils/contextCompat';
+import { getScope, getSourceCode } from 'eslint-module-utils/contextCompat';
+import trimEnd from 'string.prototype.trimend';
import importType from '../core/importType';
import isStaticRequire from '../core/staticRequire';
import docsUrl from '../docsUrl';
+const categories = {
+ named: 'named',
+ import: 'import',
+ exports: 'exports',
+};
+
const defaultGroups = ['builtin', 'external', 'parent', 'sibling', 'index'];
// REPORTING AND FIXING
function reverse(array) {
- return array.map(function (v) {
- return { ...v, rank: -v.rank };
- }).reverse();
+ return array.map((v) => ({ ...v, rank: -v.rank })).reverse();
}
function getTokensOrCommentsAfter(sourceCode, node, count) {
@@ -131,6 +136,26 @@ function findStartOfLineWithComments(sourceCode, node) {
return result;
}
+function findSpecifierStart(sourceCode, node) {
+ let token;
+
+ do {
+ token = sourceCode.getTokenBefore(node);
+ } while (token.value !== ',' && token.value !== '{');
+
+ return token.range[1];
+}
+
+function findSpecifierEnd(sourceCode, node) {
+ let token;
+
+ do {
+ token = sourceCode.getTokenAfter(node);
+ } while (token.value !== ',' && token.value !== '}');
+
+ return token.range[0];
+}
+
function isRequireExpression(expr) {
return expr != null
&& expr.type === 'CallExpression'
@@ -170,6 +195,49 @@ function isPlainImportEquals(node) {
return node.type === 'TSImportEqualsDeclaration' && node.moduleReference.expression;
}
+function isCJSExports(context, node) {
+ if (
+ node.type === 'MemberExpression'
+ && node.object.type === 'Identifier'
+ && node.property.type === 'Identifier'
+ && node.object.name === 'module'
+ && node.property.name === 'exports'
+ ) {
+ return getScope(context, node).variables.findIndex((variable) => variable.name === 'module') === -1;
+ }
+ if (
+ node.type === 'Identifier'
+ && node.name === 'exports'
+ ) {
+ return getScope(context, node).variables.findIndex((variable) => variable.name === 'exports') === -1;
+ }
+}
+
+function getNamedCJSExports(context, node) {
+ if (node.type !== 'MemberExpression') {
+ return;
+ }
+ const result = [];
+ let root = node;
+ let parent = null;
+ while (root.type === 'MemberExpression') {
+ if (root.property.type !== 'Identifier') {
+ return;
+ }
+ result.unshift(root.property.name);
+ parent = root;
+ root = root.object;
+ }
+
+ if (isCJSExports(context, root)) {
+ return result;
+ }
+
+ if (isCJSExports(context, parent)) {
+ return result.slice(1);
+ }
+}
+
function canCrossNodeWhileReorder(node) {
return isSupportedRequireModule(node) || isPlainImportModule(node) || isPlainImportEquals(node);
}
@@ -190,6 +258,12 @@ function canReorderItems(firstNode, secondNode) {
}
function makeImportDescription(node) {
+ if (node.type === 'export') {
+ if (node.node.exportKind === 'type') {
+ return 'type export';
+ }
+ return 'export';
+ }
if (node.node.importKind === 'type') {
return 'type import';
}
@@ -199,58 +273,123 @@ function makeImportDescription(node) {
return 'import';
}
-function fixOutOfOrder(context, firstNode, secondNode, order) {
+function fixOutOfOrder(context, firstNode, secondNode, order, category) {
+ const isNamed = category === categories.named;
+ const isExports = category === categories.exports;
const sourceCode = getSourceCode(context);
- const firstRoot = findRootNode(firstNode.node);
- const firstRootStart = findStartOfLineWithComments(sourceCode, firstRoot);
- const firstRootEnd = findEndOfLineWithComments(sourceCode, firstRoot);
+ const {
+ firstRoot,
+ secondRoot,
+ } = isNamed ? {
+ firstRoot: firstNode.node,
+ secondRoot: secondNode.node,
+ } : {
+ firstRoot: findRootNode(firstNode.node),
+ secondRoot: findRootNode(secondNode.node),
+ };
- const secondRoot = findRootNode(secondNode.node);
- const secondRootStart = findStartOfLineWithComments(sourceCode, secondRoot);
- const secondRootEnd = findEndOfLineWithComments(sourceCode, secondRoot);
- const canFix = canReorderItems(firstRoot, secondRoot);
+ const {
+ firstRootStart,
+ firstRootEnd,
+ secondRootStart,
+ secondRootEnd,
+ } = isNamed ? {
+ firstRootStart: findSpecifierStart(sourceCode, firstRoot),
+ firstRootEnd: findSpecifierEnd(sourceCode, firstRoot),
+ secondRootStart: findSpecifierStart(sourceCode, secondRoot),
+ secondRootEnd: findSpecifierEnd(sourceCode, secondRoot),
+ } : {
+ firstRootStart: findStartOfLineWithComments(sourceCode, firstRoot),
+ firstRootEnd: findEndOfLineWithComments(sourceCode, firstRoot),
+ secondRootStart: findStartOfLineWithComments(sourceCode, secondRoot),
+ secondRootEnd: findEndOfLineWithComments(sourceCode, secondRoot),
+ };
- let newCode = sourceCode.text.substring(secondRootStart, secondRootEnd);
- if (newCode[newCode.length - 1] !== '\n') {
- newCode = `${newCode}\n`;
+ if (firstNode.displayName === secondNode.displayName) {
+ if (firstNode.alias) {
+ firstNode.displayName = `${firstNode.displayName} as ${firstNode.alias}`;
+ }
+ if (secondNode.alias) {
+ secondNode.displayName = `${secondNode.displayName} as ${secondNode.alias}`;
+ }
}
const firstImport = `${makeImportDescription(firstNode)} of \`${firstNode.displayName}\``;
const secondImport = `\`${secondNode.displayName}\` ${makeImportDescription(secondNode)}`;
const message = `${secondImport} should occur ${order} ${firstImport}`;
- if (order === 'before') {
- context.report({
- node: secondNode.node,
- message,
- fix: canFix && ((fixer) => fixer.replaceTextRange(
- [firstRootStart, secondRootEnd],
- newCode + sourceCode.text.substring(firstRootStart, secondRootStart),
- )),
- });
- } else if (order === 'after') {
- context.report({
- node: secondNode.node,
- message,
- fix: canFix && ((fixer) => fixer.replaceTextRange(
- [secondRootStart, firstRootEnd],
- sourceCode.text.substring(secondRootEnd, firstRootEnd) + newCode,
- )),
- });
+ if (isNamed) {
+ const firstCode = sourceCode.text.slice(firstRootStart, firstRoot.range[1]);
+ const firstTrivia = sourceCode.text.slice(firstRoot.range[1], firstRootEnd);
+ const secondCode = sourceCode.text.slice(secondRootStart, secondRoot.range[1]);
+ const secondTrivia = sourceCode.text.slice(secondRoot.range[1], secondRootEnd);
+
+ if (order === 'before') {
+ const trimmedTrivia = trimEnd(secondTrivia);
+ const gapCode = sourceCode.text.slice(firstRootEnd, secondRootStart - 1);
+ const whitespaces = secondTrivia.slice(trimmedTrivia.length);
+ context.report({
+ node: secondNode.node,
+ message,
+ fix: (fixer) => fixer.replaceTextRange(
+ [firstRootStart, secondRootEnd],
+ `${secondCode},${trimmedTrivia}${firstCode}${firstTrivia}${gapCode}${whitespaces}`,
+ ),
+ });
+ } else if (order === 'after') {
+ const trimmedTrivia = trimEnd(firstTrivia);
+ const gapCode = sourceCode.text.slice(secondRootEnd + 1, firstRootStart);
+ const whitespaces = firstTrivia.slice(trimmedTrivia.length);
+ context.report({
+ node: secondNode.node,
+ message,
+ fix: (fixes) => fixes.replaceTextRange(
+ [secondRootStart, firstRootEnd],
+ `${gapCode}${firstCode},${trimmedTrivia}${secondCode}${whitespaces}`,
+ ),
+ });
+ }
+ } else {
+ const canFix = isExports || canReorderItems(firstRoot, secondRoot);
+ let newCode = sourceCode.text.substring(secondRootStart, secondRootEnd);
+
+ if (newCode[newCode.length - 1] !== '\n') {
+ newCode = `${newCode}\n`;
+ }
+
+ if (order === 'before') {
+ context.report({
+ node: secondNode.node,
+ message,
+ fix: canFix && ((fixer) => fixer.replaceTextRange(
+ [firstRootStart, secondRootEnd],
+ newCode + sourceCode.text.substring(firstRootStart, secondRootStart),
+ )),
+ });
+ } else if (order === 'after') {
+ context.report({
+ node: secondNode.node,
+ message,
+ fix: canFix && ((fixer) => fixer.replaceTextRange(
+ [secondRootStart, firstRootEnd],
+ sourceCode.text.substring(secondRootEnd, firstRootEnd) + newCode,
+ )),
+ });
+ }
}
}
-function reportOutOfOrder(context, imported, outOfOrder, order) {
+function reportOutOfOrder(context, imported, outOfOrder, order, category) {
outOfOrder.forEach(function (imp) {
const found = imported.find(function hasHigherRank(importedItem) {
return importedItem.rank > imp.rank;
});
- fixOutOfOrder(context, found, imp, order);
+ fixOutOfOrder(context, found, imp, order, category);
});
}
-function makeOutOfOrderReport(context, imported) {
+function makeOutOfOrderReport(context, imported, category) {
const outOfOrder = findOutOfOrder(imported);
if (!outOfOrder.length) {
return;
@@ -260,10 +399,10 @@ function makeOutOfOrderReport(context, imported) {
const reversedImported = reverse(imported);
const reversedOrder = findOutOfOrder(reversedImported);
if (reversedOrder.length < outOfOrder.length) {
- reportOutOfOrder(context, reversedImported, reversedOrder, 'after');
+ reportOutOfOrder(context, reversedImported, reversedOrder, 'after', category);
return;
}
- reportOutOfOrder(context, imported, outOfOrder, 'before');
+ reportOutOfOrder(context, imported, outOfOrder, 'before', category);
}
const compareString = (a, b) => {
@@ -642,6 +781,30 @@ module.exports = {
'never',
],
},
+ named: {
+ default: false,
+ oneOf: [{
+ type: 'boolean',
+ }, {
+ type: 'object',
+ properties: {
+ enabled: { type: 'boolean' },
+ import: { type: 'boolean' },
+ export: { type: 'boolean' },
+ require: { type: 'boolean' },
+ cjsExports: { type: 'boolean' },
+ types: {
+ type: 'string',
+ enum: [
+ 'mixed',
+ 'types-first',
+ 'types-last',
+ ],
+ },
+ },
+ additionalProperties: false,
+ }],
+ },
alphabetize: {
type: 'object',
properties: {
@@ -670,10 +833,28 @@ module.exports = {
],
},
- create: function importOrderRule(context) {
+ create(context) {
const options = context.options[0] || {};
const newlinesBetweenImports = options['newlines-between'] || 'ignore';
const pathGroupsExcludedImportTypes = new Set(options.pathGroupsExcludedImportTypes || ['builtin', 'external', 'object']);
+
+ const named = {
+ types: 'mixed',
+ ...typeof options.named === 'object' ? {
+ ...options.named,
+ import: 'import' in options.named ? options.named.import : options.named.enabled,
+ export: 'export' in options.named ? options.named.export : options.named.enabled,
+ require: 'require' in options.named ? options.named.require : options.named.enabled,
+ cjsExports: 'cjsExports' in options.named ? options.named.cjsExports : options.named.enabled,
+ } : {
+ import: options.named,
+ export: options.named,
+ require: options.named,
+ cjsExports: options.named,
+ },
+ };
+
+ const namedGroups = named.types === 'mixed' ? [] : named.types === 'types-last' ? ['value'] : ['type'];
const alphabetize = getAlphabetizeConfig(options);
const distinctGroup = options.distinctGroup == null ? defaultDistinctGroup : !!options.distinctGroup;
let ranks;
@@ -696,6 +877,7 @@ module.exports = {
};
}
const importMap = new Map();
+ const exportMap = new Map();
function getBlockImports(node) {
if (!importMap.has(node)) {
@@ -704,8 +886,38 @@ module.exports = {
return importMap.get(node);
}
+ function getBlockExports(node) {
+ if (!exportMap.has(node)) {
+ exportMap.set(node, []);
+ }
+ return exportMap.get(node);
+ }
+
+ function makeNamedOrderReport(context, namedImports) {
+ if (namedImports.length > 1) {
+ const imports = namedImports.map(
+ (namedImport) => {
+ const kind = namedImport.kind || 'value';
+ const rank = namedGroups.findIndex((entry) => [].concat(entry).indexOf(kind) > -1);
+
+ return {
+ displayName: namedImport.value,
+ rank: rank === -1 ? namedGroups.length : rank,
+ ...namedImport,
+ value: `${namedImport.value}:${namedImport.alias || ''}`,
+ };
+ });
+
+ if (alphabetize.order !== 'ignore') {
+ mutateRanksToAlphabetize(imports, alphabetize);
+ }
+
+ makeOutOfOrderReport(context, imports, categories.named);
+ }
+ }
+
return {
- ImportDeclaration: function handleImports(node) {
+ ImportDeclaration(node) {
// Ignoring unassigned imports unless warnOnUnassignedImports is set
if (node.specifiers.length || options.warnOnUnassignedImports) {
const name = node.source.value;
@@ -721,9 +933,27 @@ module.exports = {
getBlockImports(node.parent),
pathGroupsExcludedImportTypes,
);
+
+ if (named.import) {
+ makeNamedOrderReport(
+ context,
+ node.specifiers.filter(
+ (specifier) => specifier.type === 'ImportSpecifier').map(
+ (specifier) => ({
+ node: specifier,
+ value: specifier.imported.name,
+ type: 'import',
+ kind: specifier.importKind,
+ ...specifier.local.range[0] !== specifier.imported.range[0] && {
+ alias: specifier.local.name,
+ },
+ }),
+ ),
+ );
+ }
}
},
- TSImportEqualsDeclaration: function handleImports(node) {
+ TSImportEqualsDeclaration(node) {
// skip "export import"s
if (node.isExport) {
return;
@@ -755,7 +985,7 @@ module.exports = {
pathGroupsExcludedImportTypes,
);
},
- CallExpression: function handleRequires(node) {
+ CallExpression(node) {
if (!isStaticRequire(node)) {
return;
}
@@ -777,7 +1007,90 @@ module.exports = {
pathGroupsExcludedImportTypes,
);
},
- 'Program:exit': function reportAndReset() {
+ ...named.require && {
+ VariableDeclarator(node) {
+ if (node.id.type === 'ObjectPattern' && isRequireExpression(node.init)) {
+ for (let i = 0; i < node.id.properties.length; i++) {
+ if (
+ node.id.properties[i].key.type !== 'Identifier'
+ || node.id.properties[i].value.type !== 'Identifier'
+ ) {
+ return;
+ }
+ }
+ makeNamedOrderReport(
+ context,
+ node.id.properties.map((prop) => ({
+ node: prop,
+ value: prop.key.name,
+ type: 'require',
+ ...prop.key.range[0] !== prop.value.range[0] && {
+ alias: prop.value.name,
+ },
+ })),
+ );
+ }
+ },
+ },
+ ...named.export && {
+ ExportNamedDeclaration(node) {
+ makeNamedOrderReport(
+ context,
+ node.specifiers.map((specifier) => ({
+ node: specifier,
+ value: specifier.local.name,
+ type: 'export',
+ kind: specifier.exportKind,
+ ...specifier.local.range[0] !== specifier.exported.range[0] && {
+ alias: specifier.exported.name,
+ },
+ })),
+ );
+ },
+ },
+ ...named.cjsExports && {
+ AssignmentExpression(node) {
+ if (node.parent.type === 'ExpressionStatement') {
+ if (isCJSExports(context, node.left)) {
+ if (node.right.type === 'ObjectExpression') {
+ for (let i = 0; i < node.right.properties.length; i++) {
+ if (
+ node.right.properties[i].key.type !== 'Identifier'
+ || node.right.properties[i].value.type !== 'Identifier'
+ ) {
+ return;
+ }
+ }
+
+ makeNamedOrderReport(
+ context,
+ node.right.properties.map((prop) => ({
+ node: prop,
+ value: prop.key.name,
+ type: 'export',
+ ...prop.key.range[0] !== prop.value.range[0] && {
+ alias: prop.value.name,
+ },
+ })),
+ );
+ }
+ } else {
+ const nameParts = getNamedCJSExports(context, node.left);
+ if (nameParts && nameParts.length > 0) {
+ const name = nameParts.join('.');
+ getBlockExports(node.parent.parent).push({
+ node,
+ value: name,
+ displayName: name,
+ type: 'export',
+ rank: 0,
+ });
+ }
+ }
+ }
+ },
+ },
+ 'Program:exit'() {
importMap.forEach((imported) => {
if (newlinesBetweenImports !== 'ignore') {
makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, distinctGroup);
@@ -787,10 +1100,18 @@ module.exports = {
mutateRanksToAlphabetize(imported, alphabetize);
}
- makeOutOfOrderReport(context, imported);
+ makeOutOfOrderReport(context, imported, categories.import);
+ });
+
+ exportMap.forEach((exported) => {
+ if (alphabetize.order !== 'ignore') {
+ mutateRanksToAlphabetize(exported, alphabetize);
+ makeOutOfOrderReport(context, exported, categories.exports);
+ }
});
importMap.clear();
+ exportMap.clear();
},
};
},
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index c2d659f839..978c8e34d0 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -1133,6 +1133,140 @@ ruleTester.run('order', rule, {
},
],
}),
+ // named import order
+ test({
+ code: `
+ import { a, B as C, Z } from './Z';
+ const { D, n: c, Y } = require('./Z');
+ export { C, D };
+ export { A, B, C as default } from "./Z";
+
+ const { ["ignore require-statements with non-identifier imports"]: z, d } = require("./Z");
+ exports = { ["ignore exports statements with non-identifiers"]: Z, D };
+ `,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc', caseInsensitive: true },
+ }],
+ }),
+ test({
+ code: `
+ const { b, A } = require('./Z');
+ `,
+ options: [{
+ named: true,
+ alphabetize: { order: 'desc' },
+ }],
+ }),
+ test({
+ code: `
+ import { A, B } from "./Z";
+ export { Z, A } from "./Z";
+ export { N, P } from "./Z";
+ const { X, Y } = require("./Z");
+ `,
+ options: [{
+ named: {
+ require: true,
+ import: true,
+ export: false,
+ },
+ }],
+ }),
+ test({
+ code: `
+ import { B, A } from "./Z";
+ const { D, C } = require("./Z");
+ export { B, A } from "./Z";
+ `,
+ options: [{
+ named: {
+ require: false,
+ import: false,
+ export: false,
+ },
+ }],
+ }),
+ test({
+ code: `
+ import { B, A, R } from "foo";
+ const { D, O, G } = require("tunes");
+ export { B, A, Z } from "foo";
+ `,
+ options: [{
+ named: { enabled: false },
+ }],
+ }),
+ test({
+ code: `
+ import { A as A, A as B, A as C } from "./Z";
+ const { a, a: b, a: c } = require("./Z");
+ `,
+ options: [{
+ named: true,
+ }],
+ }),
+ test({
+ code: `
+ import { A, B, C } from "./Z";
+ exports = { A, B, C };
+ module.exports = { a: A, b: B, c: C };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ }),
+ test({
+ code: `
+ module.exports.A = { };
+ module.exports.A.B = { };
+ module.exports.B = { };
+ exports.C = { };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ }),
+ // ensure other assignments are untouched
+ test({
+ code: `
+ var exports = null;
+ var module = null;
+ exports = { };
+ module = { };
+ module.exports = { };
+ module.exports.U = { };
+ module.exports.N = { };
+ module.exports.C = { };
+ exports.L = { };
+ exports.E = { };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ }),
+ test({
+ code: `
+ exports["B"] = { };
+ exports["C"] = { };
+ exports["A"] = { };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ }),
],
invalid: [
// builtin before external module (require)
@@ -2742,6 +2876,205 @@ ruleTester.run('order', rule, {
message: 'There should be no empty line within import group',
}],
}),
+ // named import order
+ test({
+ code: `
+ var { B, A: R } = require("./Z");
+ import { O as G, D } from "./Z";
+ import { K, L, J } from "./Z";
+ export { Z, X, Y } from "./Z";
+ `,
+ output: `
+ var { A: R, B } = require("./Z");
+ import { D, O as G } from "./Z";
+ import { J, K, L } from "./Z";
+ export { X, Y, Z } from "./Z";
+ `,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` import should occur before import of `B`',
+ }, {
+ message: '`D` import should occur before import of `O`',
+ }, {
+ message: '`J` import should occur before import of `K`',
+ }, {
+ message: '`Z` export should occur after export of `Y`',
+ }],
+ }),
+ test({
+ code: `
+ import { D, C } from "./Z";
+ var { B, A } = require("./Z");
+ export { B, A };
+ `,
+ output: `
+ import { C, D } from "./Z";
+ var { B, A } = require("./Z");
+ export { A, B };
+ `,
+ options: [{
+ named: {
+ require: false,
+ import: true,
+ export: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`C` import should occur before import of `D`',
+ }, {
+ message: '`A` export should occur before export of `B`',
+ }],
+ }),
+ test({
+ code: `
+ import { A as B, A as C, A } from "./Z";
+ export { A, A as D, A as B, A as C } from "./Z";
+ const { a: b, a: c, a } = require("./Z");
+ `,
+ output: `
+ import { A, A as B, A as C } from "./Z";
+ export { A, A as B, A as C, A as D } from "./Z";
+ const { a, a: b, a: c } = require("./Z");
+ `,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` import should occur before import of `A as B`',
+ }, {
+ message: '`A as D` export should occur after export of `A as C`',
+ }, {
+ message: '`a` import should occur before import of `a as b`',
+ }],
+ }),
+ test({
+ code: `
+ import { A, B, C } from "./Z";
+ exports = { B, C, A };
+ module.exports = { c: C, a: A, b: B };
+ `,
+ output: `
+ import { A, B, C } from "./Z";
+ exports = { A, B, C };
+ module.exports = { a: A, b: B, c: C };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` export should occur before export of `B`',
+ }, {
+ message: '`c` export should occur after export of `b`',
+ }],
+ }),
+ test({
+ code: `
+ exports.B = { };
+ module.exports.A = { };
+ module.exports.C = { };
+ `,
+ output: `
+ module.exports.A = { };
+ exports.B = { };
+ module.exports.C = { };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` export should occur before export of `B`',
+ }],
+ }),
+ test({
+ code: `
+ exports.A.C = { };
+ module.exports.A.A = { };
+ exports.A.B = { };
+ `,
+ output: `
+ module.exports.A.A = { };
+ exports.A.B = { };
+ exports.A.C = { };
+ `,
+ options: [{
+ named: {
+ cjsExports: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A.C` export should occur after export of `A.B`',
+ }],
+ }),
+ // multiline named specifiers & trailing commas
+ test({
+ code: `
+ const {
+ F: O,
+ O: B,
+ /* Hello World */
+ A: R
+ } = require("./Z");
+ import {
+ Y,
+ X,
+ } from "./Z";
+ export {
+ Z, A,
+ B
+ } from "./Z";
+ module.exports = {
+ a: A, o: O,
+ b: B
+ };
+ `,
+ output: `
+ const {
+ /* Hello World */
+ A: R,
+ F: O,
+ O: B
+ } = require("./Z");
+ import {
+ X,
+ Y,
+ } from "./Z";
+ export { A,
+ B,
+ Z
+ } from "./Z";
+ module.exports = {
+ a: A,
+ b: B, o: O
+ };
+ `,
+ options: [{
+ named: {
+ enabled: true,
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` import should occur before import of `F`',
+ }, {
+ message: '`X` import should occur before import of `Y`',
+ }, {
+ message: '`Z` export should occur after export of `B`',
+ }, {
+ message: '`b` export should occur before export of `o`',
+ }],
+ }),
// Alphabetize with require
...semver.satisfies(eslintPkg.version, '< 3.0.0') ? [] : [
test({
@@ -2772,6 +3105,9 @@ context('TypeScript', function () {
// Type-only imports were added in TypeScript ESTree 2.23.0
.filter((parser) => parser !== parsers.TS_OLD)
.forEach((parser) => {
+ const supportsTypeSpecifiers = semver.satisfies(require('@typescript-eslint/parser/package.json').version, '>= 5');
+ const supportsImportTypeSpecifiers = parser !== parsers.TS_NEW || supportsTypeSpecifiers;
+ const supportsExportTypeSpecifiers = parser === parsers.TS_NEW && supportsTypeSpecifiers;
const parserConfig = {
parser,
settings: {
@@ -3238,6 +3574,108 @@ context('TypeScript', function () {
},
],
}),
+ // named import order
+ test({
+ code: `
+ import { type Z, A } from "./Z";
+ import type N, { E, D } from "./Z";
+ import type { L, G } from "./Z";
+ `,
+ output: `
+ import { A, type Z } from "./Z";
+ import type N, { D, E } from "./Z";
+ import type { G, L } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [
+ { message: `\`A\` import should occur before${supportsImportTypeSpecifiers ? ' type' : ''} import of \`Z\`` },
+ { message: '`D` import should occur before import of `E`' },
+ { message: '`G` import should occur before import of `L`' },
+ ],
+ }),
+ test({
+ code: `
+ const { B, /* Hello World */ A } = require("./Z");
+ export { B, A } from "./Z";
+ `,
+ output: `
+ const { /* Hello World */ A, B } = require("./Z");
+ export { A, B } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` import should occur before import of `B`',
+ }, {
+ message: '`A` export should occur before export of `B`',
+ }],
+ }),
+
+ supportsExportTypeSpecifiers ? [
+ test({
+ code: `
+ export { type B, A };
+ `,
+ output: `
+ export { A, type B };
+ `,
+ ...parserConfig,
+ options: [{
+ named: {
+ enabled: true,
+ types: 'mixed',
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` export should occur before type export of `B`',
+ }],
+ }),
+ test({
+ code: `
+ import { type B, A, default as C } from "./Z";
+ `,
+ output: `
+ import { A, default as C, type B } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: {
+ import: true,
+ types: 'types-last',
+ },
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`B` type import should occur after import of `default`',
+ }],
+ }),
+ test({
+ code: `
+ export { A, type Z } from "./Z";
+ `,
+ output: `
+ export { type Z, A } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: {
+ enabled: true,
+ types: 'types-first',
+ },
+ }],
+ errors: [
+ { message: '`Z` type export should occur before export of `A`' },
+ ],
+ }),
+ ] : [],
isCoreModule('node:child_process') && isCoreModule('node:fs/promises') ? [
test({
From fcbdcbae2327f0335e75c9f756ff67d96c712f97 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andrzej=20W=C3=B3dkiewicz?= <akwodkiewicz@gmail.com>
Date: Tue, 6 Aug 2024 09:08:37 +0200
Subject: [PATCH 146/199] [Fix] `no-named-as-default`: Allow using an
identifier if the export is both a named and a default export
- add tests for #1594
---
CHANGELOG.md | 3 +
src/rules/no-named-as-default.js | 63 ++++++++--
tests/files/no-named-as-default/exports.js | 4 +
.../misleading-re-exports.js | 2 +
.../no-named-as-default/no-default-export.js | 1 +
tests/files/no-named-as-default/re-exports.js | 2 +
tests/files/no-named-as-default/something.js | 1 +
tests/src/rules/no-named-as-default.js | 110 +++++++++++++++---
8 files changed, 162 insertions(+), 24 deletions(-)
create mode 100644 tests/files/no-named-as-default/exports.js
create mode 100644 tests/files/no-named-as-default/misleading-re-exports.js
create mode 100644 tests/files/no-named-as-default/no-default-export.js
create mode 100644 tests/files/no-named-as-default/re-exports.js
create mode 100644 tests/files/no-named-as-default/something.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 89c752b4ed..4e7ef808eb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
+- [`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export ([#3032], thanks [@akwodkiewicz])
## [2.30.0] - 2024-09-02
@@ -1139,6 +1140,7 @@ for info on changes for earlier releases.
[#3043]: https://github.com/import-js/eslint-plugin-import/pull/3043
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
+[#3032]: https://github.com/import-js/eslint-plugin-import/pull/3032
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
@@ -1726,6 +1728,7 @@ for info on changes for earlier releases.
[@AdriAt360]: https://github.com/AdriAt360
[@ai]: https://github.com/ai
[@aks-]: https://github.com/aks-
+[@akwodkiewicz]: https://github.com/akwodkiewicz
[@aladdin-add]: https://github.com/aladdin-add
[@alex-page]: https://github.com/alex-page
[@alexgorbatchev]: https://github.com/alexgorbatchev
diff --git a/src/rules/no-named-as-default.js b/src/rules/no-named-as-default.js
index c5adc7afe8..dacd294f46 100644
--- a/src/rules/no-named-as-default.js
+++ b/src/rules/no-named-as-default.js
@@ -15,28 +15,71 @@ module.exports = {
create(context) {
function checkDefault(nameKey, defaultSpecifier) {
+ /**
+ * For ImportDefaultSpecifier we're interested in the "local" name (`foo` for `import {bar as foo} ...`)
+ * For ExportDefaultSpecifier we're interested in the "exported" name (`foo` for `export {bar as foo} ...`)
+ */
+ const analyzedName = defaultSpecifier[nameKey].name;
+
// #566: default is a valid specifier
- if (defaultSpecifier[nameKey].name === 'default') { return; }
+ if (analyzedName === 'default') { return; }
const declaration = importDeclaration(context, defaultSpecifier);
+ /** @type {import('../exportMap').default | null} */
+ const importedModule = ExportMapBuilder.get(declaration.source.value, context);
+ if (importedModule == null) { return; }
- const imports = ExportMapBuilder.get(declaration.source.value, context);
- if (imports == null) { return; }
+ if (importedModule.errors.length > 0) {
+ importedModule.reportErrors(context, declaration);
+ return;
+ }
- if (imports.errors.length) {
- imports.reportErrors(context, declaration);
+ if (!importedModule.hasDefault) {
+ // The rule is triggered for default imports/exports, so if the imported module has no default
+ // this means we're dealing with incorrect source code anyway
return;
}
- if (imports.has('default') && imports.has(defaultSpecifier[nameKey].name)) {
+ if (!importedModule.has(analyzedName)) {
+ // The name used locally for the default import was not even used in the imported module.
+ return;
+ }
- context.report(
- defaultSpecifier,
- `Using exported name '${defaultSpecifier[nameKey].name}' as identifier for default export.`,
- );
+ /**
+ * FIXME: We can verify if a default and a named export are pointing to the same symbol only
+ * if they are both `reexports`. In case one of the symbols is not a re-export, but defined
+ * in the file, the ExportMap structure has no info about what actually is being exported --
+ * the value in the `namespace` Map is an empty object.
+ *
+ * To solve this, it would require not relying on the ExportMap, but on some other way of
+ * accessing the imported module and its exported values.
+ *
+ * Additionally, although `ExportMap.get` is a unified way to get info from both `reexports`
+ * and `namespace` maps, it does not return valid output we need here, and I think this is
+ * related to the "cycle safeguards" in the `get` function.
+ */
+ if (importedModule.reexports.has(analyzedName) && importedModule.reexports.has('default')) {
+ const thingImportedWithNamedImport = importedModule.reexports.get(analyzedName).getImport();
+ const thingImportedWithDefaultImport = importedModule.reexports.get('default').getImport();
+
+ // Case: both imports point to the same file and they both refer to the same symbol in this file.
+ if (
+ thingImportedWithNamedImport.path === thingImportedWithDefaultImport.path
+ && thingImportedWithNamedImport.local === thingImportedWithDefaultImport.local
+ ) {
+ // #1594: the imported module exports the same thing via a default export and a named export
+ return;
+ }
}
+
+ context.report(
+ defaultSpecifier,
+ `Using exported name '${defaultSpecifier[nameKey].name}' as identifier for default ${nameKey === 'local' ? `import` : `export`}.`,
+ );
+
}
+
return {
ImportDefaultSpecifier: checkDefault.bind(null, 'local'),
ExportDefaultSpecifier: checkDefault.bind(null, 'exported'),
diff --git a/tests/files/no-named-as-default/exports.js b/tests/files/no-named-as-default/exports.js
new file mode 100644
index 0000000000..62402634f6
--- /dev/null
+++ b/tests/files/no-named-as-default/exports.js
@@ -0,0 +1,4 @@
+const variable = 1;
+
+export { variable };
+export default variable;
diff --git a/tests/files/no-named-as-default/misleading-re-exports.js b/tests/files/no-named-as-default/misleading-re-exports.js
new file mode 100644
index 0000000000..8d36a0866e
--- /dev/null
+++ b/tests/files/no-named-as-default/misleading-re-exports.js
@@ -0,0 +1,2 @@
+export { variable as something } from './exports';
+export { something as default } from './something';
diff --git a/tests/files/no-named-as-default/no-default-export.js b/tests/files/no-named-as-default/no-default-export.js
new file mode 100644
index 0000000000..db30747974
--- /dev/null
+++ b/tests/files/no-named-as-default/no-default-export.js
@@ -0,0 +1 @@
+export const foobar = 4;
diff --git a/tests/files/no-named-as-default/re-exports.js b/tests/files/no-named-as-default/re-exports.js
new file mode 100644
index 0000000000..20306c1829
--- /dev/null
+++ b/tests/files/no-named-as-default/re-exports.js
@@ -0,0 +1,2 @@
+export { something as default } from "./something";
+export { something } from "./something";
diff --git a/tests/files/no-named-as-default/something.js b/tests/files/no-named-as-default/something.js
new file mode 100644
index 0000000000..d8fd6851b3
--- /dev/null
+++ b/tests/files/no-named-as-default/something.js
@@ -0,0 +1 @@
+export const something = 42;
diff --git a/tests/src/rules/no-named-as-default.js b/tests/src/rules/no-named-as-default.js
index c6646a4f0d..7fcd6e4f72 100644
--- a/tests/src/rules/no-named-as-default.js
+++ b/tests/src/rules/no-named-as-default.js
@@ -12,14 +12,20 @@ ruleTester.run('no-named-as-default', rule, {
test({ code: 'import bar, { foo } from "./empty-folder";' }),
// es7
- test({ code: 'export bar, { foo } from "./bar";',
- parser: parsers.BABEL_OLD }),
- test({ code: 'export bar from "./bar";',
- parser: parsers.BABEL_OLD }),
+ test({
+ code: 'export bar, { foo } from "./bar";',
+ parser: parsers.BABEL_OLD,
+ }),
+ test({
+ code: 'export bar from "./bar";',
+ parser: parsers.BABEL_OLD,
+ }),
// #566: don't false-positive on `default` itself
- test({ code: 'export default from "./bar";',
- parser: parsers.BABEL_OLD }),
+ test({
+ code: 'export default from "./bar";',
+ parser: parsers.BABEL_OLD,
+ }),
// es2022: Arbitrary module namespae identifier names
testVersion('>= 8.7', () => ({
@@ -27,6 +33,48 @@ ruleTester.run('no-named-as-default', rule, {
parserOptions: { ecmaVersion: 2022 },
})),
+ // #1594: Allow importing as default if object is exported both as default and named
+ test({ code: 'import something from "./no-named-as-default/re-exports.js";' }),
+ test({
+ code: 'import { something } from "./no-named-as-default/re-exports.js";',
+ }),
+ test({
+ code: 'import myOwnNameForVariable from "./no-named-as-default/exports.js";',
+ }),
+ test({
+ code: 'import { variable } from "./no-named-as-default/exports.js";',
+ }),
+ test({
+ code: 'import variable from "./no-named-as-default/misleading-re-exports.js";',
+ }),
+ test({
+ // incorrect import
+ code: 'import foobar from "./no-named-as-default/no-default-export.js";',
+ }),
+ // same tests, but for exports
+ test({
+ code: 'export something from "./no-named-as-default/re-exports.js";',
+ parser: parsers.BABEL_OLD,
+ }),
+ test({
+ code: 'export { something } from "./no-named-as-default/re-exports.js";',
+ }),
+ test({
+ code: 'export myOwnNameForVariable from "./no-named-as-default/exports.js";',
+ parser: parsers.BABEL_OLD,
+ }),
+ test({
+ code: 'export { variable } from "./no-named-as-default/exports.js";',
+ }),
+ test({
+ code: 'export variable from "./no-named-as-default/misleading-re-exports.js";',
+ parser: parsers.BABEL_OLD,
+ }),
+ test({
+ code: 'export foobar from "./no-named-as-default/no-default-export.js";',
+ parser: parsers.BABEL_OLD,
+ }),
+
...SYNTAX_CASES,
),
@@ -34,13 +82,17 @@ ruleTester.run('no-named-as-default', rule, {
test({
code: 'import foo from "./bar";',
errors: [{
- message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ImportDefaultSpecifier' }] }),
+ message: 'Using exported name \'foo\' as identifier for default import.',
+ type: 'ImportDefaultSpecifier',
+ }],
+ }),
test({
code: 'import foo, { foo as bar } from "./bar";',
errors: [{
- message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ImportDefaultSpecifier' }] }),
+ message: 'Using exported name \'foo\' as identifier for default import.',
+ type: 'ImportDefaultSpecifier',
+ }],
+ }),
// es7
test({
@@ -48,13 +100,17 @@ ruleTester.run('no-named-as-default', rule, {
parser: parsers.BABEL_OLD,
errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ExportDefaultSpecifier' }] }),
+ type: 'ExportDefaultSpecifier',
+ }],
+ }),
test({
code: 'export foo, { foo as bar } from "./bar";',
parser: parsers.BABEL_OLD,
errors: [{
message: 'Using exported name \'foo\' as identifier for default export.',
- type: 'ExportDefaultSpecifier' }] }),
+ type: 'ExportDefaultSpecifier',
+ }],
+ }),
test({
code: 'import foo from "./malformed.js"',
@@ -68,7 +124,7 @@ ruleTester.run('no-named-as-default', rule, {
testVersion('>= 8.7', () => ({
code: 'import foo from "./export-default-string-and-named"',
errors: [{
- message: 'Using exported name \'foo\' as identifier for default export.',
+ message: 'Using exported name \'foo\' as identifier for default import.',
type: 'ImportDefaultSpecifier',
}],
parserOptions: { ecmaVersion: 2022 },
@@ -76,10 +132,36 @@ ruleTester.run('no-named-as-default', rule, {
testVersion('>= 8.7', () => ({
code: 'import foo, { foo as bar } from "./export-default-string-and-named"',
errors: [{
- message: 'Using exported name \'foo\' as identifier for default export.',
+ message: 'Using exported name \'foo\' as identifier for default import.',
type: 'ImportDefaultSpecifier',
}],
parserOptions: { ecmaVersion: 2022 },
})),
+
+ // #1594: Allow importing as default if object is exported both as default and named
+ test({
+ code: 'import something from "./no-named-as-default/misleading-re-exports.js";',
+ parser: parsers.BABEL_OLD,
+ errors: [{
+ message: 'Using exported name \'something\' as identifier for default import.',
+ type: 'ImportDefaultSpecifier',
+ }],
+ }),
+ // The only cases that are not covered by the fix
+ test({
+ code: 'import variable from "./no-named-as-default/exports.js";',
+ errors: [{
+ message: 'Using exported name \'variable\' as identifier for default import.',
+ type: 'ImportDefaultSpecifier',
+ }],
+ }),
+ test({
+ code: 'export variable from "./no-named-as-default/exports.js";',
+ parser: parsers.BABEL_OLD,
+ errors: [{
+ message: 'Using exported name \'variable\' as identifier for default export.',
+ type: 'ExportDefaultSpecifier',
+ }],
+ }),
),
});
From f72f2072f4245f2c3494816d7c14352fc9e07c0a Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Tue, 10 Sep 2024 07:52:43 +1200
Subject: [PATCH 147/199] [utils] [fix] `parse`: remove unneeded extra
backticks
---
utils/CHANGELOG.md | 5 +++++
utils/parse.js | 2 +-
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 6b2a5e5e19..ca733eee05 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Fixed
+- `parse`: remove unneeded extra backticks ([#3057], thanks [@G-Rath])
+
## v2.11.0 - 2024-09-05
### New
@@ -165,6 +168,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3057]: https://github.com/import-js/eslint-plugin-import/pull/3057
[#3049]: https://github.com/import-js/eslint-plugin-import/pull/3049
[#3039]: https://github.com/import-js/eslint-plugin-import/pull/3039
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
@@ -204,6 +208,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@brettz9]: https://github.com/brettz9
[@christophercurrie]: https://github.com/christophercurrie
[@DMartens]: https://github.com/DMartens
+[@G-Rath]: https://github.com/G-Rath
[@hulkish]: https://github.com/hulkish
[@Hypnosphi]: https://github.com/Hypnosphi
[@iamnapo]: https://github.com/iamnapo
diff --git a/utils/parse.js b/utils/parse.js
index 75d527b008..21a443eca4 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -161,7 +161,7 @@ exports.default = function parse(path, content, context) {
if (!ast || typeof ast !== 'object') {
console.warn(
// Can only be invalid for custom parser per imports/parser
- '`parseForESLint` from parser `' + (typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`') + '` is invalid and will just be ignored'
+ '`parseForESLint` from parser `' + (typeof parserOrPath === 'string' ? parserOrPath : 'context.languageOptions.parser') + '` is invalid and will just be ignored'
);
} else {
// @ts-expect-error TODO: FIXME
From d66933cb1df96812fc36a08c27b062e271f7581a Mon Sep 17 00:00:00 2001
From: Joshua O'Brien <joshua.obrien@tutanota.com>
Date: Fri, 20 Sep 2024 18:37:04 +1000
Subject: [PATCH 148/199] [Docs] `no-relative-packages`: fix typo
---
CHANGELOG.md | 5 +++++
docs/rules/no-relative-packages.md | 3 +--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4e7ef808eb..32899988a3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
- [`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export ([#3032], thanks [@akwodkiewicz])
+### Changed
+- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
+
## [2.30.0] - 2024-09-02
### Added
@@ -1136,6 +1139,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
[#3043]: https://github.com/import-js/eslint-plugin-import/pull/3043
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
@@ -1840,6 +1844,7 @@ for info on changes for earlier releases.
[@johnthagen]: https://github.com/johnthagen
[@jonboiser]: https://github.com/jonboiser
[@josh]: https://github.com/josh
+[@joshuaobrien]: https://github.com/joshuaobrien
[@JounQin]: https://github.com/JounQin
[@jquense]: https://github.com/jquense
[@jseminck]: https://github.com/jseminck
diff --git a/docs/rules/no-relative-packages.md b/docs/rules/no-relative-packages.md
index 4014ed9859..ed724a9ebe 100644
--- a/docs/rules/no-relative-packages.md
+++ b/docs/rules/no-relative-packages.md
@@ -6,8 +6,7 @@
Use this rule to prevent importing packages through relative paths.
-It's useful in Yarn/Lerna workspaces, were it's possible to import a sibling
-package using `../package` relative path, while direct `package` is the correct one.
+It's useful in Yarn/Lerna workspaces, where it's possible to import a sibling package using `../package` relative path, while direct `package` is the correct one.
## Examples
From 6075b9cb579022f45c2d132e1fbaa22976ca87c4 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Sun, 15 Sep 2024 10:10:47 -0500
Subject: [PATCH 149/199] [utils] [fix] `parse`: espree parser isn't working
with flat config
This change addresses an issue with using the espree parser with flat config. `keysFromParser` is responsible for finding the `visitorKeys` from a combination of the parser instance, parserPath, and the results of a call to `parseForESLint`. When using flat config, the `parserPath` will not be on the context object., and there are no results from `parseForESLint`. The espree parser _does_ provide visitor keys as a prop on the parser itself. However, this logic was only returning it when it found that "espree" was somewhere in the `parserPath` (which doesn't exist on flat config).
I changed it so that it first does the check for the old-school babel parser using parser path, and then just checks the parser instance for the presence of `VisitorKeys`, rather than using parserPath at all. The reason for the re-order is that if the old babel-eslint parser, for some reason has `VisitorKeys`, having the new condition first, would change the behavior.
---
.nycrc | 3 ++-
examples/flat/eslint.config.mjs | 1 +
examples/flat/src/depth-zero.js | 3 +++
examples/flat/src/es6/depth-one-dynamic.js | 3 +++
examples/legacy/.eslintrc.cjs | 1 +
examples/legacy/src/depth-zero.js | 3 +++
examples/legacy/src/es6/depth-one-dynamic.js | 3 +++
utils/CHANGELOG.md | 2 ++
utils/parse.js | 12 +++++++++---
9 files changed, 27 insertions(+), 4 deletions(-)
create mode 100644 examples/flat/src/depth-zero.js
create mode 100644 examples/flat/src/es6/depth-one-dynamic.js
create mode 100644 examples/legacy/src/depth-zero.js
create mode 100644 examples/legacy/src/es6/depth-one-dynamic.js
diff --git a/.nycrc b/.nycrc
index 5d75e2157c..c5396cb18c 100644
--- a/.nycrc
+++ b/.nycrc
@@ -14,6 +14,7 @@
"resolvers/*/test",
"scripts",
"memo-parser",
- "lib"
+ "lib",
+ "examples"
]
}
diff --git a/examples/flat/eslint.config.mjs b/examples/flat/eslint.config.mjs
index 370514a65b..1432652658 100644
--- a/examples/flat/eslint.config.mjs
+++ b/examples/flat/eslint.config.mjs
@@ -20,6 +20,7 @@ export default [
'import/no-dynamic-require': 'warn',
'import/no-nodejs-modules': 'warn',
'import/no-unused-modules': ['warn', { unusedExports: true }],
+ 'import/no-cycle': 'warn',
},
},
];
diff --git a/examples/flat/src/depth-zero.js b/examples/flat/src/depth-zero.js
new file mode 100644
index 0000000000..8cfde99795
--- /dev/null
+++ b/examples/flat/src/depth-zero.js
@@ -0,0 +1,3 @@
+import { foo } from "./es6/depth-one-dynamic";
+
+foo();
diff --git a/examples/flat/src/es6/depth-one-dynamic.js b/examples/flat/src/es6/depth-one-dynamic.js
new file mode 100644
index 0000000000..ca129fd622
--- /dev/null
+++ b/examples/flat/src/es6/depth-one-dynamic.js
@@ -0,0 +1,3 @@
+export function foo() {}
+
+export const bar = () => import("../depth-zero").then(({foo}) => foo);
diff --git a/examples/legacy/.eslintrc.cjs b/examples/legacy/.eslintrc.cjs
index e3cec097f0..90e065c9dc 100644
--- a/examples/legacy/.eslintrc.cjs
+++ b/examples/legacy/.eslintrc.cjs
@@ -20,5 +20,6 @@ module.exports = {
'import/no-dynamic-require': 'warn',
'import/no-nodejs-modules': 'warn',
'import/no-unused-modules': ['warn', { unusedExports: true }],
+ 'import/no-cycle': 'warn',
},
};
diff --git a/examples/legacy/src/depth-zero.js b/examples/legacy/src/depth-zero.js
new file mode 100644
index 0000000000..8cfde99795
--- /dev/null
+++ b/examples/legacy/src/depth-zero.js
@@ -0,0 +1,3 @@
+import { foo } from "./es6/depth-one-dynamic";
+
+foo();
diff --git a/examples/legacy/src/es6/depth-one-dynamic.js b/examples/legacy/src/es6/depth-one-dynamic.js
new file mode 100644
index 0000000000..cda7091cdc
--- /dev/null
+++ b/examples/legacy/src/es6/depth-one-dynamic.js
@@ -0,0 +1,3 @@
+export function foo() {}
+
+export const bar = () => import("../depth-zero").then(({ foo }) => foo);
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index ca733eee05..94fc20f7d9 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -7,6 +7,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- `parse`: remove unneeded extra backticks ([#3057], thanks [@G-Rath])
+- `parse`: espree parser isn't working with flat config ([#3061], thanks [@michaelfaith])
## v2.11.0 - 2024-09-05
@@ -168,6 +169,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3061]: https://github.com/import-js/eslint-plugin-import/pull/3061
[#3057]: https://github.com/import-js/eslint-plugin-import/pull/3057
[#3049]: https://github.com/import-js/eslint-plugin-import/pull/3049
[#3039]: https://github.com/import-js/eslint-plugin-import/pull/3039
diff --git a/utils/parse.js b/utils/parse.js
index 21a443eca4..a419371662 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -29,12 +29,18 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
if (parsedResult && parsedResult.visitorKeys) {
return parsedResult.visitorKeys;
}
- if (typeof parserPath === 'string' && (/.*espree.*/).test(parserPath)) {
- return parserInstance.VisitorKeys;
- }
+ // The old babel parser doesn't have a `parseForESLint` eslint function, so we don't end
+ // up with a `parsedResult` here. It also doesn't expose the visitor keys on the parser itself,
+ // so we have to try and infer the visitor-keys module from the parserPath.
+ // This is NOT supported in flat config!
if (typeof parserPath === 'string' && (/.*babel-eslint.*/).test(parserPath)) {
return getBabelEslintVisitorKeys(parserPath);
}
+ // The espree parser doesn't have the `parseForESLint` function, so we don't ended up with a
+ // `parsedResult` here, but it does expose the visitor keys on the parser instance that we can use.
+ if (parserInstance && parserInstance.VisitorKeys) {
+ return parserInstance.VisitorKeys;
+ }
return null;
}
From 0642419aeee4de20f006b1aee1f04510eeb1e6fb Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Wed, 18 Sep 2024 17:01:51 -0500
Subject: [PATCH 150/199] [utils] [fix] `parse`: add `ecmaVersion` and
`sourceType` to `parserOptions`
This change adds `ecmaVersion` and `sourceType` to the options we're passing to the parsers, if they're present on `languageOptions` (which would only be the case for flat config).
---
tests/src/core/parse.js | 14 ++++++++++++++
utils/CHANGELOG.md | 1 +
utils/parse.js | 16 ++++++++++++++--
3 files changed, 29 insertions(+), 2 deletions(-)
diff --git a/tests/src/core/parse.js b/tests/src/core/parse.js
index 275b93982b..b213268907 100644
--- a/tests/src/core/parse.js
+++ b/tests/src/core/parse.js
@@ -138,4 +138,18 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
parseStubParser.parse = parseSpy;
expect(parse.bind(null, path, content, { settings: {}, parserPath: 'espree', languageOptions: { parserOptions: { sourceType: 'module', ecmaVersion: 2015, ecmaFeatures: { jsx: true } } }, parserOptions: { sourceType: 'script' } })).not.to.throw(Error);
});
+
+ it('passes ecmaVersion and sourceType from languageOptions to parser', () => {
+ const parseSpy = sinon.spy();
+ const languageOptions = { ecmaVersion: 'latest', sourceType: 'module', parserOptions: { ecmaFeatures: { jsx: true } } };
+ parseStubParser.parse = parseSpy;
+ parse(path, content, { settings: {}, parserPath: parseStubParserPath, languageOptions });
+ expect(parseSpy.args[0][1], 'custom parser to clone the parserOptions object').to.not.equal(languageOptions);
+ expect(parseSpy.args[0][1], 'custom parser to get ecmaFeatures in parserOptions which is a clone of ecmaFeatures passed in')
+ .to.have.property('ecmaFeatures')
+ .that.is.eql(languageOptions.parserOptions.ecmaFeatures)
+ .and.is.not.equal(languageOptions.parserOptions.ecmaFeatures);
+ expect(parseSpy.args[0][1], 'custom parser to get ecmaVersion in parserOptions from languageOptions').to.have.property('ecmaVersion', languageOptions.ecmaVersion);
+ expect(parseSpy.args[0][1], 'custom parser to get sourceType in parserOptions from languageOptions').to.have.property('sourceType', languageOptions.sourceType);
+ });
});
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 94fc20f7d9..704a282da5 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- `parse`: remove unneeded extra backticks ([#3057], thanks [@G-Rath])
- `parse`: espree parser isn't working with flat config ([#3061], thanks [@michaelfaith])
+- `parse`: add `ecmaVersion` and `sourceType` to `parserOptions` ([#3061], thanks [@michaelfaith])
## v2.11.0 - 2024-09-05
diff --git a/utils/parse.js b/utils/parse.js
index a419371662..03022ac401 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -36,7 +36,7 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
if (typeof parserPath === 'string' && (/.*babel-eslint.*/).test(parserPath)) {
return getBabelEslintVisitorKeys(parserPath);
}
- // The espree parser doesn't have the `parseForESLint` function, so we don't ended up with a
+ // The espree parser doesn't have the `parseForESLint` function, so we don't end up with a
// `parsedResult` here, but it does expose the visitor keys on the parser instance that we can use.
if (parserInstance && parserInstance.VisitorKeys) {
return parserInstance.VisitorKeys;
@@ -113,7 +113,8 @@ exports.default = function parse(path, content, context) {
if (context == null) { throw new Error('need context to parse properly'); }
// ESLint in "flat" mode only sets context.languageOptions.parserOptions
- let parserOptions = context.languageOptions && context.languageOptions.parserOptions || context.parserOptions;
+ const languageOptions = context.languageOptions;
+ let parserOptions = languageOptions && languageOptions.parserOptions || context.parserOptions;
const parserOrPath = getParser(path, context);
if (!parserOrPath) { throw new Error('parserPath or languageOptions.parser is required!'); }
@@ -144,6 +145,17 @@ exports.default = function parse(path, content, context) {
delete parserOptions.project;
delete parserOptions.projects;
+ // If this is a flat config, we need to add ecmaVersion and sourceType (if present) from languageOptions
+ if (languageOptions && languageOptions.ecmaVersion) {
+ parserOptions.ecmaVersion = languageOptions.ecmaVersion;
+ }
+ if (languageOptions && languageOptions.sourceType) {
+ // @ts-expect-error languageOptions is from the flatConfig Linter type in 8.57 while parserOptions is not.
+ // Non-flat config parserOptions.sourceType doesn't have "commonjs" in the type. Once upgraded to v9 types,
+ // they'll be the same and this expect-error should be removed.
+ parserOptions.sourceType = languageOptions.sourceType;
+ }
+
// require the parser relative to the main module (i.e., ESLint)
const parser = typeof parserOrPath === 'string' ? moduleRequire(parserOrPath) : parserOrPath;
From 91f944d8e4b1591aa45f7d1b734dc2a2fe9acc57 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 23 Sep 2024 15:34:39 -0700
Subject: [PATCH 151/199] [utils] v2.11.1
---
utils/CHANGELOG.md | 2 ++
utils/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 704a282da5..6e71a26f7c 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.11.1 - 2024-09-23
+
### Fixed
- `parse`: remove unneeded extra backticks ([#3057], thanks [@G-Rath])
- `parse`: espree parser isn't working with flat config ([#3061], thanks [@michaelfaith])
diff --git a/utils/package.json b/utils/package.json
index df63ac1683..709142fafb 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.11.0",
+ "version": "2.11.1",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From a9815dac72e667f1cb9d898022183c428111b2fa Mon Sep 17 00:00:00 2001
From: liuxingbaoyu <30521560+liuxingbaoyu@users.noreply.github.com>
Date: Thu, 19 Sep 2024 21:01:07 +0800
Subject: [PATCH 152/199] [Fix] `export`: False positive for exported
overloaded functions in TS
---
CHANGELOG.md | 3 +++
src/rules/export.js | 48 +++++++++++++--------------------------
tests/src/rules/export.js | 26 +++++++++++++++++++--
3 files changed, 43 insertions(+), 34 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 32899988a3..1dbd46fc7a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
- [`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export ([#3032], thanks [@akwodkiewicz])
+- [`export`]: False positive for exported overloaded functions in TS ([#3065], thanks [@liuxingbaoyu])
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
@@ -1140,6 +1141,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
+[#3065]: https://github.com/import-js/eslint-plugin-import/pull/3065
[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
[#3043]: https://github.com/import-js/eslint-plugin-import/pull/3043
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
@@ -1875,6 +1877,7 @@ for info on changes for earlier releases.
[@lilling]: https://github.com/lilling
[@ljharb]: https://github.com/ljharb
[@ljqx]: https://github.com/ljqx
+[@liuxingbaoyu]: https://github.com/liuxingbaoyu
[@lo1tuma]: https://github.com/lo1tuma
[@loganfsmyth]: https://github.com/loganfsmyth
[@luczsoma]: https://github.com/luczsoma
diff --git a/src/rules/export.js b/src/rules/export.js
index 197a0eb51c..fbbc39d75f 100644
--- a/src/rules/export.js
+++ b/src/rules/export.js
@@ -2,7 +2,6 @@ import ExportMapBuilder from '../exportMap/builder';
import recursivePatternCapture from '../exportMap/patternCapture';
import docsUrl from '../docsUrl';
import includes from 'array-includes';
-import flatMap from 'array.prototype.flatmap';
/*
Notes on TypeScript namespaces aka TSModuleDeclaration:
@@ -27,42 +26,25 @@ const rootProgram = 'root';
const tsTypePrefix = 'type:';
/**
- * Detect function overloads like:
+ * remove function overloads like:
* ```ts
* export function foo(a: number);
* export function foo(a: string);
- * export function foo(a: number|string) { return a; }
* ```
* @param {Set<Object>} nodes
- * @returns {boolean}
*/
-function isTypescriptFunctionOverloads(nodes) {
- const nodesArr = Array.from(nodes);
-
- const idents = flatMap(
- nodesArr,
- (node) => node.declaration && (
- node.declaration.type === 'TSDeclareFunction' // eslint 6+
- || node.declaration.type === 'TSEmptyBodyFunctionDeclaration' // eslint 4-5
- )
- ? node.declaration.id.name
- : [],
- );
- if (new Set(idents).size !== idents.length) {
- return true;
- }
-
- const types = new Set(nodesArr.map((node) => node.parent.type));
- if (!types.has('TSDeclareFunction')) {
- return false;
- }
- if (types.size === 1) {
- return true;
- }
- if (types.size === 2 && types.has('FunctionDeclaration')) {
- return true;
- }
- return false;
+function removeTypescriptFunctionOverloads(nodes) {
+ nodes.forEach((node) => {
+ const declType = node.type === 'ExportDefaultDeclaration' ? node.declaration.type : node.parent.type;
+ if (
+ // eslint 6+
+ declType === 'TSDeclareFunction'
+ // eslint 4-5
+ || declType === 'TSEmptyBodyFunctionDeclaration'
+ ) {
+ nodes.delete(node);
+ }
+ });
}
/**
@@ -227,9 +209,11 @@ module.exports = {
'Program:exit'() {
for (const [, named] of namespace) {
for (const [name, nodes] of named) {
+ removeTypescriptFunctionOverloads(nodes);
+
if (nodes.size <= 1) { continue; }
- if (isTypescriptFunctionOverloads(nodes) || isTypescriptNamespaceMerging(nodes)) { continue; }
+ if (isTypescriptNamespaceMerging(nodes)) { continue; }
for (const node of nodes) {
if (shouldSkipTypescriptNamespace(node, nodes)) { continue; }
diff --git a/tests/src/rules/export.js b/tests/src/rules/export.js
index a7f2bec122..f16a25ecf5 100644
--- a/tests/src/rules/export.js
+++ b/tests/src/rules/export.js
@@ -56,6 +56,15 @@ ruleTester.run('export', rule, {
`,
parser,
})),
+ getTSParsers().map((parser) => ({
+ code: `
+ export default function foo(param: string): boolean;
+ export default function foo(param: string, param1?: number): boolean {
+ return param && param1;
+ }
+ `,
+ parser,
+ })),
),
invalid: [].concat(
@@ -154,6 +163,19 @@ ruleTester.run('export', rule, {
ecmaVersion: 2022,
},
})),
+
+ getTSParsers().map((parser) => ({
+ code: `
+ export default function a(): void;
+ export default function a() {}
+ export { x as default };
+ `,
+ errors: [
+ 'Multiple default exports.',
+ 'Multiple default exports.',
+ ],
+ parser,
+ })),
),
});
@@ -510,7 +532,7 @@ context('TypeScript', function () {
}),
test({
code: `
- export function Foo();
+ export function Foo() { };
export class Foo { }
export namespace Foo { }
`,
@@ -529,7 +551,7 @@ context('TypeScript', function () {
test({
code: `
export const Foo = 'bar';
- export function Foo();
+ export function Foo() { };
export namespace Foo { }
`,
errors: [
From 5c9757c5ac1a0e32392333f60f9e1f11dc53aebf Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 23 Sep 2024 22:30:42 -0700
Subject: [PATCH 153/199] [Refactor] add some more type info; switch for-ofs to
forEaches
---
src/rules/consistent-type-specifier-style.js | 19 ++++++-
src/rules/no-cycle.js | 4 +-
src/rules/no-duplicates.js | 34 +++++++----
src/rules/no-mutable-exports.js | 59 ++++++++++----------
4 files changed, 72 insertions(+), 44 deletions(-)
diff --git a/src/rules/consistent-type-specifier-style.js b/src/rules/consistent-type-specifier-style.js
index ee5ff9fbc6..84c33ecd81 100644
--- a/src/rules/consistent-type-specifier-style.js
+++ b/src/rules/consistent-type-specifier-style.js
@@ -6,6 +6,12 @@ function isComma(token) {
return token.type === 'Punctuator' && token.value === ',';
}
+/**
+ * @param {import('eslint').Rule.Fix[]} fixes
+ * @param {import('eslint').Rule.RuleFixer} fixer
+ * @param {import('eslint').SourceCode.SourceCode} sourceCode
+ * @param {(ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier)[]} specifiers
+ * */
function removeSpecifiers(fixes, fixer, sourceCode, specifiers) {
for (const specifier of specifiers) {
// remove the trailing comma
@@ -17,6 +23,7 @@ function removeSpecifiers(fixes, fixer, sourceCode, specifiers) {
}
}
+/** @type {(node: import('estree').Node, sourceCode: import('eslint').SourceCode.SourceCode, specifiers: (ImportSpecifier | ImportNamespaceSpecifier)[], kind: 'type' | 'typeof') => string} */
function getImportText(
node,
sourceCode,
@@ -38,6 +45,7 @@ function getImportText(
return `import ${kind} {${names.join(', ')}} from ${sourceString};`;
}
+/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
meta: {
type: 'suggestion',
@@ -102,6 +110,7 @@ module.exports = {
// prefer-top-level
return {
+ /** @param {import('estree').ImportDeclaration} node */
ImportDeclaration(node) {
if (
// already top-level is valid
@@ -120,9 +129,13 @@ module.exports = {
return;
}
+ /** @type {typeof node.specifiers} */
const typeSpecifiers = [];
+ /** @type {typeof node.specifiers} */
const typeofSpecifiers = [];
+ /** @type {typeof node.specifiers} */
const valueSpecifiers = [];
+ /** @type {typeof node.specifiers[number]} */
let defaultSpecifier = null;
for (const specifier of node.specifiers) {
if (specifier.type === 'ImportDefaultSpecifier') {
@@ -144,6 +157,7 @@ module.exports = {
const newImports = `${typeImport}\n${typeofImport}`.trim();
if (typeSpecifiers.length + typeofSpecifiers.length === node.specifiers.length) {
+ /** @type {('type' | 'typeof')[]} */
// all specifiers have inline specifiers - so we replace the entire import
const kind = [].concat(
typeSpecifiers.length > 0 ? 'type' : [],
@@ -162,7 +176,7 @@ module.exports = {
});
} else {
// remove specific specifiers and insert new imports for them
- for (const specifier of typeSpecifiers.concat(typeofSpecifiers)) {
+ typeSpecifiers.concat(typeofSpecifiers).forEach((specifier) => {
context.report({
node: specifier,
message: 'Prefer using a top-level {{kind}}-only import instead of inline {{kind}} specifiers.',
@@ -170,6 +184,7 @@ module.exports = {
kind: specifier.importKind,
},
fix(fixer) {
+ /** @type {import('eslint').Rule.Fix[]} */
const fixes = [];
// if there are no value specifiers, then the other report fixer will be called, not this one
@@ -215,7 +230,7 @@ module.exports = {
);
},
});
- }
+ });
}
},
};
diff --git a/src/rules/no-cycle.js b/src/rules/no-cycle.js
index d7c748d807..713503d9f8 100644
--- a/src/rules/no-cycle.js
+++ b/src/rules/no-cycle.js
@@ -152,9 +152,9 @@ module.exports = {
*/
if (path === myPath && toTraverse.length > 0) { return true; }
if (route.length + 1 < maxDepth) {
- for (const { source } of toTraverse) {
+ toTraverse.forEach(({ source }) => {
untraversed.push({ mget: getter, route: route.concat(source) });
- }
+ });
}
}
}
diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
index 32557802fa..b8c8d848ca 100644
--- a/src/rules/no-duplicates.js
+++ b/src/rules/no-duplicates.js
@@ -74,6 +74,7 @@ function hasProblematicComments(node, sourceCode) {
);
}
+/** @type {(first: import('estree').ImportDeclaration, rest: import('estree').ImportDeclaration[], sourceCode: import('eslint').SourceCode.SourceCode, context: import('eslint').Rule.RuleContext) => import('eslint').Rule.ReportFixer | undefined} */
function getFix(first, rest, sourceCode, context) {
// Sorry ESLint <= 3 users, no autofix for you. Autofixing duplicate imports
// requires multiple `fixer.whatever()` calls in the `fix`: We both need to
@@ -123,7 +124,7 @@ function getFix(first, rest, sourceCode, context) {
isEmpty: !hasSpecifiers(node),
};
})
- .filter(Boolean);
+ .filter((x) => !!x);
const unnecessaryImports = restWithoutComments.filter((node) => !hasSpecifiers(node)
&& !hasNamespace(node)
@@ -139,6 +140,7 @@ function getFix(first, rest, sourceCode, context) {
return undefined;
}
+ /** @type {import('eslint').Rule.ReportFixer} */
return (fixer) => {
const tokens = sourceCode.getTokens(first);
const openBrace = tokens.find((token) => isPunctuator(token, '{'));
@@ -185,6 +187,7 @@ function getFix(first, rest, sourceCode, context) {
['', !firstHasTrailingComma && !firstIsEmpty, firstExistingIdentifiers],
);
+ /** @type {import('eslint').Rule.Fix[]} */
const fixes = [];
if (shouldAddSpecifiers && preferInline && first.importKind === 'type') {
@@ -228,7 +231,7 @@ function getFix(first, rest, sourceCode, context) {
}
// Remove imports whose specifiers have been moved into the first import.
- for (const specifier of specifiers) {
+ specifiers.forEach((specifier) => {
const importNode = specifier.importNode;
fixes.push(fixer.remove(importNode));
@@ -237,12 +240,12 @@ function getFix(first, rest, sourceCode, context) {
if (charAfterImport === '\n') {
fixes.push(fixer.removeRange(charAfterImportRange));
}
- }
+ });
// Remove imports whose default import has been moved to the first import,
// and side-effect-only imports that are unnecessary due to the first
// import.
- for (const node of unnecessaryImports) {
+ unnecessaryImports.forEach((node) => {
fixes.push(fixer.remove(node));
const charAfterImportRange = [node.range[1], node.range[1] + 1];
@@ -250,12 +253,13 @@ function getFix(first, rest, sourceCode, context) {
if (charAfterImport === '\n') {
fixes.push(fixer.removeRange(charAfterImportRange));
}
- }
+ });
return fixes;
};
}
+/** @type {(imported: Map<string, import('estree').ImportDeclaration[]>, context: import('eslint').Rule.RuleContext) => void} */
function checkImports(imported, context) {
for (const [module, nodes] of imported.entries()) {
if (nodes.length > 1) {
@@ -270,16 +274,17 @@ function checkImports(imported, context) {
fix, // Attach the autofix (if any) to the first import.
});
- for (const node of rest) {
+ rest.forEach((node) => {
context.report({
node: node.source,
message,
});
- }
+ });
}
}
}
+/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
meta: {
type: 'problem',
@@ -305,10 +310,13 @@ module.exports = {
],
},
+ /** @param {import('eslint').Rule.RuleContext} context */
create(context) {
+ /** @type {boolean} */
// Prepare the resolver from options.
- const considerQueryStringOption = context.options[0]
- && context.options[0].considerQueryString;
+ const considerQueryStringOption = context.options[0] && context.options[0].considerQueryString;
+ /** @type {boolean} */
+ const preferInline = context.options[0] && context.options[0]['prefer-inline'];
const defaultResolver = (sourcePath) => resolve(sourcePath, context) || sourcePath;
const resolver = considerQueryStringOption ? (sourcePath) => {
const parts = sourcePath.match(/^([^?]*)\?(.*)$/);
@@ -318,11 +326,14 @@ module.exports = {
return `${defaultResolver(parts[1])}?${parts[2]}`;
} : defaultResolver;
+ /** @type {Map<unknown, { imported: Map<string, import('estree').ImportDeclaration[]>, nsImported: Map<string, import('estree').ImportDeclaration[]>, defaultTypesImported: Map<string, import('estree').ImportDeclaration[]>, namedTypesImported: Map<string, import('estree').ImportDeclaration[]>}>} */
const moduleMaps = new Map();
+ /** @param {import('estree').ImportDeclaration} n */
+ /** @returns {typeof moduleMaps[keyof typeof moduleMaps]} */
function getImportMap(n) {
if (!moduleMaps.has(n.parent)) {
- moduleMaps.set(n.parent, {
+ moduleMaps.set(n.parent, /** @type {typeof moduleMaps} */ {
imported: new Map(),
nsImported: new Map(),
defaultTypesImported: new Map(),
@@ -330,7 +341,6 @@ module.exports = {
});
}
const map = moduleMaps.get(n.parent);
- const preferInline = context.options[0] && context.options[0]['prefer-inline'];
if (!preferInline && n.importKind === 'type') {
return n.specifiers.length > 0 && n.specifiers[0].type === 'ImportDefaultSpecifier' ? map.defaultTypesImported : map.namedTypesImported;
}
@@ -342,7 +352,9 @@ module.exports = {
}
return {
+ /** @param {import('estree').ImportDeclaration} n */
ImportDeclaration(n) {
+ /** @type {string} */
// resolved path will cover aliased duplicates
const resolvedPath = resolver(n.source.value);
const importMap = getImportMap(n);
diff --git a/src/rules/no-mutable-exports.js b/src/rules/no-mutable-exports.js
index c3d18b2c99..0a0e128dc0 100644
--- a/src/rules/no-mutable-exports.js
+++ b/src/rules/no-mutable-exports.js
@@ -2,6 +2,7 @@ import { getScope } from 'eslint-module-utils/contextCompat';
import docsUrl from '../docsUrl';
+/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
meta: {
type: 'suggestion',
@@ -21,41 +22,41 @@ module.exports = {
}
}
+ /** @type {(scope: import('eslint').Scope.Scope, name: string) => void} */
function checkDeclarationsInScope({ variables }, name) {
- for (const variable of variables) {
- if (variable.name === name) {
- for (const def of variable.defs) {
- if (def.type === 'Variable' && def.parent) {
+ variables
+ .filter((variable) => variable.name === name)
+ .forEach((variable) => {
+ variable.defs
+ .filter((def) => def.type === 'Variable' && def.parent)
+ .forEach((def) => {
checkDeclaration(def.parent);
- }
- }
- }
- }
- }
-
- function handleExportDefault(node) {
- const scope = getScope(context, node);
-
- if (node.declaration.name) {
- checkDeclarationsInScope(scope, node.declaration.name);
- }
+ });
+ });
}
- function handleExportNamed(node) {
- const scope = getScope(context, node);
+ return {
+ /** @param {import('estree').ExportDefaultDeclaration} node */
+ ExportDefaultDeclaration(node) {
+ const scope = getScope(context, node);
- if (node.declaration) {
- checkDeclaration(node.declaration);
- } else if (!node.source) {
- for (const specifier of node.specifiers) {
- checkDeclarationsInScope(scope, specifier.local.name);
+ if ('name' in node.declaration && node.declaration.name) {
+ checkDeclarationsInScope(scope, node.declaration.name);
}
- }
- }
-
- return {
- ExportDefaultDeclaration: handleExportDefault,
- ExportNamedDeclaration: handleExportNamed,
+ },
+
+ /** @param {import('estree').ExportNamedDeclaration} node */
+ ExportNamedDeclaration(node) {
+ const scope = getScope(context, node);
+
+ if ('declaration' in node && node.declaration) {
+ checkDeclaration(node.declaration);
+ } else if (!('source' in node) || !node.source) {
+ node.specifiers.forEach((specifier) => {
+ checkDeclarationsInScope(scope, specifier.local.name);
+ });
+ }
+ },
};
},
};
From f1db531f3f468ef1f5581b7b82111c17e389cf4e Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Mon, 23 Sep 2024 18:11:12 +0300
Subject: [PATCH 154/199] [Performance] `no-cycle`: dont scc for each linted
file
---
CHANGELOG.md | 2 ++
src/scc.js | 10 ++++++++--
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1dbd46fc7a..e40edde5eb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
+- [Performance] [`no-cycle`]: dont scc for each linted file ([#3068], thanks [@soryy708])
## [2.30.0] - 2024-09-02
@@ -1140,6 +1141,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3068]: https://github.com/import-js/eslint-plugin-import/pull/3068
[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
[#3065]: https://github.com/import-js/eslint-plugin-import/pull/3065
[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
diff --git a/src/scc.js b/src/scc.js
index 44c818bbe1..c2b2c637dc 100644
--- a/src/scc.js
+++ b/src/scc.js
@@ -18,12 +18,18 @@ export default class StronglyConnectedComponentsBuilder {
}
static for(context) {
- const cacheKey = context.cacheKey || hashObject(context).digest('hex');
+ const settingsHash = hashObject({
+ settings: context.settings,
+ parserOptions: context.parserOptions,
+ parserPath: context.parserPath,
+ }).digest('hex');
+ const cacheKey = context.path + settingsHash;
if (cache.has(cacheKey)) {
return cache.get(cacheKey);
}
const scc = StronglyConnectedComponentsBuilder.calculate(context);
- cache.set(cacheKey, scc);
+ const visitedFiles = Object.keys(scc);
+ visitedFiles.forEach((filePath) => cache.set(filePath + settingsHash, scc));
return scc;
}
From 3ecc727d6dd7474deb7f91ef6d174065e2bb5580 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 24 Sep 2024 21:51:15 -0700
Subject: [PATCH 155/199] [Deps] update `eslint-module-utils`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index eda679b819..1126b19836 100644
--- a/package.json
+++ b/package.json
@@ -117,7 +117,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.11.0",
+ "eslint-module-utils": "^2.11.1",
"hasown": "^2.0.2",
"is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
From cae364c2732cf6f49e5d85961df8cd9e8fc0fe2c Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 12 Apr 2024 14:49:34 +1200
Subject: [PATCH 156/199] [Tests] don't include output when nothing has been
changed
---
tests/src/rule-tester.js | 3 +
tests/src/rules/dynamic-import-chunkname.js | 554 +++++---------------
tests/src/rules/newline-after-import.js | 47 +-
tests/src/rules/no-commonjs.js | 47 +-
tests/src/rules/no-duplicates.js | 145 ++---
tests/src/rules/no-namespace.js | 16 +-
tests/src/rules/order.js | 116 +---
tests/src/rules/unambiguous.js | 6 +-
8 files changed, 251 insertions(+), 683 deletions(-)
create mode 100644 tests/src/rule-tester.js
diff --git a/tests/src/rule-tester.js b/tests/src/rule-tester.js
new file mode 100644
index 0000000000..89c5846120
--- /dev/null
+++ b/tests/src/rule-tester.js
@@ -0,0 +1,3 @@
+export function withoutAutofixOutput(test) {
+ return { ...test, output: test.code };
+}
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index 81e018af76..1362196728 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -1,5 +1,6 @@
import { SYNTAX_CASES, getTSParsers, parsers } from '../utils';
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import semver from 'semver';
const rule = require('rules/dynamic-import-chunkname');
@@ -423,225 +424,172 @@ ruleTester.run('dynamic-import-chunkname', rule, {
],
invalid: [
- {
+ withoutAutofixOutput({
code: `import(
// webpackChunkName: "someModule"
'someModule'
)`,
options,
parser,
- output: `import(
- // webpackChunkName: "someModule"
- 'someModule'
- )`,
errors: [{
message: nonBlockCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: 'import(\'test\')',
options,
parser,
- output: 'import(\'test\')',
errors: [{
message: noLeadingCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: someModule */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: someModule */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule' */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: "someModule' */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: 'someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: 'someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName:"someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName:"someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: true */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: true */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "my-module-[id]" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: "my-module-[id]" */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: ["request"] */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: ["request"] */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/*webpackChunkName: "someModule"*/
'someModule'
)`,
options,
parser,
- output: `import(
- /*webpackChunkName: "someModule"*/
- 'someModule'
- )`,
errors: [{
message: noPaddingCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName : "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName : "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule" ; */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: "someModule" ; */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* totally not webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* totally not webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: true */
/* webpackChunk: "someModule" */
@@ -649,339 +597,253 @@ ruleTester.run('dynamic-import-chunkname', rule, {
)`,
options,
parser,
- output: `import(
- /* webpackPrefetch: true */
- /* webpackChunk: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: true, webpackChunk: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackPrefetch: true, webpackChunk: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule123" */
'someModule'
)`,
options: pickyCommentOptions,
parser,
- output: `import(
- /* webpackChunkName: "someModule123" */
- 'someModule'
- )`,
errors: [{
message: pickyChunkNameFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: "module", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackPrefetch: "module", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPreload: "module", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackPreload: "module", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackIgnore: "no", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackIgnore: "no", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackInclude: "someModule", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackInclude: "someModule", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackInclude: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackInclude: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExclude: "someModule", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackExclude: "someModule", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExclude: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackExclude: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackMode: "fast", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackMode: "fast", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackMode: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackMode: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExports: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackExports: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExports: /default/, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser,
- output: `import(
- /* webpackExports: /default/, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
/* webpackChunkName "someModule" */
'someModule'
)`,
options: multipleImportFunctionOptions,
- output: `dynamicImport(
- /* webpackChunkName "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `definitelyNotStaticImport(
/* webpackChunkName "someModule" */
'someModule'
)`,
options: multipleImportFunctionOptions,
- output: `definitelyNotStaticImport(
- /* webpackChunkName "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
// webpackChunkName: "someModule"
'someModule'
)`,
options,
- output: `dynamicImport(
- // webpackChunkName: "someModule"
- 'someModule'
- )`,
errors: [{
message: nonBlockCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: 'dynamicImport(\'test\')',
options,
- output: 'dynamicImport(\'test\')',
errors: [{
message: noLeadingCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
/* webpackChunkName: someModule */
'someModule'
)`,
options,
- output: `dynamicImport(
- /* webpackChunkName: someModule */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
/* webpackChunkName "someModule" */
'someModule'
)`,
options,
- output: `dynamicImport(
- /* webpackChunkName "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
/* webpackChunkName:"someModule" */
'someModule'
)`,
options,
- output: `dynamicImport(
- /* webpackChunkName:"someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `dynamicImport(
/* webpackChunkName: "someModule123" */
'someModule'
)`,
options: pickyCommentOptions,
- output: `dynamicImport(
- /* webpackChunkName: "someModule123" */
- 'someModule'
- )`,
errors: [{
message: pickyChunkNameFormatError,
type: 'CallExpression',
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule" */
/* webpackMode: "eager" */
@@ -989,11 +851,6 @@ ruleTester.run('dynamic-import-chunkname', rule, {
)`,
options,
parser,
- output: `import(
- /* webpackChunkName: "someModule" */
- /* webpackMode: "eager" */
- 'someModule'
- )`,
errors: [{
message: eagerModeError,
type: 'CallExpression',
@@ -1016,7 +873,7 @@ ruleTester.run('dynamic-import-chunkname', rule, {
},
],
}],
- },
+ }),
],
});
@@ -1343,177 +1200,136 @@ context('TypeScript', () => {
},
],
invalid: [
- {
+ withoutAutofixOutput({
code: `import(
// webpackChunkName: "someModule"
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- // webpackChunkName: "someModule"
- 'someModule'
- )`,
errors: [{
message: nonBlockCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: 'import(\'test\')',
options,
parser: typescriptParser,
- output: 'import(\'test\')',
errors: [{
message: noLeadingCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: someModule */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: someModule */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName "someModule' */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName "someModule' */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName 'someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName 'someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName:"someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName:"someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/*webpackChunkName: "someModule"*/
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /*webpackChunkName: "someModule"*/
- 'someModule'
- )`,
errors: [{
message: noPaddingCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName : "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName : "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule" ; */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: "someModule" ; */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* totally not webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* totally not webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: invalidSyntaxCommentError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: true */
/* webpackChunk: "someModule" */
@@ -1521,283 +1337,210 @@ context('TypeScript', () => {
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackPrefetch: true */
- /* webpackChunk: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: true, webpackChunk: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackPrefetch: true, webpackChunk: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: true */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: true */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "my-module-[id]" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: "my-module-[id]" */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: ["request"] */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: ["request"] */
- 'someModule'
- )`,
errors: [{
message: chunkNameFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule123" */
'someModule'
)`,
options: pickyCommentOptions,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: "someModule123" */
- 'someModule'
- )`,
errors: [{
message: pickyChunkNameFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPrefetch: "module", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackPrefetch: "module", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackPreload: "module", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackPreload: "module", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackIgnore: "no", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackIgnore: "no", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackInclude: "someModule", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackInclude: "someModule", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackInclude: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackInclude: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExclude: "someModule", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackExclude: "someModule", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExclude: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackExclude: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackMode: "fast", webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackMode: "fast", webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackMode: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackMode: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExports: true, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackExports: true, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackExports: /default/, webpackChunkName: "someModule" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackExports: /default/, webpackChunkName: "someModule" */
- 'someModule'
- )`,
errors: [{
message: commentFormatError,
type: nodeType,
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import(
/* webpackChunkName: "someModule", webpackMode: "eager" */
'someModule'
)`,
options,
parser: typescriptParser,
- output: `import(
- /* webpackChunkName: "someModule", webpackMode: "eager" */
- 'someModule'
- )`,
errors: [{
message: eagerModeError,
type: nodeType,
@@ -1818,8 +1561,8 @@ context('TypeScript', () => {
},
],
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `
import(
/* webpackMode: "eager", webpackChunkName: "someModule" */
@@ -1828,12 +1571,6 @@ context('TypeScript', () => {
`,
options,
parser: typescriptParser,
- output: `
- import(
- /* webpackMode: "eager", webpackChunkName: "someModule" */
- 'someModule'
- )
- `,
errors: [{
message: eagerModeError,
type: nodeType,
@@ -1858,8 +1595,8 @@ context('TypeScript', () => {
},
],
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `
import(
/* webpackMode: "eager", webpackPrefetch: true, webpackChunkName: "someModule" */
@@ -1868,12 +1605,6 @@ context('TypeScript', () => {
`,
options,
parser: typescriptParser,
- output: `
- import(
- /* webpackMode: "eager", webpackPrefetch: true, webpackChunkName: "someModule" */
- 'someModule'
- )
- `,
errors: [{
message: eagerModeError,
type: nodeType,
@@ -1898,8 +1629,8 @@ context('TypeScript', () => {
},
],
}],
- },
- {
+ }),
+ withoutAutofixOutput({
code: `
import(
/* webpackChunkName: "someModule" */
@@ -1909,13 +1640,6 @@ context('TypeScript', () => {
`,
options,
parser: typescriptParser,
- output: `
- import(
- /* webpackChunkName: "someModule" */
- /* webpackMode: "eager" */
- 'someModule'
- )
- `,
errors: [{
message: eagerModeError,
type: nodeType,
@@ -1942,7 +1666,7 @@ context('TypeScript', () => {
},
],
}],
- },
+ }),
],
});
});
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index b78e891a35..5c827c0d26 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -1,4 +1,5 @@
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
import semver from 'semver';
import { version as tsEslintVersion } from 'typescript-eslint-parser/package.json';
@@ -710,9 +711,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
- {
+ withoutAutofixOutput({
code: `import foo from 'foo';\n\n\n\nexport default function() {};`,
- output: `import foo from 'foo';\n\n\n\nexport default function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -720,10 +720,9 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import foo from 'foo';\n\n\n\n\nexport default function() {};`,
- output: `import foo from 'foo';\n\n\n\n\nexport default function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -731,7 +730,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- },
+ }),
{
code: `import foo from 'foo';\n// some random comment\nexport default function() {};`,
output: `import foo from 'foo';\n\n// some random comment\nexport default function() {};`,
@@ -743,9 +742,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
- {
+ withoutAutofixOutput({
code: `import foo from 'foo';\n// some random comment\n\n\nexport default function() {};`,
- output: `import foo from 'foo';\n// some random comment\n\n\nexport default function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -753,10 +751,9 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- },
- {
+ }),
+ withoutAutofixOutput({
code: `import foo from 'foo';\n// some random comment\n\n\n\nexport default function() {};`,
- output: `import foo from 'foo';\n// some random comment\n\n\n\nexport default function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -764,7 +761,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- },
+ }),
{
code: `import foo from 'foo';\n// some random comment\nexport default function() {};`,
output: `import foo from 'foo';\n\n\n// some random comment\nexport default function() {};`,
@@ -787,9 +784,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
- {
+ withoutAutofixOutput({
code: `import foo from 'foo';\n\n\n\n// some random comment\nexport default function() {};`,
- output: `import foo from 'foo';\n\n\n\n// some random comment\nexport default function() {};`,
options: [{ count: 2, exactCount: true, considerComments: true }],
errors: [{
line: 1,
@@ -797,19 +793,12 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: IMPORT_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- },
- {
+ }),
+ withoutAutofixOutput({
code: `
import foo from 'foo';
- // Some random single line comment
- var bar = 42;
- `,
- output: `
- import foo from 'foo';
-
-
// Some random single line comment
var bar = 42;
`,
@@ -820,7 +809,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
options: [{ considerComments: true, count: 1, exactCount: true }],
- },
+ }),
{
code: `import foo from 'foo';export default function() {};`,
output: `import foo from 'foo';\n\nexport default function() {};`,
@@ -832,9 +821,8 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
}],
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
},
- {
+ withoutAutofixOutput({
code: `const foo = require('foo');\n\n\n\nconst bar = function() {};`,
- output: `const foo = require('foo');\n\n\n\nconst bar = function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -842,10 +830,9 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015 },
- },
- {
+ }),
+ withoutAutofixOutput({
code: `const foo = require('foo');\n\n\n\n// some random comment\nconst bar = function() {};`,
- output: `const foo = require('foo');\n\n\n\n// some random comment\nconst bar = function() {};`,
options: [{ count: 2, exactCount: true }],
errors: [{
line: 1,
@@ -853,7 +840,7 @@ ruleTester.run('newline-after-import', require('rules/newline-after-import'), {
message: REQUIRE_ERROR_MESSAGE_MULTIPLE(2),
}],
parserOptions: { ecmaVersion: 2015 },
- },
+ }),
{
code: `import foo from 'foo';// some random comment\nexport default function() {};`,
output: `import foo from 'foo';\n\n// some random comment\nexport default function() {};`,
diff --git a/tests/src/rules/no-commonjs.js b/tests/src/rules/no-commonjs.js
index b7c0aa803f..9950608a78 100644
--- a/tests/src/rules/no-commonjs.js
+++ b/tests/src/rules/no-commonjs.js
@@ -1,4 +1,5 @@
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
@@ -69,47 +70,41 @@ ruleTester.run('no-commonjs', require('rules/no-commonjs'), {
// imports
...semver.satisfies(eslintPkg.version, '< 4.0.0') ? [] : [
- { code: 'var x = require("x")', output: 'var x = require("x")', errors: [{ message: IMPORT_MESSAGE }] },
- { code: 'x = require("x")', output: 'x = require("x")', errors: [{ message: IMPORT_MESSAGE }] },
- { code: 'require("x")', output: 'require("x")', errors: [{ message: IMPORT_MESSAGE }] },
- { code: 'require(`x`)',
+ withoutAutofixOutput({ code: 'var x = require("x")', errors: [{ message: IMPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'x = require("x")', errors: [{ message: IMPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'require("x")', errors: [{ message: IMPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'require(`x`)',
parserOptions: { ecmaVersion: 2015 },
- output: 'require(`x`)',
errors: [{ message: IMPORT_MESSAGE }],
- },
+ }),
- { code: 'if (typeof window !== "undefined") require("x")',
+ withoutAutofixOutput({ code: 'if (typeof window !== "undefined") require("x")',
options: [{ allowConditionalRequire: false }],
- output: 'if (typeof window !== "undefined") require("x")',
errors: [{ message: IMPORT_MESSAGE }],
- },
- { code: 'if (typeof window !== "undefined") { require("x") }',
+ }),
+ withoutAutofixOutput({ code: 'if (typeof window !== "undefined") { require("x") }',
options: [{ allowConditionalRequire: false }],
- output: 'if (typeof window !== "undefined") { require("x") }',
errors: [{ message: IMPORT_MESSAGE }],
- },
- { code: 'try { require("x") } catch (error) {}',
+ }),
+ withoutAutofixOutput({ code: 'try { require("x") } catch (error) {}',
options: [{ allowConditionalRequire: false }],
- output: 'try { require("x") } catch (error) {}',
errors: [{ message: IMPORT_MESSAGE }],
- },
+ }),
],
// exports
- { code: 'exports.face = "palm"', output: 'exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] },
- { code: 'module.exports.face = "palm"', output: 'module.exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] },
- { code: 'module.exports = face', output: 'module.exports = face', errors: [{ message: EXPORT_MESSAGE }] },
- { code: 'exports = module.exports = {}', output: 'exports = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] },
- { code: 'var x = module.exports = {}', output: 'var x = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] },
- { code: 'module.exports = {}',
+ withoutAutofixOutput({ code: 'exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'module.exports.face = "palm"', errors: [{ message: EXPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'module.exports = face', errors: [{ message: EXPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'exports = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'var x = module.exports = {}', errors: [{ message: EXPORT_MESSAGE }] }),
+ withoutAutofixOutput({ code: 'module.exports = {}',
options: ['allow-primitive-modules'],
- output: 'module.exports = {}',
errors: [{ message: EXPORT_MESSAGE }],
- },
- { code: 'var x = module.exports',
+ }),
+ withoutAutofixOutput({ code: 'var x = module.exports',
options: ['allow-primitive-modules'],
- output: 'var x = module.exports',
errors: [{ message: EXPORT_MESSAGE }],
- },
+ }),
],
});
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index c46f9df85d..a48e4d3f74 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -3,6 +3,7 @@ import { test as testUtil, getNonDefaultParsers, parsers, tsVersionSatisfies, ty
import jsxConfig from '../../../config/react';
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
@@ -96,15 +97,14 @@ ruleTester.run('no-duplicates', rule, {
}),
// #86: duplicate unresolved modules should be flagged
- test({
+ // Autofix bail because of different default import names.
+ test(withoutAutofixOutput({
code: "import foo from 'non-existent'; import bar from 'non-existent';",
- // Autofix bail because of different default import names.
- output: "import foo from 'non-existent'; import bar from 'non-existent';",
errors: [
"'non-existent' imported multiple times.",
"'non-existent' imported multiple times.",
],
- }),
+ })),
test({
code: "import type { x } from './foo'; import type { y } from './foo'",
@@ -227,12 +227,11 @@ ruleTester.run('no-duplicates', rule, {
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
}),
- test({
+ // Autofix bail because cannot merge namespace imports.
+ test(withoutAutofixOutput({
code: "import * as ns1 from './foo'; import * as ns2 from './foo'",
- // Autofix bail because cannot merge namespace imports.
- output: "import * as ns1 from './foo'; import * as ns2 from './foo'",
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
+ })),
test({
code: "import * as ns from './foo'; import {x} from './foo'; import {y} from './foo'",
@@ -248,89 +247,57 @@ ruleTester.run('no-duplicates', rule, {
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
}),
- test({
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
// some-tool-disable-next-line
import {x} from './foo'
import {//y\ny} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- // some-tool-disable-next-line
- import {x} from './foo'
- import {//y\ny} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
// some-tool-disable-next-line
import {y} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- // some-tool-disable-next-line
- import {y} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo' // some-tool-disable-line
import {y} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo' // some-tool-disable-line
- import {y} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import {y} from './foo' // some-tool-disable-line
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import {y} from './foo' // some-tool-disable-line
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
/* comment */ import {y} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- /* comment */ import {y} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import {y} from './foo' /* comment
multiline */
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import {y} from './foo' /* comment
- multiline */
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
+ })),
test({
code: `
@@ -361,75 +328,48 @@ import {x,y} from './foo'
`,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
}),
-
- test({
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import/* comment */{y} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import/* comment */{y} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import/* comment */'./foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import/* comment */'./foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import{y}/* comment */from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import{y}/* comment */from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from './foo'
import{y}from/* comment */'./foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from './foo'
- import{y}from/* comment */'./foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
-
- test({
+ })),
+ // Autofix bail because of comment.
+ test(withoutAutofixOutput({
code: `
import {x} from
// some-tool-disable-next-line
'./foo'
import {y} from './foo'
`,
- // Autofix bail because of comment.
- output: `
- import {x} from
- // some-tool-disable-next-line
- './foo'
- import {y} from './foo'
- `,
errors: ['\'./foo\' imported multiple times.', '\'./foo\' imported multiple times.'],
- }),
+ })),
// #2027 long import list generate empty lines
test({
@@ -616,9 +556,8 @@ context('TypeScript', function () {
]);
const invalid = [
- test({
+ test(withoutAutofixOutput({
code: "import type x from './foo'; import type y from './foo'",
- output: "import type x from './foo'; import type y from './foo'",
...parserConfig,
errors: [
{
@@ -632,7 +571,7 @@ context('TypeScript', function () {
message: "'./foo' imported multiple times.",
},
],
- }),
+ })),
test({
code: "import type x from './foo'; import type x from './foo'",
output: "import type x from './foo'; ",
diff --git a/tests/src/rules/no-namespace.js b/tests/src/rules/no-namespace.js
index 03a23e3dd7..e297d953a3 100644
--- a/tests/src/rules/no-namespace.js
+++ b/tests/src/rules/no-namespace.js
@@ -1,4 +1,5 @@
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import { test } from '../utils';
@@ -82,33 +83,30 @@ ruleTester.run('no-namespace', require('rules/no-namespace'), {
],
invalid: [
- test({
+ test(withoutAutofixOutput({
code: 'import * as foo from \'foo\';',
- output: 'import * as foo from \'foo\';',
errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
}],
- }),
- test({
+ })),
+ test(withoutAutofixOutput({
code: 'import defaultExport, * as foo from \'foo\';',
- output: 'import defaultExport, * as foo from \'foo\';',
errors: [{
line: 1,
column: 23,
message: ERROR_MESSAGE,
}],
- }),
- test({
+ })),
+ test(withoutAutofixOutput({
code: 'import * as foo from \'./foo\';',
- output: 'import * as foo from \'./foo\';',
errors: [{
line: 1,
column: 8,
message: ERROR_MESSAGE,
}],
- }),
+ })),
...FIX_TESTS,
],
});
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 978c8e34d0..ff6b657304 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -1,6 +1,7 @@
import { test, getTSParsers, getNonDefaultParsers, testFilePath, parsers } from '../utils';
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
@@ -21,10 +22,6 @@ const flowRuleTester = new RuleTester({
});
const rule = require('rules/order');
-function withoutAutofixOutput(test) {
- return { ...test, output: test.code };
-}
-
ruleTester.run('order', rule, {
valid: [
// Default order using require
@@ -1906,19 +1903,13 @@ ruleTester.run('order', rule, {
],
}),
// Cannot fix newlines-between with multiline comment after
- test({
+ test(withoutAutofixOutput({
code: `
var fs = require('fs'); /* multiline
comment */
var index = require('./');
`,
- output: `
- var fs = require('fs'); /* multiline
- comment */
-
- var index = require('./');
- `,
options: [
{
groups: [['builtin'], ['index']],
@@ -1931,7 +1922,7 @@ ruleTester.run('order', rule, {
message: 'There should be no empty line between import groups',
},
],
- }),
+ })),
// Option newlines-between: 'always' - should report lack of newline between groups
test({
code: `
@@ -2017,7 +2008,7 @@ ruleTester.run('order', rule, {
}),
// Option newlines-between: 'never' with unassigned imports and warnOnUnassignedImports disabled
// newline is preserved to match existing behavior
- test({
+ test(withoutAutofixOutput({
code: `
import path from 'path';
import 'loud-rejection';
@@ -2025,13 +2016,6 @@ ruleTester.run('order', rule, {
import 'something-else';
import _ from 'lodash';
`,
- output: `
- import path from 'path';
- import 'loud-rejection';
-
- import 'something-else';
- import _ from 'lodash';
- `,
options: [{ 'newlines-between': 'never', warnOnUnassignedImports: false }],
errors: [
{
@@ -2039,7 +2023,7 @@ ruleTester.run('order', rule, {
message: 'There should be no empty line between import groups',
},
],
- }),
+ })),
// Option newlines-between: 'never' with unassigned imports and warnOnUnassignedImports enabled
test({
code: `
@@ -2064,7 +2048,7 @@ ruleTester.run('order', rule, {
],
}),
// Option newlines-between: 'never' cannot fix if there are other statements between imports
- test({
+ test(withoutAutofixOutput({
code: `
import path from 'path';
export const abc = 123;
@@ -2072,13 +2056,6 @@ ruleTester.run('order', rule, {
import 'something-else';
import _ from 'lodash';
`,
- output: `
- import path from 'path';
- export const abc = 123;
-
- import 'something-else';
- import _ from 'lodash';
- `,
options: [{ 'newlines-between': 'never' }],
errors: [
{
@@ -2086,7 +2063,7 @@ ruleTester.run('order', rule, {
message: 'There should be no empty line between import groups',
},
],
- }),
+ })),
// Option newlines-between: 'always' should report missing empty lines when using not assigned imports
test({
code: `
@@ -2170,7 +2147,7 @@ ruleTester.run('order', rule, {
],
}),
// reorder fix cannot cross function call on moving below #1
- test({
+ test(withoutAutofixOutput({
code: `
const local = require('./local');
@@ -2181,22 +2158,12 @@ ruleTester.run('order', rule, {
fn_call();
`,
- output: `
- const local = require('./local');
-
- fn_call();
-
- const global1 = require('global1');
- const global2 = require('global2');
-
- fn_call();
- `,
errors: [{
message: '`./local` import should occur after import of `global2`',
}],
- }),
+ })),
// reorder fix cannot cross function call on moving below #2
- test({
+ test(withoutAutofixOutput({
code: `
const local = require('./local');
fn_call();
@@ -2205,20 +2172,12 @@ ruleTester.run('order', rule, {
fn_call();
`,
- output: `
- const local = require('./local');
- fn_call();
- const global1 = require('global1');
- const global2 = require('global2');
-
- fn_call();
- `,
errors: [{
message: '`./local` import should occur after import of `global2`',
}],
- }),
+ })),
// reorder fix cannot cross function call on moving below #3
- test({
+ test(withoutAutofixOutput({
code: `
const local1 = require('./local1');
const local2 = require('./local2');
@@ -2232,26 +2191,13 @@ ruleTester.run('order', rule, {
const global5 = require('global5');
fn_call();
`,
- output: `
- const local1 = require('./local1');
- const local2 = require('./local2');
- const local3 = require('./local3');
- const local4 = require('./local4');
- fn_call();
- const global1 = require('global1');
- const global2 = require('global2');
- const global3 = require('global3');
- const global4 = require('global4');
- const global5 = require('global5');
- fn_call();
- `,
errors: [
'`./local1` import should occur after import of `global5`',
'`./local2` import should occur after import of `global5`',
'`./local3` import should occur after import of `global5`',
'`./local4` import should occur after import of `global5`',
],
- }),
+ })),
// reorder fix cannot cross function call on moving below
test(withoutAutofixOutput({
code: `
@@ -2561,7 +2507,7 @@ ruleTester.run('order', rule, {
}],
})),
// reorder fix cannot cross function call on moving below (from #1252)
- test({
+ test(withoutAutofixOutput({
code: `
const env = require('./config');
@@ -2572,20 +2518,10 @@ ruleTester.run('order', rule, {
http.createServer(express());
`,
- output: `
- const env = require('./config');
-
- Object.keys(env);
-
- const http = require('http');
- const express = require('express');
-
- http.createServer(express());
- `,
errors: [{
message: '`./config` import should occur after import of `express`',
}],
- }),
+ })),
// reorder cannot cross non plain requires
test(withoutAutofixOutput({
code: `
@@ -3497,19 +3433,13 @@ context('TypeScript', function () {
],
}),
// warns for out of order unassigned imports (warnOnUnassignedImports enabled)
- test({
+ test(withoutAutofixOutput({
code: `
import './local1';
import global from 'global1';
import local from './local2';
import 'global2';
`,
- output: `
- import './local1';
- import global from 'global1';
- import local from './local2';
- import 'global2';
- `,
errors: [
{
message: '`global1` import should occur before import of `./local1`',
@@ -3519,9 +3449,9 @@ context('TypeScript', function () {
},
],
options: [{ warnOnUnassignedImports: true }],
- }),
+ })),
// fix cannot move below unassigned import (warnOnUnassignedImports enabled)
- test({
+ test(withoutAutofixOutput({
code: `
import local from './local';
@@ -3530,19 +3460,11 @@ context('TypeScript', function () {
import global2 from 'global2';
import global3 from 'global3';
`,
- output: `
- import local from './local';
-
- import 'global1';
-
- import global2 from 'global2';
- import global3 from 'global3';
- `,
errors: [{
message: '`./local` import should occur after import of `global3`',
}],
options: [{ warnOnUnassignedImports: true }],
- }),
+ })),
// Imports inside module declaration
test({
code: `
diff --git a/tests/src/rules/unambiguous.js b/tests/src/rules/unambiguous.js
index 8cef69625f..c103353e49 100644
--- a/tests/src/rules/unambiguous.js
+++ b/tests/src/rules/unambiguous.js
@@ -1,4 +1,5 @@
import { RuleTester } from 'eslint';
+import { withoutAutofixOutput } from '../rule-tester';
import { parsers } from '../utils';
const ruleTester = new RuleTester();
@@ -48,11 +49,10 @@ ruleTester.run('unambiguous', rule, {
},
],
invalid: [
- {
+ withoutAutofixOutput({
code: 'function x() {}',
parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
- output: 'function x() {}',
errors: ['This module could be parsed as a valid script.'],
- },
+ }),
],
});
From 743ebca91a5bc151ce3d5862b52474ceaaf6c8de Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 20 Sep 2024 07:23:53 +1200
Subject: [PATCH 157/199] [Tests] `no-cycle`: don't override the filename
---
tests/src/rules/no-cycle.js | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/tests/src/rules/no-cycle.js b/tests/src/rules/no-cycle.js
index d005727e31..e9b41c8fba 100644
--- a/tests/src/rules/no-cycle.js
+++ b/tests/src/rules/no-cycle.js
@@ -8,11 +8,13 @@ const rule = require('rules/no-cycle');
const error = (message) => ({ message });
-const test = (def) => _test(Object.assign(def, {
+const test = (def) => _test({
filename: testFilePath('./cycles/depth-zero.js'),
-}));
-const testVersion = (specifier, t) => _testVersion(specifier, () => Object.assign(t(), {
+ ...def,
+});
+const testVersion = (specifier, t) => _testVersion(specifier, () => ({
filename: testFilePath('./cycles/depth-zero.js'),
+ ...t(),
}));
const testDialects = ['es6'];
From 6218a8acb5afde0db1f2273bab1db642a3668269 Mon Sep 17 00:00:00 2001
From: Ivan Rubinson <soryy708@gmail.com>
Date: Wed, 25 Sep 2024 18:14:32 +0300
Subject: [PATCH 158/199] [Docs] `no-cycle`: add `disableScc` to docs
---
CHANGELOG.md | 2 ++
docs/rules/no-cycle.md | 8 ++++++++
2 files changed, 10 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e40edde5eb..33b4eb4f4e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
- [Performance] [`no-cycle`]: dont scc for each linted file ([#3068], thanks [@soryy708])
+- [Docs] [`no-cycle`]: add `disableScc` to docs ([#3070], thanks [@soryy708])
## [2.30.0] - 2024-09-02
@@ -1141,6 +1142,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3070]: https://github.com/import-js/eslint-plugin-import/pull/3070
[#3068]: https://github.com/import-js/eslint-plugin-import/pull/3068
[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
[#3065]: https://github.com/import-js/eslint-plugin-import/pull/3065
diff --git a/docs/rules/no-cycle.md b/docs/rules/no-cycle.md
index 76e96f95f2..898b75330e 100644
--- a/docs/rules/no-cycle.md
+++ b/docs/rules/no-cycle.md
@@ -94,6 +94,14 @@ export function getBar() { return import('./bar'); }
> Cyclic dependency are **always** a dangerous anti-pattern as discussed extensively in [#2265](https://github.com/import-js/eslint-plugin-import/issues/2265). Please be extra careful about using this option.
+#### `disableScc`
+
+This option disables a pre-processing step that calculates [Strongly Connected Components](https://en.wikipedia.org/wiki/Strongly_connected_component), which are used for avoiding unnecessary work checking files in different SCCs for cycles.
+
+However, under some configurations, this pre-processing may be more expensive than the time it saves.
+
+When this option is `true`, we don't calculate any SCC graph, and check all files for cycles (leading to higher time-complexity). Default is `false`.
+
## When Not To Use It
This rule is comparatively computationally expensive. If you are pressed for lint
From 61f02a2cac4b9c12bba8da670e5ccdd772a363e2 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Sun, 15 Sep 2024 11:12:26 -0500
Subject: [PATCH 159/199] [Fix] `exportMap`: export map cache is tainted by
unreliable parse results
This change addresses and issue observed with the v9 upgrade, where the ExportMap Cache is being tainted with a bad export map, if the parse doesn't yield a `visitorKeys` (which can happen if an incompatible parser is used (e.g. og babel eslint)) for one run of the no-cycle rule. If a subsequent test is run with a compatible parser, then the bad export map will be found in the cache and used instead of attempting to proceed with the parse.
I also updated the `getExports` test to use a valid parserPath, rather than a mocked one, so that the tests are acting on a valid parserPath. Otherwise the export map won't be cached following this change.
---
CHANGELOG.md | 2 ++
src/exportMap/builder.js | 6 +++++-
tests/src/core/getExports.js | 24 ++++++++++++++++++------
3 files changed, 25 insertions(+), 7 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 33b4eb4f4e..da66f7e87f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
- [`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export ([#3032], thanks [@akwodkiewicz])
- [`export`]: False positive for exported overloaded functions in TS ([#3065], thanks [@liuxingbaoyu])
+- `exportMap`: export map cache is tainted by unreliable parse results ([#3062], thanks [@michaelfaith])
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
@@ -1146,6 +1147,7 @@ for info on changes for earlier releases.
[#3068]: https://github.com/import-js/eslint-plugin-import/pull/3068
[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
[#3065]: https://github.com/import-js/eslint-plugin-import/pull/3065
+[#3062]: https://github.com/import-js/eslint-plugin-import/pull/3062
[#3052]: https://github.com/import-js/eslint-plugin-import/pull/3052
[#3043]: https://github.com/import-js/eslint-plugin-import/pull/3043
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
diff --git a/src/exportMap/builder.js b/src/exportMap/builder.js
index 5348dba375..f7b9006eff 100644
--- a/src/exportMap/builder.js
+++ b/src/exportMap/builder.js
@@ -92,7 +92,11 @@ export default class ExportMapBuilder {
exportMap.mtime = stats.mtime;
- exportCache.set(cacheKey, exportMap);
+ // If the visitor keys were not populated, then we shouldn't save anything to the cache,
+ // since the parse results may not be reliable.
+ if (exportMap.visitorKeys) {
+ exportCache.set(cacheKey, exportMap);
+ }
return exportMap;
}
diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
index 76003410d5..f11a261311 100644
--- a/tests/src/core/getExports.js
+++ b/tests/src/core/getExports.js
@@ -1,15 +1,18 @@
import { expect } from 'chai';
+import fs from 'fs';
import semver from 'semver';
import sinon from 'sinon';
import eslintPkg from 'eslint/package.json';
+import { test as testUnambiguous } from 'eslint-module-utils/unambiguous';
import typescriptPkg from 'typescript/package.json';
import * as tsConfigLoader from 'tsconfig-paths/lib/tsconfig-loader';
-import ExportMapBuilder from '../../../src/exportMap/builder';
-
-import * as fs from 'fs';
+import ExportMapBuilder from '../../../src/exportMap/builder';
import { getFilename } from '../utils';
-import { test as testUnambiguous } from 'eslint-module-utils/unambiguous';
+
+const babelPath = require.resolve('babel-eslint');
+const hypotheticalLocation = babelPath.replace('index.js', 'visitor-keys.js');
+const isVisitorKeysSupported = fs.existsSync(hypotheticalLocation);
describe('ExportMap', function () {
const fakeContext = Object.assign(
@@ -21,7 +24,7 @@ describe('ExportMap', function () {
},
{
settings: {},
- parserPath: 'babel-eslint',
+ parserPath: require.resolve('babel-eslint'),
},
);
@@ -36,11 +39,20 @@ describe('ExportMap', function () {
});
- it('returns a cached copy on subsequent requests', function () {
+ (isVisitorKeysSupported ? it : it.skip)('returns a cached copy on subsequent requests', function () {
expect(ExportMapBuilder.get('./named-exports', fakeContext))
.to.exist.and.equal(ExportMapBuilder.get('./named-exports', fakeContext));
});
+ it('does not return a cached copy if the parse does not yield a visitor keys', function () {
+ const mockContext = {
+ ...fakeContext,
+ parserPath: 'not-real',
+ };
+ expect(ExportMapBuilder.get('./named-exports', mockContext))
+ .to.exist.and.not.equal(ExportMapBuilder.get('./named-exports', mockContext));
+ });
+
it('does not return a cached copy after modification', (done) => {
const firstAccess = ExportMapBuilder.get('./mutator', fakeContext);
expect(firstAccess).to.exist;
From 3fbe10fa85d5fc2fad338bfb062fb2f57ce996fa Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Thu, 26 Sep 2024 08:48:38 +1200
Subject: [PATCH 160/199] [Tests] use re-exported `RuleTester`
This reduces the diff in #2996.
---
CHANGELOG.md | 2 ++
tests/src/rule-tester.js | 2 ++
tests/src/rules/consistent-type-specifier-style.js | 2 +-
tests/src/rules/default.js | 2 +-
tests/src/rules/dynamic-import-chunkname.js | 3 +--
tests/src/rules/export.js | 2 +-
tests/src/rules/exports-last.js | 2 +-
tests/src/rules/extensions.js | 2 +-
tests/src/rules/first.js | 2 +-
tests/src/rules/group-exports.js | 2 +-
tests/src/rules/max-dependencies.js | 2 +-
tests/src/rules/named.js | 2 +-
tests/src/rules/namespace.js | 2 +-
tests/src/rules/newline-after-import.js | 3 +--
tests/src/rules/no-absolute-path.js | 2 +-
tests/src/rules/no-amd.js | 2 +-
tests/src/rules/no-anonymous-default-export.js | 2 +-
tests/src/rules/no-commonjs.js | 3 +--
tests/src/rules/no-cycle.js | 2 +-
tests/src/rules/no-default-export.js | 2 +-
tests/src/rules/no-deprecated.js | 2 +-
tests/src/rules/no-duplicates.js | 3 +--
tests/src/rules/no-dynamic-require.js | 2 +-
tests/src/rules/no-empty-named-blocks.js | 2 +-
tests/src/rules/no-extraneous-dependencies.js | 2 +-
tests/src/rules/no-import-module-exports.js | 2 +-
tests/src/rules/no-internal-modules.js | 2 +-
tests/src/rules/no-mutable-exports.js | 2 +-
tests/src/rules/no-named-as-default-member.js | 2 +-
tests/src/rules/no-named-as-default.js | 2 +-
tests/src/rules/no-named-default.js | 2 +-
tests/src/rules/no-named-export.js | 2 +-
tests/src/rules/no-namespace.js | 3 +--
tests/src/rules/no-nodejs-modules.js | 2 +-
tests/src/rules/no-relative-packages.js | 2 +-
tests/src/rules/no-relative-parent-imports.js | 2 +-
tests/src/rules/no-restricted-paths.js | 2 +-
tests/src/rules/no-self-import.js | 2 +-
tests/src/rules/no-unassigned-import.js | 2 +-
tests/src/rules/no-unresolved.js | 2 +-
tests/src/rules/no-unused-modules.js | 2 +-
tests/src/rules/no-useless-path-segments.js | 2 +-
tests/src/rules/no-webpack-loader-syntax.js | 2 +-
tests/src/rules/order.js | 3 +--
tests/src/rules/prefer-default-export.js | 2 +-
tests/src/rules/unambiguous.js | 3 +--
46 files changed, 48 insertions(+), 51 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index da66f7e87f..8dcb3a98de 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
- [Performance] [`no-cycle`]: dont scc for each linted file ([#3068], thanks [@soryy708])
- [Docs] [`no-cycle`]: add `disableScc` to docs ([#3070], thanks [@soryy708])
+- [Tests] use re-exported `RuleTester` ([#3071], thanks [@G-Rath])
## [2.30.0] - 2024-09-02
@@ -1143,6 +1144,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3071]: https://github.com/import-js/eslint-plugin-import/pull/3071
[#3070]: https://github.com/import-js/eslint-plugin-import/pull/3070
[#3068]: https://github.com/import-js/eslint-plugin-import/pull/3068
[#3066]: https://github.com/import-js/eslint-plugin-import/pull/3066
diff --git a/tests/src/rule-tester.js b/tests/src/rule-tester.js
index 89c5846120..f00b520d07 100644
--- a/tests/src/rule-tester.js
+++ b/tests/src/rule-tester.js
@@ -1,3 +1,5 @@
export function withoutAutofixOutput(test) {
return { ...test, output: test.code };
}
+
+export { RuleTester } from 'eslint';
diff --git a/tests/src/rules/consistent-type-specifier-style.js b/tests/src/rules/consistent-type-specifier-style.js
index 7799238c32..139457ff60 100644
--- a/tests/src/rules/consistent-type-specifier-style.js
+++ b/tests/src/rules/consistent-type-specifier-style.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import { test, parsers, tsVersionSatisfies, eslintVersionSatisfies, typescriptEslintParserSatisfies } from '../utils';
const rule = require('rules/consistent-type-specifier-style');
diff --git a/tests/src/rules/default.js b/tests/src/rules/default.js
index eb2028c71a..1df57a23aa 100644
--- a/tests/src/rules/default.js
+++ b/tests/src/rules/default.js
@@ -1,6 +1,6 @@
import path from 'path';
import { test, testVersion, SYNTAX_CASES, getTSParsers, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import semver from 'semver';
import { version as tsEslintVersion } from 'typescript-eslint-parser/package.json';
diff --git a/tests/src/rules/dynamic-import-chunkname.js b/tests/src/rules/dynamic-import-chunkname.js
index 1362196728..e8f97475da 100644
--- a/tests/src/rules/dynamic-import-chunkname.js
+++ b/tests/src/rules/dynamic-import-chunkname.js
@@ -1,6 +1,5 @@
import { SYNTAX_CASES, getTSParsers, parsers } from '../utils';
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import semver from 'semver';
const rule = require('rules/dynamic-import-chunkname');
diff --git a/tests/src/rules/export.js b/tests/src/rules/export.js
index f16a25ecf5..338501511c 100644
--- a/tests/src/rules/export.js
+++ b/tests/src/rules/export.js
@@ -1,6 +1,6 @@
import { test, testFilePath, SYNTAX_CASES, getTSParsers, testVersion } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import { version as tsEslintVersion } from 'typescript-eslint-parser/package.json';
diff --git a/tests/src/rules/exports-last.js b/tests/src/rules/exports-last.js
index d7122e9a00..a676ae044b 100644
--- a/tests/src/rules/exports-last.js
+++ b/tests/src/rules/exports-last.js
@@ -1,6 +1,6 @@
import { test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/exports-last';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index 14d84eaa62..97267832c5 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/extensions';
import { getTSParsers, test, testFilePath, parsers } from '../utils';
diff --git a/tests/src/rules/first.js b/tests/src/rules/first.js
index f34f227b2d..52b71db861 100644
--- a/tests/src/rules/first.js
+++ b/tests/src/rules/first.js
@@ -2,7 +2,7 @@ import { test, getTSParsers, testVersion } from '../utils';
import fs from 'fs';
import path from 'path';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/first');
diff --git a/tests/src/rules/group-exports.js b/tests/src/rules/group-exports.js
index c3d07046f0..6f05bc866b 100644
--- a/tests/src/rules/group-exports.js
+++ b/tests/src/rules/group-exports.js
@@ -1,5 +1,5 @@
import { test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/group-exports';
import { resolve } from 'path';
import { default as babelPresetFlow } from 'babel-preset-flow';
diff --git a/tests/src/rules/max-dependencies.js b/tests/src/rules/max-dependencies.js
index 982a4b427a..959ee68de3 100644
--- a/tests/src/rules/max-dependencies.js
+++ b/tests/src/rules/max-dependencies.js
@@ -1,6 +1,6 @@
import { test, getTSParsers, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/max-dependencies');
diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
index 227bffc80d..f506caeb68 100644
--- a/tests/src/rules/named.js
+++ b/tests/src/rules/named.js
@@ -1,5 +1,5 @@
import { test, SYNTAX_CASES, getTSParsers, testFilePath, testVersion, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import path from 'path';
import { CASE_SENSITIVE_FS } from 'eslint-module-utils/resolve';
diff --git a/tests/src/rules/namespace.js b/tests/src/rules/namespace.js
index 3f768a5717..60fcb93f6d 100644
--- a/tests/src/rules/namespace.js
+++ b/tests/src/rules/namespace.js
@@ -1,5 +1,5 @@
import { test, SYNTAX_CASES, getTSParsers, testVersion, testFilePath, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester({ env: { es6: true } });
diff --git a/tests/src/rules/newline-after-import.js b/tests/src/rules/newline-after-import.js
index 5c827c0d26..984e898550 100644
--- a/tests/src/rules/newline-after-import.js
+++ b/tests/src/rules/newline-after-import.js
@@ -1,5 +1,4 @@
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
import semver from 'semver';
import { version as tsEslintVersion } from 'typescript-eslint-parser/package.json';
diff --git a/tests/src/rules/no-absolute-path.js b/tests/src/rules/no-absolute-path.js
index bfa08465c0..bcf215137b 100644
--- a/tests/src/rules/no-absolute-path.js
+++ b/tests/src/rules/no-absolute-path.js
@@ -1,6 +1,6 @@
import { test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-absolute-path');
diff --git a/tests/src/rules/no-amd.js b/tests/src/rules/no-amd.js
index 5317aa8fde..6b66578df3 100644
--- a/tests/src/rules/no-amd.js
+++ b/tests/src/rules/no-amd.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
diff --git a/tests/src/rules/no-anonymous-default-export.js b/tests/src/rules/no-anonymous-default-export.js
index 53b2fc6fbb..37b3009f0c 100644
--- a/tests/src/rules/no-anonymous-default-export.js
+++ b/tests/src/rules/no-anonymous-default-export.js
@@ -1,6 +1,6 @@
import { test, testVersion, SYNTAX_CASES } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-anonymous-default-export');
diff --git a/tests/src/rules/no-commonjs.js b/tests/src/rules/no-commonjs.js
index 9950608a78..3211c085a7 100644
--- a/tests/src/rules/no-commonjs.js
+++ b/tests/src/rules/no-commonjs.js
@@ -1,5 +1,4 @@
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
diff --git a/tests/src/rules/no-cycle.js b/tests/src/rules/no-cycle.js
index e9b41c8fba..ae4baab666 100644
--- a/tests/src/rules/no-cycle.js
+++ b/tests/src/rules/no-cycle.js
@@ -1,6 +1,6 @@
import { parsers, test as _test, testFilePath, testVersion as _testVersion } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-default-export.js b/tests/src/rules/no-default-export.js
index 6c1a85a1d5..29292427cc 100644
--- a/tests/src/rules/no-default-export.js
+++ b/tests/src/rules/no-default-export.js
@@ -1,6 +1,6 @@
import { parsers, test, testVersion } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-default-export');
diff --git a/tests/src/rules/no-deprecated.js b/tests/src/rules/no-deprecated.js
index 318ea7c368..ad51d23c21 100644
--- a/tests/src/rules/no-deprecated.js
+++ b/tests/src/rules/no-deprecated.js
@@ -1,6 +1,6 @@
import { test, SYNTAX_CASES, getTSParsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-deprecated');
diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
index a48e4d3f74..cf57a3d599 100644
--- a/tests/src/rules/no-duplicates.js
+++ b/tests/src/rules/no-duplicates.js
@@ -2,8 +2,7 @@ import * as path from 'path';
import { test as testUtil, getNonDefaultParsers, parsers, tsVersionSatisfies, typescriptEslintParserSatisfies } from '../utils';
import jsxConfig from '../../../config/react';
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
diff --git a/tests/src/rules/no-dynamic-require.js b/tests/src/rules/no-dynamic-require.js
index e316470ec8..fc7cf2b066 100644
--- a/tests/src/rules/no-dynamic-require.js
+++ b/tests/src/rules/no-dynamic-require.js
@@ -1,6 +1,6 @@
import { parsers, test, testVersion } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-empty-named-blocks.js b/tests/src/rules/no-empty-named-blocks.js
index 87965a1407..d9514a845b 100644
--- a/tests/src/rules/no-empty-named-blocks.js
+++ b/tests/src/rules/no-empty-named-blocks.js
@@ -1,6 +1,6 @@
import { parsers, test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-empty-named-blocks');
diff --git a/tests/src/rules/no-extraneous-dependencies.js b/tests/src/rules/no-extraneous-dependencies.js
index dd01c141d3..4a465eb39d 100644
--- a/tests/src/rules/no-extraneous-dependencies.js
+++ b/tests/src/rules/no-extraneous-dependencies.js
@@ -3,7 +3,7 @@ import typescriptConfig from '../../../config/typescript';
import path from 'path';
import fs from 'fs';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-import-module-exports.js b/tests/src/rules/no-import-module-exports.js
index aa927857e0..5738f8c524 100644
--- a/tests/src/rules/no-import-module-exports.js
+++ b/tests/src/rules/no-import-module-exports.js
@@ -1,5 +1,5 @@
import path from 'path';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import { eslintVersionSatisfies, test, testVersion } from '../utils';
diff --git a/tests/src/rules/no-internal-modules.js b/tests/src/rules/no-internal-modules.js
index c1c3015453..9fa91ea3d6 100644
--- a/tests/src/rules/no-internal-modules.js
+++ b/tests/src/rules/no-internal-modules.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
import rule from 'rules/no-internal-modules';
diff --git a/tests/src/rules/no-mutable-exports.js b/tests/src/rules/no-mutable-exports.js
index 1171443c4a..ff9643b0d7 100644
--- a/tests/src/rules/no-mutable-exports.js
+++ b/tests/src/rules/no-mutable-exports.js
@@ -1,5 +1,5 @@
import { parsers, test, testVersion } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/no-mutable-exports';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-named-as-default-member.js b/tests/src/rules/no-named-as-default-member.js
index 1773176f4f..5c00224ed4 100644
--- a/tests/src/rules/no-named-as-default-member.js
+++ b/tests/src/rules/no-named-as-default-member.js
@@ -1,5 +1,5 @@
import { test, testVersion, SYNTAX_CASES } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/no-named-as-default-member';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-named-as-default.js b/tests/src/rules/no-named-as-default.js
index 7fcd6e4f72..349372067b 100644
--- a/tests/src/rules/no-named-as-default.js
+++ b/tests/src/rules/no-named-as-default.js
@@ -1,5 +1,5 @@
import { test, testVersion, SYNTAX_CASES, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-named-as-default');
diff --git a/tests/src/rules/no-named-default.js b/tests/src/rules/no-named-default.js
index 191c9c6ce9..d36e26c448 100644
--- a/tests/src/rules/no-named-default.js
+++ b/tests/src/rules/no-named-default.js
@@ -1,5 +1,5 @@
import { test, testVersion, SYNTAX_CASES, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-named-default');
diff --git a/tests/src/rules/no-named-export.js b/tests/src/rules/no-named-export.js
index 58b5da2f85..83ea8571fc 100644
--- a/tests/src/rules/no-named-export.js
+++ b/tests/src/rules/no-named-export.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import { parsers, test, testVersion } from '../utils';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-namespace.js b/tests/src/rules/no-namespace.js
index e297d953a3..f5cd967a22 100644
--- a/tests/src/rules/no-namespace.js
+++ b/tests/src/rules/no-namespace.js
@@ -1,5 +1,4 @@
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import { test } from '../utils';
diff --git a/tests/src/rules/no-nodejs-modules.js b/tests/src/rules/no-nodejs-modules.js
index b25eb0ce85..cf131ffee2 100644
--- a/tests/src/rules/no-nodejs-modules.js
+++ b/tests/src/rules/no-nodejs-modules.js
@@ -1,6 +1,6 @@
import { test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const isCore = require('is-core-module');
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/no-relative-packages.js b/tests/src/rules/no-relative-packages.js
index 6104aeb9ca..9b424506c5 100644
--- a/tests/src/rules/no-relative-packages.js
+++ b/tests/src/rules/no-relative-packages.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/no-relative-packages';
import { normalize } from 'path';
diff --git a/tests/src/rules/no-relative-parent-imports.js b/tests/src/rules/no-relative-parent-imports.js
index 1af9b8cf8d..93c8b97aac 100644
--- a/tests/src/rules/no-relative-parent-imports.js
+++ b/tests/src/rules/no-relative-parent-imports.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/no-relative-parent-imports';
import { parsers, test as _test, testFilePath } from '../utils';
diff --git a/tests/src/rules/no-restricted-paths.js b/tests/src/rules/no-restricted-paths.js
index a83a804a0a..c3382ad086 100644
--- a/tests/src/rules/no-restricted-paths.js
+++ b/tests/src/rules/no-restricted-paths.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import rule from 'rules/no-restricted-paths';
import { getTSParsers, test, testFilePath } from '../utils';
diff --git a/tests/src/rules/no-self-import.js b/tests/src/rules/no-self-import.js
index ff1248b43c..dd2ea1bf2d 100644
--- a/tests/src/rules/no-self-import.js
+++ b/tests/src/rules/no-self-import.js
@@ -1,6 +1,6 @@
import { test, testFilePath } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-self-import');
diff --git a/tests/src/rules/no-unassigned-import.js b/tests/src/rules/no-unassigned-import.js
index f96808cbcc..b73246ac0d 100644
--- a/tests/src/rules/no-unassigned-import.js
+++ b/tests/src/rules/no-unassigned-import.js
@@ -1,7 +1,7 @@
import { test } from '../utils';
import * as path from 'path';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-unassigned-import');
diff --git a/tests/src/rules/no-unresolved.js b/tests/src/rules/no-unresolved.js
index 9bf1a42d4a..c6e300c5dc 100644
--- a/tests/src/rules/no-unresolved.js
+++ b/tests/src/rules/no-unresolved.js
@@ -4,7 +4,7 @@ import { getTSParsers, test, SYNTAX_CASES, testVersion, parsers } from '../utils
import { CASE_SENSITIVE_FS } from 'eslint-module-utils/resolve';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-unresolved');
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 80bd70227e..22b54ce6f4 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -2,7 +2,7 @@ import { test, testVersion, testFilePath, getTSParsers, parsers } from '../utils
import jsxConfig from '../../../config/react';
import typescriptConfig from '../../../config/typescript';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import fs from 'fs';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
diff --git a/tests/src/rules/no-useless-path-segments.js b/tests/src/rules/no-useless-path-segments.js
index d6d0395dea..87f7a73e9a 100644
--- a/tests/src/rules/no-useless-path-segments.js
+++ b/tests/src/rules/no-useless-path-segments.js
@@ -1,5 +1,5 @@
import { parsers, test } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
const ruleTester = new RuleTester();
const rule = require('rules/no-useless-path-segments');
diff --git a/tests/src/rules/no-webpack-loader-syntax.js b/tests/src/rules/no-webpack-loader-syntax.js
index 05ad242f50..86114b36c6 100644
--- a/tests/src/rules/no-webpack-loader-syntax.js
+++ b/tests/src/rules/no-webpack-loader-syntax.js
@@ -1,6 +1,6 @@
import { test, getTSParsers, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import semver from 'semver';
const ruleTester = new RuleTester();
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index ff6b657304..ea62cec71d 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -1,7 +1,6 @@
import { test, getTSParsers, getNonDefaultParsers, testFilePath, parsers } from '../utils';
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import eslintPkg from 'eslint/package.json';
import semver from 'semver';
import flatMap from 'array.prototype.flatmap';
diff --git a/tests/src/rules/prefer-default-export.js b/tests/src/rules/prefer-default-export.js
index a7310445b5..8e459873f9 100644
--- a/tests/src/rules/prefer-default-export.js
+++ b/tests/src/rules/prefer-default-export.js
@@ -1,6 +1,6 @@
import { test, testVersion, getNonDefaultParsers, parsers } from '../utils';
-import { RuleTester } from 'eslint';
+import { RuleTester } from '../rule-tester';
import semver from 'semver';
import { version as tsEslintVersion } from 'typescript-eslint-parser/package.json';
diff --git a/tests/src/rules/unambiguous.js b/tests/src/rules/unambiguous.js
index c103353e49..15c67470ef 100644
--- a/tests/src/rules/unambiguous.js
+++ b/tests/src/rules/unambiguous.js
@@ -1,5 +1,4 @@
-import { RuleTester } from 'eslint';
-import { withoutAutofixOutput } from '../rule-tester';
+import { RuleTester, withoutAutofixOutput } from '../rule-tester';
import { parsers } from '../utils';
const ruleTester = new RuleTester();
From 468321a2acc667f355fdc03543be9589361ab0ef Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Thu, 26 Sep 2024 05:12:56 -0500
Subject: [PATCH 161/199] [utils] [new] `hash`: add support for hashing
functions
---
utils/CHANGELOG.md | 4 ++++
utils/hash.js | 2 ++
2 files changed, 6 insertions(+)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 6e71a26f7c..e2a6e9139d 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Added
+- `hash`: add support for hashing functions ([#3072], thanks [@michaelfaith])
+
## v2.11.1 - 2024-09-23
### Fixed
@@ -172,6 +175,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3061]: https://github.com/import-js/eslint-plugin-import/pull/3061
[#3057]: https://github.com/import-js/eslint-plugin-import/pull/3057
[#3049]: https://github.com/import-js/eslint-plugin-import/pull/3049
diff --git a/utils/hash.js b/utils/hash.js
index b3ce618b54..21ed524a9f 100644
--- a/utils/hash.js
+++ b/utils/hash.js
@@ -17,6 +17,8 @@ function hashify(value, hash) {
if (Array.isArray(value)) {
hashArray(value, hash);
+ } else if (typeof value === 'function') {
+ hash.update(String(value));
} else if (value instanceof Object) {
hashObject(value, hash);
} else {
From 96cad2ad906d8f0cf9a80792a6afb1300a532180 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 26 Sep 2024 12:32:24 -0700
Subject: [PATCH 162/199] [utils] v2.12.0
---
utils/CHANGELOG.md | 2 ++
utils/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index e2a6e9139d..619d050633 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+## v2.12.0 - 2024-09-26
+
### Added
- `hash`: add support for hashing functions ([#3072], thanks [@michaelfaith])
diff --git a/utils/package.json b/utils/package.json
index 709142fafb..017eb7192b 100644
--- a/utils/package.json
+++ b/utils/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-module-utils",
- "version": "2.11.1",
+ "version": "2.12.0",
"description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
"engines": {
"node": ">=4"
From ab0941e5fb1aee388816f0b91659e256e33d8710 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Wed, 25 Sep 2024 20:32:24 -0500
Subject: [PATCH 163/199] [Fix] `exportMap`: improve cacheKey when using flat
config
Discovered this issue in https://github.com/import-js/eslint-plugin-import/pull/2996#issuecomment-2372522774
This change improves the logic for generating the cache key used for both the exportMap cache and resolver cache when using flat config. Prior to this change, the cache key was a combination of the `parserPath`, a hash of the `parserOptions`, a hash of the plugin settings, and the path of the file. When using flat config, `parserPath` isn't provided. So, there's the possibility of incorrect cache objects being used if someone ran with this plugin using different parsers within the same lint execution, if parserOptions and settings are the same. The equivalent cacheKey construction when using flat config is to use `languageOptions` as a component of the key, rather than `parserPath` and `parserOptions`. One caveat is that the `parser` property of `languageOptions` is an object that oftentimes has the same two functions (`parse` and `parseForESLint`). This won't be reliably distinct when using the base JSON.stringify function to detect changes. So, this implementation uses a replace function along with `JSON.stringify` to stringify function properties along with other property types.
To ensure that this will work properly with v9, I also tested this against #2996 with v9 installed. Not only does it pass all tests in that branch, but it also removes the need to add this exception: https://github.com/import-js/eslint-plugin-import/pull/2996#discussion_r1774135785
---
CHANGELOG.md | 2 +
package.json | 2 +-
src/exportMap/childContext.js | 35 +++++++++++---
tests/src/exportMap/childContext.js | 72 ++++++++++++++++++++++++++++-
4 files changed, 103 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8dcb3a98de..90cabd4eb3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export ([#3032], thanks [@akwodkiewicz])
- [`export`]: False positive for exported overloaded functions in TS ([#3065], thanks [@liuxingbaoyu])
- `exportMap`: export map cache is tainted by unreliable parse results ([#3062], thanks [@michaelfaith])
+- `exportMap`: improve cacheKey when using flat config ([#3072], thanks [@michaelfaith])
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
@@ -1144,6 +1145,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3071]: https://github.com/import-js/eslint-plugin-import/pull/3071
[#3070]: https://github.com/import-js/eslint-plugin-import/pull/3070
[#3068]: https://github.com/import-js/eslint-plugin-import/pull/3068
diff --git a/package.json b/package.json
index 1126b19836..c0a6b56e4a 100644
--- a/package.json
+++ b/package.json
@@ -117,7 +117,7 @@
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
- "eslint-module-utils": "^2.11.1",
+ "eslint-module-utils": "^2.12.0",
"hasown": "^2.0.2",
"is-core-module": "^2.15.1",
"is-glob": "^4.0.3",
diff --git a/src/exportMap/childContext.js b/src/exportMap/childContext.js
index 3534c59138..8994ac206a 100644
--- a/src/exportMap/childContext.js
+++ b/src/exportMap/childContext.js
@@ -1,10 +1,18 @@
import { hashObject } from 'eslint-module-utils/hash';
-let parserOptionsHash = '';
-let prevParserOptions = '';
+let optionsHash = '';
+let prevOptions = '';
let settingsHash = '';
let prevSettings = '';
+// Replacer function helps us with serializing the parser nested within `languageOptions`.
+function stringifyReplacerFn(_, value) {
+ if (typeof value === 'function') {
+ return String(value);
+ }
+ return value;
+}
+
/**
* don't hold full context object in memory, just grab what we need.
* also calculate a cacheKey, where parts of the cacheKey hash are memoized
@@ -17,13 +25,28 @@ export default function childContext(path, context) {
prevSettings = JSON.stringify(settings);
}
- if (JSON.stringify(parserOptions) !== prevParserOptions) {
- parserOptionsHash = hashObject({ parserOptions }).digest('hex');
- prevParserOptions = JSON.stringify(parserOptions);
+ // We'll use either a combination of `parserOptions` and `parserPath` or `languageOptions`
+ // to construct the cache key, depending on whether this is using a flat config or not.
+ let optionsToken;
+ if (!parserPath && languageOptions) {
+ if (JSON.stringify(languageOptions, stringifyReplacerFn) !== prevOptions) {
+ optionsHash = hashObject({ languageOptions }).digest('hex');
+ prevOptions = JSON.stringify(languageOptions, stringifyReplacerFn);
+ }
+ // For languageOptions, we're just using the hashed options as the options token
+ optionsToken = optionsHash;
+ } else {
+ if (JSON.stringify(parserOptions) !== prevOptions) {
+ optionsHash = hashObject({ parserOptions }).digest('hex');
+ prevOptions = JSON.stringify(parserOptions);
+ }
+ // When not using flat config, we use a combination of the hashed parserOptions
+ // and parserPath as the token
+ optionsToken = String(parserPath) + optionsHash;
}
return {
- cacheKey: String(parserPath) + parserOptionsHash + settingsHash + String(path),
+ cacheKey: optionsToken + settingsHash + String(path),
settings,
parserOptions,
parserPath,
diff --git a/tests/src/exportMap/childContext.js b/tests/src/exportMap/childContext.js
index 06fa04afec..5bc53fdb06 100644
--- a/tests/src/exportMap/childContext.js
+++ b/tests/src/exportMap/childContext.js
@@ -1,4 +1,5 @@
import { expect } from 'chai';
+import { hashObject } from 'eslint-module-utils/hash';
import childContext from '../../../src/exportMap/childContext';
@@ -16,8 +17,13 @@ describe('childContext', () => {
const languageOptions = {
ecmaVersion: 2024,
sourceType: 'module',
- parser: {},
+ parser: {
+ parseForESLint() { return 'parser1'; },
+ },
};
+ const languageOptionsHash = hashObject({ languageOptions }).digest('hex');
+ const parserOptionsHash = hashObject({ parserOptions }).digest('hex');
+ const settingsHash = hashObject({ settings }).digest('hex');
// https://github.com/import-js/eslint-plugin-import/issues/3051
it('should pass context properties through, if present', () => {
@@ -48,4 +54,68 @@ describe('childContext', () => {
expect(result.path).to.equal(path);
expect(result.cacheKey).to.be.a('string');
});
+
+ it('should construct cache key out of languageOptions if present', () => {
+ const mockContext = {
+ settings,
+ languageOptions,
+ };
+
+ const result = childContext(path, mockContext);
+
+ expect(result.cacheKey).to.equal(languageOptionsHash + settingsHash + path);
+ });
+
+ it('should use the same cache key upon multiple calls', () => {
+ const mockContext = {
+ settings,
+ languageOptions,
+ };
+
+ let result = childContext(path, mockContext);
+
+ const expectedCacheKey = languageOptionsHash + settingsHash + path;
+ expect(result.cacheKey).to.equal(expectedCacheKey);
+
+ result = childContext(path, mockContext);
+ expect(result.cacheKey).to.equal(expectedCacheKey);
+ });
+
+ it('should update cacheKey if different languageOptions are passed in', () => {
+ const mockContext = {
+ settings,
+ languageOptions,
+ };
+
+ let result = childContext(path, mockContext);
+
+ const firstCacheKey = languageOptionsHash + settingsHash + path;
+ expect(result.cacheKey).to.equal(firstCacheKey);
+
+ // Second run with different parser function
+ mockContext.languageOptions = {
+ ...languageOptions,
+ parser: {
+ parseForESLint() { return 'parser2'; },
+ },
+ };
+
+ result = childContext(path, mockContext);
+
+ const secondCacheKey = hashObject({ languageOptions: mockContext.languageOptions }).digest('hex') + settingsHash + path;
+ expect(result.cacheKey).to.not.equal(firstCacheKey);
+ expect(result.cacheKey).to.equal(secondCacheKey);
+ });
+
+ it('should construct cache key out of parserOptions and parserPath if no languageOptions', () => {
+ const mockContext = {
+ settings,
+ parserOptions,
+ parserPath,
+ };
+
+ const result = childContext(path, mockContext);
+
+ expect(result.cacheKey).to.equal(String(parserPath) + parserOptionsHash + settingsHash + path);
+ });
});
From 6be20dfa1170c9c5f3cf12f328c1a7cc5cd04c13 Mon Sep 17 00:00:00 2001
From: Emin Yilmaz <70356757+unbeauvoyage@users.noreply.github.com>
Date: Thu, 26 Sep 2024 17:19:32 +0900
Subject: [PATCH 164/199] [Docs] `no-restricted-paths`: fix grammar
---
CHANGELOG.md | 3 +++
docs/rules/no-restricted-paths.md | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 90cabd4eb3..699cd58e45 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,6 +21,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Performance] [`no-cycle`]: dont scc for each linted file ([#3068], thanks [@soryy708])
- [Docs] [`no-cycle`]: add `disableScc` to docs ([#3070], thanks [@soryy708])
- [Tests] use re-exported `RuleTester` ([#3071], thanks [@G-Rath])
+- [Docs] `no-restricted-paths`: fix grammar ([#3073], thanks [@unbeauvoyage])
## [2.30.0] - 2024-09-02
@@ -1145,6 +1146,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3071]: https://github.com/import-js/eslint-plugin-import/pull/3071
[#3070]: https://github.com/import-js/eslint-plugin-import/pull/3070
@@ -1997,6 +1999,7 @@ for info on changes for earlier releases.
[@tomprats]: https://github.com/tomprats
[@TrevorBurnham]: https://github.com/TrevorBurnham
[@ttmarek]: https://github.com/ttmarek
+[@unbeauvoyage]: https://github.com/unbeauvoyage
[@vikr01]: https://github.com/vikr01
[@wenfangdu]: https://github.com/wenfangdu
[@wKich]: https://github.com/wKich
diff --git a/docs/rules/no-restricted-paths.md b/docs/rules/no-restricted-paths.md
index 293f3ba009..a905226c22 100644
--- a/docs/rules/no-restricted-paths.md
+++ b/docs/rules/no-restricted-paths.md
@@ -5,7 +5,7 @@
Some projects contain files which are not always meant to be executed in the same environment.
For example consider a web application that contains specific code for the server and some specific code for the browser/client. In this case you don’t want to import server-only files in your client code.
-In order to prevent such scenarios this rule allows you to define restricted zones where you can forbid files from imported if they match a specific path.
+In order to prevent such scenarios this rule allows you to define restricted zones where you can forbid files from being imported if they match a specific path.
## Rule Details
From 55fa203518fe71a28c697407b436619961009166 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 27 Sep 2024 11:37:41 +1200
Subject: [PATCH 165/199] [Tests] `no-default-export`, `no-named-export`: add
test case
---
CHANGELOG.md | 3 ++-
tests/src/rules/no-default-export.js | 3 +++
tests/src/rules/no-named-export.js | 3 +++
3 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 699cd58e45..8c249f1dff 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,7 +21,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Performance] [`no-cycle`]: dont scc for each linted file ([#3068], thanks [@soryy708])
- [Docs] [`no-cycle`]: add `disableScc` to docs ([#3070], thanks [@soryy708])
- [Tests] use re-exported `RuleTester` ([#3071], thanks [@G-Rath])
-- [Docs] `no-restricted-paths`: fix grammar ([#3073], thanks [@unbeauvoyage])
+- [Docs] [`no-restricted-paths`]: fix grammar ([#3073], thanks [@unbeauvoyage])
+- [Tests] [`no-default-export`], [`no-named-export`]: add test case (thanks [@G-Rath])
## [2.30.0] - 2024-09-02
diff --git a/tests/src/rules/no-default-export.js b/tests/src/rules/no-default-export.js
index 29292427cc..eef8b13224 100644
--- a/tests/src/rules/no-default-export.js
+++ b/tests/src/rules/no-default-export.js
@@ -7,6 +7,9 @@ const rule = require('rules/no-default-export');
ruleTester.run('no-default-export', rule, {
valid: [
+ test({
+ code: 'module.exports = function foo() {}',
+ }),
test({
code: `
export const foo = 'foo';
diff --git a/tests/src/rules/no-named-export.js b/tests/src/rules/no-named-export.js
index 83ea8571fc..c592189f55 100644
--- a/tests/src/rules/no-named-export.js
+++ b/tests/src/rules/no-named-export.js
@@ -6,6 +6,9 @@ const rule = require('rules/no-named-export');
ruleTester.run('no-named-export', rule, {
valid: [].concat(
+ test({
+ code: 'module.export.foo = function () {}',
+ }),
test({
code: 'export default function bar() {};',
}),
From 0bc13553d44e962b416d602da779364515d3df28 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 30 Sep 2024 13:43:45 +0700
Subject: [PATCH 166/199] [Tests] `no-default-export`, `no-named-export`: add
test cases with non-module `sourceType`
---
tests/src/rules/no-default-export.js | 6 ++++++
tests/src/rules/no-named-export.js | 6 ++++++
2 files changed, 12 insertions(+)
diff --git a/tests/src/rules/no-default-export.js b/tests/src/rules/no-default-export.js
index eef8b13224..8434ee1486 100644
--- a/tests/src/rules/no-default-export.js
+++ b/tests/src/rules/no-default-export.js
@@ -7,6 +7,12 @@ const rule = require('rules/no-default-export');
ruleTester.run('no-default-export', rule, {
valid: [
+ test({
+ code: 'module.exports = function foo() {}',
+ parserOptions: {
+ sourceType: 'script',
+ },
+ }),
test({
code: 'module.exports = function foo() {}',
}),
diff --git a/tests/src/rules/no-named-export.js b/tests/src/rules/no-named-export.js
index c592189f55..41f8e8f02c 100644
--- a/tests/src/rules/no-named-export.js
+++ b/tests/src/rules/no-named-export.js
@@ -6,6 +6,12 @@ const rule = require('rules/no-named-export');
ruleTester.run('no-named-export', rule, {
valid: [].concat(
+ test({
+ code: 'module.export.foo = function () {}',
+ parserOptions: {
+ sourceType: 'script',
+ },
+ }),
test({
code: 'module.export.foo = function () {}',
}),
From 1fa8a07a791b2497c8003e63e45f359eb65b1508 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 30 Sep 2024 13:59:51 +0700
Subject: [PATCH 167/199] [Refactor] create `sourceType` helper
---
src/core/sourceType.js | 7 +++++++
src/rules/no-default-export.js | 3 ++-
src/rules/no-named-export.js | 3 ++-
src/rules/unambiguous.js | 3 ++-
4 files changed, 13 insertions(+), 3 deletions(-)
create mode 100644 src/core/sourceType.js
diff --git a/src/core/sourceType.js b/src/core/sourceType.js
new file mode 100644
index 0000000000..4243be4cf9
--- /dev/null
+++ b/src/core/sourceType.js
@@ -0,0 +1,7 @@
+/**
+ * @param {import('eslint').Rule.RuleContext} context
+ * @returns 'module' | 'script' | undefined
+ */
+export default function sourceType(context) {
+ return context.parserOptions.sourceType;
+}
diff --git a/src/rules/no-default-export.js b/src/rules/no-default-export.js
index fcb4f1b2fd..d18f0c48f6 100644
--- a/src/rules/no-default-export.js
+++ b/src/rules/no-default-export.js
@@ -1,6 +1,7 @@
import { getSourceCode } from 'eslint-module-utils/contextCompat';
import docsUrl from '../docsUrl';
+import sourceType from '../core/sourceType';
module.exports = {
meta: {
@@ -15,7 +16,7 @@ module.exports = {
create(context) {
// ignore non-modules
- if (context.parserOptions.sourceType !== 'module') {
+ if (sourceType(context) !== 'module') {
return {};
}
diff --git a/src/rules/no-named-export.js b/src/rules/no-named-export.js
index efaf9dc4c8..fc9b2c48d6 100644
--- a/src/rules/no-named-export.js
+++ b/src/rules/no-named-export.js
@@ -1,3 +1,4 @@
+import sourceType from '../core/sourceType';
import docsUrl from '../docsUrl';
module.exports = {
@@ -13,7 +14,7 @@ module.exports = {
create(context) {
// ignore non-modules
- if (context.parserOptions.sourceType !== 'module') {
+ if (sourceType(context) !== 'module') {
return {};
}
diff --git a/src/rules/unambiguous.js b/src/rules/unambiguous.js
index 91152ea2af..2491fad3eb 100644
--- a/src/rules/unambiguous.js
+++ b/src/rules/unambiguous.js
@@ -5,6 +5,7 @@
import { isModule } from 'eslint-module-utils/unambiguous';
import docsUrl from '../docsUrl';
+import sourceType from '../core/sourceType';
module.exports = {
meta: {
@@ -19,7 +20,7 @@ module.exports = {
create(context) {
// ignore non-modules
- if (context.parserOptions.sourceType !== 'module') {
+ if (sourceType(context) !== 'module') {
return {};
}
From d27a639f338a77a6a0de87cb40c17d7b81a65b41 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Mon, 16 Sep 2024 08:07:30 +1200
Subject: [PATCH 168/199] [Fix] adjust "is source type module" checks for flat
config
Also see https://github.com/jest-community/eslint-plugin-jest/pull/1639
---
CHANGELOG.md | 2 ++
src/core/sourceType.js | 9 +++++++--
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8c249f1dff..9865e3b2b6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`export`]: False positive for exported overloaded functions in TS ([#3065], thanks [@liuxingbaoyu])
- `exportMap`: export map cache is tainted by unreliable parse results ([#3062], thanks [@michaelfaith])
- `exportMap`: improve cacheKey when using flat config ([#3072], thanks [@michaelfaith])
+- adjust "is source type module" checks for flat config ([#2996], thanks [@G-Rath])
### Changed
- [Docs] [`no-relative-packages`]: fix typo ([#3066], thanks [@joshuaobrien])
@@ -1165,6 +1166,7 @@ for info on changes for earlier releases.
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
[#3004]: https://github.com/import-js/eslint-plugin-import/pull/3004
[#2998]: https://github.com/import-js/eslint-plugin-import/pull/2998
+[#2996]: https://github.com/import-js/eslint-plugin-import/pull/2996
[#2993]: https://github.com/import-js/eslint-plugin-import/pull/2993
[#2991]: https://github.com/import-js/eslint-plugin-import/pull/2991
[#2989]: https://github.com/import-js/eslint-plugin-import/pull/2989
diff --git a/src/core/sourceType.js b/src/core/sourceType.js
index 4243be4cf9..5ff92edc97 100644
--- a/src/core/sourceType.js
+++ b/src/core/sourceType.js
@@ -1,7 +1,12 @@
/**
* @param {import('eslint').Rule.RuleContext} context
- * @returns 'module' | 'script' | undefined
+ * @returns 'module' | 'script' | 'commonjs' | undefined
*/
export default function sourceType(context) {
- return context.parserOptions.sourceType;
+ if ('sourceType' in context.parserOptions) {
+ return context.parserOptions.sourceType;
+ }
+ if ('languageOptions' in context && context.languageOptions) {
+ return context.languageOptions.sourceType;
+ }
}
From d66cde00ee15c49951071636ccf0b3c4ed8ba831 Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Sun, 7 Apr 2024 12:31:53 +1200
Subject: [PATCH 169/199] [New] support eslint v9
Co-authored-by: Gareth Jones <jones258@gmail.com>
Co-authored-by: michael faith <michaelfaith@users.noreply.github.com>
---
.github/workflows/node-4+.yml | 27 ++++++++++
CHANGELOG.md | 1 +
package.json | 4 +-
tests/files/issue210.config.flat.js | 3 ++
tests/files/just-json-files/eslint.config.js | 28 +++++++++++
tests/src/cli.js | 53 +++++++++++++-------
tests/src/rule-tester.js | 46 ++++++++++++++++-
tests/src/rules/named.js | 4 +-
tests/src/rules/namespace.js | 2 +-
tests/src/rules/no-unused-modules.js | 16 +++---
10 files changed, 152 insertions(+), 32 deletions(-)
create mode 100644 tests/files/issue210.config.flat.js
create mode 100644 tests/files/just-json-files/eslint.config.js
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
index f2dad098ca..323c2ad540 100644
--- a/.github/workflows/node-4+.yml
+++ b/.github/workflows/node-4+.yml
@@ -36,6 +36,7 @@ jobs:
- macos-latest
node-version: ${{ fromJson(needs.matrix.outputs.latest) }}
eslint:
+ - 9
- 8
- 7
- 6
@@ -63,34 +64,58 @@ jobs:
env:
TS_PARSER: 2
exclude:
+ - node-version: 16
+ eslint: 9
+ - node-version: 15
+ eslint: 9
- node-version: 15
eslint: 8
+ - node-version: 14
+ eslint: 9
+ - node-version: 13
+ eslint: 9
- node-version: 13
eslint: 8
+ - node-version: 12
+ eslint: 9
+ - node-version: 11
+ eslint: 9
- node-version: 11
eslint: 8
+ - node-version: 10
+ eslint: 9
- node-version: 10
eslint: 8
+ - node-version: 9
+ eslint: 9
- node-version: 9
eslint: 8
- node-version: 9
eslint: 7
+ - node-version: 8
+ eslint: 9
- node-version: 8
eslint: 8
- node-version: 8
eslint: 7
+ - node-version: 7
+ eslint: 9
- node-version: 7
eslint: 8
- node-version: 7
eslint: 7
- node-version: 7
eslint: 6
+ - node-version: 6
+ eslint: 9
- node-version: 6
eslint: 8
- node-version: 6
eslint: 7
- node-version: 6
eslint: 6
+ - node-version: 5
+ eslint: 9
- node-version: 5
eslint: 8
- node-version: 5
@@ -99,6 +124,8 @@ jobs:
eslint: 6
- node-version: 5
eslint: 5
+ - node-version: 4
+ eslint: 9
- node-version: 4
eslint: 8
- node-version: 4
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9865e3b2b6..795fa5bc48 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
### Added
+- support eslint v9 ([#2996], thanks [@G-Rath] [@michaelfaith])
- [`order`]: allow validating named imports ([#3043], thanks [@manuth])
### Fixed
diff --git a/package.json b/package.json
index c0a6b56e4a..53997893aa 100644
--- a/package.json
+++ b/package.json
@@ -76,7 +76,7 @@
"chai": "^4.3.10",
"cross-env": "^4.0.0",
"escope": "^3.6.0",
- "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8",
+ "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9",
"eslint-doc-generator": "^1.6.1",
"eslint-import-resolver-node": "file:./resolvers/node",
"eslint-import-resolver-typescript": "^1.0.2 || ^1.1.1",
@@ -106,7 +106,7 @@
"typescript-eslint-parser": "^15 || ^20 || ^22"
},
"peerDependencies": {
- "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8"
+ "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9"
},
"dependencies": {
"@rtsao/scc": "^1.1.0",
diff --git a/tests/files/issue210.config.flat.js b/tests/files/issue210.config.flat.js
new file mode 100644
index 0000000000..c894376f48
--- /dev/null
+++ b/tests/files/issue210.config.flat.js
@@ -0,0 +1,3 @@
+exports.languageOptions = {
+ sourceType: 'module',
+}
diff --git a/tests/files/just-json-files/eslint.config.js b/tests/files/just-json-files/eslint.config.js
new file mode 100644
index 0000000000..b1bf2070bb
--- /dev/null
+++ b/tests/files/just-json-files/eslint.config.js
@@ -0,0 +1,28 @@
+var jsonPlugin = require('eslint-plugin-json');
+
+if (!jsonPlugin.processors.json) {
+ jsonPlugin.processors.json = jsonPlugin.processors['.json'];
+}
+
+module.exports = [
+ {
+ files: ['tests/files/just-json-files/*.json'],
+ plugins:{
+ json: jsonPlugin,
+ },
+ processor: 'json/json',
+ rules: Object.assign(
+ {},
+ {
+ 'import/no-unused-modules': [
+ 'error',
+ {
+ 'missingExports': false,
+ 'unusedExports': true,
+ },
+ ],
+ },
+ jsonPlugin.configs.recommended.rules
+ )
+ },
+];
diff --git a/tests/src/cli.js b/tests/src/cli.js
index 8a73454878..60b8382d09 100644
--- a/tests/src/cli.js
+++ b/tests/src/cli.js
@@ -15,17 +15,29 @@ describe('CLI regression tests', function () {
let cli;
before(function () {
if (ESLint) {
- eslint = new ESLint({
- useEslintrc: false,
- overrideConfigFile: './tests/files/issue210.config.js',
- rulePaths: ['./src/rules'],
- overrideConfig: {
- rules: {
- named: 2,
+ if (semver.satisfies(eslintPkg.version, '>= 9')) {
+ eslint = new ESLint({
+ overrideConfigFile: './tests/files/issue210.config.flat.js',
+ overrideConfig: {
+ rules: {
+ 'import/named': 2,
+ },
},
- },
- plugins: { 'eslint-plugin-import': importPlugin },
- });
+ plugins: { 'eslint-plugin-import': importPlugin },
+ });
+ } else {
+ eslint = new ESLint({
+ useEslintrc: false,
+ overrideConfigFile: './tests/files/issue210.config.js',
+ rulePaths: ['./src/rules'],
+ overrideConfig: {
+ rules: {
+ named: 2,
+ },
+ },
+ plugins: { 'eslint-plugin-import': importPlugin },
+ });
+ }
} else {
cli = new CLIEngine({
useEslintrc: false,
@@ -56,13 +68,20 @@ describe('CLI regression tests', function () {
this.skip();
} else {
if (ESLint) {
- eslint = new ESLint({
- useEslintrc: false,
- overrideConfigFile: './tests/files/just-json-files/.eslintrc.json',
- rulePaths: ['./src/rules'],
- ignore: false,
- plugins: { 'eslint-plugin-import': importPlugin },
- });
+ if (semver.satisfies(eslintPkg.version, '>= 9')) {
+ eslint = new ESLint({
+ overrideConfigFile: './tests/files/just-json-files/eslint.config.js',
+ plugins: { 'eslint-plugin-import': importPlugin },
+ });
+ } else {
+ eslint = new ESLint({
+ useEslintrc: false,
+ overrideConfigFile: './tests/files/just-json-files/.eslintrc.json',
+ rulePaths: ['./src/rules'],
+ ignore: false,
+ plugins: { 'eslint-plugin-import': importPlugin },
+ });
+ }
} else {
cli = new CLIEngine({
useEslintrc: false,
diff --git a/tests/src/rule-tester.js b/tests/src/rule-tester.js
index f00b520d07..390c6cd7f7 100644
--- a/tests/src/rule-tester.js
+++ b/tests/src/rule-tester.js
@@ -1,5 +1,47 @@
+import { RuleTester } from 'eslint';
+import { version as eslintVersion } from 'eslint/package.json';
+import semver from 'semver';
+
+export const usingFlatConfig = semver.major(eslintVersion) >= 9;
+
export function withoutAutofixOutput(test) {
- return { ...test, output: test.code };
+ return { ...test, ...usingFlatConfig || { output: test.code } };
+}
+
+class FlatCompatRuleTester extends RuleTester {
+ constructor(testerConfig = { parserOptions: { sourceType: 'script' } }) {
+ super(FlatCompatRuleTester._flatCompat(testerConfig));
+ }
+
+ run(ruleName, rule, tests) {
+ super.run(ruleName, rule, {
+ valid: tests.valid.map((t) => FlatCompatRuleTester._flatCompat(t)),
+ invalid: tests.invalid.map((t) => FlatCompatRuleTester._flatCompat(t)),
+ });
+ }
+
+ static _flatCompat(config) {
+ if (!config || !usingFlatConfig || typeof config !== 'object') {
+ return config;
+ }
+
+ const { parser, parserOptions = {}, languageOptions = {}, ...remainingConfig } = config;
+ const { ecmaVersion, sourceType, ...remainingParserOptions } = parserOptions;
+ const parserObj = typeof parser === 'string' ? require(parser) : parser;
+
+ return {
+ ...remainingConfig,
+ languageOptions: {
+ ...languageOptions,
+ ...parserObj ? { parser: parserObj } : {},
+ ...ecmaVersion ? { ecmaVersion } : {},
+ ...sourceType ? { sourceType } : {},
+ parserOptions: {
+ ...remainingParserOptions,
+ },
+ },
+ };
+ }
}
-export { RuleTester } from 'eslint';
+export { FlatCompatRuleTester as RuleTester };
diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
index f506caeb68..51a76c1290 100644
--- a/tests/src/rules/named.js
+++ b/tests/src/rules/named.js
@@ -1,5 +1,5 @@
import { test, SYNTAX_CASES, getTSParsers, testFilePath, testVersion, parsers } from '../utils';
-import { RuleTester } from '../rule-tester';
+import { RuleTester, usingFlatConfig } from '../rule-tester';
import path from 'path';
import { CASE_SENSITIVE_FS } from 'eslint-module-utils/resolve';
@@ -32,7 +32,7 @@ ruleTester.run('named', rule, {
settings: { 'import/resolve': { extensions: ['.js', '.jsx'] } } }),
// validate that eslint-disable-line silences this properly
- test({ code: 'import {a, b, d} from "./common"; // eslint-disable-line named' }),
+ test({ code: `import {a, b, d} from "./common"; // eslint-disable-line ${usingFlatConfig ? 'rule-to-test/' : ''}named` }),
test({ code: 'import { foo, bar } from "./re-export-names"' }),
diff --git a/tests/src/rules/namespace.js b/tests/src/rules/namespace.js
index 60fcb93f6d..2a31d57e19 100644
--- a/tests/src/rules/namespace.js
+++ b/tests/src/rules/namespace.js
@@ -2,7 +2,7 @@ import { test, SYNTAX_CASES, getTSParsers, testVersion, testFilePath, parsers }
import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
-const ruleTester = new RuleTester({ env: { es6: true } });
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
const rule = require('rules/namespace');
function error(name, namespace) {
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index 22b54ce6f4..d86f406220 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -288,8 +288,8 @@ describe('dynamic imports', function () {
// test for unused exports with `import()`
ruleTester.run('no-unused-modules', rule, {
- valid: [
- test({
+ valid: [].concat(
+ testVersion('< 9', () => ({
options: unusedExportsOptions,
code: `
export const a = 10
@@ -300,10 +300,10 @@ describe('dynamic imports', function () {
`,
parser: parsers.BABEL_OLD,
filename: testFilePath('./no-unused-modules/exports-for-dynamic-js.js'),
- }),
- ],
- invalid: [
- test({
+ })),
+ ),
+ invalid: [].concat(
+ testVersion('< 9', () => ({
options: unusedExportsOptions,
code: `
export const a = 10
@@ -319,8 +319,8 @@ describe('dynamic imports', function () {
error(`exported declaration 'b' not used within other modules`),
error(`exported declaration 'c' not used within other modules`),
error(`exported declaration 'default' not used within other modules`),
- ] }),
- ],
+ ] })),
+ ),
});
typescriptRuleTester.run('no-unused-modules', rule, {
valid: [
From 5a51b9a4ca13cb5fa5cfa349a99999826b5e2aed Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Mon, 8 Apr 2024 17:11:39 +1200
Subject: [PATCH 170/199] [Tests] `rule-tester`: try this babel class
workaround
---
tests/src/rule-tester.js | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/tests/src/rule-tester.js b/tests/src/rule-tester.js
index 390c6cd7f7..103f2fd6fe 100644
--- a/tests/src/rule-tester.js
+++ b/tests/src/rule-tester.js
@@ -8,13 +8,13 @@ export function withoutAutofixOutput(test) {
return { ...test, ...usingFlatConfig || { output: test.code } };
}
-class FlatCompatRuleTester extends RuleTester {
+class FlatCompatRuleTester {
constructor(testerConfig = { parserOptions: { sourceType: 'script' } }) {
- super(FlatCompatRuleTester._flatCompat(testerConfig));
+ this._tester = new RuleTester(FlatCompatRuleTester._flatCompat(testerConfig));
}
run(ruleName, rule, tests) {
- super.run(ruleName, rule, {
+ this._tester.run(ruleName, rule, {
valid: tests.valid.map((t) => FlatCompatRuleTester._flatCompat(t)),
invalid: tests.invalid.map((t) => FlatCompatRuleTester._flatCompat(t)),
});
From d225176343d491db07a1c9e6e521ea90f169c928 Mon Sep 17 00:00:00 2001
From: Lenz Weber-Tronic <lorenz.weber-tronic@apollographql.com>
Date: Wed, 5 Jul 2023 12:20:03 +0200
Subject: [PATCH 171/199] [New] `extensions`: add the `checkTypeImports` option
---
CHANGELOG.md | 3 ++
docs/rules/extensions.md | 18 ++++++++++
src/rules/extensions.js | 9 +++--
tests/src/rules/extensions.js | 67 +++++++++++++++++++++++++++++++++++
4 files changed, 95 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 795fa5bc48..d1dc35e798 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- support eslint v9 ([#2996], thanks [@G-Rath] [@michaelfaith])
- [`order`]: allow validating named imports ([#3043], thanks [@manuth])
+- [`extensions`]: add the `checkTypeImports` option ([#2817], thanks [@phryneas])
### Fixed
- `ExportMap` / flat config: include `languageOptions` in context ([#3052], thanks [@michaelfaith])
@@ -1187,6 +1188,7 @@ for info on changes for earlier releases.
[#2842]: https://github.com/import-js/eslint-plugin-import/pull/2842
[#2835]: https://github.com/import-js/eslint-plugin-import/pull/2835
[#2832]: https://github.com/import-js/eslint-plugin-import/pull/2832
+[#2817]: https://github.com/import-js/eslint-plugin-import/pull/2817
[#2778]: https://github.com/import-js/eslint-plugin-import/pull/2778
[#2756]: https://github.com/import-js/eslint-plugin-import/pull/2756
[#2754]: https://github.com/import-js/eslint-plugin-import/pull/2754
@@ -1942,6 +1944,7 @@ for info on changes for earlier releases.
[@pcorpet]: https://github.com/pcorpet
[@Pearce-Ropion]: https://github.com/Pearce-Ropion
[@Pessimistress]: https://github.com/Pessimistress
+[@phryneas]: https://github.com/phryneas
[@pmcelhaney]: https://github.com/pmcelhaney
[@preco21]: https://github.com/preco21
[@pri1311]: https://github.com/pri1311
diff --git a/docs/rules/extensions.md b/docs/rules/extensions.md
index 946ccb7bf8..5d15e93f15 100644
--- a/docs/rules/extensions.md
+++ b/docs/rules/extensions.md
@@ -56,6 +56,8 @@ For example, `["error", "never", { "svg": "always" }]` would require that all ex
In that case, if you still want to specify extensions, you can do so inside the **pattern** property.
Default value of `ignorePackages` is `false`.
+By default, `import type` and `export type` style imports/exports are ignored. If you want to check them as well, you can set the `checkTypeImports` option to `true`.
+
### Exception
When disallowing the use of certain extensions this rule makes an exception and allows the use of extension when the file would not be resolvable without extension.
@@ -104,6 +106,14 @@ import express from 'express/index';
import * as path from 'path';
```
+The following patterns are considered problems when the configuration is set to "never" and the option "checkTypeImports" is set to `true`:
+
+```js
+import type { Foo } from './foo.ts';
+
+export type { Foo } from './foo.ts';
+```
+
The following patterns are considered problems when configuration set to "always":
```js
@@ -167,6 +177,14 @@ import express from 'express';
import foo from '@/foo';
```
+The following patterns are considered problems when the configuration is set to "always" and the option "checkTypeImports" is set to `true`:
+
+```js
+import type { Foo } from './foo';
+
+export type { Foo } from './foo';
+```
+
## When Not To Use It
If you are not concerned about a consistent usage of file extension.
diff --git a/src/rules/extensions.js b/src/rules/extensions.js
index b1e5c6d9f1..c2c03a2b17 100644
--- a/src/rules/extensions.js
+++ b/src/rules/extensions.js
@@ -14,6 +14,7 @@ const properties = {
type: 'object',
properties: {
pattern: patternProperties,
+ checkTypeImports: { type: 'boolean' },
ignorePackages: { type: 'boolean' },
},
};
@@ -35,7 +36,7 @@ function buildProperties(context) {
}
// If this is not the new structure, transfer all props to result.pattern
- if (obj.pattern === undefined && obj.ignorePackages === undefined) {
+ if (obj.pattern === undefined && obj.ignorePackages === undefined && obj.checkTypeImports === undefined) {
Object.assign(result.pattern, obj);
return;
}
@@ -49,6 +50,10 @@ function buildProperties(context) {
if (obj.ignorePackages !== undefined) {
result.ignorePackages = obj.ignorePackages;
}
+
+ if (obj.checkTypeImports !== undefined) {
+ result.checkTypeImports = obj.checkTypeImports;
+ }
});
if (result.defaultConfig === 'ignorePackages') {
@@ -168,7 +173,7 @@ module.exports = {
if (!extension || !importPath.endsWith(`.${extension}`)) {
// ignore type-only imports and exports
- if (node.importKind === 'type' || node.exportKind === 'type') { return; }
+ if (!props.checkTypeImports && (node.importKind === 'type' || node.exportKind === 'type')) { return; }
const extensionRequired = isUseOfExtensionRequired(extension, isPackage);
const extensionForbidden = isUseOfExtensionForbidden(extension);
if (extensionRequired && !extensionForbidden) {
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index 97267832c5..883dfab657 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -3,6 +3,15 @@ import rule from 'rules/extensions';
import { getTSParsers, test, testFilePath, parsers } from '../utils';
const ruleTester = new RuleTester();
+const ruleTesterWithTypeScriptImports = new RuleTester({
+ settings: {
+ 'import/resolver': {
+ typescript: {
+ alwaysTryTypes: true,
+ },
+ },
+ },
+});
ruleTester.run('extensions', rule, {
valid: [
@@ -689,6 +698,64 @@ describe('TypeScript', () => {
],
parser,
}),
+ test({
+ code: 'import type T from "./typescript-declare";',
+ errors: ['Missing file extension for "./typescript-declare"'],
+ options: [
+ 'always',
+ { ts: 'never', tsx: 'never', js: 'never', jsx: 'never', checkTypeImports: true },
+ ],
+ parser,
+ }),
+ test({
+ code: 'export type { MyType } from "./typescript-declare";',
+ errors: ['Missing file extension for "./typescript-declare"'],
+ options: [
+ 'always',
+ { ts: 'never', tsx: 'never', js: 'never', jsx: 'never', checkTypeImports: true },
+ ],
+ parser,
+ }),
+ ],
+ });
+ ruleTesterWithTypeScriptImports.run(`${parser}: (with TS resolver) extensions are enforced for type imports/export when checkTypeImports is set`, rule, {
+ valid: [
+ test({
+ code: 'import type { MyType } from "./typescript-declare.ts";',
+ options: [
+ 'always',
+ { checkTypeImports: true },
+ ],
+ parser,
+ }),
+ test({
+ code: 'export type { MyType } from "./typescript-declare.ts";',
+ options: [
+ 'always',
+ { checkTypeImports: true },
+ ],
+ parser,
+ }),
+ ],
+ invalid: [
+ test({
+ code: 'import type { MyType } from "./typescript-declare";',
+ errors: ['Missing file extension "ts" for "./typescript-declare"'],
+ options: [
+ 'always',
+ { checkTypeImports: true },
+ ],
+ parser,
+ }),
+ test({
+ code: 'export type { MyType } from "./typescript-declare";',
+ errors: ['Missing file extension "ts" for "./typescript-declare"'],
+ options: [
+ 'always',
+ { checkTypeImports: true },
+ ],
+ parser,
+ }),
],
});
});
From 3f1ac249272db87f0191727beeaa368fcbe7aab4 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 3 Oct 2024 13:15:10 +0700
Subject: [PATCH 172/199] [utils] [refactor] `parse`: avoid using a regex here
---
utils/CHANGELOG.md | 3 +++
utils/parse.js | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index 619d050633..bb93725125 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Changed
+- [refactor] `parse`: avoid using a regex here (thanks [@ljharb])
+
## v2.12.0 - 2024-09-26
### Added
diff --git a/utils/parse.js b/utils/parse.js
index 03022ac401..793e37152e 100644
--- a/utils/parse.js
+++ b/utils/parse.js
@@ -33,7 +33,7 @@ function keysFromParser(parserPath, parserInstance, parsedResult) {
// up with a `parsedResult` here. It also doesn't expose the visitor keys on the parser itself,
// so we have to try and infer the visitor-keys module from the parserPath.
// This is NOT supported in flat config!
- if (typeof parserPath === 'string' && (/.*babel-eslint.*/).test(parserPath)) {
+ if (typeof parserPath === 'string' && parserPath.indexOf('babel-eslint') > -1) {
return getBabelEslintVisitorKeys(parserPath);
}
// The espree parser doesn't have the `parseForESLint` function, so we don't end up with a
From 91f809b28323bfbd27749bae84daed00511b07e5 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 3 Oct 2024 13:18:14 +0700
Subject: [PATCH 173/199] v2.31.0
---
CHANGELOG.md | 5 ++++-
package.json | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d1dc35e798..cbf393750e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+## [2.31.0] - 2024-10-03
+
### Added
- support eslint v9 ([#2996], thanks [@G-Rath] [@michaelfaith])
- [`order`]: allow validating named imports ([#3043], thanks [@manuth])
@@ -1646,7 +1648,8 @@ for info on changes for earlier releases.
[#119]: https://github.com/import-js/eslint-plugin-import/issues/119
[#89]: https://github.com/import-js/eslint-plugin-import/issues/89
-[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.30.0...HEAD
+[Unreleased]: https://github.com/import-js/eslint-plugin-import/compare/v2.31.0...HEAD
+[2.31.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.30.0...v2.31.0
[2.30.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.1...v2.30.0
[2.29.1]: https://github.com/import-js/eslint-plugin-import/compare/v2.29.0...v2.29.1
[2.29.0]: https://github.com/import-js/eslint-plugin-import/compare/v2.28.1...v2.29.0
diff --git a/package.json b/package.json
index 53997893aa..7852506bd4 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-import",
- "version": "2.30.0",
+ "version": "2.31.0",
"description": "Import with sanity.",
"engines": {
"node": ">=4"
From 67cc79841fc823ad4af2532af2dc6704e4b3b03a Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 3 Oct 2024 17:36:09 +0700
Subject: [PATCH 174/199] [meta] add missing changelog links
---
CHANGELOG.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cbf393750e..ab57069c42 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -45,11 +45,11 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`order`]: do not compare first path segment for relative paths ([#2682]) ([#2885], thanks [@mihkeleidast])
### Changed
-- [Docs] `no-extraneous-dependencies`: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
+- [Docs] [`no-extraneous-dependencies`]: Make glob pattern description more explicit ([#2944], thanks [@mulztob])
- [`no-unused-modules`]: add console message to help debug [#2866]
- [Refactor] `ExportMap`: make procedures static instead of monkeypatching exportmap ([#2982], thanks [@soryy708])
- [Refactor] `ExportMap`: separate ExportMap instance from its builder logic ([#2985], thanks [@soryy708])
-- [Docs] `order`: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
+- [Docs] [`order`]: Add a quick note on how unbound imports and --fix ([#2640], thanks [@minervabot])
- [Tests] appveyor -> GHA (run tests on Windows in both pwsh and WSL + Ubuntu) ([#2987], thanks [@joeyguerra])
- [actions] migrate OSX tests to GHA ([ljharb#37], thanks [@aks-])
- [Refactor] `exportMapBuilder`: avoid hoisting ([#2989], thanks [@soryy708])
@@ -1831,6 +1831,7 @@ for info on changes for earlier releases.
[@fsmaia]: https://github.com/fsmaia
[@fson]: https://github.com/fson
[@futpib]: https://github.com/futpib
+[@G-Rath]: https://github.com/G-Rath
[@gajus]: https://github.com/gajus
[@gausie]: https://github.com/gausie
[@gavriguy]: https://github.com/gavriguy
From ac7d3966abdac247deabc373ff3f73dcca765c44 Mon Sep 17 00:00:00 2001
From: seiya <20365512+seiyab@users.noreply.github.com>
Date: Tue, 12 Nov 2024 22:24:47 +0000
Subject: [PATCH 175/199] [resolvers/webpack] [new] add cache option
---
resolvers/webpack/CHANGELOG.md | 3 ++
resolvers/webpack/README.md | 11 +++++
resolvers/webpack/index.js | 21 +++++++-
resolvers/webpack/test/cache.js | 48 +++++++++++++++++++
.../files/webpack.function.config.multiple.js | 1 +
5 files changed, 83 insertions(+), 1 deletion(-)
create mode 100644 resolvers/webpack/test/cache.js
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 79b2837e3d..1d23bf6fdd 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
+- [new] add cache option ([#3100], thanks [@seiyab])
## 0.13.9 - 2024-09-02
- [refactor] simplify loop ([#3029], thanks [@fregante])
@@ -182,6 +183,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- `interpret` configs (such as `.babel.js`). Thanks to [@gausie] for the initial PR ([#164], ages ago! 😅) and [@jquense] for tests ([#278]).
+[#3100]: https://github.com/import-js/eslint-plugin-import/pull/3100
[#3029]: https://github.com/import-js/eslint-plugin-import/pull/3029
[#2287]: https://github.com/import-js/eslint-plugin-import/pull/2287
[#2023]: https://github.com/import-js/eslint-plugin-import/pull/2023
@@ -247,6 +249,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
[@Rogeres]: https://github.com/Rogeres
[@Satyam]: https://github.com/Satyam
[@Schweinepriester]: https://github.com/Schweinepriester
+[@seiyab]: https://github.com/seiyab
[@SkeLLLa]: https://github.com/SkeLLLa
[@taion]: https://github.com/taion
[@toshafed]: https://github.com/toshafed
diff --git a/resolvers/webpack/README.md b/resolvers/webpack/README.md
index 06513ba141..9b01396898 100644
--- a/resolvers/webpack/README.md
+++ b/resolvers/webpack/README.md
@@ -94,6 +94,17 @@ settings:
production: true
```
+If your config is set as a function, it will be evaluated at every resolution. You have an option to prevent this by caching it using the `cache` parameter:
+
+```yaml
+---
+settings:
+ import/resolver:
+ webpack:
+ config: 'webpack.config.js'
+ cache: true
+```
+
## Support
[Get supported eslint-import-resolver-webpack with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-eslint-import-resolver-webpack?utm_source=npm-eslint-import-resolver-webpack&utm_medium=referral&utm_campaign=readme)
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
index 83297cd185..ae736abe76 100644
--- a/resolvers/webpack/index.js
+++ b/resolvers/webpack/index.js
@@ -311,6 +311,22 @@ function getResolveSync(configPath, webpackConfig, cwd) {
return cached.value;
}
+const _evalCache = new Map();
+function evaluateFunctionConfigCached(configPath, webpackConfig, env, argv) {
+ const cacheKey = JSON.stringify({ configPath, args: [env, argv] });
+ if (_evalCache.has(cacheKey)) {
+ return _evalCache.get(cacheKey);
+ }
+ const cached = webpackConfig(env, argv);
+ _evalCache.set(cacheKey, cached);
+
+ while (_evalCache.size > MAX_CACHE) {
+ // remove oldest item
+ _evalCache.delete(_evalCache.keys().next().value);
+ }
+ return cached;
+}
+
/**
* Find the full path to 'source', given 'file' as a full reference path.
*
@@ -354,6 +370,7 @@ exports.resolve = function (source, file, settings) {
const configIndex = settings && settings['config-index'];
const env = settings && settings.env;
const argv = settings && typeof settings.argv !== 'undefined' ? settings.argv : {};
+ const shouldCacheFunctionConfig = settings && settings.cache;
let packageDir;
let configPath = typeof _configPath === 'string' && _configPath.startsWith('.')
@@ -398,7 +415,9 @@ exports.resolve = function (source, file, settings) {
}
if (typeof webpackConfig === 'function') {
- webpackConfig = webpackConfig(env, argv);
+ webpackConfig = shouldCacheFunctionConfig
+ ? evaluateFunctionConfigCached(configPath, webpackConfig, env, argv)
+ : webpackConfig(env, argv);
}
if (isArray(webpackConfig)) {
diff --git a/resolvers/webpack/test/cache.js b/resolvers/webpack/test/cache.js
new file mode 100644
index 0000000000..04d6de0577
--- /dev/null
+++ b/resolvers/webpack/test/cache.js
@@ -0,0 +1,48 @@
+'use strict';
+
+const chai = require('chai');
+const expect = chai.expect;
+const path = require('path');
+
+const resolve = require('../index').resolve;
+
+const file = path.join(__dirname, 'files', 'src', 'jsx', 'dummy.js');
+
+describe('cache', function () {
+ it('can distinguish different config files', function () {
+ const setting1 = {
+ config: require(path.join(__dirname, './files/webpack.function.config.js')),
+ argv: {
+ mode: 'test',
+ },
+ cache: true,
+ };
+ expect(resolve('baz', file, setting1)).to.have.property('path')
+ .and.equal(path.join(__dirname, 'files', 'some', 'bar', 'bar.js'));
+ const setting2 = {
+ config: require(path.join(__dirname, './files/webpack.function.config.multiple.js')),
+ cache: true,
+ };
+ expect(resolve('baz', file, setting2)).to.have.property('path')
+ .and.equal(path.join(__dirname, 'files', 'some', 'goofy', 'path', 'foo.js'));
+ });
+
+ it('can distinguish different config', function () {
+ const setting1 = {
+ config: require(path.join(__dirname, './files/webpack.function.config.js')),
+ env: {
+ dummy: true,
+ },
+ cache: true,
+ };
+ expect(resolve('bar', file, setting1)).to.have.property('path')
+ .and.equal(path.join(__dirname, 'files', 'some', 'goofy', 'path', 'bar.js'));
+ const setting2 = {
+ config: require(path.join(__dirname, './files/webpack.function.config.multiple.js')),
+ cache: true,
+ };
+ const result = resolve('bar', file, setting2);
+ expect(result).not.to.have.property('path');
+ expect(result).to.have.property('found').to.be.false;
+ });
+});
diff --git a/resolvers/webpack/test/files/webpack.function.config.multiple.js b/resolvers/webpack/test/files/webpack.function.config.multiple.js
index 4dbc94bbc9..8ab982bbc6 100644
--- a/resolvers/webpack/test/files/webpack.function.config.multiple.js
+++ b/resolvers/webpack/test/files/webpack.function.config.multiple.js
@@ -7,6 +7,7 @@ module.exports = [function(env) {
alias: {
'foo': path.join(__dirname, 'some', 'goofy', 'path', 'foo.js'),
'bar': env ? path.join(__dirname, 'some', 'goofy', 'path', 'bar.js') : undefined,
+ 'baz': path.join(__dirname, 'some', 'goofy', 'path', 'foo.js'),
'some-alias': path.join(__dirname, 'some'),
},
modules: [
From a20d84398a7946f53f2f20a83d6ff028bebbce62 Mon Sep 17 00:00:00 2001
From: Yuri Mikushov <mikushov.yu@gmail.com>
Date: Fri, 15 Nov 2024 09:38:43 +0100
Subject: [PATCH 176/199] [Docs] `dynamic-import-chunkname`: fix typo in usage
of the rule
---
docs/rules/dynamic-import-chunkname.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/rules/dynamic-import-chunkname.md b/docs/rules/dynamic-import-chunkname.md
index de554148ee..d9ee8d15e2 100644
--- a/docs/rules/dynamic-import-chunkname.md
+++ b/docs/rules/dynamic-import-chunkname.md
@@ -15,7 +15,7 @@ You can also configure the regex format you'd like to accept for the webpackChun
```javascript
{
- "dynamic-import-chunkname": [2, {
+ "import/dynamic-import-chunkname": [2, {
importFunctions: ["dynamicImport"],
webpackChunknameFormat: "[a-zA-Z0-57-9-/_]+",
allowEmpty: false
From d5f295081ed1fcf9ff1b21a1a586cc50caebe36f Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Mon, 18 Nov 2024 03:06:33 -0800
Subject: [PATCH 177/199] [Docs] `extensions`, `order`: improve documentation
---
.markdownlint.json | 3 +
CHANGELOG.md | 5 +
docs/rules/extensions.md | 55 ++-
docs/rules/order.md | 915 ++++++++++++++++++++++++++++++++-------
4 files changed, 815 insertions(+), 163 deletions(-)
diff --git a/.markdownlint.json b/.markdownlint.json
index d179615f45..02a066730b 100644
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -1,5 +1,8 @@
{
"line-length": false,
+ "no-duplicate-heading": {
+ "siblings_only": true
+ },
"ul-indent": {
"start_indent": 1,
"start_indented": true
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ab57069c42..2174fc46bf 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Changed
+- [Docs] `extensions`, `order`: improve documentation ([#3106], thanks [@Xunnamius])
+
## [2.31.0] - 2024-10-03
### Added
@@ -1152,6 +1155,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3071]: https://github.com/import-js/eslint-plugin-import/pull/3071
@@ -2018,6 +2022,7 @@ for info on changes for earlier releases.
[@wtgtybhertgeghgtwtg]: https://github.com/wtgtybhertgeghgtwtg
[@xM8WVqaG]: https://github.com/xM8WVqaG
[@xpl]: https://github.com/xpl
+[@Xunnamius]: https://github.com/Xunnamius
[@yesl-kim]: https://github.com/yesl-kim
[@yndajas]: https://github.com/yndajas
[@yordis]: https://github.com/yordis
diff --git a/docs/rules/extensions.md b/docs/rules/extensions.md
index 5d15e93f15..bd9f3f3584 100644
--- a/docs/rules/extensions.md
+++ b/docs/rules/extensions.md
@@ -10,13 +10,13 @@ In order to provide a consistent use of file extensions across your code base, t
This rule either takes one string option, one object option, or a string and an object option. If it is the string `"never"` (the default value), then the rule forbids the use for any extension. If it is the string `"always"`, then the rule enforces the use of extensions for all import statements. If it is the string `"ignorePackages"`, then the rule enforces the use of extensions for all import statements except package imports.
-```json
+```jsonc
"import/extensions": [<severity>, "never" | "always" | "ignorePackages"]
```
By providing an object you can configure each extension separately.
-```json
+```jsonc
"import/extensions": [<severity>, {
<extension>: "never" | "always" | "ignorePackages"
}]
@@ -26,7 +26,7 @@ By providing an object you can configure each extension separately.
By providing both a string and an object, the string will set the default setting for all extensions, and the object can be used to set granular overrides for specific extensions.
-```json
+```jsonc
"import/extensions": [
<severity>,
"never" | "always" | "ignorePackages",
@@ -40,7 +40,7 @@ For example, `["error", "never", { "svg": "always" }]` would require that all ex
`ignorePackages` can be set as a separate boolean option like this:
-```json
+```jsonc
"import/extensions": [
<severity>,
"never" | "always" | "ignorePackages",
@@ -58,6 +58,50 @@ Default value of `ignorePackages` is `false`.
By default, `import type` and `export type` style imports/exports are ignored. If you want to check them as well, you can set the `checkTypeImports` option to `true`.
+Unfortunately, in more advanced linting setups, such as when employing custom specifier aliases (e.g. you're using `eslint-import-resolver-alias`, `paths` in `tsconfig.json`, etc), this rule can be too coarse-grained when determining which imports to ignore and on which to enforce the config.
+This is especially troublesome if you have import specifiers that [look like externals or builtins](./order.md#how-imports-are-grouped).
+
+Set `pathGroupOverrides` to force this rule to always ignore certain imports and never ignore others.
+`pathGroupOverrides` accepts an array of one or more [`PathGroupOverride`](#pathgroupoverride) objects.
+
+For example:
+
+```jsonc
+"import/extensions": [
+ <severity>,
+ "never" | "always" | "ignorePackages",
+ {
+ ignorePackages: true | false,
+ pattern: {
+ <extension>: "never" | "always" | "ignorePackages"
+ },
+ pathGroupOverrides: [
+ {
+ pattern: "package-name-to-ignore",
+ action: "ignore",
+ },
+ {
+ pattern: "bespoke+alias:{*,*/**}",
+ action: "enforce",
+ }
+ ]
+ }
+]
+```
+
+> \[!NOTE]
+>
+> `pathGroupOverrides` is inspired by [`pathGroups` in `'import/order'`](./order.md#pathgroups) and shares a similar interface.
+> If you're using `pathGroups` already, you may find `pathGroupOverrides` very useful.
+
+### `PathGroupOverride`
+
+| property | required | type | description |
+| :--------------: | :------: | :---------------------: | --------------------------------------------------------------- |
+| `pattern` | ☑️ | `string` | [Minimatch pattern][16] for specifier matching |
+| `patternOptions` | | `object` | [Minimatch options][17]; default: `{nocomment: true}` |
+| `action` | ☑️ | `"enforce" \| "ignore"` | What action to take on imports whose specifiers match `pattern` |
+
### Exception
When disallowing the use of certain extensions this rule makes an exception and allows the use of extension when the file would not be resolvable without extension.
@@ -190,3 +234,6 @@ export type { Foo } from './foo';
If you are not concerned about a consistent usage of file extension.
In the future, when this rule supports native node ESM resolution, and the plugin is configured to use native rather than transpiled ESM (a config option that is not yet available) - setting this to `always` will have no effect.
+
+[16]: https://www.npmjs.com/package/minimatch#features
+[17]: https://www.npmjs.com/package/minimatch#options
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 6762799534..fcdd4fda7e 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -6,7 +6,7 @@
Enforce a convention in the order of `require()` / `import` statements.
-With the [`groups`](#groups-array) option set to `["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"]` the order is as shown in the following example:
+With the [`groups`][18] option set to `["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"]` the order is as shown in the following example:
```ts
// 1. node "builtin" modules
@@ -32,9 +32,7 @@ import log = console.log;
import type { Foo } from 'foo';
```
-Unassigned imports are ignored, as the order they are imported in may be important.
-
-Statements using the ES6 `import` syntax must appear before any `require()` statements.
+See [here][3] for further details on how imports are grouped.
## Fail
@@ -98,86 +96,151 @@ import 'format2.css'; // OK
## Options
-This rule supports the following options:
+This rule supports the following options (none of which are required):
-### `groups: [array]`
+ - [`groups`][18]
+ - [`pathGroups`][8]
+ - [`pathGroupsExcludedImportTypes`][9]
+ - [`distinctGroup`][32]
+ - [`newlines-between`][20]
+ - [`alphabetize`][30]
+ - [`named`][33]
+ - [`warnOnUnassignedImports`][5]
+ - [`sortTypesAmongThemselves`][7]
+ - [`newlines-between-types`][27]
+ - [`consolidateIslands`][25]
-How groups are defined, and the order to respect. `groups` must be an array of `string` or [`string`]. The only allowed `string`s are:
-`"builtin"`, `"external"`, `"internal"`, `"unknown"`, `"parent"`, `"sibling"`, `"index"`, `"object"`, `"type"`.
-The enforced order is the same as the order of each element in a group. Omitted types are implicitly grouped together as the last element. Example:
+---
-```ts
-[
- 'builtin', // Built-in types are first
- ['sibling', 'parent'], // Then sibling and parent types. They can be mingled together
- 'index', // Then the index file
- 'object',
- // Then the rest: internal and external type
-]
-```
+### `groups`
-The default value is `["builtin", "external", "parent", "sibling", "index"]`.
+Valid values: `("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type")[]` \
+Default: `["builtin", "external", "parent", "sibling", "index"]`
-You can set the options like this:
+Determines which imports are subject to ordering, and how to order
+them. The predefined groups are: `"builtin"`, `"external"`, `"internal"`,
+`"unknown"`, `"parent"`, `"sibling"`, `"index"`, `"object"`, and `"type"`.
-```ts
-"import/order": [
- "error",
- {
+The import order enforced by this rule is the same as the order of each group
+in `groups`. Imports belonging to groups omitted from `groups` are lumped
+together at the end.
+
+#### Example
+
+```jsonc
+{
+ "import/order": ["error", {
"groups": [
- "index",
- "sibling",
- "parent",
- "internal",
- "external",
+ // Imports of builtins are first
"builtin",
+ // Then sibling and parent imports. They can be mingled together
+ ["sibling", "parent"],
+ // Then index file imports
+ "index",
+ // Then any arcane TypeScript imports
"object",
- "type"
- ]
- }
-]
+ // Then the omitted imports: internal, external, type, unknown
+ ],
+ }],
+}
```
-### `pathGroups: [array of objects]`
+#### How Imports Are Grouped
-To be able to group by paths mostly needed with aliases pathGroups can be defined.
+An import (a `ImportDeclaration`, `TSImportEqualsDeclaration`, or `require()` `CallExpression`) is grouped by its type (`"require"` vs `"import"`), its [specifier][4], and any corresponding identifiers.
-Properties of the objects
-
-| property | required | type | description |
-|----------------|:--------:|--------|---------------|
-| pattern | x | string | minimatch pattern for the paths to be in this group (will not be used for builtins or externals) |
-| patternOptions | | object | options for minimatch, default: { nocomment: true } |
-| group | x | string | one of the allowed groups, the pathGroup will be positioned relative to this group |
-| position | | string | defines where around the group the pathGroup will be positioned, can be 'after' or 'before', if not provided pathGroup will be positioned like the group |
+```ts
+import { identifier1, identifier2 } from 'specifier1';
+import type { MyType } from 'specifier2';
+const identifier3 = require('specifier3');
+```
-```json
+Roughly speaking, the grouping algorithm is as follows:
+
+1. If the import has no corresponding identifiers (e.g. `import './my/thing.js'`), is otherwise "unassigned," or is an unsupported use of `require()`, and [`warnOnUnassignedImports`][5] is disabled, it will be ignored entirely since the order of these imports may be important for their [side-effects][31]
+2. If the import is part of an arcane TypeScript declaration (e.g. `import log = console.log`), it will be considered **object**. However, note that external module references (e.g. `import x = require('z')`) are treated as normal `require()`s and import-exports (e.g. `export import w = y;`) are ignored entirely
+3. If the import is [type-only][6], `"type"` is in `groups`, and [`sortTypesAmongThemselves`][7] is disabled, it will be considered **type** (with additional implications if using [`pathGroups`][8] and `"type"` is in [`pathGroupsExcludedImportTypes`][9])
+4. If the import's specifier matches [`import/internal-regex`][28], it will be considered **internal**
+5. If the import's specifier is an absolute path, it will be considered **unknown**
+6. If the import's specifier has the name of a Node.js core module (using [is-core-module][10]), it will be considered **builtin**
+7. If the import's specifier matches [`import/core-modules`][11], it will be considered **builtin**
+8. If the import's specifier is a path relative to the parent directory of its containing file (e.g. starts with `../`), it will be considered **parent**
+9. If the import's specifier is one of `['.', './', './index', './index.js']`, it will be considered **index**
+10. If the import's specifier is a path relative to its containing file (e.g. starts with `./`), it will be considered **sibling**
+11. If the import's specifier is a path pointing to a file outside the current package's root directory (determined using [package-up][12]), it will be considered **external**
+12. If the import's specifier matches [`import/external-module-folders`][29] (defaults to matching anything pointing to files within the current package's `node_modules` directory), it will be considered **external**
+13. If the import's specifier is a path pointing to a file within the current package's root directory (determined using [package-up][12]), it will be considered **internal**
+14. If the import's specifier has a name that looks like a scoped package (e.g. `@scoped/package-name`), it will be considered **external**
+15. If the import's specifier has a name that starts with a word character, it will be considered **external**
+16. If this point is reached, the import will be ignored entirely
+
+At the end of the process, if they co-exist in the same file, all top-level `require()` statements that haven't been ignored are shifted (with respect to their order) below any ES6 `import` or similar declarations. Finally, any type-only declarations are potentially reorganized according to [`sortTypesAmongThemselves`][7].
+
+### `pathGroups`
+
+Valid values: `PathGroup[]` \
+Default: `[]`
+
+Sometimes [the predefined groups][18] are not fine-grained
+enough, especially when using import aliases. `pathGroups` defines one or more
+[`PathGroup`][13]s relative to a predefined group. Imports are associated with a
+[`PathGroup`][13] based on path matching against the import specifier (using
+[minimatch][14]).
+
+> \[!IMPORTANT]
+>
+> Note that, by default, imports grouped as `"builtin"`, `"external"`, or `"object"` will not be considered for further `pathGroups` matching unless they are removed from [`pathGroupsExcludedImportTypes`][9].
+
+#### `PathGroup`
+
+| property | required | type | description |
+| :--------------: | :------: | :--------------------: | ------------------------------------------------------------------------------------------------------------------------------- |
+| `pattern` | ☑️ | `string` | [Minimatch pattern][16] for specifier matching |
+| `patternOptions` | | `object` | [Minimatch options][17]; default: `{nocomment: true}` |
+| `group` | ☑️ | [predefined group][18] | One of the [predefined groups][18] to which matching imports will be positioned relatively |
+| `position` | | `"after" \| "before"` | Where, in relation to `group`, matching imports will be positioned; default: same position as `group` (neither before or after) |
+
+#### Example
+
+```jsonc
{
"import/order": ["error", {
"pathGroups": [
{
+ // Minimatch pattern used to match against specifiers
"pattern": "~/**",
- "group": "external"
+ // The predefined group this PathGroup is defined in relation to
+ "group": "external",
+ // How matching imports will be positioned relative to "group"
+ "position": "after"
}
]
}]
}
```
-### `distinctGroup: [boolean]`
+### `pathGroupsExcludedImportTypes`
-This changes how `pathGroups[].position` affects grouping. The property is most useful when `newlines-between` is set to `always` and at least 1 `pathGroups` entry has a `position` property set.
+Valid values: `("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type")[]` \
+Default: `["builtin", "external", "object"]`
-By default, in the context of a particular `pathGroup` entry, when setting `position`, a new "group" will silently be created. That is, even if the `group` is specified, a newline will still separate imports that match that `pattern` with the rest of the group (assuming `newlines-between` is `always`). This is undesirable if your intentions are to use `position` to position _within_ the group (and not create a new one). Override this behavior by setting `distinctGroup` to `false`; this will keep imports within the same group as intended.
+By default, imports in certain [groups][18] are excluded
+from being matched against [`pathGroups`][8] to prevent overeager sorting. Use
+`pathGroupsExcludedImportTypes` to modify which groups are excluded.
-Note that currently, `distinctGroup` defaults to `true`. However, in a later update, the default will change to `false`
+> \[!TIP]
+>
+> If using imports with custom specifier aliases (e.g.
+> you're using `eslint-import-resolver-alias`, `paths` in `tsconfig.json`, etc) that [end up
+> grouped][3] as `"builtin"` or `"external"` imports,
+> remove them from `pathGroupsExcludedImportTypes` to ensure they are ordered
+> correctly.
-Example:
+#### Example
-```json
+```jsonc
{
"import/order": ["error", {
- "newlines-between": "always",
"pathGroups": [
{
"pattern": "@app/**",
@@ -185,54 +248,74 @@ Example:
"position": "after"
}
],
- "distinctGroup": false
+ "pathGroupsExcludedImportTypes": ["builtin"]
}]
}
```
-### `pathGroupsExcludedImportTypes: [array]`
+### `distinctGroup`
+
+Valid values: `boolean` \
+Default: `true`
+
+> \[!CAUTION]
+>
+> Currently, `distinctGroup` defaults to `true`. However, in a later update, the
+> default will change to `false`.
-This defines import types that are not handled by configured pathGroups.
-If you have added path groups with patterns that look like `"builtin"` or `"external"` imports, you have to remove this group (`"builtin"` and/or `"external"`) from the default exclusion list (e.g., `["builtin", "external", "object"]`, etc) to sort these path groups correctly.
+This changes how [`PathGroup.position`][13] affects grouping, and is most useful when [`newlines-between`][20] is set to `always` and at least one [`PathGroup`][13] has a `position` property set.
-Example:
+When [`newlines-between`][20] is set to `always` and an import matching a specific [`PathGroup.pattern`][13] is encountered, that import is added to a sort of "sub-group" associated with that [`PathGroup`][13]. Thanks to [`newlines-between`][20], imports in this "sub-group" will have a new line separating them from the rest of the imports in [`PathGroup.group`][13].
-```json
+This behavior can be undesirable when using [`PathGroup.position`][13] to order imports _within_ [`PathGroup.group`][13] instead of creating a distinct "sub-group". Set `distinctGroup` to `false` to disable the creation of these "sub-groups".
+
+#### Example
+
+```jsonc
{
"import/order": ["error", {
+ "distinctGroup": false,
+ "newlines-between": "always",
"pathGroups": [
{
"pattern": "@app/**",
"group": "external",
"position": "after"
}
- ],
- "pathGroupsExcludedImportTypes": ["builtin"]
+ ]
}]
}
```
-[Import Type](https://github.com/import-js/eslint-plugin-import/blob/HEAD/src/core/importType.js#L90) is resolved as a fixed string in predefined set, it can't be a `patterns`(e.g., `react`, `react-router-dom`, etc). See [#2156] for details.
+### `newlines-between`
+
+Valid values: `"ignore" | "always" | "always-and-inside-groups" | "never"` \
+Default: `"ignore"`
+
+Enforces or forbids new lines between import groups.
-### `newlines-between: [ignore|always|always-and-inside-groups|never]`
+ - If set to `ignore`, no errors related to new lines between import groups will be reported
-Enforces or forbids new lines between import groups:
+ - If set to `always`, at least one new line between each group will be enforced, and new lines inside a group will be forbidden
- - If set to `ignore`, no errors related to new lines between import groups will be reported.
- - If set to `always`, at least one new line between each group will be enforced, and new lines inside a group will be forbidden. To prevent multiple lines between imports, core `no-multiple-empty-lines` rule can be used.
- - If set to `always-and-inside-groups`, it will act like `always` except newlines are allowed inside import groups.
- - If set to `never`, no new lines are allowed in the entire import section.
+ > [!TIP]
+ >
+ > To prevent multiple lines between imports, the [`no-multiple-empty-lines` rule][21], or a tool like [Prettier][22], can be used.
-The default value is `"ignore"`.
+ - If set to `always-and-inside-groups`, it will act like `always` except new lines are allowed inside import groups
-With the default group setting, the following will be invalid:
+ - If set to `never`, no new lines are allowed in the entire import section
+
+#### Example
+
+With the default [`groups`][18] setting, the following will fail the rule check:
```ts
/* eslint import/order: ["error", {"newlines-between": "always"}] */
import fs from 'fs';
import path from 'path';
-import index from './';
import sibling from './foo';
+import index from './';
```
```ts
@@ -240,8 +323,8 @@ import sibling from './foo';
import fs from 'fs';
import path from 'path';
-import index from './';
import sibling from './foo';
+import index from './';
```
```ts
@@ -249,21 +332,21 @@ import sibling from './foo';
import fs from 'fs';
import path from 'path';
-import index from './';
-
import sibling from './foo';
+
+import index from './';
```
-while those will be valid:
+While this will pass:
```ts
/* eslint import/order: ["error", {"newlines-between": "always"}] */
import fs from 'fs';
import path from 'path';
-import index from './';
-
import sibling from './foo';
+
+import index from './';
```
```ts
@@ -272,163 +355,677 @@ import fs from 'fs';
import path from 'path';
-import index from './';
-
import sibling from './foo';
+
+import index from './';
```
```ts
/* eslint import/order: ["error", {"newlines-between": "never"}] */
import fs from 'fs';
import path from 'path';
-import index from './';
import sibling from './foo';
+import index from './';
```
-### `named: true|false|{ enabled: true|false, import: true|false, export: true|false, require: true|false, cjsExports: true|false, types: mixed|types-first|types-last }`
+### `alphabetize`
-Enforce ordering of names within imports and exports:
+Valid values: `{ order?: "asc" | "desc" | "ignore", orderImportKind?: "asc" | "desc" | "ignore", caseInsensitive?: boolean }` \
+Default: `{ order: "ignore", orderImportKind: "ignore", caseInsensitive: false }`
- - If set to `true`, named imports must be ordered according to the `alphabetize` options
- - If set to `false`, named imports can occur in any order
+Determine the sort order of imports within each [predefined group][18] or [`PathGroup`][8] alphabetically based on specifier.
-`enabled` enables the named ordering for all expressions by default.
-Use `import`, `export` and `require` and `cjsExports` to override the enablement for the following kind of expressions:
+> \[!NOTE]
+>
+> Imports will be alphabetized based on their _specifiers_, not by their
+> identifiers. For example, `const a = require('z');` will come _after_ `const z = require('a');` when `alphabetize` is set to `{ order: "asc" }`.
+
+Valid properties and their values include:
+
+ - **`order`**: use `"asc"` to sort in ascending order, `"desc"` to sort in descending order, or "ignore" to prevent sorting
+
+ - **`orderImportKind`**: use `"asc"` to sort various _import kinds_, e.g. [type-only and typeof imports][6], in ascending order, `"desc"` to sort them in descending order, or "ignore" to prevent sorting
+
+ - **`caseInsensitive`**: use `true` to ignore case and `false` to consider case when sorting
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "alphabetize": {
+ "order": "asc",
+ "caseInsensitive": true
+ }
+ }]
+}
+```
+
+This will fail the rule check:
+
+```ts
+import React, { PureComponent } from 'react';
+import aTypes from 'prop-types';
+import { compose, apply } from 'xcompose';
+import * as classnames from 'classnames';
+import blist from 'BList';
+```
+
+While this will pass:
+
+```ts
+import blist from 'BList';
+import * as classnames from 'classnames';
+import aTypes from 'prop-types';
+import React, { PureComponent } from 'react';
+import { compose, apply } from 'xcompose';
+```
+
+### `named`
+
+Valid values: `boolean | { enabled: boolean, import?: boolean, export?: boolean, require?: boolean, cjsExports?: boolean, types?: "mixed" | "types-first" | "types-last" }` \
+Default: `false`
+
+Enforce ordering of names within imports and exports.
+
+If set to `true` or `{ enabled: true }`, _all_ named imports must be ordered
+according to [`alphabetize`][30]. If set to `false` or `{ enabled:
+false }`, named imports can occur in any order.
+
+If set to `{ enabled: true, ... }`, and any of the properties `import`,
+`export`, `require`, or `cjsExports` are set to `false`, named ordering is
+disabled with respect to the following kind of expressions:
- `import`:
- ```ts
- import { Readline } from "readline";
- ```
+ ```ts
+ import { Readline } from "readline";
+ ```
- `export`:
- ```ts
- export { Readline };
- // and
- export { Readline } from "readline";
- ```
+ ```ts
+ export { Readline };
+ // and
+ export { Readline } from "readline";
+ ```
- - `require`
+ - `require`:
- ```ts
- const { Readline } = require("readline");
- ```
+ ```ts
+ const { Readline } = require("readline");
+ ```
- - `cjsExports`
+ - `cjsExports`:
- ```ts
- module.exports.Readline = Readline;
- // and
- module.exports = { Readline };
- ```
+ ```ts
+ module.exports.Readline = Readline;
+ // and
+ module.exports = { Readline };
+ ```
-The `types` option allows you to specify the order of `import`s and `export`s of `type` specifiers.
-Following values are possible:
+Further, the `named.types` option allows you to specify the order of [import identifiers with inline type qualifiers][23] (or "type-only" identifiers/names), e.g. `import { type TypeIdentifier1, normalIdentifier2 } from 'specifier';`.
- - `types-first`: forces `type` specifiers to occur first
- - `types-last`: forces value specifiers to occur first
- - `mixed`: sorts all specifiers in alphabetical order
+`named.types` accepts the following values:
-The default value is `false`.
+ - `types-first`: forces type-only identifiers to occur first
+ - `types-last`: forces type-only identifiers to occur last
+ - `mixed`: sorts all identifiers in alphabetical order
-Example setting:
+#### Example
-```ts
+Given the following settings:
+
+```jsonc
{
- named: true,
- alphabetize: {
- order: 'asc'
- }
+ "import/order": ["error", {
+ "named": true,
+ "alphabetize": {
+ "order": "asc"
+ }
+ }]
}
```
This will fail the rule check:
```ts
-/* eslint import/order: ["error", {"named": true, "alphabetize": {"order": "asc"}}] */
import { compose, apply } from 'xcompose';
```
While this will pass:
```ts
-/* eslint import/order: ["error", {"named": true, "alphabetize": {"order": "asc"}}] */
import { apply, compose } from 'xcompose';
```
-### `alphabetize: {order: asc|desc|ignore, orderImportKind: asc|desc|ignore, caseInsensitive: true|false}`
+### `warnOnUnassignedImports`
-Sort the order within each group in alphabetical manner based on **import path**:
+Valid values: `boolean` \
+Default: `false`
- - `order`: use `asc` to sort in ascending order, and `desc` to sort in descending order (default: `ignore`).
- - `orderImportKind`: use `asc` to sort in ascending order various import kinds, e.g. imports prefixed with `type` or `typeof`, with same import path. Use `desc` to sort in descending order (default: `ignore`).
- - `caseInsensitive`: use `true` to ignore case, and `false` to consider case (default: `false`).
+Warn when "unassigned" imports are out of order. Unassigned imports are imports
+with no corresponding identifiers (e.g. `import './my/thing.js'` or
+`require('./side-effects.js')`).
-Example setting:
+> \[!NOTE]
+>
+> These warnings are not fixable with `--fix` since unassigned imports might be
+> used for their
+> [side-effects][31],
+> and changing the order of such imports cannot be done safely.
-```ts
-alphabetize: {
- order: 'asc', /* sort in ascending order. Options: ['ignore', 'asc', 'desc'] */
- caseInsensitive: true /* ignore case. Options: [true, false] */
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "warnOnUnassignedImports": true
+ }]
}
```
This will fail the rule check:
```ts
-/* eslint import/order: ["error", {"alphabetize": {"order": "asc", "caseInsensitive": true}}] */
-import React, { PureComponent } from 'react';
-import aTypes from 'prop-types';
-import { compose, apply } from 'xcompose';
-import * as classnames from 'classnames';
-import blist from 'BList';
+import fs from 'fs';
+import './styles.css';
+import path from 'path';
```
While this will pass:
```ts
-/* eslint import/order: ["error", {"alphabetize": {"order": "asc", "caseInsensitive": true}}] */
-import blist from 'BList';
-import * as classnames from 'classnames';
-import aTypes from 'prop-types';
-import React, { PureComponent } from 'react';
-import { compose, apply } from 'xcompose';
+import fs from 'fs';
+import path from 'path';
+import './styles.css';
```
-### `warnOnUnassignedImports: true|false`
+### `sortTypesAmongThemselves`
+
+Valid values: `boolean` \
+Default: `false`
+
+> \[!NOTE]
+>
+> This setting is only meaningful when `"type"` is included in [`groups`][18].
+
+Sort [type-only imports][6] separately from normal non-type imports.
- - default: `false`
+When enabled, the intragroup sort order of [type-only imports][6] will mirror the intergroup ordering of normal imports as defined by [`groups`][18], [`pathGroups`][8], etc.
-Warns when unassigned imports are out of order. These warning will not be fixed
-with `--fix` because unassigned imports are used for side-effects and changing the
-import of order of modules with side effects can not be done automatically in a
-way that is safe.
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "alphabetize": { "order": "asc" }
+ }]
+}
+```
+
+This will fail the rule check even though it's logically ordered as we expect (builtins come before parents, parents come before siblings, siblings come before indices), the only difference is we separated type-only imports from normal imports:
+
+```ts
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+import b from "path";
+import c from "../foo.js";
+import d from "./bar.js";
+import e from "./";
+```
+
+This happens because [type-only imports][6] are considered part of one global
+[`"type"` group](#how-imports-are-grouped) by default. However, if we set
+`sortTypesAmongThemselves` to `true`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "alphabetize": { "order": "asc" },
+ "sortTypesAmongThemselves": true
+ }]
+}
+```
+
+The same example will pass.
+
+### `newlines-between-types`
+
+Valid values: `"ignore" | "always" | "always-and-inside-groups" | "never"` \
+Default: the value of [`newlines-between`][20]
+
+> \[!NOTE]
+>
+> This setting is only meaningful when [`sortTypesAmongThemselves`][7] is enabled.
+
+`newlines-between-types` is functionally identical to [`newlines-between`][20] except it only enforces or forbids new lines between _[type-only][6] import groups_, which exist only when [`sortTypesAmongThemselves`][7] is enabled.
+
+In addition, when determining if a new line is enforceable or forbidden between the type-only imports and the normal imports, `newlines-between-types` takes precedence over [`newlines-between`][20].
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesAmongThemselves": true,
+ "newlines-between": "always"
+ }]
+}
+```
This will fail the rule check:
```ts
-/* eslint import/order: ["error", {"warnOnUnassignedImports": true}] */
-import fs from 'fs';
-import './styles.css';
-import path from 'path';
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+import b from "path";
+
+import c from "../foo.js";
+
+import d from "./bar.js";
+
+import e from "./";
```
-While this will pass:
+However, if we set `newlines-between-types` to `"ignore"`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesAmongThemselves": true,
+ "newlines-between": "always",
+ "newlines-between-types": "ignore"
+ }]
+}
+```
+
+The same example will pass.
+
+Note the new line after `import type E from './';` but before `import a from "fs";`. This new line separates the type-only imports from the normal imports. Its existence is governed by [`newlines-between-types`][27] and _not `newlines-between`_.
+
+> \[!IMPORTANT]
+>
+> In certain situations, [`consolidateIslands: true`][25] will take precedence over `newlines-between-types: "never"`, if used, when it comes to the new line separating type-only imports from normal imports.
+
+The next example will pass even though there's a new line preceding the normal import and [`newlines-between`][20] is set to `"never"`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesAmongThemselves": true,
+ "newlines-between": "never",
+ "newlines-between-types": "always"
+ }]
+}
+```
```ts
-/* eslint import/order: ["error", {"warnOnUnassignedImports": true}] */
-import fs from 'fs';
-import path from 'path';
-import './styles.css';
+import type A from "fs";
+
+import type B from "path";
+
+import type C from "../foo.js";
+
+import type D from "./bar.js";
+
+import type E from './';
+
+import a from "fs";
+import b from "path";
+import c from "../foo.js";
+import d from "./bar.js";
+import e from "./";
```
-## Related
+While the following fails due to the new line between the last type import and the first normal import:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesAmongThemselves": true,
+ "newlines-between": "always",
+ "newlines-between-types": "never"
+ }]
+}
+```
+
+```ts
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+
+import b from "path";
+
+import c from "../foo.js";
+
+import d from "./bar.js";
+
+import e from "./";
+```
+
+### `consolidateIslands`
- - [`import/external-module-folders`] setting
+Valid values: `"inside-groups" | "never"` \
+Default: `"never"`
- - [`import/internal-regex`] setting
+> \[!NOTE]
+>
+> This setting is only meaningful when [`newlines-between`][20] and/or [`newlines-between-types`][27] is set to `"always-and-inside-groups"`.
-[`import/external-module-folders`]: ../../README.md#importexternal-module-folders
+When set to `"inside-groups"`, this ensures imports spanning multiple lines are separated from other imports with a new line while single-line imports are grouped together (and the space between them consolidated) if they belong to the same [group][18] or [`pathGroups`][8].
+
+> \[!IMPORTANT]
+>
+> When all of the following are true:
+>
+> - `consolidateIslands` is set to `"inside-groups"`
+> - [`newlines-between`][20] is set to `"always-and-inside-groups"`
+> - [`newlines-between-types`][27] is set to `"never"`
+> - [`sortTypesAmongThemselves`][7] is set to `true`
+>
+> Then [`newlines-between-types`][27] will yield to `consolidateIslands` and allow new lines to separate multi-line imports and a single new line to separate all [type-only imports][6] from all normal imports. Other than that, [`newlines-between-types: "never"`][27] functions as described.
+>
+> This configuration is useful to keep type-only imports stacked tightly
+> together at the bottom of your import block to preserve space while still
+> logically organizing normal imports for quick and pleasant reference.
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "newlines-between": "always-and-inside-groups",
+ "consolidateIslands": "inside-groups"
+ }]
+}
+```
+
+This will fail the rule check:
+
+```ts
+var fs = require('fs');
+var path = require('path');
+var { util1, util2, util3 } = require('util');
+var async = require('async');
+var relParent1 = require('../foo');
+var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+} = require('../');
+var relParent3 = require('../bar');
+var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+var sibling2 = require('./bar');
+var sibling3 = require('./foobar');
+```
+
+While this will succeed (and is what `--fix` would yield):
+
+```ts
+var fs = require('fs');
+var path = require('path');
+var { util1, util2, util3 } = require('util');
+
+var async = require('async');
+
+var relParent1 = require('../foo');
+
+var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+} = require('../');
+
+var relParent3 = require('../bar');
+
+var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+var sibling2 = require('./bar');
+var sibling3 = require('./foobar');
+```
+
+Note the intragroup "islands" of grouped single-line imports, as well as multi-line imports, are surrounded by new lines. At the same time, note the typical new lines separating different groups are still maintained thanks to [`newlines-between`][20].
+
+The same holds true for the next example; when given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "alphabetize": { "order": "asc" },
+ "groups": ["external", "internal", "index", "type"],
+ "pathGroups": [
+ {
+ "pattern": "dirA/**",
+ "group": "internal",
+ "position": "after"
+ },
+ {
+ "pattern": "dirB/**",
+ "group": "internal",
+ "position": "before"
+ },
+ {
+ "pattern": "dirC/**",
+ "group": "internal"
+ }
+ ],
+ "newlines-between": "always-and-inside-groups",
+ "newlines-between-types": "never",
+ "pathGroupsExcludedImportTypes": [],
+ "sortTypesAmongThemselves": true,
+ "consolidateIslands": "inside-groups"
+ }]
+}
+```
+
+> [!IMPORTANT]
+>
+> **Pay special attention to the value of [`pathGroupsExcludedImportTypes`][9]** in this example's settings.
+> Without it, the successful example below would fail.
+> This is because the imports with specifiers starting with "dirA/", "dirB/", and "dirC/" are all [considered part of the `"external"` group](#how-imports-are-grouped), and imports in that group are excluded from [`pathGroups`][8] matching by default.
+>
+> The fix is to remove `"external"` (and, in this example, the others) from [`pathGroupsExcludedImportTypes`][9].
+
+This will fail the rule check:
+
+```ts
+import c from 'Bar';
+import d from 'bar';
+import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+} from 'baz';
+import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+} from 'fizz';
+import a from 'foo';
+import b from 'dirA/bar';
+import index from './';
+import type { AA,
+ BB, CC } from 'abc';
+import type { Z } from 'fizz';
+import type {
+ A,
+ B
+} from 'foo';
+import type { C2 } from 'dirB/Bar';
+import type {
+ D2,
+ X2,
+ Y2
+} from 'dirB/bar';
+import type { E2 } from 'dirB/baz';
+import type { C3 } from 'dirC/Bar';
+import type {
+ D3,
+ X3,
+ Y3
+} from 'dirC/bar';
+import type { E3 } from 'dirC/baz';
+import type { F3 } from 'dirC/caz';
+import type { C1 } from 'dirA/Bar';
+import type {
+ D1,
+ X1,
+ Y1
+} from 'dirA/bar';
+import type { E1 } from 'dirA/baz';
+import type { F } from './index.js';
+import type { G } from './aaa.js';
+import type { H } from './bbb';
+```
+
+While this will succeed (and is what `--fix` would yield):
+
+```ts
+import c from 'Bar';
+import d from 'bar';
+
+import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+} from 'baz';
+
+import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+} from 'fizz';
+
+import a from 'foo';
+
+import b from 'dirA/bar';
+
+import index from './';
+
+import type { AA,
+ BB, CC } from 'abc';
+
+import type { Z } from 'fizz';
+
+import type {
+ A,
+ B
+} from 'foo';
+
+import type { C2 } from 'dirB/Bar';
+
+import type {
+ D2,
+ X2,
+ Y2
+} from 'dirB/bar';
+
+import type { E2 } from 'dirB/baz';
+import type { C3 } from 'dirC/Bar';
+
+import type {
+ D3,
+ X3,
+ Y3
+} from 'dirC/bar';
+
+import type { E3 } from 'dirC/baz';
+import type { F3 } from 'dirC/caz';
+import type { C1 } from 'dirA/Bar';
+
+import type {
+ D1,
+ X1,
+ Y1
+} from 'dirA/bar';
+
+import type { E1 } from 'dirA/baz';
+import type { F } from './index.js';
+import type { G } from './aaa.js';
+import type { H } from './bbb';
+```
+
+## Related
-[`import/internal-regex`]: ../../README.md#importinternal-regex
+ - [`import/external-module-folders`][29]
+ - [`import/internal-regex`][28]
+ - [`import/core-modules`][11]
+
+[3]: #how-imports-are-grouped
+[4]: https://nodejs.org/api/esm.html#terminology
+[5]: #warnonunassignedimports
+[6]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export
+[7]: #sorttypesamongthemselves
+[8]: #pathgroups
+[9]: #pathgroupsexcludedimporttypes
+[10]: https://www.npmjs.com/package/is-core-module
+[11]: ../../README.md#importcore-modules
+[12]: https://www.npmjs.com/package/package-up
+[13]: #pathgroup
+[14]: https://www.npmjs.com/package/minimatch
+[16]: https://www.npmjs.com/package/minimatch#features
+[17]: https://www.npmjs.com/package/minimatch#options
+[18]: #groups
+[20]: #newlines-between
+[21]: https://eslint.org/docs/latest/rules/no-multiple-empty-lines
+[22]: https://prettier.io
+[23]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names
+[25]: #consolidateislands
+[27]: #newlines-between-types
+[28]: ../../README.md#importinternal-regex
+[29]: ../../README.md#importexternal-module-folders
+[30]: #alphabetize
+[31]: https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free
+[32]: #distinctgroup
+[33]: #named
From 8c8058cfe96c52ed3f718580e085140f51f03510 Mon Sep 17 00:00:00 2001
From: Mikhail Pertsev <mikhail.pertsev@brightpattern.com>
Date: Thu, 4 Jul 2024 10:49:15 +0200
Subject: [PATCH 178/199] [New] add `enforce-node-protocol-usage` rule and
`import/node-version` setting
Co-authored-by: Mikhail Pertsev <mikhail.pertsev@brightpattern.com>
Co-authored-by: sevenc-nanashi <sevenc7c@sevenc7c.com>
---
.markdownlint.json | 1 +
CHANGELOG.md | 14 +-
README.md | 47 ++-
docs/rules/enforce-node-protocol-usage.md | 81 ++++
src/index.js | 1 +
src/rules/enforce-node-protocol-usage.js | 147 ++++++++
.../src/rules/enforce-node-protocol-usage.js | 345 ++++++++++++++++++
7 files changed, 617 insertions(+), 19 deletions(-)
create mode 100644 docs/rules/enforce-node-protocol-usage.md
create mode 100644 src/rules/enforce-node-protocol-usage.js
create mode 100644 tests/src/rules/enforce-node-protocol-usage.js
diff --git a/.markdownlint.json b/.markdownlint.json
index 02a066730b..f434832d2b 100644
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -1,5 +1,6 @@
{
"line-length": false,
+ "ignore_case": true,
"no-duplicate-heading": {
"siblings_only": true
},
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2174fc46bf..b3a92d015c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,8 +6,11 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## [Unreleased]
+### Added
+- add [`enforce-node-protocol-usage`] rule and `import/node-version` setting ([#3024], thanks [@GoldStrikeArch] and [@sevenc-nanashi])
+
### Changed
-- [Docs] `extensions`, `order`: improve documentation ([#3106], thanks [@Xunnamius])
+- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
## [2.31.0] - 2024-10-03
@@ -1106,10 +1109,12 @@ for info on changes for earlier releases.
[`import/core-modules` setting]: ./README.md#importcore-modules
[`import/external-module-folders` setting]: ./README.md#importexternal-module-folders
[`internal-regex` setting]: ./README.md#importinternal-regex
+[`import/node-version` setting]: ./README.md#importnode-version
[`consistent-type-specifier-style`]: ./docs/rules/consistent-type-specifier-style.md
[`default`]: ./docs/rules/default.md
[`dynamic-import-chunkname`]: ./docs/rules/dynamic-import-chunkname.md
+[`enforce-node-protocol-usage`]: ./docs/rules/enforce-node-protocol-usage.md
[`export`]: ./docs/rules/export.md
[`exports-last`]: ./docs/rules/exports-last.md
[`extensions`]: ./docs/rules/extensions.md
@@ -1169,6 +1174,7 @@ for info on changes for earlier releases.
[#3036]: https://github.com/import-js/eslint-plugin-import/pull/3036
[#3033]: https://github.com/import-js/eslint-plugin-import/pull/3033
[#3032]: https://github.com/import-js/eslint-plugin-import/pull/3032
+[#3024]: https://github.com/import-js/eslint-plugin-import/pull/3024
[#3018]: https://github.com/import-js/eslint-plugin-import/pull/3018
[#3012]: https://github.com/import-js/eslint-plugin-import/pull/3012
[#3011]: https://github.com/import-js/eslint-plugin-import/pull/3011
@@ -1788,7 +1794,6 @@ for info on changes for earlier releases.
[@bicstone]: https://github.com/bicstone
[@Blasz]: https://github.com/Blasz
[@bmish]: https://github.com/bmish
-[@developer-bandi]: https://github.com/developer-bandi
[@borisyankov]: https://github.com/borisyankov
[@bradennapier]: https://github.com/bradennapier
[@bradzacher]: https://github.com/bradzacher
@@ -1808,6 +1813,7 @@ for info on changes for earlier releases.
[@darkartur]: https://github.com/darkartur
[@davidbonnet]: https://github.com/davidbonnet
[@dbrewer5]: https://github.com/dbrewer5
+[@developer-bandi]: https://github.com/developer-bandi
[@devinrhode2]: https://github.com/devinrhode2
[@devongovett]: https://github.com/devongovett
[@dmnd]: https://github.com/dmnd
@@ -1842,6 +1848,7 @@ for info on changes for earlier releases.
[@georeith]: https://github.com/georeith
[@giodamelio]: https://github.com/giodamelio
[@gnprice]: https://github.com/gnprice
+[@GoldStrikeArch]: https://github.com/GoldStrikeArch
[@golergka]: https://github.com/golergka
[@golopot]: https://github.com/golopot
[@GoodForOneFare]: https://github.com/GoodForOneFare
@@ -1901,9 +1908,9 @@ for info on changes for earlier releases.
[@Librazy]: https://github.com/Librazy
[@liby]: https://github.com/liby
[@lilling]: https://github.com/lilling
+[@liuxingbaoyu]: https://github.com/liuxingbaoyu
[@ljharb]: https://github.com/ljharb
[@ljqx]: https://github.com/ljqx
-[@liuxingbaoyu]: https://github.com/liuxingbaoyu
[@lo1tuma]: https://github.com/lo1tuma
[@loganfsmyth]: https://github.com/loganfsmyth
[@luczsoma]: https://github.com/luczsoma
@@ -1977,6 +1984,7 @@ for info on changes for earlier releases.
[@Schweinepriester]: https://github.com/Schweinepriester
[@scottnonnenberg]: https://github.com/scottnonnenberg
[@sergei-startsev]: https://github.com/sergei-startsev
+[@sevenc-nanashi]: https://github.com/sevenc-nanashi
[@sharmilajesupaul]: https://github.com/sharmilajesupaul
[@sheepsteak]: https://github.com/sheepsteak
[@silverwind]: https://github.com/silverwind
diff --git a/README.md b/README.md
index 8cc723423f..81dedf65be 100644
--- a/README.md
+++ b/README.md
@@ -51,22 +51,23 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
### Static analysis
-| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
-| :--------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :--- | :- | :- | :- | :- | :- |
-| [default](docs/rules/default.md) | Ensure a default export is present, given a default import. | ❗ ☑️ | | | | | |
-| [named](docs/rules/named.md) | Ensure named imports correspond to a named export in the remote file. | ❗ ☑️ | | ⌨️ | | | |
-| [namespace](docs/rules/namespace.md) | Ensure imported namespaces contain dereferenced properties as they are dereferenced. | ❗ ☑️ | | | | | |
-| [no-absolute-path](docs/rules/no-absolute-path.md) | Forbid import of modules using absolute paths. | | | | 🔧 | | |
-| [no-cycle](docs/rules/no-cycle.md) | Forbid a module from importing a module with a dependency path back to itself. | | | | | | |
-| [no-dynamic-require](docs/rules/no-dynamic-require.md) | Forbid `require()` calls with expressions. | | | | | | |
-| [no-internal-modules](docs/rules/no-internal-modules.md) | Forbid importing the submodules of other modules. | | | | | | |
-| [no-relative-packages](docs/rules/no-relative-packages.md) | Forbid importing packages through relative paths. | | | | 🔧 | | |
-| [no-relative-parent-imports](docs/rules/no-relative-parent-imports.md) | Forbid importing modules from parent directories. | | | | | | |
-| [no-restricted-paths](docs/rules/no-restricted-paths.md) | Enforce which files can be imported in a given folder. | | | | | | |
-| [no-self-import](docs/rules/no-self-import.md) | Forbid a module from importing itself. | | | | | | |
-| [no-unresolved](docs/rules/no-unresolved.md) | Ensure imports point to a file/module that can be resolved. | ❗ ☑️ | | | | | |
-| [no-useless-path-segments](docs/rules/no-useless-path-segments.md) | Forbid unnecessary path segments in import and require statements. | | | | 🔧 | | |
-| [no-webpack-loader-syntax](docs/rules/no-webpack-loader-syntax.md) | Forbid webpack loader syntax in imports. | | | | | | |
+| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
+| :----------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :--- | :- | :- | :- | :- | :- |
+| [default](docs/rules/default.md) | Ensure a default export is present, given a default import. | ❗ ☑️ | | | | | |
+| [enforce-node-protocol-usage](docs/rules/enforce-node-protocol-usage.md) | Enforce either using, or omitting, the `node:` protocol when importing Node.js builtin modules. | | | | 🔧 | | |
+| [named](docs/rules/named.md) | Ensure named imports correspond to a named export in the remote file. | ❗ ☑️ | | ⌨️ | | | |
+| [namespace](docs/rules/namespace.md) | Ensure imported namespaces contain dereferenced properties as they are dereferenced. | ❗ ☑️ | | | | | |
+| [no-absolute-path](docs/rules/no-absolute-path.md) | Forbid import of modules using absolute paths. | | | | 🔧 | | |
+| [no-cycle](docs/rules/no-cycle.md) | Forbid a module from importing a module with a dependency path back to itself. | | | | | | |
+| [no-dynamic-require](docs/rules/no-dynamic-require.md) | Forbid `require()` calls with expressions. | | | | | | |
+| [no-internal-modules](docs/rules/no-internal-modules.md) | Forbid importing the submodules of other modules. | | | | | | |
+| [no-relative-packages](docs/rules/no-relative-packages.md) | Forbid importing packages through relative paths. | | | | 🔧 | | |
+| [no-relative-parent-imports](docs/rules/no-relative-parent-imports.md) | Forbid importing modules from parent directories. | | | | | | |
+| [no-restricted-paths](docs/rules/no-restricted-paths.md) | Enforce which files can be imported in a given folder. | | | | | | |
+| [no-self-import](docs/rules/no-self-import.md) | Forbid a module from importing itself. | | | | | | |
+| [no-unresolved](docs/rules/no-unresolved.md) | Ensure imports point to a file/module that can be resolved. | ❗ ☑️ | | | | | |
+| [no-useless-path-segments](docs/rules/no-useless-path-segments.md) | Forbid unnecessary path segments in import and require statements. | | | | 🔧 | | |
+| [no-webpack-loader-syntax](docs/rules/no-webpack-loader-syntax.md) | Forbid webpack loader syntax in imports. | | | | | | |
### Style guide
@@ -495,6 +496,20 @@ For example, if your packages in a monorepo are all in `@scope`, you can configu
}
```
+### `import/node-version`
+
+A string that represents the version of Node.js that you are using.
+A falsy value will imply the version of Node.js that you are running ESLint with.
+
+```jsonc
+// .eslintrc
+{
+ "settings": {
+ "import/node-version": "22.3.4",
+ },
+}
+```
+
## SublimeLinter-eslint
SublimeLinter-eslint introduced a change to support `.eslintignore` files
diff --git a/docs/rules/enforce-node-protocol-usage.md b/docs/rules/enforce-node-protocol-usage.md
new file mode 100644
index 0000000000..8d023b4e9c
--- /dev/null
+++ b/docs/rules/enforce-node-protocol-usage.md
@@ -0,0 +1,81 @@
+# import/enforce-node-protocol-usage
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+Enforce either using, or omitting, the `node:` protocol when importing Node.js builtin modules.
+
+## Rule Details
+
+This rule enforces that builtins node imports are using, or omitting, the `node:` protocol.
+
+Determining whether a specifier is a core module depends on the node version being used to run `eslint`.
+This version can be specified in the configuration with the [`import/node-version` setting](../../README.md#importnode-version).
+
+Reasons to prefer using the protocol include:
+
+ - the code is more explicitly and clearly referencing a Node.js built-in module
+
+Reasons to prefer omitting the protocol include:
+
+ - some tools don't support the `node:` protocol
+ - the code is more portable, because import maps and automatic polyfilling can be used
+
+## Options
+
+The rule requires a single string option which may be one of:
+
+ - `'always'` - enforces that builtins node imports are using the `node:` protocol.
+ - `'never'` - enforces that builtins node imports are not using the `node:` protocol.
+
+## Examples
+
+### `'always'`
+
+❌ Invalid
+
+```js
+import fs from 'fs';
+export { promises } from 'fs';
+// require
+const fs = require('fs/promises');
+```
+
+✅ Valid
+
+```js
+import fs from 'node:fs';
+export { promises } from 'node:fs';
+import * as test from 'node:test';
+// require
+const fs = require('node:fs/promises');
+```
+
+### `'never'`
+
+❌ Invalid
+
+```js
+import fs from 'node:fs';
+export { promises } from 'node:fs';
+// require
+const fs = require('node:fs/promises');
+```
+
+✅ Valid
+
+```js
+import fs from 'fs';
+export { promises } from 'fs';
+
+// require
+const fs = require('fs/promises');
+
+// This rule will not enforce not using `node:` protocol when the module is only available under the `node:` protocol.
+import * as test from 'node:test';
+```
+
+## When Not To Use It
+
+If you don't want to consistently enforce using, or omitting, the `node:` protocol when importing Node.js builtin modules.
diff --git a/src/index.js b/src/index.js
index 0ab82ebee8..6252620605 100644
--- a/src/index.js
+++ b/src/index.js
@@ -45,6 +45,7 @@ export const rules = {
'dynamic-import-chunkname': require('./rules/dynamic-import-chunkname'),
'no-import-module-exports': require('./rules/no-import-module-exports'),
'no-empty-named-blocks': require('./rules/no-empty-named-blocks'),
+ 'enforce-node-protocol-usage': require('./rules/enforce-node-protocol-usage'),
// export
'exports-last': require('./rules/exports-last'),
diff --git a/src/rules/enforce-node-protocol-usage.js b/src/rules/enforce-node-protocol-usage.js
new file mode 100644
index 0000000000..88c31fc727
--- /dev/null
+++ b/src/rules/enforce-node-protocol-usage.js
@@ -0,0 +1,147 @@
+'use strict';
+
+const isCoreModule = require('is-core-module');
+const { default: docsUrl } = require('../docsUrl');
+
+const DO_PREFER_MESSAGE_ID = 'requireNodeProtocol';
+const NEVER_PREFER_MESSAGE_ID = 'forbidNodeProtocol';
+const messages = {
+ [DO_PREFER_MESSAGE_ID]: 'Prefer `node:{{moduleName}}` over `{{moduleName}}`.',
+ [NEVER_PREFER_MESSAGE_ID]: 'Prefer `{{moduleName}}` over `node:{{moduleName}}`.',
+};
+
+function replaceStringLiteral(
+ fixer,
+ node,
+ text,
+ relativeRangeStart,
+ relativeRangeEnd,
+) {
+ const firstCharacterIndex = node.range[0] + 1;
+ const start = Number.isInteger(relativeRangeEnd)
+ ? relativeRangeStart + firstCharacterIndex
+ : firstCharacterIndex;
+ const end = Number.isInteger(relativeRangeEnd)
+ ? relativeRangeEnd + firstCharacterIndex
+ : node.range[1] - 1;
+
+ return fixer.replaceTextRange([start, end], text);
+}
+
+function isStringLiteral(node) {
+ return node.type === 'Literal' && typeof node.value === 'string';
+}
+
+function isStaticRequireWith1Param(node) {
+ return !node.optional
+ && node.callee.type === 'Identifier'
+ && node.callee.name === 'require'
+ // check for only 1 argument
+ && node.arguments.length === 1
+ && node.arguments[0]
+ && isStringLiteral(node.arguments[0]);
+}
+
+function checkAndReport(src, context) {
+ // TODO use src.quasis[0].value.raw
+ if (src.type === 'TemplateLiteral') { return; }
+ const moduleName = 'value' in src ? src.value : src.name;
+ if (typeof moduleName !== 'string') { console.log(src, moduleName); }
+ const { settings } = context;
+ const nodeVersion = settings && settings['import/node-version'];
+ if (
+ typeof nodeVersion !== 'undefined'
+ && (
+ typeof nodeVersion !== 'string'
+ || !(/^[0-9]+\.[0-9]+\.[0-9]+$/).test(nodeVersion)
+ )
+ ) {
+ throw new TypeError('`import/node-version` setting must be a string in the format "10.23.45" (a semver version, with no leading zero)');
+ }
+
+ if (context.options[0] === 'never') {
+ if (!moduleName.startsWith('node:')) { return; }
+
+ const actualModuleName = moduleName.slice(5);
+ if (!isCoreModule(actualModuleName, nodeVersion || undefined)) { return; }
+
+ context.report({
+ node: src,
+ message: messages[NEVER_PREFER_MESSAGE_ID],
+ data: { moduleName: actualModuleName },
+ /** @param {import('eslint').Rule.RuleFixer} fixer */
+ fix(fixer) {
+ return replaceStringLiteral(fixer, src, '', 0, 5);
+ },
+ });
+ } else if (context.options[0] === 'always') {
+ if (
+ moduleName.startsWith('node:')
+ || !isCoreModule(moduleName, nodeVersion || undefined)
+ || !isCoreModule(`node:${moduleName}`, nodeVersion || undefined)
+ ) {
+ return;
+ }
+
+ context.report({
+ node: src,
+ message: messages[DO_PREFER_MESSAGE_ID],
+ data: { moduleName },
+ /** @param {import('eslint').Rule.RuleFixer} fixer */
+ fix(fixer) {
+ return replaceStringLiteral(fixer, src, 'node:', 0, 0);
+ },
+ });
+ } else if (typeof context.options[0] === 'undefined') {
+ throw new Error('Missing option');
+ } else {
+ throw new Error(`Unexpected option: ${context.options[0]}`);
+ }
+}
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+ meta: {
+ type: 'suggestion',
+ docs: {
+ description: 'Enforce either using, or omitting, the `node:` protocol when importing Node.js builtin modules.',
+ recommended: true,
+ category: 'Static analysis',
+ url: docsUrl('enforce-node-protocol-usage'),
+ },
+ fixable: 'code',
+ schema: {
+ type: 'array',
+ minItems: 1,
+ maxItems: 1,
+ items: [
+ {
+ enum: ['always', 'never'],
+ },
+ ],
+ },
+ messages,
+ },
+ create(context) {
+ return {
+ CallExpression(node) {
+ if (!isStaticRequireWith1Param(node)) { return; }
+
+ const arg = node.arguments[0];
+
+ return checkAndReport(arg, context);
+ },
+ ExportNamedDeclaration(node) {
+ return checkAndReport(node.source, context);
+ },
+ ImportDeclaration(node) {
+ return checkAndReport(node.source, context);
+ },
+ ImportExpression(node) {
+ if (!isStringLiteral(node.source)) { return; }
+
+ return checkAndReport(node.source, context);
+ },
+ };
+ },
+};
diff --git a/tests/src/rules/enforce-node-protocol-usage.js b/tests/src/rules/enforce-node-protocol-usage.js
new file mode 100644
index 0000000000..f9bbcbad1f
--- /dev/null
+++ b/tests/src/rules/enforce-node-protocol-usage.js
@@ -0,0 +1,345 @@
+import { RuleTester } from '../rule-tester';
+import flatMap from 'array.prototype.flatmap';
+import { satisfies } from 'semver';
+
+import { test, testVersion } from '../utils';
+
+const ruleTester = new RuleTester();
+const rule = require('rules/enforce-node-protocol-usage');
+
+const preferUsingProtocol = ['always'];
+const preferNotUsingProtocol = ['never'];
+const useNewerParser = { ecmaVersion: 2021 };
+
+const actualModules = ['fs', 'fs/promises', 'buffer', 'child_process', 'timers/promises'];
+
+const settings = {
+ 'import/node-version': '16.0.0', // the node: prefix is only available as of `^14.18 || >= 16`
+};
+
+const invalidTests = [].concat(
+ flatMap(actualModules, (moduleName) => [].concat(
+ {
+ code: `import x from "${moduleName}";`,
+ output: `import x from "node:${moduleName}";`,
+ options: preferUsingProtocol,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName } },
+ ],
+ },
+ {
+ code: `export {promises} from "${moduleName}";`,
+ output: `export {promises} from "node:${moduleName}";`,
+ options: preferUsingProtocol,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName } },
+ ],
+ },
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const x = await import('${moduleName}');
+ }
+ `,
+ output: `
+ async function foo() {
+ const x = await import('node:${moduleName}');
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName } },
+ ],
+ })),
+ )),
+
+ {
+ code: 'import fs from "fs/promises";',
+ output: 'import fs from "node:fs/promises";',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'fs/promises' },
+ },
+ ],
+ settings,
+ },
+ {
+ code: 'export {default} from "fs/promises";',
+ output: 'export {default} from "node:fs/promises";',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'fs/promises' },
+ },
+ ],
+ settings,
+ },
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const fs = await import('fs/promises');
+ }
+ `,
+ output: `
+ async function foo() {
+ const fs = await import('node:fs/promises');
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'fs/promises' },
+ },
+ ],
+ settings,
+ })),
+ {
+ code: 'import {promises} from "fs";',
+ output: 'import {promises} from "node:fs";',
+ options: preferUsingProtocol,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName: 'fs' } },
+ ],
+ },
+ {
+ code: 'export {default as promises} from "fs";',
+ output: 'export {default as promises} from "node:fs";',
+ options: preferUsingProtocol,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName: 'fs' } },
+ ],
+ },
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const fs = await import("fs/promises");
+ }
+ `,
+ output: `
+ async function foo() {
+ const fs = await import("node:fs/promises");
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'fs/promises' },
+ },
+ ],
+ settings,
+ })),
+ {
+ code: 'import "buffer";',
+ output: 'import "node:buffer";',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'buffer' },
+ },
+ ],
+ },
+ {
+ code: 'import "child_process";',
+ output: 'import "node:child_process";',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'child_process' },
+ },
+ ],
+ },
+ {
+ code: 'import "timers/promises";',
+ output: 'import "node:timers/promises";',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'timers/promises' },
+ },
+ ],
+ settings,
+ },
+ {
+ code: 'const {promises} = require("fs")',
+ output: 'const {promises} = require("node:fs")',
+ options: preferUsingProtocol,
+ errors: [
+ { messageId: 'requireNodeProtocol', data: { moduleName: 'fs' } },
+ ],
+ },
+ {
+ code: 'const fs = require("fs/promises")',
+ output: 'const fs = require("node:fs/promises")',
+ options: preferUsingProtocol,
+ errors: [
+ {
+ messageId: 'requireNodeProtocol',
+ data: { moduleName: 'fs/promises' },
+ },
+ ],
+ settings,
+ },
+);
+
+ruleTester.run('enforce-node-protocol-usage', rule, {
+ valid: [].concat(
+ test({
+ code: 'import unicorn from "unicorn";',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'import fs from "./fs";',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'import fs from "unknown-builtin-module";',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'import fs from "node:fs";',
+ options: preferUsingProtocol,
+ }),
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const fs = await import(fs);
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ })),
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const fs = await import(0);
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ })),
+ testVersion('>= 7', () => ({
+ code: `
+ async function foo() {
+ const fs = await import(\`fs\`);
+ }
+ `,
+ options: preferUsingProtocol,
+ parserOptions: useNewerParser,
+ })),
+ test({
+ code: 'import "punycode/";',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require("node:fs");',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require("node:fs/promises");',
+ options: preferUsingProtocol,
+ settings,
+ }),
+ test({
+ code: 'const fs = require(fs);',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = notRequire("fs");',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = foo.require("fs");',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require.resolve("fs");',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require(`fs`);',
+ options: preferUsingProtocol,
+ }),
+ testVersion('>= 7', () => ({
+ code: 'const fs = require?.("fs");',
+ parserOptions: useNewerParser,
+ options: preferUsingProtocol,
+ })),
+ test({
+ code: 'const fs = require("fs", extra);',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require();',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require(...["fs"]);',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require("unicorn");',
+ options: preferUsingProtocol,
+ }),
+ test({
+ code: 'import fs from "fs";',
+ options: preferNotUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require("fs");',
+ options: preferNotUsingProtocol,
+ }),
+ test({
+ code: 'const fs = require("fs/promises");',
+ options: preferNotUsingProtocol,
+ settings,
+ }),
+ test({
+ code: 'import "punycode/";',
+ options: preferNotUsingProtocol,
+ }),
+
+ // should not report if the module requires `node:` protocol
+ test({
+ code: 'const fs = require("node:test");',
+ options: preferNotUsingProtocol,
+ settings,
+ }),
+ ),
+
+ invalid: [].concat(
+ // Prefer using the protocol
+ // in node versions without `node:`, the rule should not report
+ satisfies('^14.18 || >= 16') ? invalidTests.map((testCase) => test({
+ ...testCase,
+ errors: testCase.errors.map(({ messageId, data, ...testCase }) => ({
+ ...testCase,
+ message: rule.meta.messages[messageId].replace(/{{moduleName}}/g, data.moduleName),
+ })),
+ })) : [],
+
+ // Prefer not using the protocol: flip the output and code
+ invalidTests.map((testCase) => test({
+ ...testCase,
+ code: testCase.output,
+ options: preferNotUsingProtocol,
+ output: testCase.code,
+ // eslint-disable-next-line no-unused-vars
+ errors: testCase.errors.map(({ messageId, data, ...testCase }) => ({
+ ...testCase,
+ message: rule.meta.messages.forbidNodeProtocol.replace(/{{moduleName}}/g, data.moduleName),
+ })),
+ settings,
+ })),
+ ),
+});
From 8c3c1bec09e3a7640998b226f19527ab98de624d Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 10 Dec 2024 20:27:34 -0800
Subject: [PATCH 179/199] [resolvers/webpack] [deps] update `hasown`,
`is-core-module`, `is-regex`
---
resolvers/webpack/package.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 60e5c900f0..22f0e86930 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -34,10 +34,10 @@
"debug": "^3.2.7",
"enhanced-resolve": "^0.9.1",
"find-root": "^1.1.0",
- "hasown": "^2.0.0",
+ "hasown": "^2.0.2",
"interpret": "^1.4.0",
- "is-core-module": "^2.13.1",
- "is-regex": "^1.1.4",
+ "is-core-module": "^2.15.1",
+ "is-regex": "^1.2.0",
"lodash": "^4.17.21",
"resolve": "^2.0.0-next.5",
"semver": "^5.7.2"
From e159652f541ebcd49eafdc9202dc77ee043139da Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Tue, 10 Dec 2024 20:27:59 -0800
Subject: [PATCH 180/199] [resolvers/webpack] v0.13.10
---
resolvers/webpack/CHANGELOG.md | 2 ++
resolvers/webpack/package.json | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/resolvers/webpack/CHANGELOG.md b/resolvers/webpack/CHANGELOG.md
index 1d23bf6fdd..d904a60828 100644
--- a/resolvers/webpack/CHANGELOG.md
+++ b/resolvers/webpack/CHANGELOG.md
@@ -4,6 +4,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
This change log adheres to standards from [Keep a CHANGELOG](https://keepachangelog.com).
## Unreleased
+
+## 0.13.10 - 2024-12-10
- [new] add cache option ([#3100], thanks [@seiyab])
## 0.13.9 - 2024-09-02
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
index 22f0e86930..057711e9bf 100644
--- a/resolvers/webpack/package.json
+++ b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
{
"name": "eslint-import-resolver-webpack",
- "version": "0.13.9",
+ "version": "0.13.10",
"description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
"main": "index.js",
"scripts": {
From 9d1f639a3ff5acd2bd0a44dbac761f1b1f6d583b Mon Sep 17 00:00:00 2001
From: Gareth Jones <jones258@gmail.com>
Date: Fri, 8 Nov 2024 16:08:26 +1300
Subject: [PATCH 181/199] [New] add TypeScript types
---
.github/workflows/node-pretest.yml | 13 ++++++++++++
CHANGELOG.md | 2 ++
index.d.ts | 33 ++++++++++++++++++++++++++++++
package.json | 6 +++++-
4 files changed, 53 insertions(+), 1 deletion(-)
create mode 100644 index.d.ts
diff --git a/.github/workflows/node-pretest.yml b/.github/workflows/node-pretest.yml
index f8db36de57..e25b00e499 100644
--- a/.github/workflows/node-pretest.yml
+++ b/.github/workflows/node-pretest.yml
@@ -18,6 +18,19 @@ jobs:
# skip-ls-check: true
# - run: npm run pretest
+ types:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: ljharb/actions/node/install@main
+ name: 'npm install'
+ with:
+ skip-ls-check: true
+ # for some reason we've got to force typescript to install here
+ # even though the npm script has `typescript@latest`
+ - run: npm i --force typescript@latest
+ - run: npm run test-types
+
posttest:
runs-on: ubuntu-latest
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b3a92d015c..9bfb428d43 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- add [`enforce-node-protocol-usage`] rule and `import/node-version` setting ([#3024], thanks [@GoldStrikeArch] and [@sevenc-nanashi])
+- add TypeScript types ([#3097], thanks [@G-Rath])
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
@@ -1161,6 +1162,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
+[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3071]: https://github.com/import-js/eslint-plugin-import/pull/3071
diff --git a/index.d.ts b/index.d.ts
new file mode 100644
index 0000000000..2bef94ec2b
--- /dev/null
+++ b/index.d.ts
@@ -0,0 +1,33 @@
+import { ESLint, Linter, Rule } from 'eslint';
+
+declare const plugin: ESLint.Plugin & {
+ meta: {
+ name: string;
+ version: string;
+ };
+ configs: {
+ 'recommended': Linter.LegacyConfig;
+ 'errors': Linter.LegacyConfig;
+ 'warnings': Linter.LegacyConfig;
+ 'stage-0': Linter.LegacyConfig;
+ 'react': Linter.LegacyConfig;
+ 'react-native': Linter.LegacyConfig;
+ 'electron': Linter.LegacyConfig;
+ 'typescript': Linter.LegacyConfig;
+ };
+ flatConfigs: {
+ 'recommended': Linter.FlatConfig;
+ 'errors': Linter.FlatConfig;
+ 'warnings': Linter.FlatConfig;
+ 'stage-0': Linter.FlatConfig;
+ 'react': Linter.FlatConfig;
+ 'react-native': Linter.FlatConfig;
+ 'electron': Linter.FlatConfig;
+ 'typescript': Linter.FlatConfig;
+ };
+ rules: {
+ [key: string]: Rule.RuleModule;
+ };
+};
+
+export = plugin;
diff --git a/package.json b/package.json
index 7852506bd4..7eaf93b520 100644
--- a/package.json
+++ b/package.json
@@ -6,6 +6,7 @@
"node": ">=4"
},
"main": "lib/index.js",
+ "types": "index.d.ts",
"directories": {
"test": "tests"
},
@@ -16,7 +17,8 @@
"docs",
"lib",
"config",
- "memo-parser/{*.js,LICENSE,*.md}"
+ "memo-parser/{*.js,LICENSE,*.md}",
+ "index.d.ts"
],
"scripts": {
"prebuild": "rimraf lib",
@@ -34,6 +36,7 @@
"test-examples": "npm run build && npm run test-example:legacy && npm run test-example:flat",
"test-example:legacy": "cd examples/legacy && npm install && npm run lint",
"test-example:flat": "cd examples/flat && npm install && npm run lint",
+ "test-types": "npx --package typescript@latest tsc --noEmit index.d.ts",
"prepublishOnly": "safe-publish-latest && npm run build",
"prepublish": "not-in-publish || npm run prepublishOnly",
"preupdate:eslint-docs": "npm run build",
@@ -63,6 +66,7 @@
"@angular-eslint/template-parser": "^13.5.0",
"@eslint/import-test-order-redirect-scoped": "file:./tests/files/order-redirect-scoped",
"@test-scope/some-module": "file:./tests/files/symlinked-module",
+ "@types/eslint": "^8.56.12",
"@typescript-eslint/parser": "^2.23.0 || ^3.3.0 || ^4.29.3 || ^5.10.0",
"babel-cli": "^6.26.0",
"babel-core": "^6.26.3",
From f0727a6b5a8524d35b160a9c4159844e3728e3f4 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 11 Dec 2024 11:34:33 -0800
Subject: [PATCH 182/199] [Deps] update `string.prototype.trimend`
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 7eaf93b520..f3053e1c11 100644
--- a/package.json
+++ b/package.json
@@ -130,7 +130,7 @@
"object.groupby": "^1.0.3",
"object.values": "^1.2.0",
"semver": "^6.3.1",
- "string.prototype.trimend": "^1.0.8",
+ "string.prototype.trimend": "^1.0.9",
"tsconfig-paths": "^3.15.0"
}
}
From 8b2d57083b7ce895a9fbbcacea6ef3876eee7690 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Sun, 15 Dec 2024 18:02:47 -0600
Subject: [PATCH 183/199] [utils] [fix] `unambiguous` detect modules exported
from minified code
This change adjusts the regex pattern used to detect modules to support detection on minified code.
Fixes #3107
---
tests/files/minified/no-newline.js | 3 +++
tests/files/minified/one-line-no-semi-renamed.js | 1 +
tests/files/minified/one-line-no-semi.js | 1 +
tests/files/minified/one-line.js | 1 +
tests/src/core/getExports.js | 4 ++++
utils/CHANGELOG.md | 6 ++++++
utils/unambiguous.js | 2 +-
7 files changed, 17 insertions(+), 1 deletion(-)
create mode 100644 tests/files/minified/no-newline.js
create mode 100644 tests/files/minified/one-line-no-semi-renamed.js
create mode 100644 tests/files/minified/one-line-no-semi.js
create mode 100644 tests/files/minified/one-line.js
diff --git a/tests/files/minified/no-newline.js b/tests/files/minified/no-newline.js
new file mode 100644
index 0000000000..261989a75c
--- /dev/null
+++ b/tests/files/minified/no-newline.js
@@ -0,0 +1,3 @@
+function y() {
+ console.log("y");
+}export {y};
diff --git a/tests/files/minified/one-line-no-semi-renamed.js b/tests/files/minified/one-line-no-semi-renamed.js
new file mode 100644
index 0000000000..601f9c7b71
--- /dev/null
+++ b/tests/files/minified/one-line-no-semi-renamed.js
@@ -0,0 +1 @@
+function a(){console.log('foo')}export{a as foo};
diff --git a/tests/files/minified/one-line-no-semi.js b/tests/files/minified/one-line-no-semi.js
new file mode 100644
index 0000000000..09a6328118
--- /dev/null
+++ b/tests/files/minified/one-line-no-semi.js
@@ -0,0 +1 @@
+function a(){return true}export{a};
diff --git a/tests/files/minified/one-line.js b/tests/files/minified/one-line.js
new file mode 100644
index 0000000000..b79898eb33
--- /dev/null
+++ b/tests/files/minified/one-line.js
@@ -0,0 +1 @@
+function a(){console.log("foo")};export{a};
diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
index f11a261311..a02edb85c2 100644
--- a/tests/src/core/getExports.js
+++ b/tests/src/core/getExports.js
@@ -465,6 +465,10 @@ describe('ExportMap', function () {
['bar.js', true],
['deep-es7/b.js', true],
['common.js', false],
+ ['./minified/no-newline.js', true],
+ ['./minified/one-line-no-semi-renamed.js', true],
+ ['./minified/one-line-no-semi.js', true],
+ ['./minified/one-line.js', true],
];
for (const [testFile, expectedRegexResult] of testFiles) {
diff --git a/utils/CHANGELOG.md b/utils/CHANGELOG.md
index bb93725125..fe7381a2d6 100644
--- a/utils/CHANGELOG.md
+++ b/utils/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
## Unreleased
+### Fixed
+- `unambiguous`: detect modules exported from minified code ([#3124], thanks [@michaelfaith])
+
### Changed
- [refactor] `parse`: avoid using a regex here (thanks [@ljharb])
@@ -180,6 +183,7 @@ Yanked due to critical issue with cache key resulting from #839.
### Fixed
- `unambiguous.test()` regex is now properly in multiline mode
+[#3124]: https://github.com/import-js/eslint-plugin-import/pull/3124
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
[#3061]: https://github.com/import-js/eslint-plugin-import/pull/3061
[#3057]: https://github.com/import-js/eslint-plugin-import/pull/3057
@@ -230,6 +234,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@JounQin]: https://github.com/JounQin
[@kaiyoma]: https://github.com/kaiyoma
[@leipert]: https://github.com/leipert
+[@ljharb]: https://github.com/ljharb
[@manuth]: https://github.com/manuth
[@maxkomarychev]: https://github.com/maxkomarychev
[@mgwalker]: https://github.com/mgwalker
@@ -238,6 +243,7 @@ Yanked due to critical issue with cache key resulting from #839.
[@nicolo-ribaudo]: https://github.com/nicolo-ribaudo
[@pmcelhaney]: https://github.com/pmcelhaney
[@sergei-startsev]: https://github.com/sergei-startsev
+[@silverwind]: https://github.com/silverwind
[@sompylasar]: https://github.com/sompylasar
[@timkraut]: https://github.com/timkraut
[@vikr01]: https://github.com/vikr01
diff --git a/utils/unambiguous.js b/utils/unambiguous.js
index 20aabd1bd4..df7b9be7a5 100644
--- a/utils/unambiguous.js
+++ b/utils/unambiguous.js
@@ -2,7 +2,7 @@
exports.__esModule = true;
-const pattern = /(^|;)\s*(export|import)((\s+\w)|(\s*[{*=]))|import\(/m;
+const pattern = /(^|[;})])\s*(export|import)((\s+\w)|(\s*[{*=]))|import\(/m;
/**
* detect possible imports/exports without a full parse.
*
From 1dc101b09c75b3b06fb39a84d0a8553f92203dc6 Mon Sep 17 00:00:00 2001
From: lnuvy <lnuvy.code@gmail.com>
Date: Sun, 22 Dec 2024 07:08:08 +0900
Subject: [PATCH 184/199] [Docs] add flat config guide for using
`tseslint.config()`
---
CHANGELOG.md | 3 +++
README.md | 20 ++++++++++++++++++++
2 files changed, 23 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9bfb428d43..37db85ba08 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
+- [Docs] add flat config guide for using `tseslint.config()` ([#3125], thanks [@lnuvy])
## [2.31.0] - 2024-10-03
@@ -1161,6 +1162,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
@@ -1913,6 +1915,7 @@ for info on changes for earlier releases.
[@liuxingbaoyu]: https://github.com/liuxingbaoyu
[@ljharb]: https://github.com/ljharb
[@ljqx]: https://github.com/ljqx
+[@lnuvy]: https://github.com/lnuvy
[@lo1tuma]: https://github.com/lo1tuma
[@loganfsmyth]: https://github.com/loganfsmyth
[@luczsoma]: https://github.com/luczsoma
diff --git a/README.md b/README.md
index 81dedf65be..2138f59f6d 100644
--- a/README.md
+++ b/README.md
@@ -191,6 +191,26 @@ Make sure you have installed [`@typescript-eslint/parser`] and [`eslint-import-r
[`@typescript-eslint/parser`]: https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser
[`eslint-import-resolver-typescript`]: https://github.com/import-js/eslint-import-resolver-typescript
+### Config - Flat with `config()` in `typescript-eslint`
+
+If you are using the `config` method from [`typescript-eslint`](https://github.com/typescript-eslint/typescript-eslint), ensure that the `flatConfig` is included within the `extends` array.
+
+```js
+import tseslint from 'typescript-eslint';
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+
+export default tseslint.config(
+ js.configs.recommended,
+ // other configs...
+ {
+ files: ['**/*.{ts,tsx}'],
+ extends: [importPlugin.flatConfigs.recommended],
+ // other configs...
+ }
+);
+```
+
## Resolvers
With the advent of module bundlers and the current state of modules and module
From aee018f961c8ec9781c305a82385e14e314ddc18 Mon Sep 17 00:00:00 2001
From: Ryan Machado <ryangst.hire@gmail.com>
Date: Thu, 19 Dec 2024 13:01:43 -0300
Subject: [PATCH 185/199] [Docs] add missing comma
---
CHANGELOG.md | 3 +++
README.md | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 37db85ba08..3a57da91fb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
- [Docs] add flat config guide for using `tseslint.config()` ([#3125], thanks [@lnuvy])
+- [Docs] add missing comma ([#3122], thanks [@RyanGst])
## [2.31.0] - 2024-10-03
@@ -1163,6 +1164,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
+[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
@@ -1982,6 +1984,7 @@ for info on changes for earlier releases.
[@rosswarren]: https://github.com/rosswarren
[@rperello]: https://github.com/rperello
[@rsolomon]: https://github.com/rsolomon
+[@RyanGst]: https://github.com/
[@s-h-a-d-o-w]: https://github.com/s-h-a-d-o-w
[@saschanaz]: https://github.com/saschanaz
[@schmidsi]: https://github.com/schmidsi
diff --git a/README.md b/README.md
index 2138f59f6d..993d31399a 100644
--- a/README.md
+++ b/README.md
@@ -127,7 +127,7 @@ All rules are off by default. However, you may extend one of the preset configs,
```jsonc
{
"rules": {
- "import/no-unresolved": ["error", { "commonjs": true, "amd": true }]
+ "import/no-unresolved": ["error", { "commonjs": true, "amd": true }],
"import/named": "error",
"import/namespace": "error",
"import/default": "error",
From e5edf49ecdc745a947ef7931b5dee0ef858d6b93 Mon Sep 17 00:00:00 2001
From: michael faith <michaelfaith@users.noreply.github.com>
Date: Sun, 15 Dec 2024 09:06:33 -0600
Subject: [PATCH 186/199] [Fix] `no-unused-modules`: provide more meaningful
error message when no eslintrc is present
This change adjusts what we're doing if an error is thrown while attempting to enumerate lintable files in the no-used-modules rule, when users are running with flat config. Now, if FileEnumerator throws due to a lack of eslintrc and the user is running with flat config, we catch the error and rethrow with a more informative message.
I also cleaned up the original aspects of the implementation that was using the proposed eslint context functions, since that proposal was walked back and the API was never introduced.
Note: This isn't an ideal state, since this rule still relies on the legacy api to understand what needs to be ignored. Remaining tethered to the legacy config system is going to need to be solved at some point.
Fixes #3079
---
CHANGELOG.md | 4 +
examples/v9/eslint.config.mjs | 22 +++++
examples/v9/package.json | 14 +++
examples/v9/src/depth-zero.js | 3 +
examples/v9/src/es6/depth-one-dynamic.js | 3 +
examples/v9/src/exports-unused.js | 6 ++
examples/v9/src/exports.js | 6 ++
examples/v9/src/imports.js | 6 ++
package.json | 4 +-
src/core/fsWalk.js | 48 ---------
src/rules/no-unused-modules.js | 118 ++++++++++-------------
tests/src/rules/no-unused-modules.js | 39 ++++++++
12 files changed, 157 insertions(+), 116 deletions(-)
create mode 100644 examples/v9/eslint.config.mjs
create mode 100644 examples/v9/package.json
create mode 100644 examples/v9/src/depth-zero.js
create mode 100644 examples/v9/src/es6/depth-one-dynamic.js
create mode 100644 examples/v9/src/exports-unused.js
create mode 100644 examples/v9/src/exports.js
create mode 100644 examples/v9/src/imports.js
delete mode 100644 src/core/fsWalk.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3a57da91fb..5bcd7163ff 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- add [`enforce-node-protocol-usage`] rule and `import/node-version` setting ([#3024], thanks [@GoldStrikeArch] and [@sevenc-nanashi])
- add TypeScript types ([#3097], thanks [@G-Rath])
+### Fixed
+- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
+
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
- [Docs] add flat config guide for using `tseslint.config()` ([#3125], thanks [@lnuvy])
@@ -1165,6 +1168,7 @@ for info on changes for earlier releases.
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
+[#3116]: https://github.com/import-js/eslint-plugin-import/pull/3116
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
diff --git a/examples/v9/eslint.config.mjs b/examples/v9/eslint.config.mjs
new file mode 100644
index 0000000000..7b7534d140
--- /dev/null
+++ b/examples/v9/eslint.config.mjs
@@ -0,0 +1,22 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+
+export default [
+ js.configs.recommended,
+ importPlugin.flatConfigs.recommended,
+ {
+ files: ['**/*.{js,mjs,cjs}'],
+ languageOptions: {
+ ecmaVersion: 'latest',
+ sourceType: 'module',
+ },
+ ignores: ['eslint.config.mjs', 'node_modules/*'],
+ rules: {
+ 'no-unused-vars': 'off',
+ 'import/no-dynamic-require': 'warn',
+ 'import/no-nodejs-modules': 'warn',
+ 'import/no-unused-modules': ['warn', { unusedExports: true }],
+ 'import/no-cycle': 'warn',
+ },
+ },
+];
diff --git a/examples/v9/package.json b/examples/v9/package.json
new file mode 100644
index 0000000000..4746d74005
--- /dev/null
+++ b/examples/v9/package.json
@@ -0,0 +1,14 @@
+{
+ "name": "v9",
+ "version": "1.0.0",
+ "main": "index.js",
+ "type": "module",
+ "scripts": {
+ "lint": "eslint src --report-unused-disable-directives"
+ },
+ "devDependencies": {
+ "@eslint/js": "^9.17.0",
+ "eslint": "^9.17.0",
+ "eslint-plugin-import": "file:../.."
+ }
+}
diff --git a/examples/v9/src/depth-zero.js b/examples/v9/src/depth-zero.js
new file mode 100644
index 0000000000..8cfde99795
--- /dev/null
+++ b/examples/v9/src/depth-zero.js
@@ -0,0 +1,3 @@
+import { foo } from "./es6/depth-one-dynamic";
+
+foo();
diff --git a/examples/v9/src/es6/depth-one-dynamic.js b/examples/v9/src/es6/depth-one-dynamic.js
new file mode 100644
index 0000000000..ca129fd622
--- /dev/null
+++ b/examples/v9/src/es6/depth-one-dynamic.js
@@ -0,0 +1,3 @@
+export function foo() {}
+
+export const bar = () => import("../depth-zero").then(({foo}) => foo);
diff --git a/examples/v9/src/exports-unused.js b/examples/v9/src/exports-unused.js
new file mode 100644
index 0000000000..3c44db68d0
--- /dev/null
+++ b/examples/v9/src/exports-unused.js
@@ -0,0 +1,6 @@
+export const a = 13;
+export const b = 18;
+
+const defaultExport = { a, b };
+
+export default defaultExport;
diff --git a/examples/v9/src/exports.js b/examples/v9/src/exports.js
new file mode 100644
index 0000000000..3c44db68d0
--- /dev/null
+++ b/examples/v9/src/exports.js
@@ -0,0 +1,6 @@
+export const a = 13;
+export const b = 18;
+
+const defaultExport = { a, b };
+
+export default defaultExport;
diff --git a/examples/v9/src/imports.js b/examples/v9/src/imports.js
new file mode 100644
index 0000000000..edf1336865
--- /dev/null
+++ b/examples/v9/src/imports.js
@@ -0,0 +1,6 @@
+//import c from './exports';
+import { a, b } from './exports';
+
+import path from 'path';
+import fs from 'node:fs';
+import console from 'console';
diff --git a/package.json b/package.json
index f3053e1c11..268b477ea4 100644
--- a/package.json
+++ b/package.json
@@ -33,9 +33,10 @@
"test": "npm run tests-only",
"test-compiled": "npm run prepublish && BABEL_ENV=testCompiled mocha --compilers js:babel-register tests/src",
"test-all": "node --require babel-register ./scripts/testAll",
- "test-examples": "npm run build && npm run test-example:legacy && npm run test-example:flat",
+ "test-examples": "npm run build && npm run test-example:legacy && npm run test-example:flat && npm run test-example:v9",
"test-example:legacy": "cd examples/legacy && npm install && npm run lint",
"test-example:flat": "cd examples/flat && npm install && npm run lint",
+ "test-example:v9": "cd examples/v9 && npm install && npm run lint",
"test-types": "npx --package typescript@latest tsc --noEmit index.d.ts",
"prepublishOnly": "safe-publish-latest && npm run build",
"prepublish": "not-in-publish || npm run prepublishOnly",
@@ -106,6 +107,7 @@
"rimraf": "^2.7.1",
"safe-publish-latest": "^2.0.0",
"sinon": "^2.4.1",
+ "tmp": "^0.2.1",
"typescript": "^2.8.1 || ~3.9.5 || ~4.5.2",
"typescript-eslint-parser": "^15 || ^20 || ^22"
},
diff --git a/src/core/fsWalk.js b/src/core/fsWalk.js
deleted file mode 100644
index fa112590f1..0000000000
--- a/src/core/fsWalk.js
+++ /dev/null
@@ -1,48 +0,0 @@
-/**
- * This is intended to provide similar capability as the sync api from @nodelib/fs.walk, until `eslint-plugin-import`
- * is willing to modernize and update their minimum node version to at least v16. I intentionally made the
- * shape of the API (for the part we're using) the same as @nodelib/fs.walk so that that can be swapped in
- * when the repo is ready for it.
- */
-
-import path from 'path';
-import { readdirSync } from 'fs';
-
-/** @typedef {{ name: string, path: string, dirent: import('fs').Dirent }} Entry */
-
-/**
- * Do a comprehensive walk of the provided src directory, and collect all entries. Filter out
- * any directories or entries using the optional filter functions.
- * @param {string} root - path to the root of the folder we're walking
- * @param {{ deepFilter?: (entry: Entry) => boolean, entryFilter?: (entry: Entry) => boolean }} options
- * @param {Entry} currentEntry - entry for the current directory we're working in
- * @param {Entry[]} existingEntries - list of all entries so far
- * @returns {Entry[]} an array of directory entries
- */
-export function walkSync(root, options, currentEntry, existingEntries) {
- // Extract the filter functions. Default to evaluating true, if no filter passed in.
- const { deepFilter = () => true, entryFilter = () => true } = options;
-
- let entryList = existingEntries || [];
- const currentRelativePath = currentEntry ? currentEntry.path : '.';
- const fullPath = currentEntry ? path.join(root, currentEntry.path) : root;
-
- const dirents = readdirSync(fullPath, { withFileTypes: true });
- dirents.forEach((dirent) => {
- /** @type {Entry} */
- const entry = {
- name: dirent.name,
- path: path.join(currentRelativePath, dirent.name),
- dirent,
- };
-
- if (dirent.isDirectory() && deepFilter(entry)) {
- entryList.push(entry);
- entryList = walkSync(root, options, entry, entryList);
- } else if (dirent.isFile() && entryFilter(entry)) {
- entryList.push(entry);
- }
- });
-
- return entryList;
-}
diff --git a/src/rules/no-unused-modules.js b/src/rules/no-unused-modules.js
index 358726299d..86302a0ea6 100644
--- a/src/rules/no-unused-modules.js
+++ b/src/rules/no-unused-modules.js
@@ -8,13 +8,12 @@ import { getPhysicalFilename } from 'eslint-module-utils/contextCompat';
import { getFileExtensions } from 'eslint-module-utils/ignore';
import resolve from 'eslint-module-utils/resolve';
import visit from 'eslint-module-utils/visit';
-import { dirname, join, resolve as resolvePath } from 'path';
+import { dirname, join } from 'path';
import readPkgUp from 'eslint-module-utils/readPkgUp';
import values from 'object.values';
import includes from 'array-includes';
import flatMap from 'array.prototype.flatmap';
-import { walkSync } from '../core/fsWalk';
import ExportMapBuilder from '../exportMap/builder';
import recursivePatternCapture from '../exportMap/patternCapture';
import docsUrl from '../docsUrl';
@@ -51,21 +50,62 @@ function requireFileEnumerator() {
}
/**
- *
+ * Given a FileEnumerator class, instantiate and load the list of files.
* @param FileEnumerator the `FileEnumerator` class from `eslint`'s internal api
* @param {string} src path to the src root
* @param {string[]} extensions list of supported extensions
* @returns {{ filename: string, ignored: boolean }[]} list of files to operate on
*/
function listFilesUsingFileEnumerator(FileEnumerator, src, extensions) {
- const e = new FileEnumerator({
+ // We need to know whether this is being run with flat config in order to
+ // determine how to report errors if FileEnumerator throws due to a lack of eslintrc.
+
+ const { ESLINT_USE_FLAT_CONFIG } = process.env;
+
+ // This condition is sufficient to test in v8, since the environment variable is necessary to turn on flat config
+ let isUsingFlatConfig = ESLINT_USE_FLAT_CONFIG && process.env.ESLINT_USE_FLAT_CONFIG !== 'false';
+
+ // In the case of using v9, we can check the `shouldUseFlatConfig` function
+ // If this function is present, then we assume it's v9
+ try {
+ const { shouldUseFlatConfig } = require('eslint/use-at-your-own-risk');
+ isUsingFlatConfig = shouldUseFlatConfig && ESLINT_USE_FLAT_CONFIG !== 'false';
+ } catch (_) {
+ // We don't want to throw here, since we only want to update the
+ // boolean if the function is available.
+ }
+
+ const enumerator = new FileEnumerator({
extensions,
});
- return Array.from(
- e.iterateFiles(src),
- ({ filePath, ignored }) => ({ filename: filePath, ignored }),
- );
+ try {
+ return Array.from(
+ enumerator.iterateFiles(src),
+ ({ filePath, ignored }) => ({ filename: filePath, ignored }),
+ );
+ } catch (e) {
+ // If we're using flat config, and FileEnumerator throws due to a lack of eslintrc,
+ // then we want to throw an error so that the user knows about this rule's reliance on
+ // the legacy config.
+ if (
+ isUsingFlatConfig
+ && e.message.includes('No ESLint configuration found')
+ ) {
+ throw new Error(`
+Due to the exclusion of certain internal ESLint APIs when using flat config,
+the import/no-unused-modules rule requires an .eslintrc file to know which
+files to ignore (even when using flat config).
+The .eslintrc file only needs to contain "ignorePatterns", or can be empty if
+you do not want to ignore any files.
+
+See https://github.com/import-js/eslint-plugin-import/issues/3079
+for additional context.
+`);
+ }
+ // If this isn't the case, then we'll just let the error bubble up
+ throw e;
+ }
}
/**
@@ -107,70 +147,14 @@ function listFilesWithLegacyFunctions(src, extensions) {
}
}
-/**
- * Given a source root and list of supported extensions, use fsWalk and the
- * new `eslint` `context.session` api to build the list of files we want to operate on
- * @param {string[]} srcPaths array of source paths (for flat config this should just be a singular root (e.g. cwd))
- * @param {string[]} extensions list of supported extensions
- * @param {{ isDirectoryIgnored: (path: string) => boolean, isFileIgnored: (path: string) => boolean }} session eslint context session object
- * @returns {string[]} list of files to operate on
- */
-function listFilesWithModernApi(srcPaths, extensions, session) {
- /** @type {string[]} */
- const files = [];
-
- for (let i = 0; i < srcPaths.length; i++) {
- const src = srcPaths[i];
- // Use walkSync along with the new session api to gather the list of files
- const entries = walkSync(src, {
- deepFilter(entry) {
- const fullEntryPath = resolvePath(src, entry.path);
-
- // Include the directory if it's not marked as ignore by eslint
- return !session.isDirectoryIgnored(fullEntryPath);
- },
- entryFilter(entry) {
- const fullEntryPath = resolvePath(src, entry.path);
-
- // Include the file if it's not marked as ignore by eslint and its extension is included in our list
- return (
- !session.isFileIgnored(fullEntryPath)
- && extensions.find((extension) => entry.path.endsWith(extension))
- );
- },
- });
-
- // Filter out directories and map entries to their paths
- files.push(
- ...entries
- .filter((entry) => !entry.dirent.isDirectory())
- .map((entry) => entry.path),
- );
- }
- return files;
-}
-
/**
* Given a src pattern and list of supported extensions, return a list of files to process
* with this rule.
* @param {string} src - file, directory, or glob pattern of files to act on
* @param {string[]} extensions - list of supported file extensions
- * @param {import('eslint').Rule.RuleContext} context - the eslint context object
* @returns {string[] | { filename: string, ignored: boolean }[]} the list of files that this rule will evaluate.
*/
-function listFilesToProcess(src, extensions, context) {
- // If the context object has the new session functions, then prefer those
- // Otherwise, fallback to using the deprecated `FileEnumerator` for legacy support.
- // https://github.com/eslint/eslint/issues/18087
- if (
- context.session
- && context.session.isFileIgnored
- && context.session.isDirectoryIgnored
- ) {
- return listFilesWithModernApi(src, extensions, context.session);
- }
-
- // Fallback to og FileEnumerator
+function listFilesToProcess(src, extensions) {
const FileEnumerator = requireFileEnumerator();
// If we got the FileEnumerator, then let's go with that
@@ -295,10 +279,10 @@ const isNodeModule = (path) => (/\/(node_modules)\//).test(path);
function resolveFiles(src, ignoreExports, context) {
const extensions = Array.from(getFileExtensions(context.settings));
- const srcFileList = listFilesToProcess(src, extensions, context);
+ const srcFileList = listFilesToProcess(src, extensions);
// prepare list of ignored files
- const ignoredFilesList = listFilesToProcess(ignoreExports, extensions, context);
+ const ignoredFilesList = listFilesToProcess(ignoreExports, extensions);
// The modern api will return a list of file paths, rather than an object
if (ignoredFilesList.length && typeof ignoredFilesList[0] === 'string') {
diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
index d86f406220..a15d2c2376 100644
--- a/tests/src/rules/no-unused-modules.js
+++ b/tests/src/rules/no-unused-modules.js
@@ -3,8 +3,12 @@ import jsxConfig from '../../../config/react';
import typescriptConfig from '../../../config/typescript';
import { RuleTester } from '../rule-tester';
+import { expect } from 'chai';
+import { execSync } from 'child_process';
import fs from 'fs';
import eslintPkg from 'eslint/package.json';
+import path from 'path';
+import process from 'process';
import semver from 'semver';
let FlatRuleTester;
@@ -14,6 +18,7 @@ try {
// TODO: figure out why these tests fail in eslint 4 and 5
const isESLint4TODO = semver.satisfies(eslintPkg.version, '^4 || ^5');
+const isESLint9 = semver.satisfies(eslintPkg.version, '>=9');
const ruleTester = new RuleTester();
const typescriptRuleTester = new RuleTester(typescriptConfig);
@@ -1482,3 +1487,37 @@ describe('parser ignores prefixes like BOM and hashbang', () => {
});
});
});
+
+(isESLint9 ? describe : describe.skip)('with eslint 9+', () => {
+ it('provides meaningful error when eslintrc is not present', () => {
+ const tmp = require('tmp');
+
+ // Create temp directory outside of project root
+ const tempDir = tmp.dirSync({ unsafeCleanup: true });
+
+ // Copy example project to temp directory
+ fs.cpSync(path.join(process.cwd(), 'examples/v9'), tempDir.name, { recursive: true });
+
+ let errorMessage = '';
+
+ // Build the plugin
+ try {
+ execSync('npm run build');
+ } catch (_) {
+ /* ignore */
+ }
+
+ // Install the plugin and run the lint command in the temp directory
+ try {
+ execSync(`npm install -D ${process.cwd()} && npm run lint`, { cwd: tempDir.name });
+ } catch (error) {
+ errorMessage = error.stderr.toString();
+ }
+
+ // Verify that the error message is as expected
+ expect(errorMessage).to.contain('the import/no-unused-modules rule requires an .eslintrc file');
+
+ // Cleanup
+ tempDir.removeCallback();
+ }).timeout(100000);
+});
From 78731f149b5a64c3418f1b69f37392ebeac0a762 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 30 Dec 2024 16:26:47 -0800
Subject: [PATCH 187/199] [Deps] update `array.prototype.flat`,
`array.prototype.flatmap`, `is-core-module`, `object.values`
---
package.json | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/package.json b/package.json
index 268b477ea4..125fc426e8 100644
--- a/package.json
+++ b/package.json
@@ -118,19 +118,19 @@
"@rtsao/scc": "^1.1.0",
"array-includes": "^3.1.8",
"array.prototype.findlastindex": "^1.2.5",
- "array.prototype.flat": "^1.3.2",
- "array.prototype.flatmap": "^1.3.2",
+ "array.prototype.flat": "^1.3.3",
+ "array.prototype.flatmap": "^1.3.3",
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.9",
"eslint-module-utils": "^2.12.0",
"hasown": "^2.0.2",
- "is-core-module": "^2.15.1",
+ "is-core-module": "^2.16.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
"object.fromentries": "^2.0.8",
"object.groupby": "^1.0.3",
- "object.values": "^1.2.0",
+ "object.values": "^1.2.1",
"semver": "^6.3.1",
"string.prototype.trimend": "^1.0.9",
"tsconfig-paths": "^3.15.0"
From 74c976339a5cf603e757d596f221473023f6b113 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Mon, 30 Dec 2024 16:25:35 -0800
Subject: [PATCH 188/199] [Docs] `order`: remove mistakenly included sections
in #3106
---
docs/rules/order.md | 492 ++------------------------------------------
1 file changed, 13 insertions(+), 479 deletions(-)
diff --git a/docs/rules/order.md b/docs/rules/order.md
index fcdd4fda7e..02a2b4bed7 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -106,9 +106,6 @@ This rule supports the following options (none of which are required):
- [`alphabetize`][30]
- [`named`][33]
- [`warnOnUnassignedImports`][5]
- - [`sortTypesAmongThemselves`][7]
- - [`newlines-between-types`][27]
- - [`consolidateIslands`][25]
---
@@ -159,7 +156,7 @@ Roughly speaking, the grouping algorithm is as follows:
1. If the import has no corresponding identifiers (e.g. `import './my/thing.js'`), is otherwise "unassigned," or is an unsupported use of `require()`, and [`warnOnUnassignedImports`][5] is disabled, it will be ignored entirely since the order of these imports may be important for their [side-effects][31]
2. If the import is part of an arcane TypeScript declaration (e.g. `import log = console.log`), it will be considered **object**. However, note that external module references (e.g. `import x = require('z')`) are treated as normal `require()`s and import-exports (e.g. `export import w = y;`) are ignored entirely
-3. If the import is [type-only][6], `"type"` is in `groups`, and [`sortTypesAmongThemselves`][7] is disabled, it will be considered **type** (with additional implications if using [`pathGroups`][8] and `"type"` is in [`pathGroupsExcludedImportTypes`][9])
+3. If the import is [type-only][6], and `"type"` is in `groups`, it will be considered **type** (with additional implications if using [`pathGroups`][8] and `"type"` is in [`pathGroupsExcludedImportTypes`][9])
4. If the import's specifier matches [`import/internal-regex`][28], it will be considered **internal**
5. If the import's specifier is an absolute path, it will be considered **unknown**
6. If the import's specifier has the name of a Node.js core module (using [is-core-module][10]), it will be considered **builtin**
@@ -174,18 +171,16 @@ Roughly speaking, the grouping algorithm is as follows:
15. If the import's specifier has a name that starts with a word character, it will be considered **external**
16. If this point is reached, the import will be ignored entirely
-At the end of the process, if they co-exist in the same file, all top-level `require()` statements that haven't been ignored are shifted (with respect to their order) below any ES6 `import` or similar declarations. Finally, any type-only declarations are potentially reorganized according to [`sortTypesAmongThemselves`][7].
+At the end of the process, if they co-exist in the same file, all top-level `require()` statements that haven't been ignored are shifted (with respect to their order) below any ES6 `import` or similar declarations.
### `pathGroups`
Valid values: `PathGroup[]` \
Default: `[]`
-Sometimes [the predefined groups][18] are not fine-grained
-enough, especially when using import aliases. `pathGroups` defines one or more
-[`PathGroup`][13]s relative to a predefined group. Imports are associated with a
-[`PathGroup`][13] based on path matching against the import specifier (using
-[minimatch][14]).
+Sometimes [the predefined groups][18] are not fine-grained enough, especially when using import aliases.
+`pathGroups` defines one or more [`PathGroup`][13]s relative to a predefined group.
+Imports are associated with a [`PathGroup`][13] based on path matching against the import specifier (using [minimatch][14]).
> \[!IMPORTANT]
>
@@ -224,9 +219,8 @@ enough, especially when using import aliases. `pathGroups` defines one or more
Valid values: `("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type")[]` \
Default: `["builtin", "external", "object"]`
-By default, imports in certain [groups][18] are excluded
-from being matched against [`pathGroups`][8] to prevent overeager sorting. Use
-`pathGroupsExcludedImportTypes` to modify which groups are excluded.
+By default, imports in certain [groups][18] are excluded from being matched against [`pathGroups`][8] to prevent overeager sorting.
+Use `pathGroupsExcludedImportTypes` to modify which groups are excluded.
> \[!TIP]
>
@@ -430,13 +424,10 @@ Default: `false`
Enforce ordering of names within imports and exports.
-If set to `true` or `{ enabled: true }`, _all_ named imports must be ordered
-according to [`alphabetize`][30]. If set to `false` or `{ enabled:
-false }`, named imports can occur in any order.
+If set to `true` or `{ enabled: true }`, _all_ named imports must be ordered according to [`alphabetize`][30].
+If set to `false` or `{ enabled: false }`, named imports can occur in any order.
-If set to `{ enabled: true, ... }`, and any of the properties `import`,
-`export`, `require`, or `cjsExports` are set to `false`, named ordering is
-disabled with respect to the following kind of expressions:
+If set to `{ enabled: true, ... }`, and any of the properties `import`, `export`, `require`, or `cjsExports` are set to `false`, named ordering is disabled with respect to the following kind of expressions:
- `import`:
@@ -506,15 +497,12 @@ import { apply, compose } from 'xcompose';
Valid values: `boolean` \
Default: `false`
-Warn when "unassigned" imports are out of order. Unassigned imports are imports
-with no corresponding identifiers (e.g. `import './my/thing.js'` or
-`require('./side-effects.js')`).
+Warn when "unassigned" imports are out of order.
+Unassigned imports are imports with no corresponding identifiers (e.g. `import './my/thing.js'` or `require('./side-effects.js')`).
> \[!NOTE]
>
-> These warnings are not fixable with `--fix` since unassigned imports might be
-> used for their
-> [side-effects][31],
+> These warnings are not fixable with `--fix` since unassigned imports might be used for their [side-effects][31],
> and changing the order of such imports cannot be done safely.
#### Example
@@ -545,457 +533,6 @@ import path from 'path';
import './styles.css';
```
-### `sortTypesAmongThemselves`
-
-Valid values: `boolean` \
-Default: `false`
-
-> \[!NOTE]
->
-> This setting is only meaningful when `"type"` is included in [`groups`][18].
-
-Sort [type-only imports][6] separately from normal non-type imports.
-
-When enabled, the intragroup sort order of [type-only imports][6] will mirror the intergroup ordering of normal imports as defined by [`groups`][18], [`pathGroups`][8], etc.
-
-#### Example
-
-Given the following settings:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "alphabetize": { "order": "asc" }
- }]
-}
-```
-
-This will fail the rule check even though it's logically ordered as we expect (builtins come before parents, parents come before siblings, siblings come before indices), the only difference is we separated type-only imports from normal imports:
-
-```ts
-import type A from "fs";
-import type B from "path";
-import type C from "../foo.js";
-import type D from "./bar.js";
-import type E from './';
-
-import a from "fs";
-import b from "path";
-import c from "../foo.js";
-import d from "./bar.js";
-import e from "./";
-```
-
-This happens because [type-only imports][6] are considered part of one global
-[`"type"` group](#how-imports-are-grouped) by default. However, if we set
-`sortTypesAmongThemselves` to `true`:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "alphabetize": { "order": "asc" },
- "sortTypesAmongThemselves": true
- }]
-}
-```
-
-The same example will pass.
-
-### `newlines-between-types`
-
-Valid values: `"ignore" | "always" | "always-and-inside-groups" | "never"` \
-Default: the value of [`newlines-between`][20]
-
-> \[!NOTE]
->
-> This setting is only meaningful when [`sortTypesAmongThemselves`][7] is enabled.
-
-`newlines-between-types` is functionally identical to [`newlines-between`][20] except it only enforces or forbids new lines between _[type-only][6] import groups_, which exist only when [`sortTypesAmongThemselves`][7] is enabled.
-
-In addition, when determining if a new line is enforceable or forbidden between the type-only imports and the normal imports, `newlines-between-types` takes precedence over [`newlines-between`][20].
-
-#### Example
-
-Given the following settings:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "sortTypesAmongThemselves": true,
- "newlines-between": "always"
- }]
-}
-```
-
-This will fail the rule check:
-
-```ts
-import type A from "fs";
-import type B from "path";
-import type C from "../foo.js";
-import type D from "./bar.js";
-import type E from './';
-
-import a from "fs";
-import b from "path";
-
-import c from "../foo.js";
-
-import d from "./bar.js";
-
-import e from "./";
-```
-
-However, if we set `newlines-between-types` to `"ignore"`:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "sortTypesAmongThemselves": true,
- "newlines-between": "always",
- "newlines-between-types": "ignore"
- }]
-}
-```
-
-The same example will pass.
-
-Note the new line after `import type E from './';` but before `import a from "fs";`. This new line separates the type-only imports from the normal imports. Its existence is governed by [`newlines-between-types`][27] and _not `newlines-between`_.
-
-> \[!IMPORTANT]
->
-> In certain situations, [`consolidateIslands: true`][25] will take precedence over `newlines-between-types: "never"`, if used, when it comes to the new line separating type-only imports from normal imports.
-
-The next example will pass even though there's a new line preceding the normal import and [`newlines-between`][20] is set to `"never"`:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "sortTypesAmongThemselves": true,
- "newlines-between": "never",
- "newlines-between-types": "always"
- }]
-}
-```
-
-```ts
-import type A from "fs";
-
-import type B from "path";
-
-import type C from "../foo.js";
-
-import type D from "./bar.js";
-
-import type E from './';
-
-import a from "fs";
-import b from "path";
-import c from "../foo.js";
-import d from "./bar.js";
-import e from "./";
-```
-
-While the following fails due to the new line between the last type import and the first normal import:
-
-```jsonc
-{
- "import/order": ["error", {
- "groups": ["type", "builtin", "parent", "sibling", "index"],
- "sortTypesAmongThemselves": true,
- "newlines-between": "always",
- "newlines-between-types": "never"
- }]
-}
-```
-
-```ts
-import type A from "fs";
-import type B from "path";
-import type C from "../foo.js";
-import type D from "./bar.js";
-import type E from './';
-
-import a from "fs";
-
-import b from "path";
-
-import c from "../foo.js";
-
-import d from "./bar.js";
-
-import e from "./";
-```
-
-### `consolidateIslands`
-
-Valid values: `"inside-groups" | "never"` \
-Default: `"never"`
-
-> \[!NOTE]
->
-> This setting is only meaningful when [`newlines-between`][20] and/or [`newlines-between-types`][27] is set to `"always-and-inside-groups"`.
-
-When set to `"inside-groups"`, this ensures imports spanning multiple lines are separated from other imports with a new line while single-line imports are grouped together (and the space between them consolidated) if they belong to the same [group][18] or [`pathGroups`][8].
-
-> \[!IMPORTANT]
->
-> When all of the following are true:
->
-> - `consolidateIslands` is set to `"inside-groups"`
-> - [`newlines-between`][20] is set to `"always-and-inside-groups"`
-> - [`newlines-between-types`][27] is set to `"never"`
-> - [`sortTypesAmongThemselves`][7] is set to `true`
->
-> Then [`newlines-between-types`][27] will yield to `consolidateIslands` and allow new lines to separate multi-line imports and a single new line to separate all [type-only imports][6] from all normal imports. Other than that, [`newlines-between-types: "never"`][27] functions as described.
->
-> This configuration is useful to keep type-only imports stacked tightly
-> together at the bottom of your import block to preserve space while still
-> logically organizing normal imports for quick and pleasant reference.
-
-#### Example
-
-Given the following settings:
-
-```jsonc
-{
- "import/order": ["error", {
- "newlines-between": "always-and-inside-groups",
- "consolidateIslands": "inside-groups"
- }]
-}
-```
-
-This will fail the rule check:
-
-```ts
-var fs = require('fs');
-var path = require('path');
-var { util1, util2, util3 } = require('util');
-var async = require('async');
-var relParent1 = require('../foo');
-var {
- relParent21,
- relParent22,
- relParent23,
- relParent24,
-} = require('../');
-var relParent3 = require('../bar');
-var { sibling1,
- sibling2, sibling3 } = require('./foo');
-var sibling2 = require('./bar');
-var sibling3 = require('./foobar');
-```
-
-While this will succeed (and is what `--fix` would yield):
-
-```ts
-var fs = require('fs');
-var path = require('path');
-var { util1, util2, util3 } = require('util');
-
-var async = require('async');
-
-var relParent1 = require('../foo');
-
-var {
- relParent21,
- relParent22,
- relParent23,
- relParent24,
-} = require('../');
-
-var relParent3 = require('../bar');
-
-var { sibling1,
- sibling2, sibling3 } = require('./foo');
-
-var sibling2 = require('./bar');
-var sibling3 = require('./foobar');
-```
-
-Note the intragroup "islands" of grouped single-line imports, as well as multi-line imports, are surrounded by new lines. At the same time, note the typical new lines separating different groups are still maintained thanks to [`newlines-between`][20].
-
-The same holds true for the next example; when given the following settings:
-
-```jsonc
-{
- "import/order": ["error", {
- "alphabetize": { "order": "asc" },
- "groups": ["external", "internal", "index", "type"],
- "pathGroups": [
- {
- "pattern": "dirA/**",
- "group": "internal",
- "position": "after"
- },
- {
- "pattern": "dirB/**",
- "group": "internal",
- "position": "before"
- },
- {
- "pattern": "dirC/**",
- "group": "internal"
- }
- ],
- "newlines-between": "always-and-inside-groups",
- "newlines-between-types": "never",
- "pathGroupsExcludedImportTypes": [],
- "sortTypesAmongThemselves": true,
- "consolidateIslands": "inside-groups"
- }]
-}
-```
-
-> [!IMPORTANT]
->
-> **Pay special attention to the value of [`pathGroupsExcludedImportTypes`][9]** in this example's settings.
-> Without it, the successful example below would fail.
-> This is because the imports with specifiers starting with "dirA/", "dirB/", and "dirC/" are all [considered part of the `"external"` group](#how-imports-are-grouped), and imports in that group are excluded from [`pathGroups`][8] matching by default.
->
-> The fix is to remove `"external"` (and, in this example, the others) from [`pathGroupsExcludedImportTypes`][9].
-
-This will fail the rule check:
-
-```ts
-import c from 'Bar';
-import d from 'bar';
-import {
- aa,
- bb,
- cc,
- dd,
- ee,
- ff,
- gg
-} from 'baz';
-import {
- hh,
- ii,
- jj,
- kk,
- ll,
- mm,
- nn
-} from 'fizz';
-import a from 'foo';
-import b from 'dirA/bar';
-import index from './';
-import type { AA,
- BB, CC } from 'abc';
-import type { Z } from 'fizz';
-import type {
- A,
- B
-} from 'foo';
-import type { C2 } from 'dirB/Bar';
-import type {
- D2,
- X2,
- Y2
-} from 'dirB/bar';
-import type { E2 } from 'dirB/baz';
-import type { C3 } from 'dirC/Bar';
-import type {
- D3,
- X3,
- Y3
-} from 'dirC/bar';
-import type { E3 } from 'dirC/baz';
-import type { F3 } from 'dirC/caz';
-import type { C1 } from 'dirA/Bar';
-import type {
- D1,
- X1,
- Y1
-} from 'dirA/bar';
-import type { E1 } from 'dirA/baz';
-import type { F } from './index.js';
-import type { G } from './aaa.js';
-import type { H } from './bbb';
-```
-
-While this will succeed (and is what `--fix` would yield):
-
-```ts
-import c from 'Bar';
-import d from 'bar';
-
-import {
- aa,
- bb,
- cc,
- dd,
- ee,
- ff,
- gg
-} from 'baz';
-
-import {
- hh,
- ii,
- jj,
- kk,
- ll,
- mm,
- nn
-} from 'fizz';
-
-import a from 'foo';
-
-import b from 'dirA/bar';
-
-import index from './';
-
-import type { AA,
- BB, CC } from 'abc';
-
-import type { Z } from 'fizz';
-
-import type {
- A,
- B
-} from 'foo';
-
-import type { C2 } from 'dirB/Bar';
-
-import type {
- D2,
- X2,
- Y2
-} from 'dirB/bar';
-
-import type { E2 } from 'dirB/baz';
-import type { C3 } from 'dirC/Bar';
-
-import type {
- D3,
- X3,
- Y3
-} from 'dirC/bar';
-
-import type { E3 } from 'dirC/baz';
-import type { F3 } from 'dirC/caz';
-import type { C1 } from 'dirA/Bar';
-
-import type {
- D1,
- X1,
- Y1
-} from 'dirA/bar';
-
-import type { E1 } from 'dirA/baz';
-import type { F } from './index.js';
-import type { G } from './aaa.js';
-import type { H } from './bbb';
-```
-
## Related
- [`import/external-module-folders`][29]
@@ -1006,7 +543,6 @@ import type { H } from './bbb';
[4]: https://nodejs.org/api/esm.html#terminology
[5]: #warnonunassignedimports
[6]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export
-[7]: #sorttypesamongthemselves
[8]: #pathgroups
[9]: #pathgroupsexcludedimporttypes
[10]: https://www.npmjs.com/package/is-core-module
@@ -1021,8 +557,6 @@ import type { H } from './bbb';
[21]: https://eslint.org/docs/latest/rules/no-multiple-empty-lines
[22]: https://prettier.io
[23]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names
-[25]: #consolidateislands
-[27]: #newlines-between-types
[28]: ../../README.md#importinternal-regex
[29]: ../../README.md#importexternal-module-folders
[30]: #alphabetize
From fa36d4983c03f1e3a63c3cd555ea2fb34adc0a86 Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Mon, 18 Nov 2024 03:17:01 -0800
Subject: [PATCH 189/199] [New] `extensions`: add `pathGroupOverrides to allow
enforcement decision overrides based on specifier
---
CHANGELOG.md | 2 +
src/rules/extensions.js | 50 +++++++++++++-
tests/src/rules/extensions.js | 120 ++++++++++++++++++++++++++++++++++
3 files changed, 169 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5bcd7163ff..6aff8cda1a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Added
- add [`enforce-node-protocol-usage`] rule and `import/node-version` setting ([#3024], thanks [@GoldStrikeArch] and [@sevenc-nanashi])
- add TypeScript types ([#3097], thanks [@G-Rath])
+- [`extensions`]: add `pathGroupOverrides to allow enforcement decision overrides based on specifier ([#3105], thanks [@Xunnamius])
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
@@ -1170,6 +1171,7 @@ for info on changes for earlier releases.
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
[#3116]: https://github.com/import-js/eslint-plugin-import/pull/3116
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
+[#3105]: https://github.com/import-js/eslint-plugin-import/pull/3105
[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
diff --git a/src/rules/extensions.js b/src/rules/extensions.js
index c2c03a2b17..2aeef64758 100644
--- a/src/rules/extensions.js
+++ b/src/rules/extensions.js
@@ -1,5 +1,6 @@
import path from 'path';
+import minimatch from 'minimatch';
import resolve from 'eslint-module-utils/resolve';
import { isBuiltIn, isExternalModule, isScoped } from '../core/importType';
import moduleVisitor from 'eslint-module-utils/moduleVisitor';
@@ -16,6 +17,26 @@ const properties = {
pattern: patternProperties,
checkTypeImports: { type: 'boolean' },
ignorePackages: { type: 'boolean' },
+ pathGroupOverrides: {
+ type: 'array',
+ items: {
+ type: 'object',
+ properties: {
+ pattern: {
+ type: 'string',
+ },
+ patternOptions: {
+ type: 'object',
+ },
+ action: {
+ type: 'string',
+ enum: ['enforce', 'ignore'],
+ },
+ },
+ additionalProperties: false,
+ required: ['pattern', 'action'],
+ },
+ },
},
};
@@ -54,6 +75,10 @@ function buildProperties(context) {
if (obj.checkTypeImports !== undefined) {
result.checkTypeImports = obj.checkTypeImports;
}
+
+ if (obj.pathGroupOverrides !== undefined) {
+ result.pathGroupOverrides = obj.pathGroupOverrides;
+ }
});
if (result.defaultConfig === 'ignorePackages') {
@@ -143,20 +168,39 @@ module.exports = {
return false;
}
+ function computeOverrideAction(pathGroupOverrides, path) {
+ for (let i = 0, l = pathGroupOverrides.length; i < l; i++) {
+ const { pattern, patternOptions, action } = pathGroupOverrides[i];
+ if (minimatch(path, pattern, patternOptions || { nocomment: true })) {
+ return action;
+ }
+ }
+ }
+
function checkFileExtension(source, node) {
// bail if the declaration doesn't have a source, e.g. "export { foo };", or if it's only partially typed like in an editor
if (!source || !source.value) { return; }
const importPathWithQueryString = source.value;
+ // If not undefined, the user decided if rules are enforced on this import
+ const overrideAction = computeOverrideAction(
+ props.pathGroupOverrides || [],
+ importPathWithQueryString,
+ );
+
+ if (overrideAction === 'ignore') {
+ return;
+ }
+
// don't enforce anything on builtins
- if (isBuiltIn(importPathWithQueryString, context.settings)) { return; }
+ if (!overrideAction && isBuiltIn(importPathWithQueryString, context.settings)) { return; }
const importPath = importPathWithQueryString.replace(/\?(.*)$/, '');
// don't enforce in root external packages as they may have names with `.js`.
// Like `import Decimal from decimal.js`)
- if (isExternalRootModule(importPath)) { return; }
+ if (!overrideAction && isExternalRootModule(importPath)) { return; }
const resolvedPath = resolve(importPath, context);
@@ -174,7 +218,7 @@ module.exports = {
if (!extension || !importPath.endsWith(`.${extension}`)) {
// ignore type-only imports and exports
if (!props.checkTypeImports && (node.importKind === 'type' || node.exportKind === 'type')) { return; }
- const extensionRequired = isUseOfExtensionRequired(extension, isPackage);
+ const extensionRequired = isUseOfExtensionRequired(extension, !overrideAction && isPackage);
const extensionForbidden = isUseOfExtensionForbidden(extension);
if (extensionRequired && !extensionForbidden) {
context.report({
diff --git a/tests/src/rules/extensions.js b/tests/src/rules/extensions.js
index 883dfab657..8843713e34 100644
--- a/tests/src/rules/extensions.js
+++ b/tests/src/rules/extensions.js
@@ -736,6 +736,86 @@ describe('TypeScript', () => {
],
parser,
}),
+
+ // pathGroupOverrides: no patterns match good bespoke specifiers
+ test({
+ code: `
+ import { ErrorMessage as UpstreamErrorMessage } from '@black-flag/core/util';
+
+ import { $instances } from 'rootverse+debug:src.ts';
+ import { $exists } from 'rootverse+bfe:src/symbols.ts';
+
+ import type { Entries } from 'type-fest';
+ `,
+ parser,
+ options: [
+ 'always',
+ {
+ ignorePackages: true,
+ checkTypeImports: true,
+ pathGroupOverrides: [
+ {
+ pattern: 'multiverse{*,*/**}',
+ action: 'enforce',
+ },
+ ],
+ },
+ ],
+ }),
+ // pathGroupOverrides: an enforce pattern matches good bespoke specifiers
+ test({
+ code: `
+ import { ErrorMessage as UpstreamErrorMessage } from '@black-flag/core/util';
+
+ import { $instances } from 'rootverse+debug:src.ts';
+ import { $exists } from 'rootverse+bfe:src/symbols.ts';
+
+ import type { Entries } from 'type-fest';
+ `,
+ parser,
+ options: [
+ 'always',
+ {
+ ignorePackages: true,
+ checkTypeImports: true,
+ pathGroupOverrides: [
+ {
+ pattern: 'rootverse{*,*/**}',
+ action: 'enforce',
+ },
+ ],
+ },
+ ],
+ }),
+ // pathGroupOverrides: an ignore pattern matches bad bespoke specifiers
+ test({
+ code: `
+ import { ErrorMessage as UpstreamErrorMessage } from '@black-flag/core/util';
+
+ import { $instances } from 'rootverse+debug:src';
+ import { $exists } from 'rootverse+bfe:src/symbols';
+
+ import type { Entries } from 'type-fest';
+ `,
+ parser,
+ options: [
+ 'always',
+ {
+ ignorePackages: true,
+ checkTypeImports: true,
+ pathGroupOverrides: [
+ {
+ pattern: 'multiverse{*,*/**}',
+ action: 'enforce',
+ },
+ {
+ pattern: 'rootverse{*,*/**}',
+ action: 'ignore',
+ },
+ ],
+ },
+ ],
+ }),
],
invalid: [
test({
@@ -756,6 +836,46 @@ describe('TypeScript', () => {
],
parser,
}),
+
+ // pathGroupOverrides: an enforce pattern matches bad bespoke specifiers
+ test({
+ code: `
+ import { ErrorMessage as UpstreamErrorMessage } from '@black-flag/core/util';
+
+ import { $instances } from 'rootverse+debug:src';
+ import { $exists } from 'rootverse+bfe:src/symbols';
+
+ import type { Entries } from 'type-fest';
+ `,
+ parser,
+ options: [
+ 'always',
+ {
+ ignorePackages: true,
+ checkTypeImports: true,
+ pathGroupOverrides: [
+ {
+ pattern: 'rootverse{*,*/**}',
+ action: 'enforce',
+ },
+ {
+ pattern: 'universe{*,*/**}',
+ action: 'ignore',
+ },
+ ],
+ },
+ ],
+ errors: [
+ {
+ message: 'Missing file extension for "rootverse+debug:src"',
+ line: 4,
+ },
+ {
+ message: 'Missing file extension for "rootverse+bfe:src/symbols"',
+ line: 5,
+ },
+ ],
+ }),
],
});
});
From 341178de7d0ca76e6fc35550737509b8da95d44e Mon Sep 17 00:00:00 2001
From: D <intellix@users.noreply.github.com>
Date: Wed, 8 Jan 2025 18:41:53 +0000
Subject: [PATCH 190/199] [readme] Update flatConfig example to include
typescript config
---
CHANGELOG.md | 3 +++
README.md | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6aff8cda1a..80b1f632a1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
- [Docs] add flat config guide for using `tseslint.config()` ([#3125], thanks [@lnuvy])
- [Docs] add missing comma ([#3122], thanks [@RyanGst])
+- [readme] Update flatConfig example to include typescript config ([#3138], thanks [@intellix])
## [2.31.0] - 2024-10-03
@@ -1167,6 +1168,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
[#3116]: https://github.com/import-js/eslint-plugin-import/pull/3116
@@ -1873,6 +1875,7 @@ for info on changes for earlier releases.
[@hulkish]: https://github.com/hulkish
[@hyperupcall]: https://github.com/hyperupcall
[@Hypnosphi]: https://github.com/Hypnosphi
+[@intellix]: https://github.com/intellix
[@isiahmeadows]: https://github.com/isiahmeadows
[@IvanGoncharov]: https://github.com/IvanGoncharov
[@ivo-stefchev]: https://github.com/ivo-stefchev
diff --git a/README.md b/README.md
index 993d31399a..885f34873c 100644
--- a/README.md
+++ b/README.md
@@ -205,7 +205,7 @@ export default tseslint.config(
// other configs...
{
files: ['**/*.{ts,tsx}'],
- extends: [importPlugin.flatConfigs.recommended],
+ extends: [importPlugin.flatConfigs.recommended, importPlugin.flatConfigs.typescript],
// other configs...
}
);
From fd1ae63492a554ded6c5cc7fc262034804819e5e Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Sun, 22 Dec 2024 17:56:27 -0800
Subject: [PATCH 191/199] [New] `order`: add `sortTypesGroup` option to allow
intragroup sorting of type-only imports
Closes #2912
Closes #2347
Closes #2441
Subsumes #2615
---
CHANGELOG.md | 2 +
docs/rules/order.md | 64 +++++++++++++-
src/rules/order.js | 33 +++++--
tests/src/rules/order.js | 182 +++++++++++++++++++++++++++++++++++++++
4 files changed, 274 insertions(+), 7 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 80b1f632a1..9d60bc3110 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- add [`enforce-node-protocol-usage`] rule and `import/node-version` setting ([#3024], thanks [@GoldStrikeArch] and [@sevenc-nanashi])
- add TypeScript types ([#3097], thanks [@G-Rath])
- [`extensions`]: add `pathGroupOverrides to allow enforcement decision overrides based on specifier ([#3105], thanks [@Xunnamius])
+- [`order`]: add `sortTypesGroup` option to allow intragroup sorting of type-only imports ([#3104], thanks [@Xunnamius])
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
@@ -1174,6 +1175,7 @@ for info on changes for earlier releases.
[#3116]: https://github.com/import-js/eslint-plugin-import/pull/3116
[#3106]: https://github.com/import-js/eslint-plugin-import/pull/3106
[#3105]: https://github.com/import-js/eslint-plugin-import/pull/3105
+[#3104]: https://github.com/import-js/eslint-plugin-import/pull/3104
[#3097]: https://github.com/import-js/eslint-plugin-import/pull/3097
[#3073]: https://github.com/import-js/eslint-plugin-import/pull/3073
[#3072]: https://github.com/import-js/eslint-plugin-import/pull/3072
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 02a2b4bed7..996df915c2 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -106,6 +106,7 @@ This rule supports the following options (none of which are required):
- [`alphabetize`][30]
- [`named`][33]
- [`warnOnUnassignedImports`][5]
+ - [`sortTypesGroup`][7]
---
@@ -156,7 +157,7 @@ Roughly speaking, the grouping algorithm is as follows:
1. If the import has no corresponding identifiers (e.g. `import './my/thing.js'`), is otherwise "unassigned," or is an unsupported use of `require()`, and [`warnOnUnassignedImports`][5] is disabled, it will be ignored entirely since the order of these imports may be important for their [side-effects][31]
2. If the import is part of an arcane TypeScript declaration (e.g. `import log = console.log`), it will be considered **object**. However, note that external module references (e.g. `import x = require('z')`) are treated as normal `require()`s and import-exports (e.g. `export import w = y;`) are ignored entirely
-3. If the import is [type-only][6], and `"type"` is in `groups`, it will be considered **type** (with additional implications if using [`pathGroups`][8] and `"type"` is in [`pathGroupsExcludedImportTypes`][9])
+3. If the import is [type-only][6], `"type"` is in `groups`, and [`sortTypesGroup`][7] is disabled, it will be considered **type** (with additional implications if using [`pathGroups`][8] and `"type"` is in [`pathGroupsExcludedImportTypes`][9])
4. If the import's specifier matches [`import/internal-regex`][28], it will be considered **internal**
5. If the import's specifier is an absolute path, it will be considered **unknown**
6. If the import's specifier has the name of a Node.js core module (using [is-core-module][10]), it will be considered **builtin**
@@ -171,7 +172,7 @@ Roughly speaking, the grouping algorithm is as follows:
15. If the import's specifier has a name that starts with a word character, it will be considered **external**
16. If this point is reached, the import will be ignored entirely
-At the end of the process, if they co-exist in the same file, all top-level `require()` statements that haven't been ignored are shifted (with respect to their order) below any ES6 `import` or similar declarations.
+At the end of the process, if they co-exist in the same file, all top-level `require()` statements that haven't been ignored are shifted (with respect to their order) below any ES6 `import` or similar declarations. Finally, any type-only declarations are potentially reorganized according to [`sortTypesGroup`][7].
### `pathGroups`
@@ -533,6 +534,64 @@ import path from 'path';
import './styles.css';
```
+### `sortTypesGroup`
+
+Valid values: `boolean` \
+Default: `false`
+
+> \[!NOTE]
+>
+> This setting is only meaningful when `"type"` is included in [`groups`][18].
+
+Sort [type-only imports][6] separately from normal non-type imports.
+
+When enabled, the intragroup sort order of [type-only imports][6] will mirror the intergroup ordering of normal imports as defined by [`groups`][18], [`pathGroups`][8], etc.
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "alphabetize": { "order": "asc" }
+ }]
+}
+```
+
+This will fail the rule check even though it's logically ordered as we expect (builtins come before parents, parents come before siblings, siblings come before indices), the only difference is we separated type-only imports from normal imports:
+
+```ts
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+import b from "path";
+import c from "../foo.js";
+import d from "./bar.js";
+import e from "./";
+```
+
+This happens because [type-only imports][6] are considered part of one global
+[`"type"` group](#how-imports-are-grouped) by default. However, if we set
+`sortTypesGroup` to `true`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "alphabetize": { "order": "asc" },
+ "sortTypesGroup": true
+ }]
+}
+```
+
+The same example will pass.
+
## Related
- [`import/external-module-folders`][29]
@@ -543,6 +602,7 @@ import './styles.css';
[4]: https://nodejs.org/api/esm.html#terminology
[5]: #warnonunassignedimports
[6]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export
+[7]: #sorttypesgroup
[8]: #pathgroups
[9]: #pathgroupsexcludedimporttypes
[10]: https://www.npmjs.com/package/is-core-module
diff --git a/src/rules/order.js b/src/rules/order.js
index d6f25ddd33..ead2fdff97 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -513,22 +513,34 @@ function computePathRank(ranks, pathGroups, path, maxPosition) {
}
}
-function computeRank(context, ranks, importEntry, excludedImportTypes) {
+function computeRank(context, ranks, importEntry, excludedImportTypes, isSortingTypesGroup) {
let impType;
let rank;
+
+ const isTypeGroupInGroups = ranks.omittedTypes.indexOf('type') === -1;
+ const isTypeOnlyImport = importEntry.node.importKind === 'type';
+ const isExcludedFromPathRank = isTypeOnlyImport && isTypeGroupInGroups && excludedImportTypes.has('type');
+
if (importEntry.type === 'import:object') {
impType = 'object';
- } else if (importEntry.node.importKind === 'type' && ranks.omittedTypes.indexOf('type') === -1) {
+ } else if (isTypeOnlyImport && isTypeGroupInGroups && !isSortingTypesGroup) {
impType = 'type';
} else {
impType = importType(importEntry.value, context);
}
- if (!excludedImportTypes.has(impType)) {
+
+ if (!excludedImportTypes.has(impType) && !isExcludedFromPathRank) {
rank = computePathRank(ranks.groups, ranks.pathGroups, importEntry.value, ranks.maxPosition);
}
+
if (typeof rank === 'undefined') {
rank = ranks.groups[impType];
}
+
+ if (isTypeOnlyImport && isSortingTypesGroup) {
+ rank = ranks.groups.type + rank / 10;
+ }
+
if (importEntry.type !== 'import' && !importEntry.type.startsWith('import:')) {
rank += 100;
}
@@ -536,8 +548,8 @@ function computeRank(context, ranks, importEntry, excludedImportTypes) {
return rank;
}
-function registerNode(context, importEntry, ranks, imported, excludedImportTypes) {
- const rank = computeRank(context, ranks, importEntry, excludedImportTypes);
+function registerNode(context, importEntry, ranks, imported, excludedImportTypes, isSortingTypesGroup) {
+ const rank = computeRank(context, ranks, importEntry, excludedImportTypes, isSortingTypesGroup);
if (rank !== -1) {
imported.push({ ...importEntry, rank });
}
@@ -781,6 +793,10 @@ module.exports = {
'never',
],
},
+ sortTypesGroup: {
+ type: 'boolean',
+ default: false,
+ },
named: {
default: false,
oneOf: [{
@@ -837,6 +853,7 @@ module.exports = {
const options = context.options[0] || {};
const newlinesBetweenImports = options['newlines-between'] || 'ignore';
const pathGroupsExcludedImportTypes = new Set(options.pathGroupsExcludedImportTypes || ['builtin', 'external', 'object']);
+ const sortTypesGroup = options.sortTypesGroup;
const named = {
types: 'mixed',
@@ -879,6 +896,9 @@ module.exports = {
const importMap = new Map();
const exportMap = new Map();
+ const isTypeGroupInGroups = ranks.omittedTypes.indexOf('type') === -1;
+ const isSortingTypesGroup = isTypeGroupInGroups && sortTypesGroup;
+
function getBlockImports(node) {
if (!importMap.has(node)) {
importMap.set(node, []);
@@ -932,6 +952,7 @@ module.exports = {
ranks,
getBlockImports(node.parent),
pathGroupsExcludedImportTypes,
+ isSortingTypesGroup,
);
if (named.import) {
@@ -983,6 +1004,7 @@ module.exports = {
ranks,
getBlockImports(node.parent),
pathGroupsExcludedImportTypes,
+ isSortingTypesGroup,
);
},
CallExpression(node) {
@@ -1005,6 +1027,7 @@ module.exports = {
ranks,
getBlockImports(block),
pathGroupsExcludedImportTypes,
+ isSortingTypesGroup,
);
},
...named.require && {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index ea62cec71d..6da42474c3 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -3285,6 +3285,188 @@ context('TypeScript', function () {
}],
}),
] : [],
+ // Option sortTypesGroup: false (default)
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import b from 'dirA/bar';
+ import type { D } from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA } from 'abc';
+ import type { A } from 'foo';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: [],
+ },
+ ],
+ }),
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import b from 'dirA/bar';
+ import type { D } from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA } from 'abc';
+ import type { A } from 'foo';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: false,
+ },
+ ],
+ }),
+ // Option sortTypesGroup: true and 'type' in pathGroupsExcludedImportTypes
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA } from 'abc';
+ import type { C } from 'dirA/Bar';
+ import type { D } from 'dirA/bar';
+ import type { A } from 'foo';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: ['type'],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Option sortTypesGroup: true and 'type' omitted from groups
+ test({
+ code: `
+ import c from 'Bar';
+ import type { AA } from 'abc';
+ import a from 'foo';
+ import type { A } from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import b from 'dirA/bar';
+ import type { D } from 'dirA/bar';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: [],
+ // Becomes a no-op without "type" in groups
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ test({
+ code: `
+ import c from 'Bar';
+ import type { AA } from 'abc';
+ import a from 'foo';
+ import type { A } from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import b from 'dirA/bar';
+ import type { D } from 'dirA/bar';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: [],
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true puts type imports in the same order as regular imports (from issue #2441, PR #2615)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ alphabetize: {
+ order: 'asc',
+ caseInsensitive: true,
+ },
+ sortTypesGroup: true,
+ },
+ ],
+ }),
),
invalid: [].concat(
// Option alphabetize: {order: 'asc'}
From 668d493dbb456415c3aa12bcbde7917d475393c5 Mon Sep 17 00:00:00 2001
From: Nisharg Shah <nishargshah3101@gmail.com>
Date: Fri, 24 Jan 2025 18:43:21 +0530
Subject: [PATCH 192/199] [Fix] configs: added missing name attribute for
eslint config inspector
---
CHANGELOG.md | 3 +++
src/index.js | 8 ++++----
2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9d60bc3110..1cb9b56276 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
+- configs: added missing name attribute for eslint config inspector ([#3151], thanks [@NishargShah])
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
@@ -1169,6 +1170,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
@@ -1965,6 +1967,7 @@ for info on changes for earlier releases.
[@Nfinished]: https://github.com/Nfinished
[@nickofthyme]: https://github.com/nickofthyme
[@nicolashenry]: https://github.com/nicolashenry
+[@NishargShah]: https://github.com/NishargShah
[@noelebrun]: https://github.com/noelebrun
[@ntdb]: https://github.com/ntdb
[@nwalters512]: https://github.com/nwalters512
diff --git a/src/index.js b/src/index.js
index 6252620605..6cd7bffe2f 100644
--- a/src/index.js
+++ b/src/index.js
@@ -96,8 +96,8 @@ export const flatConfigs = {
warnings: createFlatConfig(require('../config/flat/warnings'), 'warnings'),
// useful stuff for folks using various environments
- react: require('../config/flat/react'),
- 'react-native': configs['react-native'],
- electron: configs.electron,
- typescript: configs.typescript,
+ react: createFlatConfig(require('../config/flat/react'), 'react'),
+ 'react-native': createFlatConfig(configs['react-native'], 'react-native'),
+ electron: createFlatConfig(configs.electron, 'electron'),
+ typescript: createFlatConfig(configs.typescript, 'typescript'),
};
From e1e55384e53702b670cf9eea4adfaf004244b72b Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Sun, 22 Dec 2024 17:56:27 -0800
Subject: [PATCH 193/199] [New] `order`: add `newlines-between-types` option to
control intragroup sorting of type-only imports
Closes #2912
Closes #2347
Closes #2441
Subsumes #2615
---
CHANGELOG.md | 2 +
docs/rules/order.md | 131 +++++++++++++
src/rules/order.js | 120 ++++++++----
tests/src/rules/order.js | 383 +++++++++++++++++++++++++++++++++++++++
4 files changed, 603 insertions(+), 33 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1cb9b56276..a2a436a38a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- add TypeScript types ([#3097], thanks [@G-Rath])
- [`extensions`]: add `pathGroupOverrides to allow enforcement decision overrides based on specifier ([#3105], thanks [@Xunnamius])
- [`order`]: add `sortTypesGroup` option to allow intragroup sorting of type-only imports ([#3104], thanks [@Xunnamius])
+- [`order`]: add `newlines-between-types` option to control intragroup sorting of type-only imports ([#3127], thanks [@Xunnamius])
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
@@ -1172,6 +1173,7 @@ for info on changes for earlier releases.
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
+[#3127]: https://github.com/import-js/eslint-plugin-import/pull/3127
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
[#3116]: https://github.com/import-js/eslint-plugin-import/pull/3116
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 996df915c2..3dee4b6de1 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -107,6 +107,7 @@ This rule supports the following options (none of which are required):
- [`named`][33]
- [`warnOnUnassignedImports`][5]
- [`sortTypesGroup`][7]
+ - [`newlines-between-types`][27]
---
@@ -592,6 +593,135 @@ This happens because [type-only imports][6] are considered part of one global
The same example will pass.
+### `newlines-between-types`
+
+Valid values: `"ignore" | "always" | "always-and-inside-groups" | "never"` \
+Default: the value of [`newlines-between`][20]
+
+> \[!NOTE]
+>
+> This setting is only meaningful when [`sortTypesGroup`][7] is enabled.
+
+`newlines-between-types` is functionally identical to [`newlines-between`][20] except it only enforces or forbids new lines between _[type-only][6] import groups_, which exist only when [`sortTypesGroup`][7] is enabled.
+
+In addition, when determining if a new line is enforceable or forbidden between the type-only imports and the normal imports, `newlines-between-types` takes precedence over [`newlines-between`][20].
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesGroup": true,
+ "newlines-between": "always"
+ }]
+}
+```
+
+This will fail the rule check:
+
+```ts
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+import b from "path";
+
+import c from "../foo.js";
+
+import d from "./bar.js";
+
+import e from "./";
+```
+
+However, if we set `newlines-between-types` to `"ignore"`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesGroup": true,
+ "newlines-between": "always",
+ "newlines-between-types": "ignore"
+ }]
+}
+```
+
+The same example will pass.
+
+Note the new line after `import type E from './';` but before `import a from "fs";`. This new line separates the type-only imports from the normal imports. Its existence is governed by [`newlines-between-types`][27] and _not `newlines-between`_.
+
+> \[!IMPORTANT]
+>
+> In certain situations, `consolidateIslands: true` will take precedence over `newlines-between-types: "never"`, if used, when it comes to the new line separating type-only imports from normal imports.
+
+The next example will pass even though there's a new line preceding the normal import and [`newlines-between`][20] is set to `"never"`:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesGroup": true,
+ "newlines-between": "never",
+ "newlines-between-types": "always"
+ }]
+}
+```
+
+```ts
+import type A from "fs";
+
+import type B from "path";
+
+import type C from "../foo.js";
+
+import type D from "./bar.js";
+
+import type E from './';
+
+import a from "fs";
+import b from "path";
+import c from "../foo.js";
+import d from "./bar.js";
+import e from "./";
+```
+
+While the following fails due to the new line between the last type import and the first normal import:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "groups": ["type", "builtin", "parent", "sibling", "index"],
+ "sortTypesGroup": true,
+ "newlines-between": "always",
+ "newlines-between-types": "never"
+ }]
+}
+```
+
+```ts
+import type A from "fs";
+import type B from "path";
+import type C from "../foo.js";
+import type D from "./bar.js";
+import type E from './';
+
+import a from "fs";
+
+import b from "path";
+
+import c from "../foo.js";
+
+import d from "./bar.js";
+
+import e from "./";
+```
+
## Related
- [`import/external-module-folders`][29]
@@ -617,6 +747,7 @@ The same example will pass.
[21]: https://eslint.org/docs/latest/rules/no-multiple-empty-lines
[22]: https://prettier.io
[23]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names
+[27]: #newlines-between-types
[28]: ../../README.md#importinternal-regex
[29]: ../../README.md#importexternal-module-folders
[30]: #alphabetize
diff --git a/src/rules/order.js b/src/rules/order.js
index ead2fdff97..cb77c15809 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -416,7 +416,7 @@ const compareString = (a, b) => {
};
/** Some parsers (languages without types) don't provide ImportKind */
-const DEAFULT_IMPORT_KIND = 'value';
+const DEFAULT_IMPORT_KIND = 'value';
const getNormalizedValue = (node, toLowerCase) => {
const value = node.value;
return toLowerCase ? String(value).toLowerCase() : value;
@@ -462,8 +462,8 @@ function getSorter(alphabetizeOptions) {
// In case the paths are equal (result === 0), sort them by importKind
if (!result && multiplierImportKind) {
result = multiplierImportKind * compareString(
- nodeA.node.importKind || DEAFULT_IMPORT_KIND,
- nodeB.node.importKind || DEAFULT_IMPORT_KIND,
+ nodeA.node.importKind || DEFAULT_IMPORT_KIND,
+ nodeB.node.importKind || DEFAULT_IMPORT_KIND,
);
}
@@ -677,7 +677,7 @@ function removeNewLineAfterImport(context, currentImport, previousImport) {
return undefined;
}
-function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, distinctGroup) {
+function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, newlinesBetweenTypeOnlyImports, distinctGroup, isSortingTypesGroup) {
const getNumberOfEmptyLinesBetween = (currentImport, previousImport) => {
const linesBetweenImports = getSourceCode(context).lines.slice(
previousImport.node.loc.end.line,
@@ -690,35 +690,72 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, di
let previousImport = imported[0];
imported.slice(1).forEach(function (currentImport) {
- const emptyLinesBetween = getNumberOfEmptyLinesBetween(currentImport, previousImport);
- const isStartOfDistinctGroup = getIsStartOfDistinctGroup(currentImport, previousImport);
-
- if (newlinesBetweenImports === 'always'
- || newlinesBetweenImports === 'always-and-inside-groups') {
- if (currentImport.rank !== previousImport.rank && emptyLinesBetween === 0) {
- if (distinctGroup || !distinctGroup && isStartOfDistinctGroup) {
- context.report({
- node: previousImport.node,
- message: 'There should be at least one empty line between import groups',
- fix: fixNewLineAfterImport(context, previousImport),
- });
- }
- } else if (emptyLinesBetween > 0
- && newlinesBetweenImports !== 'always-and-inside-groups') {
- if (distinctGroup && currentImport.rank === previousImport.rank || !distinctGroup && !isStartOfDistinctGroup) {
- context.report({
- node: previousImport.node,
- message: 'There should be no empty line within import group',
- fix: removeNewLineAfterImport(context, currentImport, previousImport),
- });
+ const emptyLinesBetween = getNumberOfEmptyLinesBetween(
+ currentImport,
+ previousImport,
+ );
+
+ const isStartOfDistinctGroup = getIsStartOfDistinctGroup(
+ currentImport,
+ previousImport,
+ );
+
+ const isTypeOnlyImport = currentImport.node.importKind === 'type';
+ const isPreviousImportTypeOnlyImport = previousImport.node.importKind === 'type';
+
+ const isNormalImportFollowingTypeOnlyImportAndRelevant = !isTypeOnlyImport && isPreviousImportTypeOnlyImport && isSortingTypesGroup;
+
+ const isTypeOnlyImportAndRelevant = isTypeOnlyImport && isSortingTypesGroup;
+
+ const isNotIgnored = isTypeOnlyImportAndRelevant
+ && newlinesBetweenTypeOnlyImports !== 'ignore'
+ || !isTypeOnlyImportAndRelevant && newlinesBetweenImports !== 'ignore';
+
+ if (isNotIgnored) {
+ const shouldAssertNewlineBetweenGroups = (isTypeOnlyImportAndRelevant || isNormalImportFollowingTypeOnlyImportAndRelevant)
+ && (newlinesBetweenTypeOnlyImports === 'always'
+ || newlinesBetweenTypeOnlyImports === 'always-and-inside-groups')
+ || !isTypeOnlyImportAndRelevant && !isNormalImportFollowingTypeOnlyImportAndRelevant
+ && (newlinesBetweenImports === 'always'
+ || newlinesBetweenImports === 'always-and-inside-groups');
+
+ const shouldAssertNoNewlineWithinGroup = (isTypeOnlyImportAndRelevant || isNormalImportFollowingTypeOnlyImportAndRelevant)
+ && newlinesBetweenTypeOnlyImports !== 'always-and-inside-groups'
+ || !isTypeOnlyImportAndRelevant && !isNormalImportFollowingTypeOnlyImportAndRelevant
+ && newlinesBetweenImports !== 'always-and-inside-groups';
+
+ const shouldAssertNoNewlineBetweenGroup = !isSortingTypesGroup
+ || !isNormalImportFollowingTypeOnlyImportAndRelevant
+ || newlinesBetweenTypeOnlyImports === 'never';
+
+ if (shouldAssertNewlineBetweenGroups) {
+ if (currentImport.rank !== previousImport.rank && emptyLinesBetween === 0) {
+ if (distinctGroup || !distinctGroup && isStartOfDistinctGroup) {
+ context.report({
+ node: previousImport.node,
+ message: 'There should be at least one empty line between import groups',
+ fix: fixNewLineAfterImport(context, previousImport),
+ });
+ }
+ } else if (emptyLinesBetween > 0 && shouldAssertNoNewlineWithinGroup) {
+ if (
+ distinctGroup && currentImport.rank === previousImport.rank
+ || !distinctGroup && !isStartOfDistinctGroup
+ ) {
+ context.report({
+ node: previousImport.node,
+ message: 'There should be no empty line within import group',
+ fix: removeNewLineAfterImport(context, currentImport, previousImport),
+ });
+ }
}
+ } else if (emptyLinesBetween > 0 && shouldAssertNoNewlineBetweenGroup) {
+ context.report({
+ node: previousImport.node,
+ message: 'There should be no empty line between import groups',
+ fix: removeNewLineAfterImport(context, currentImport, previousImport),
+ });
}
- } else if (emptyLinesBetween > 0) {
- context.report({
- node: previousImport.node,
- message: 'There should be no empty line between import groups',
- fix: removeNewLineAfterImport(context, currentImport, previousImport),
- });
}
previousImport = currentImport;
@@ -793,6 +830,14 @@ module.exports = {
'never',
],
},
+ 'newlines-between-types': {
+ enum: [
+ 'ignore',
+ 'always',
+ 'always-and-inside-groups',
+ 'never',
+ ],
+ },
sortTypesGroup: {
type: 'boolean',
default: false,
@@ -845,6 +890,14 @@ module.exports = {
},
},
additionalProperties: false,
+ dependencies: {
+ 'newlines-between-types': {
+ properties: {
+ sortTypesGroup: { enum: [true] },
+ },
+ required: ['sortTypesGroup'],
+ },
+ },
},
],
},
@@ -852,6 +905,7 @@ module.exports = {
create(context) {
const options = context.options[0] || {};
const newlinesBetweenImports = options['newlines-between'] || 'ignore';
+ const newlinesBetweenTypeOnlyImports = options['newlines-between-types'] || newlinesBetweenImports;
const pathGroupsExcludedImportTypes = new Set(options.pathGroupsExcludedImportTypes || ['builtin', 'external', 'object']);
const sortTypesGroup = options.sortTypesGroup;
@@ -1115,8 +1169,8 @@ module.exports = {
},
'Program:exit'() {
importMap.forEach((imported) => {
- if (newlinesBetweenImports !== 'ignore') {
- makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, distinctGroup);
+ if (newlinesBetweenImports !== 'ignore' || newlinesBetweenTypeOnlyImports !== 'ignore') {
+ makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, newlinesBetweenTypeOnlyImports, distinctGroup, isSortingTypesGroup);
}
if (alphabetize.order !== 'ignore') {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 6da42474c3..13f96ca272 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -3440,6 +3440,168 @@ context('TypeScript', function () {
},
],
}),
+ // Option sortTypesGroup: true and newlines-between-types defaults to the value of newlines-between
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA } from 'abc';
+ import type { A } from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import type { D } from 'dirA/bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'always' (takes precedence over newlines-between between type-only and normal imports)
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+
+ import type { AA } from 'abc';
+ import type { A } from 'foo';
+
+ import type { C } from 'dirA/Bar';
+ import type { D } from 'dirA/bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'never' (takes precedence over newlines-between between type-only and normal imports)
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+ import type { AA } from 'abc';
+ import type { A } from 'foo';
+ import type { C } from 'dirA/Bar';
+ import type { D } from 'dirA/bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'never',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'ignore'
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+ import type { AA } from 'abc';
+
+ import type { A } from 'foo';
+ import type { C } from 'dirA/Bar';
+ import type { D } from 'dirA/bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'ignore',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups'
+ test({
+ code: `
+ import c from 'Bar';
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+
+ import type { AA } from 'abc';
+
+ import type { A } from 'foo';
+
+ import type { C } from 'dirA/Bar';
+
+ import type { D } from 'dirA/bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
// Option: sortTypesGroup: true puts type imports in the same order as regular imports (from issue #2441, PR #2615)
test({
code: `
@@ -3467,6 +3629,116 @@ context('TypeScript', function () {
},
],
}),
+ // Options: sortTypesGroup + newlines-between-types example #1 from the documentation (pass)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'ignore',
+ },
+ ],
+ }),
+ test({
+ code: `
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['builtin', 'parent', 'sibling', 'index', 'type'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'ignore',
+ },
+ ],
+ }),
+ // Options: sortTypesGroup + newlines-between-types example #2 from the documentation (pass)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always',
+ },
+ ],
+ }),
+ test({
+ code: `
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['builtin', 'parent', 'sibling', 'index', 'type'],
+ sortTypesGroup: true,
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always',
+ },
+ ],
+ }),
),
invalid: [].concat(
// Option alphabetize: {order: 'asc'}
@@ -3721,6 +3993,117 @@ context('TypeScript', function () {
}],
}),
+ // Options: sortTypesGroup + newlines-between-types example #1 from the documentation (fail)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ output: `
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 3,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 5,
+ },
+ ],
+ }),
+
+ // Options: sortTypesGroup + newlines-between-types example #2 from the documentation (fail)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ output: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'never',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be no empty line between import groups',
+ line: 6,
+ },
+ ],
+ }),
+
supportsExportTypeSpecifiers ? [
test({
code: `
From 42ce8569b2aab2e1dd70b0229493b370bfbfc09b Mon Sep 17 00:00:00 2001
From: Climax708 <soryy708@gmail.com>
Date: Sat, 14 Dec 2024 23:19:07 +0200
Subject: [PATCH 194/199] [meta] issue template with guidance for bug reports
---
.github/issue_template.md | 10 ++++++++++
1 file changed, 10 insertions(+)
create mode 100644 .github/issue_template.md
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 0000000000..673d652375
--- /dev/null
+++ b/.github/issue_template.md
@@ -0,0 +1,10 @@
+<!-- Reporting a bug? -->
+<!--
+ Please provide the output of running ESLint with this environment variable: `DEBUG=eslint-plugin-import:*`
+ Windows: `set DEBUG=eslint-plugin-import:* & eslint .`
+ Linux/Mac: `export DEBUG=eslint-plugin-import:* & eslint .`
+
+ It will also be helpful if you can provide a minimal reproducible example
+ Preferably a GitHub repository containing all the code & ESLint config required
+ https://stackoverflow.com/help/minimal-reproducible-example
+-->
From 5e7ea1d3f00896acbc42ba8d354a4bee70a7d1b0 Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Sat, 16 Nov 2024 17:15:44 -0800
Subject: [PATCH 195/199] [Fix] `order`: ensure arcane imports do not cause
undefined behavior
---
CHANGELOG.md | 2 ++
src/rules/order.js | 4 ++++
tests/src/rules/order.js | 32 ++++++++++++++++++++++++++++++--
3 files changed, 36 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a2a436a38a..7a092c2a46 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
- configs: added missing name attribute for eslint config inspector ([#3151], thanks [@NishargShah])
+- [`order`]: ensure arcane imports do not cause undefined behavior ([#3128], thanks [@Xunnamius])
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
@@ -1173,6 +1174,7 @@ for info on changes for earlier releases.
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
+[#3128]: https://github.com/import-js/eslint-plugin-import/pull/3128
[#3127]: https://github.com/import-js/eslint-plugin-import/pull/3127
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
[#3122]: https://github.com/import-js/eslint-plugin-import/pull/3122
diff --git a/src/rules/order.js b/src/rules/order.js
index cb77c15809..17e8735e19 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -535,6 +535,10 @@ function computeRank(context, ranks, importEntry, excludedImportTypes, isSorting
if (typeof rank === 'undefined') {
rank = ranks.groups[impType];
+
+ if (typeof rank === 'undefined') {
+ return -1;
+ }
}
if (isTypeOnlyImport && isSortingTypesGroup) {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index 13f96ca272..bde928f425 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -3115,7 +3115,6 @@ context('TypeScript', function () {
}),
// Option alphabetize: {order: 'asc'} with type group & path group
test({
- // only: true,
code: `
import c from 'Bar';
import a from 'foo';
@@ -3145,7 +3144,6 @@ context('TypeScript', function () {
}),
// Option alphabetize: {order: 'asc'} with path group
test({
- // only: true,
code: `
import c from 'Bar';
import type { A } from 'foo';
@@ -3739,6 +3737,36 @@ context('TypeScript', function () {
},
],
}),
+ // Ensure the rule doesn't choke and die on absolute paths trying to pass NaN around
+ test({
+ code: `
+ import fs from 'fs';
+
+ import '@scoped/package';
+ import type { B } from 'fs';
+
+ import type { A1 } from '/bad/bad/bad/bad';
+ import './a/b/c';
+ import type { A2 } from '/bad/bad/bad/bad';
+ import type { A3 } from '/bad/bad/bad/bad';
+ import type { D1 } from '/bad/bad/not/good';
+ import type { D2 } from '/bad/bad/not/good';
+ import type { D3 } from '/bad/bad/not/good';
+
+ import type { C } from '@something/else';
+
+ import type { E } from './index.js';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['builtin', 'type', 'unknown', 'external'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ },
+ ],
+ }),
),
invalid: [].concat(
// Option alphabetize: {order: 'asc'}
From 4f145a2c64af4931f4bf3ae951c8b719b544718f Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Mon, 30 Dec 2024 17:12:49 -0800
Subject: [PATCH 196/199] [New] `order`: add `consolidateIslands` option to
collapse excess spacing for aesthetically pleasing imports
---
CHANGELOG.md | 2 +
docs/rules/order.md | 286 +++-
src/rules/order.js | 123 +-
tests/src/rules/order.js | 2874 +++++++++++++++++++++++++++++++++++---
4 files changed, 3083 insertions(+), 202 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7a092c2a46..e72b3ca39e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`extensions`]: add `pathGroupOverrides to allow enforcement decision overrides based on specifier ([#3105], thanks [@Xunnamius])
- [`order`]: add `sortTypesGroup` option to allow intragroup sorting of type-only imports ([#3104], thanks [@Xunnamius])
- [`order`]: add `newlines-between-types` option to control intragroup sorting of type-only imports ([#3127], thanks [@Xunnamius])
+- [`order`]: add `consolidateIslands` option to collapse excess spacing for aesthetically pleasing imports ([#3129], thanks [@Xunnamius])
### Fixed
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
@@ -1174,6 +1175,7 @@ for info on changes for earlier releases.
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
+[#3129]: https://github.com/import-js/eslint-plugin-import/pull/3129
[#3128]: https://github.com/import-js/eslint-plugin-import/pull/3128
[#3127]: https://github.com/import-js/eslint-plugin-import/pull/3127
[#3125]: https://github.com/import-js/eslint-plugin-import/pull/3125
diff --git a/docs/rules/order.md b/docs/rules/order.md
index 3dee4b6de1..4a52b823e1 100644
--- a/docs/rules/order.md
+++ b/docs/rules/order.md
@@ -108,6 +108,7 @@ This rule supports the following options (none of which are required):
- [`warnOnUnassignedImports`][5]
- [`sortTypesGroup`][7]
- [`newlines-between-types`][27]
+ - [`consolidateIslands`][25]
---
@@ -184,7 +185,7 @@ Sometimes [the predefined groups][18] are not fine-grained enough, especially wh
`pathGroups` defines one or more [`PathGroup`][13]s relative to a predefined group.
Imports are associated with a [`PathGroup`][13] based on path matching against the import specifier (using [minimatch][14]).
-> \[!IMPORTANT]
+> [!IMPORTANT]
>
> Note that, by default, imports grouped as `"builtin"`, `"external"`, or `"object"` will not be considered for further `pathGroups` matching unless they are removed from [`pathGroupsExcludedImportTypes`][9].
@@ -224,7 +225,7 @@ Default: `["builtin", "external", "object"]`
By default, imports in certain [groups][18] are excluded from being matched against [`pathGroups`][8] to prevent overeager sorting.
Use `pathGroupsExcludedImportTypes` to modify which groups are excluded.
-> \[!TIP]
+> [!TIP]
>
> If using imports with custom specifier aliases (e.g.
> you're using `eslint-import-resolver-alias`, `paths` in `tsconfig.json`, etc) that [end up
@@ -254,7 +255,7 @@ Use `pathGroupsExcludedImportTypes` to modify which groups are excluded.
Valid values: `boolean` \
Default: `true`
-> \[!CAUTION]
+> [!CAUTION]
>
> Currently, `distinctGroup` defaults to `true`. However, in a later update, the
> default will change to `false`.
@@ -371,7 +372,7 @@ Default: `{ order: "ignore", orderImportKind: "ignore", caseInsensitive: false }
Determine the sort order of imports within each [predefined group][18] or [`PathGroup`][8] alphabetically based on specifier.
-> \[!NOTE]
+> [!NOTE]
>
> Imports will be alphabetized based on their _specifiers_, not by their
> identifiers. For example, `const a = require('z');` will come _after_ `const z = require('a');` when `alphabetize` is set to `{ order: "asc" }`.
@@ -502,7 +503,7 @@ Default: `false`
Warn when "unassigned" imports are out of order.
Unassigned imports are imports with no corresponding identifiers (e.g. `import './my/thing.js'` or `require('./side-effects.js')`).
-> \[!NOTE]
+> [!NOTE]
>
> These warnings are not fixable with `--fix` since unassigned imports might be used for their [side-effects][31],
> and changing the order of such imports cannot be done safely.
@@ -540,7 +541,7 @@ import './styles.css';
Valid values: `boolean` \
Default: `false`
-> \[!NOTE]
+> [!NOTE]
>
> This setting is only meaningful when `"type"` is included in [`groups`][18].
@@ -598,7 +599,7 @@ The same example will pass.
Valid values: `"ignore" | "always" | "always-and-inside-groups" | "never"` \
Default: the value of [`newlines-between`][20]
-> \[!NOTE]
+> [!NOTE]
>
> This setting is only meaningful when [`sortTypesGroup`][7] is enabled.
@@ -656,9 +657,9 @@ The same example will pass.
Note the new line after `import type E from './';` but before `import a from "fs";`. This new line separates the type-only imports from the normal imports. Its existence is governed by [`newlines-between-types`][27] and _not `newlines-between`_.
-> \[!IMPORTANT]
+> [!IMPORTANT]
>
-> In certain situations, `consolidateIslands: true` will take precedence over `newlines-between-types: "never"`, if used, when it comes to the new line separating type-only imports from normal imports.
+> In certain situations, [`consolidateIslands: true`][25] will take precedence over `newlines-between-types: "never"`, if used, when it comes to the new line separating type-only imports from normal imports.
The next example will pass even though there's a new line preceding the normal import and [`newlines-between`][20] is set to `"never"`:
@@ -722,6 +723,272 @@ import d from "./bar.js";
import e from "./";
```
+### `consolidateIslands`
+
+Valid values: `"inside-groups" | "never"` \
+Default: `"never"`
+
+> [!NOTE]
+>
+> This setting is only meaningful when [`newlines-between`][20] and/or [`newlines-between-types`][27] is set to `"always-and-inside-groups"`.
+
+When set to `"inside-groups"`, this ensures imports spanning multiple lines are separated from other imports with a new line while single-line imports are grouped together (and the space between them consolidated) if they belong to the same [group][18] or [`pathGroups`][8].
+
+> [!IMPORTANT]
+>
+> When all of the following are true:
+>
+> - [`sortTypesGroup`][7] is set to `true`
+> - `consolidateIslands` is set to `"inside-groups"`
+> - [`newlines-between`][20] is set to `"always-and-inside-groups"` when [`newlines-between-types`][27] is set to `"never"` (or vice-versa)
+>
+> Then [`newlines-between`][20]/[`newlines-between-types`][27] will yield to
+> `consolidateIslands` and allow new lines to separate multi-line imports
+> regardless of the `"never"` setting.
+>
+> This configuration is useful, for instance, to keep single-line type-only
+> imports stacked tightly together at the bottom of your import block to
+> preserve space while still logically organizing normal imports for quick and
+> pleasant reference.
+
+#### Example
+
+Given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "newlines-between": "always-and-inside-groups",
+ "consolidateIslands": "inside-groups"
+ }]
+}
+```
+
+This will fail the rule check:
+
+```ts
+var fs = require('fs');
+var path = require('path');
+var { util1, util2, util3 } = require('util');
+var async = require('async');
+var relParent1 = require('../foo');
+var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+} = require('../');
+var relParent3 = require('../bar');
+var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+var sibling2 = require('./bar');
+var sibling3 = require('./foobar');
+```
+
+While this will succeed (and is what `--fix` would yield):
+
+```ts
+var fs = require('fs');
+var path = require('path');
+var { util1, util2, util3 } = require('util');
+
+var async = require('async');
+
+var relParent1 = require('../foo');
+
+var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+} = require('../');
+
+var relParent3 = require('../bar');
+
+var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+var sibling2 = require('./bar');
+var sibling3 = require('./foobar');
+```
+
+Note the intragroup "islands" of grouped single-line imports, as well as multi-line imports, are surrounded by new lines. At the same time, note the typical new lines separating different groups are still maintained thanks to [`newlines-between`][20].
+
+The same holds true for the next example; when given the following settings:
+
+```jsonc
+{
+ "import/order": ["error", {
+ "alphabetize": { "order": "asc" },
+ "groups": ["external", "internal", "index", "type"],
+ "pathGroups": [
+ {
+ "pattern": "dirA/**",
+ "group": "internal",
+ "position": "after"
+ },
+ {
+ "pattern": "dirB/**",
+ "group": "internal",
+ "position": "before"
+ },
+ {
+ "pattern": "dirC/**",
+ "group": "internal"
+ }
+ ],
+ "newlines-between": "always-and-inside-groups",
+ "newlines-between-types": "never",
+ "pathGroupsExcludedImportTypes": [],
+ "sortTypesGroup": true,
+ "consolidateIslands": "inside-groups"
+ }]
+}
+```
+
+> [!IMPORTANT]
+>
+> **Pay special attention to the value of [`pathGroupsExcludedImportTypes`][9]** in this example's settings.
+> Without it, the successful example below would fail.
+> This is because the imports with specifiers starting with "dirA/", "dirB/", and "dirC/" are all [considered part of the `"external"` group](#how-imports-are-grouped), and imports in that group are excluded from [`pathGroups`][8] matching by default.
+>
+> The fix is to remove `"external"` (and, in this example, the others) from [`pathGroupsExcludedImportTypes`][9].
+
+This will fail the rule check:
+
+```ts
+import c from 'Bar';
+import d from 'bar';
+import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+} from 'baz';
+import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+} from 'fizz';
+import a from 'foo';
+import b from 'dirA/bar';
+import index from './';
+import type { AA,
+ BB, CC } from 'abc';
+import type { Z } from 'fizz';
+import type {
+ A,
+ B
+} from 'foo';
+import type { C2 } from 'dirB/Bar';
+import type {
+ D2,
+ X2,
+ Y2
+} from 'dirB/bar';
+import type { E2 } from 'dirB/baz';
+import type { C3 } from 'dirC/Bar';
+import type {
+ D3,
+ X3,
+ Y3
+} from 'dirC/bar';
+import type { E3 } from 'dirC/baz';
+import type { F3 } from 'dirC/caz';
+import type { C1 } from 'dirA/Bar';
+import type {
+ D1,
+ X1,
+ Y1
+} from 'dirA/bar';
+import type { E1 } from 'dirA/baz';
+import type { F } from './index.js';
+import type { G } from './aaa.js';
+import type { H } from './bbb';
+```
+
+While this will succeed (and is what `--fix` would yield):
+
+```ts
+import c from 'Bar';
+import d from 'bar';
+
+import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+} from 'baz';
+
+import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+} from 'fizz';
+
+import a from 'foo';
+
+import b from 'dirA/bar';
+
+import index from './';
+
+import type { AA,
+ BB, CC } from 'abc';
+
+import type { Z } from 'fizz';
+
+import type {
+ A,
+ B
+} from 'foo';
+
+import type { C2 } from 'dirB/Bar';
+
+import type {
+ D2,
+ X2,
+ Y2
+} from 'dirB/bar';
+
+import type { E2 } from 'dirB/baz';
+import type { C3 } from 'dirC/Bar';
+
+import type {
+ D3,
+ X3,
+ Y3
+} from 'dirC/bar';
+
+import type { E3 } from 'dirC/baz';
+import type { F3 } from 'dirC/caz';
+import type { C1 } from 'dirA/Bar';
+
+import type {
+ D1,
+ X1,
+ Y1
+} from 'dirA/bar';
+
+import type { E1 } from 'dirA/baz';
+import type { F } from './index.js';
+import type { G } from './aaa.js';
+import type { H } from './bbb';
+```
+
## Related
- [`import/external-module-folders`][29]
@@ -747,6 +1014,7 @@ import e from "./";
[21]: https://eslint.org/docs/latest/rules/no-multiple-empty-lines
[22]: https://prettier.io
[23]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names
+[25]: #consolidateislands
[27]: #newlines-between-types
[28]: ../../README.md#importinternal-regex
[29]: ../../README.md#importexternal-module-folders
diff --git a/src/rules/order.js b/src/rules/order.js
index 17e8735e19..b34efd0275 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -555,7 +555,17 @@ function computeRank(context, ranks, importEntry, excludedImportTypes, isSorting
function registerNode(context, importEntry, ranks, imported, excludedImportTypes, isSortingTypesGroup) {
const rank = computeRank(context, ranks, importEntry, excludedImportTypes, isSortingTypesGroup);
if (rank !== -1) {
- imported.push({ ...importEntry, rank });
+ let importNode = importEntry.node;
+
+ if (importEntry.type === 'require' && importNode.parent.parent.type === 'VariableDeclaration') {
+ importNode = importNode.parent.parent;
+ }
+
+ imported.push({
+ ...importEntry,
+ rank,
+ isMultiline: importNode.loc.end.line !== importNode.loc.start.line,
+ });
}
}
@@ -681,7 +691,7 @@ function removeNewLineAfterImport(context, currentImport, previousImport) {
return undefined;
}
-function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, newlinesBetweenTypeOnlyImports, distinctGroup, isSortingTypesGroup) {
+function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports_, newlinesBetweenTypeOnlyImports_, distinctGroup, isSortingTypesGroup, isConsolidatingSpaceBetweenImports) {
const getNumberOfEmptyLinesBetween = (currentImport, previousImport) => {
const linesBetweenImports = getSourceCode(context).lines.slice(
previousImport.node.loc.end.line,
@@ -707,34 +717,61 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, ne
const isTypeOnlyImport = currentImport.node.importKind === 'type';
const isPreviousImportTypeOnlyImport = previousImport.node.importKind === 'type';
- const isNormalImportFollowingTypeOnlyImportAndRelevant = !isTypeOnlyImport && isPreviousImportTypeOnlyImport && isSortingTypesGroup;
+ const isNormalImportNextToTypeOnlyImportAndRelevant = isTypeOnlyImport !== isPreviousImportTypeOnlyImport && isSortingTypesGroup;
const isTypeOnlyImportAndRelevant = isTypeOnlyImport && isSortingTypesGroup;
- const isNotIgnored = isTypeOnlyImportAndRelevant
+ // In the special case where newlinesBetweenImports and consolidateIslands
+ // want the opposite thing, consolidateIslands wins
+ const newlinesBetweenImports = isSortingTypesGroup
+ && isConsolidatingSpaceBetweenImports
+ && (previousImport.isMultiline || currentImport.isMultiline)
+ && newlinesBetweenImports_ === 'never'
+ ? 'always-and-inside-groups'
+ : newlinesBetweenImports_;
+
+ // In the special case where newlinesBetweenTypeOnlyImports and
+ // consolidateIslands want the opposite thing, consolidateIslands wins
+ const newlinesBetweenTypeOnlyImports = isSortingTypesGroup
+ && isConsolidatingSpaceBetweenImports
+ && (isNormalImportNextToTypeOnlyImportAndRelevant
+ || previousImport.isMultiline
+ || currentImport.isMultiline)
+ && newlinesBetweenTypeOnlyImports_ === 'never'
+ ? 'always-and-inside-groups'
+ : newlinesBetweenTypeOnlyImports_;
+
+ const isNotIgnored = isTypeOnlyImportAndRelevant
&& newlinesBetweenTypeOnlyImports !== 'ignore'
|| !isTypeOnlyImportAndRelevant && newlinesBetweenImports !== 'ignore';
if (isNotIgnored) {
- const shouldAssertNewlineBetweenGroups = (isTypeOnlyImportAndRelevant || isNormalImportFollowingTypeOnlyImportAndRelevant)
+ const shouldAssertNewlineBetweenGroups = (isTypeOnlyImportAndRelevant || isNormalImportNextToTypeOnlyImportAndRelevant)
&& (newlinesBetweenTypeOnlyImports === 'always'
|| newlinesBetweenTypeOnlyImports === 'always-and-inside-groups')
- || !isTypeOnlyImportAndRelevant && !isNormalImportFollowingTypeOnlyImportAndRelevant
+ || !isTypeOnlyImportAndRelevant && !isNormalImportNextToTypeOnlyImportAndRelevant
&& (newlinesBetweenImports === 'always'
|| newlinesBetweenImports === 'always-and-inside-groups');
- const shouldAssertNoNewlineWithinGroup = (isTypeOnlyImportAndRelevant || isNormalImportFollowingTypeOnlyImportAndRelevant)
+ const shouldAssertNoNewlineWithinGroup = (isTypeOnlyImportAndRelevant || isNormalImportNextToTypeOnlyImportAndRelevant)
&& newlinesBetweenTypeOnlyImports !== 'always-and-inside-groups'
- || !isTypeOnlyImportAndRelevant && !isNormalImportFollowingTypeOnlyImportAndRelevant
+ || !isTypeOnlyImportAndRelevant && !isNormalImportNextToTypeOnlyImportAndRelevant
&& newlinesBetweenImports !== 'always-and-inside-groups';
- const shouldAssertNoNewlineBetweenGroup = !isSortingTypesGroup
- || !isNormalImportFollowingTypeOnlyImportAndRelevant
+ const shouldAssertNoNewlineBetweenGroup = !isSortingTypesGroup
+ || !isNormalImportNextToTypeOnlyImportAndRelevant
|| newlinesBetweenTypeOnlyImports === 'never';
+ const isTheNewlineBetweenImportsInTheSameGroup = distinctGroup && currentImport.rank === previousImport.rank
+ || !distinctGroup && !isStartOfDistinctGroup;
+
+ // Let's try to cut down on linting errors sent to the user
+ let alreadyReported = false;
+
if (shouldAssertNewlineBetweenGroups) {
if (currentImport.rank !== previousImport.rank && emptyLinesBetween === 0) {
if (distinctGroup || !distinctGroup && isStartOfDistinctGroup) {
+ alreadyReported = true;
context.report({
node: previousImport.node,
message: 'There should be at least one empty line between import groups',
@@ -742,10 +779,8 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, ne
});
}
} else if (emptyLinesBetween > 0 && shouldAssertNoNewlineWithinGroup) {
- if (
- distinctGroup && currentImport.rank === previousImport.rank
- || !distinctGroup && !isStartOfDistinctGroup
- ) {
+ if (isTheNewlineBetweenImportsInTheSameGroup) {
+ alreadyReported = true;
context.report({
node: previousImport.node,
message: 'There should be no empty line within import group',
@@ -754,12 +789,41 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, ne
}
}
} else if (emptyLinesBetween > 0 && shouldAssertNoNewlineBetweenGroup) {
+ alreadyReported = true;
context.report({
node: previousImport.node,
message: 'There should be no empty line between import groups',
fix: removeNewLineAfterImport(context, currentImport, previousImport),
});
}
+
+ if (!alreadyReported && isConsolidatingSpaceBetweenImports) {
+ if (emptyLinesBetween === 0 && currentImport.isMultiline) {
+ context.report({
+ node: previousImport.node,
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ fix: fixNewLineAfterImport(context, previousImport),
+ });
+ } else if (emptyLinesBetween === 0 && previousImport.isMultiline) {
+ context.report({
+ node: previousImport.node,
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ fix: fixNewLineAfterImport(context, previousImport),
+ });
+ } else if (
+ emptyLinesBetween > 0
+ && !previousImport.isMultiline
+ && !currentImport.isMultiline
+ && isTheNewlineBetweenImportsInTheSameGroup
+ ) {
+ context.report({
+ node: previousImport.node,
+ message:
+ 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ fix: removeNewLineAfterImport(context, currentImport, previousImport),
+ });
+ }
+ }
}
previousImport = currentImport;
@@ -842,6 +906,12 @@ module.exports = {
'never',
],
},
+ consolidateIslands: {
+ enum: [
+ 'inside-groups',
+ 'never',
+ ],
+ },
sortTypesGroup: {
type: 'boolean',
default: false,
@@ -901,6 +971,18 @@ module.exports = {
},
required: ['sortTypesGroup'],
},
+ consolidateIslands: {
+ anyOf: [{
+ properties: {
+ 'newlines-between': { enum: ['always-and-inside-groups'] },
+ },
+ required: ['newlines-between'],
+ }, {
+ properties: {
+ 'newlines-between-types': { enum: ['always-and-inside-groups'] },
+ },
+ required: ['newlines-between-types'],
+ }] },
},
},
],
@@ -912,6 +994,7 @@ module.exports = {
const newlinesBetweenTypeOnlyImports = options['newlines-between-types'] || newlinesBetweenImports;
const pathGroupsExcludedImportTypes = new Set(options.pathGroupsExcludedImportTypes || ['builtin', 'external', 'object']);
const sortTypesGroup = options.sortTypesGroup;
+ const consolidateIslands = options.consolidateIslands || 'never';
const named = {
types: 'mixed',
@@ -1174,7 +1257,17 @@ module.exports = {
'Program:exit'() {
importMap.forEach((imported) => {
if (newlinesBetweenImports !== 'ignore' || newlinesBetweenTypeOnlyImports !== 'ignore') {
- makeNewlinesBetweenReport(context, imported, newlinesBetweenImports, newlinesBetweenTypeOnlyImports, distinctGroup, isSortingTypesGroup);
+ makeNewlinesBetweenReport(
+ context,
+ imported,
+ newlinesBetweenImports,
+ newlinesBetweenTypeOnlyImports,
+ distinctGroup,
+ isSortingTypesGroup,
+ consolidateIslands === 'inside-groups'
+ && (newlinesBetweenImports === 'always-and-inside-groups'
+ || newlinesBetweenTypeOnlyImports === 'always-and-inside-groups'),
+ );
}
if (alphabetize.order !== 'ignore') {
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index bde928f425..fa592c9b19 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -530,7 +530,7 @@ ruleTester.run('order', rule, {
},
],
}),
- // Option newlines-between: 'always' with multiline imports #1
+ // Option newlines-between: 'always' with multi-line imports #1
test({
code: `
import path from 'path';
@@ -546,7 +546,7 @@ ruleTester.run('order', rule, {
`,
options: [{ 'newlines-between': 'always' }],
}),
- // Option newlines-between: 'always' with multiline imports #2
+ // Option newlines-between: 'always' with multi-line imports #2
test({
code: `
import path from 'path';
@@ -557,7 +557,7 @@ ruleTester.run('order', rule, {
`,
options: [{ 'newlines-between': 'always' }],
}),
- // Option newlines-between: 'always' with multiline imports #3
+ // Option newlines-between: 'always' with multi-line imports #3
test({
code: `
import foo
@@ -671,6 +671,33 @@ ruleTester.run('order', rule, {
},
],
}),
+ // Option newlines-between: 'always-and-inside-groups' and consolidateIslands: true
+ test({
+ code: `
+ var fs = require('fs');
+ var path = require('path');
+ var util = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent2 } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var sibling = require('./foo');
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
// Option alphabetize: {order: 'ignore'}
test({
code: `
@@ -1343,19 +1370,19 @@ ruleTester.run('order', rule, {
message: '`fs` import should occur before import of `async`',
}],
}),
- // fix order with multilines comments at the end and start of line
+ // fix order with multi-lines comments at the end and start of line
test({
code: `
- /* multiline1
- comment1 */ var async = require('async'); /* multiline2
- comment2 */ var fs = require('fs'); /* multiline3
+ /* multi-line1
+ comment1 */ var async = require('async'); /* multi-line2
+ comment2 */ var fs = require('fs'); /* multi-line3
comment3 */
`,
output: `
- /* multiline1
+ /* multi-line1
comment1 */ var fs = require('fs');` + ' ' + `
- var async = require('async'); /* multiline2
- comment2 *//* multiline3
+ var async = require('async'); /* multi-line2
+ comment2 *//* multi-line3
comment3 */
`,
errors: [{
@@ -1376,7 +1403,7 @@ ruleTester.run('order', rule, {
message: '`fs` import should occur before import of `async`',
}],
}),
- // fix order of multiline import
+ // fix order of multi-line import
test({
code: `
var async = require('async');
@@ -1901,10 +1928,10 @@ ruleTester.run('order', rule, {
},
],
}),
- // Cannot fix newlines-between with multiline comment after
+ // Cannot fix newlines-between with multi-line comment after
test(withoutAutofixOutput({
code: `
- var fs = require('fs'); /* multiline
+ var fs = require('fs'); /* multi-line
comment */
var index = require('./');
@@ -2952,7 +2979,7 @@ ruleTester.run('order', rule, {
message: '`A.C` export should occur after export of `A.B`',
}],
}),
- // multiline named specifiers & trailing commas
+ // multi-line named specifiers & trailing commas
test({
code: `
const {
@@ -3032,6 +3059,156 @@ ruleTester.run('order', rule, {
}],
}),
],
+ // Option newlines-between: 'always-and-inside-groups' and consolidateIslands: true
+ test({
+ code: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+ var async = require('async');
+ var relParent1 = require('../foo');
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+ var relParent3 = require('../bar');
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ output: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 5,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 6,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 12,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 13,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 15,
+ },
+ ],
+ }),
+ test({
+ code: `
+ var fs = require('fs');
+
+ var path = require('path');
+
+ var { util1, util2, util3 } = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+ var sibling2 = require('./bar');
+
+ var sibling3 = require('./foobar');
+ `,
+ output: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 2,
+ },
+ {
+ message: 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 4,
+ },
+ {
+ message: 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 24,
+ },
+ ],
+ }),
].filter(Boolean),
});
@@ -3767,261 +3944,2289 @@ context('TypeScript', function () {
},
],
}),
- ),
- invalid: [].concat(
- // Option alphabetize: {order: 'asc'}
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'inside-groups'
test({
code: `
- import b from 'bar';
import c from 'Bar';
- import type { C } from 'Bar';
- import a from 'foo';
- import type { A } from 'foo';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
- import index from './';
- `,
- output: `
- import c from 'Bar';
- import type { C } from 'Bar';
- import b from 'bar';
import a from 'foo';
- import type { A } from 'foo';
+
+ import b from 'dirA/bar';
import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
`,
...parserConfig,
options: [
{
- groups: ['external', 'index'],
alphabetize: { order: 'asc' },
- },
- ],
- errors: [
- {
- message: semver.satisfies(eslintPkg.version, '< 3')
- ? '`bar` import should occur after type import of `Bar`'
- : /(`bar` import should occur after type import of `Bar`)|(`Bar` type import should occur before import of `bar`)/,
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
},
],
}),
- // Option alphabetize: {order: 'desc'}
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'never' (default)
test({
code: `
- import a from 'foo';
- import type { A } from 'foo';
import c from 'Bar';
- import type { C } from 'Bar';
- import b from 'bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
- import index from './';
- `,
- output: `
import a from 'foo';
- import type { A } from 'foo';
- import b from 'bar';
- import c from 'Bar';
- import type { C } from 'Bar';
+
+ import b from 'dirA/bar';
import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
`,
...parserConfig,
options: [
{
- groups: ['external', 'index'],
- alphabetize: { order: 'desc' },
- },
- ],
- errors: [
- {
- message: semver.satisfies(eslintPkg.version, '< 3')
- ? '`bar` import should occur before import of `Bar`'
- : /(`bar` import should occur before import of `Bar`)|(`Bar` import should occur after import of `bar`)/,
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'never',
},
],
}),
- // Option alphabetize: {order: 'asc'} with type group
+ // Ensure consolidateIslands: 'inside-groups', newlines-between: 'always-and-inside-groups', and newlines-between-types: 'never' do not fight for dominance
test({
code: `
- import b from 'bar';
- import c from 'Bar';
- import a from 'foo';
-
- import index from './';
-
- import type { A } from 'foo';
- import type { C } from 'Bar';
- `,
- output: `
- import c from 'Bar';
- import b from 'bar';
- import a from 'foo';
-
- import index from './';
-
- import type { C } from 'Bar';
- import type { A } from 'foo';
+ import makeVanillaYargs from 'yargs/yargs';
+
+ import { createDebugLogger } from 'multiverse+rejoinder';
+
+ import { globalDebuggerNamespace } from 'rootverse+bfe:src/constant.ts';
+ import { ErrorMessage, type KeyValueEntry } from 'rootverse+bfe:src/error.ts';
+
+ import {
+ $artificiallyInvoked,
+ $canonical,
+ $exists,
+ $genesis
+ } from 'rootverse+bfe:src/symbols.ts';
+
+ import type {
+ Entries,
+ LiteralUnion,
+ OmitIndexSignature,
+ Promisable,
+ StringKeyOf
+ } from 'type-fest';
`,
...parserConfig,
options: [
{
- groups: ['external', 'index', 'type'],
- alphabetize: { order: 'asc' },
- },
+ alphabetize: {
+ order: 'asc',
+ orderImportKind: 'asc',
+ caseInsensitive: true,
+ },
+ named: {
+ enabled: true,
+ types: 'types-last',
+ },
+ groups: [
+ 'builtin',
+ 'external',
+ 'internal',
+ ['parent', 'sibling', 'index'],
+ ['object', 'type'],
+ ],
+ pathGroups: [
+ {
+ pattern: 'multiverse{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ {
+ pattern: 'rootverse{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ {
+ pattern: 'universe{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ ],
+ distinctGroup: true,
+ pathGroupsExcludedImportTypes: ['builtin', 'object'],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'never',
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ // Ensure consolidateIslands: 'inside-groups', newlines-between: 'never', and newlines-between-types: 'always-and-inside-groups' do not fight for dominance
+ test({
+ code: `
+ import makeVanillaYargs from 'yargs/yargs';
+ import { createDebugLogger } from 'multiverse+rejoinder';
+ import { globalDebuggerNamespace } from 'rootverse+bfe:src/constant.ts';
+ import { ErrorMessage, type KeyValueEntry } from 'rootverse+bfe:src/error.ts';
+ import { $artificiallyInvoked } from 'rootverse+bfe:src/symbols.ts';
+
+ import type {
+ Entries,
+ LiteralUnion,
+ OmitIndexSignature,
+ Promisable,
+ StringKeyOf
+ } from 'type-fest';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: {
+ order: 'asc',
+ orderImportKind: 'asc',
+ caseInsensitive: true,
+ },
+ named: {
+ enabled: true,
+ types: 'types-last',
+ },
+ groups: [
+ 'builtin',
+ 'external',
+ 'internal',
+ ['parent', 'sibling', 'index'],
+ ['object', 'type'],
+ ],
+ pathGroups: [
+ {
+ pattern: 'multiverse{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ {
+ pattern: 'rootverse{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ {
+ pattern: 'universe{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ ],
+ distinctGroup: true,
+ pathGroupsExcludedImportTypes: ['builtin', 'object'],
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always-and-inside-groups',
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ test({
+ code: `
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ test({
+ code: `
+ import assert from 'assert';
+ import { isNativeError } from 'util/types';
+
+ import { runNoRejectOnBadExit } from '@-xun/run';
+ import { TrialError } from 'named-app-errors';
+ import { resolve as resolverLibrary } from 'resolve.exports';
+
+ import { ${supportsImportTypeSpecifiers ? 'toAbsolutePath, type AbsolutePath' : 'AbsolutePath, toAbsolutePath'} } from 'rootverse+project-utils:src/fs.ts';
+
+ import type { PackageJson } from 'type-fest';
+ // Some comment about remembering to do something
+ import type { XPackageJson } from 'rootverse:src/assets/config/_package.json.ts';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: {
+ order: 'asc',
+ orderImportKind: 'asc',
+ caseInsensitive: true,
+ },
+ named: {
+ enabled: true,
+ types: 'types-last',
+ },
+ groups: [
+ 'builtin',
+ 'external',
+ 'internal',
+ ['parent', 'sibling', 'index'],
+ ['object', 'type'],
+ ],
+ pathGroups: [
+ {
+ pattern: 'rootverse{*,*/**}',
+ group: 'external',
+ position: 'after',
+ },
+ ],
+ distinctGroup: true,
+ pathGroupsExcludedImportTypes: ['builtin', 'object'],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'never',
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+
+ // Documentation passing example #1 for newlines-between
+ test({
+ code: `
+ import fs from 'fs';
+ import path from 'path';
+
+ import sibling from './foo';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'always',
+ },
+ ],
+ }),
+ // Documentation passing example #2 for newlines-between
+ test({
+ code: `
+ import fs from 'fs';
+
+ import path from 'path';
+
+ import sibling from './foo';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ },
+ ],
+ }),
+ // Documentation passing example #3 for newlines-between
+ test({
+ code: `
+ import fs from 'fs';
+ import path from 'path';
+ import sibling from './foo';
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'never',
+ },
+ ],
+ }),
+ // Documentation passing example #1 for alphabetize
+ test({
+ code: `
+ import blist2 from 'blist';
+ import blist from 'BList';
+ import * as classnames from 'classnames';
+ import aTypes from 'prop-types';
+ import React, { PureComponent } from 'react';
+ import { compose, apply } from 'xcompose';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: {
+ order: 'asc',
+ caseInsensitive: true,
+ },
+ },
+ ],
+ }),
+ // (not an example, but we also test caseInsensitive: false for completeness)
+ test({
+ code: `
+ import blist from 'BList';
+ import blist2 from 'blist';
+ import * as classnames from 'classnames';
+ import aTypes from 'prop-types';
+ import React, { PureComponent } from 'react';
+ import { compose, apply } from 'xcompose';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: {
+ order: 'asc',
+ caseInsensitive: false,
+ },
+ },
+ ],
+ }),
+ // Documentation passing example #1 for named
+ test({
+ code: `
+ import { apply, compose } from 'xcompose';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ named: true,
+ alphabetize: {
+ order: 'asc',
+ },
+ },
+ ],
+ }),
+ // Documentation passing example #1 for warnOnUnassignedImports
+ test({
+ code: `
+ import fs from 'fs';
+ import path from 'path';
+ import './styles.css';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ warnOnUnassignedImports: true,
+ },
+ ],
+ }),
+ // Documentation passing example #1 for sortTypesGroup
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ alphabetize: { order: 'asc' },
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // (not an example, but we also test the reverse for completeness)
+ test({
+ code: `
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['builtin', 'parent', 'sibling', 'index', 'type'],
+ sortTypesGroup: true,
+ },
+ ],
+ }),
+ // Documentation passing example #1 for newlines-between-types
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'ignore',
+ },
+ ],
+ }),
+ // (not an example, but we also test the reverse for completeness)
+ test({
+ code: `
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['builtin', 'parent', 'sibling', 'index', 'type'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'ignore',
+ },
+ ],
+ }),
+ // Documentation passing example #2 for newlines-between-types
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always',
+ },
+ ],
+ }),
+ // (not an example, but we also test the reverse for completeness)
+ test({
+ code: `
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['builtin', 'parent', 'sibling', 'index', 'type'],
+ sortTypesGroup: true,
+ 'newlines-between': 'never',
+ 'newlines-between-types': 'always',
+ },
+ ],
+ }),
+ // Documentation passing example #1 for consolidateIslands
+ test({
+ code: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ // Documentation passing example #2 for consolidateIslands
+ test({
+ code: `
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'never',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ // (not an example, but we also test the reverse for completeness)
+ test({
+ code: `
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['type', 'external', 'internal', 'index'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'never',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ }),
+ ),
+ invalid: [].concat(
+ // Option alphabetize: {order: 'asc'}
+ test({
+ code: `
+ import b from 'bar';
+ import c from 'Bar';
+ import type { C } from 'Bar';
+ import a from 'foo';
+ import type { A } from 'foo';
+
+ import index from './';
+ `,
+ output: `
+ import c from 'Bar';
+ import type { C } from 'Bar';
+ import b from 'bar';
+ import a from 'foo';
+ import type { A } from 'foo';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['external', 'index'],
+ alphabetize: { order: 'asc' },
+ },
+ ],
+ errors: [
+ {
+ message: semver.satisfies(eslintPkg.version, '< 3')
+ ? '`bar` import should occur after type import of `Bar`'
+ : /(`bar` import should occur after type import of `Bar`)|(`Bar` type import should occur before import of `bar`)/,
+ },
+ ],
+ }),
+ // Option alphabetize: {order: 'desc'}
+ test({
+ code: `
+ import a from 'foo';
+ import type { A } from 'foo';
+ import c from 'Bar';
+ import type { C } from 'Bar';
+ import b from 'bar';
+
+ import index from './';
+ `,
+ output: `
+ import a from 'foo';
+ import type { A } from 'foo';
+ import b from 'bar';
+ import c from 'Bar';
+ import type { C } from 'Bar';
+
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['external', 'index'],
+ alphabetize: { order: 'desc' },
+ },
+ ],
+ errors: [
+ {
+ message: semver.satisfies(eslintPkg.version, '< 3')
+ ? '`bar` import should occur before import of `Bar`'
+ : /(`bar` import should occur before import of `Bar`)|(`Bar` import should occur after import of `bar`)/,
+ },
+ ],
+ }),
+ // Option alphabetize: {order: 'asc'} with type group
+ test({
+ code: `
+ import b from 'bar';
+ import c from 'Bar';
+ import a from 'foo';
+
+ import index from './';
+
+ import type { A } from 'foo';
+ import type { C } from 'Bar';
+ `,
+ output: `
+ import c from 'Bar';
+ import b from 'bar';
+ import a from 'foo';
+
+ import index from './';
+
+ import type { C } from 'Bar';
+ import type { A } from 'foo';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['external', 'index', 'type'],
+ alphabetize: { order: 'asc' },
+ },
+ ],
+ errors: semver.satisfies(eslintPkg.version, '< 3') ? [
+ { message: '`Bar` import should occur before import of `bar`' },
+ { message: '`Bar` type import should occur before type import of `foo`' },
+ ] : [
+ { message: /(`Bar` import should occur before import of `bar`)|(`bar` import should occur after import of `Bar`)/ },
+ { message: /(`Bar` type import should occur before type import of `foo`)|(`foo` type import should occur after type import of `Bar`)/ },
+ ],
+ }),
+ // Option alphabetize: {order: 'desc'} with type group
+ test({
+ code: `
+ import a from 'foo';
+ import c from 'Bar';
+ import b from 'bar';
+
+ import index from './';
+
+ import type { C } from 'Bar';
+ import type { A } from 'foo';
+ `,
+ output: `
+ import a from 'foo';
+ import b from 'bar';
+ import c from 'Bar';
+
+ import index from './';
+
+ import type { A } from 'foo';
+ import type { C } from 'Bar';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['external', 'index', 'type'],
+ alphabetize: { order: 'desc' },
+ },
+ ],
+ errors: semver.satisfies(eslintPkg.version, '< 3') ? [
+ { message: '`bar` import should occur before import of `Bar`' },
+ { message: '`foo` type import should occur before type import of `Bar`' },
+ ] : [
+ { message: /(`bar` import should occur before import of `Bar`)|(`Bar` import should occur after import of `bar`)/ },
+ { message: /(`foo` type import should occur before type import of `Bar`)|(`Bar` type import should occur after import of type `foo`)/ },
+ ],
+ }),
+ // warns for out of order unassigned imports (warnOnUnassignedImports enabled)
+ test(withoutAutofixOutput({
+ code: `
+ import './local1';
+ import global from 'global1';
+ import local from './local2';
+ import 'global2';
+ `,
+ errors: [
+ {
+ message: '`global1` import should occur before import of `./local1`',
+ },
+ {
+ message: '`global2` import should occur before import of `./local1`',
+ },
+ ],
+ options: [{ warnOnUnassignedImports: true }],
+ })),
+ // fix cannot move below unassigned import (warnOnUnassignedImports enabled)
+ test(withoutAutofixOutput({
+ code: `
+ import local from './local';
+
+ import 'global1';
+
+ import global2 from 'global2';
+ import global3 from 'global3';
+ `,
+ errors: [{
+ message: '`./local` import should occur after import of `global3`',
+ }],
+ options: [{ warnOnUnassignedImports: true }],
+ })),
+ // Imports inside module declaration
+ test({
+ code: `
+ import type { ParsedPath } from 'path';
+ import type { CopyOptions } from 'fs';
+
+ declare module 'my-module' {
+ import type { ParsedPath } from 'path';
+ import type { CopyOptions } from 'fs';
+ }
+ `,
+ output: `
+ import type { CopyOptions } from 'fs';
+ import type { ParsedPath } from 'path';
+
+ declare module 'my-module' {
+ import type { CopyOptions } from 'fs';
+ import type { ParsedPath } from 'path';
+ }
+ `,
+ errors: [
+ { message: '`fs` type import should occur before type import of `path`' },
+ { message: '`fs` type import should occur before type import of `path`' },
+ ],
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ },
+ ],
+ }),
+ // named import order
+ test({
+ code: `
+ import { type Z, A } from "./Z";
+ import type N, { E, D } from "./Z";
+ import type { L, G } from "./Z";
+ `,
+ output: `
+ import { A, type Z } from "./Z";
+ import type N, { D, E } from "./Z";
+ import type { G, L } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [
+ { message: `\`A\` import should occur before${supportsImportTypeSpecifiers ? ' type' : ''} import of \`Z\`` },
+ { message: '`D` import should occur before import of `E`' },
+ { message: '`G` import should occur before import of `L`' },
+ ],
+ }),
+ test({
+ code: `
+ const { B, /* Hello World */ A } = require("./Z");
+ export { B, A } from "./Z";
+ `,
+ output: `
+ const { /* Hello World */ A, B } = require("./Z");
+ export { A, B } from "./Z";
+ `,
+ ...parserConfig,
+ options: [{
+ named: true,
+ alphabetize: { order: 'asc' },
+ }],
+ errors: [{
+ message: '`A` import should occur before import of `B`',
+ }, {
+ message: '`A` export should occur before export of `B`',
+ }],
+ }),
+ // Options: sortTypesGroup + newlines-between-types example #1 from the documentation (fail)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ output: `
+ import type A from "fs";
+ import type B from "path";
+
+ import type C from "../foo.js";
+
+ import type D from "./bar.js";
+
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 3,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 5,
+ },
+ ],
+ }),
+ // Options: sortTypesGroup + newlines-between-types example #2 from the documentation (fail)
+ test({
+ code: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ output: `
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+ import a from "fs";
+ import b from "path";
+
+ import c from "../foo.js";
+
+ import d from "./bar.js";
+
+ import e from "./";
+ `,
+ ...parserConfig,
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ sortTypesGroup: true,
+ 'newlines-between': 'always',
+ 'newlines-between-types': 'never',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be no empty line between import groups',
+ line: 6,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'inside-groups' with all newlines
+ test({
+ code: `
+ import c from 'Bar';
+
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+
+ import type { H } from './bbb';
+ `,
+ output: `
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ errors: [
+ {
+ message:
+ 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 2,
+ },
+ {
+ message:
+ 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 60,
+ },
+ {
+ message:
+ 'There should be no empty lines between this single-line import and the single-line import that follows it',
+ line: 76,
+ },
+ ],
+ }),
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'inside-groups' with no newlines
+ test({
+ code: `
+ import c from 'Bar';
+ import d from 'bar';
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+ import type { AA,
+ BB, CC } from 'abc';
+ import type { Z } from 'fizz';
+ import type {
+ A,
+ B
+ } from 'foo';
+ import type { C2 } from 'dirB/Bar';
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ output: `
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
],
- errors: semver.satisfies(eslintPkg.version, '< 3') ? [
- { message: '`Bar` import should occur before import of `bar`' },
- { message: '`Bar` type import should occur before type import of `foo`' },
- ] : [
- { message: /(`Bar` import should occur before import of `bar`)|(`bar` import should occur after import of `Bar`)/ },
- { message: /(`Bar` type import should occur before type import of `foo`)|(`foo` type import should occur after type import of `Bar`)/ },
+ errors: [
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 3,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 4,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 13,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 22,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 23,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 24,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 25,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 27,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 28,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 32,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 33,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 38,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 39,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 40,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 46,
+ },
+ {
+ message: 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 47,
+ },
+ {
+ message: 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 48,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 53,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 54,
+ },
],
}),
- // Option alphabetize: {order: 'desc'} with type group
+ // Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'never' (default)
test({
code: `
+ import c from 'Bar';
+ import d from 'bar';
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+ import type { AA,
+ BB, CC } from 'abc';
+ import type { Z } from 'fizz';
+ import type {
+ A,
+ B
+ } from 'foo';
+ import type { C2 } from 'dirB/Bar';
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ output: `
import c from 'Bar';
- import b from 'bar';
+ import d from 'bar';
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+ import a from 'foo';
+
+ import b from 'dirA/bar';
import index from './';
- import type { C } from 'Bar';
- import type { A } from 'foo';
+ import type { AA,
+ BB, CC } from 'abc';
+ import type { Z } from 'fizz';
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+ import type { E2 } from 'dirB/baz';
+
+ import type { C3 } from 'dirC/Bar';
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+
+ import type { C1 } from 'dirA/Bar';
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+ import type { E1 } from 'dirA/baz';
+
+ import type { F } from './index.js';
+
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
`,
- output: `
- import a from 'foo';
- import b from 'bar';
- import c from 'Bar';
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'always-and-inside-groups',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'never',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 22,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 23,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 24,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 28,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 38,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 46,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 53,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 54,
+ },
+
+ ],
+ }),
+ // Documentation failing example #1 for newlines-between
+ test({
+ code: `
+ import fs from 'fs';
+ import path from 'path';
+ import sibling from './foo';
import index from './';
+ `,
+ output: `
+ import fs from 'fs';
+ import path from 'path';
- import type { A } from 'foo';
- import type { C } from 'Bar';
+ import sibling from './foo';
+
+ import index from './';
`,
...parserConfig,
options: [
{
- groups: ['external', 'index', 'type'],
- alphabetize: { order: 'desc' },
+ 'newlines-between': 'always',
},
],
- errors: semver.satisfies(eslintPkg.version, '< 3') ? [
- { message: '`bar` import should occur before import of `Bar`' },
- { message: '`foo` type import should occur before type import of `Bar`' },
- ] : [
- { message: /(`bar` import should occur before import of `Bar`)|(`Bar` import should occur after import of `bar`)/ },
- { message: /(`foo` type import should occur before type import of `Bar`)|(`Bar` type import should occur after import of type `foo`)/ },
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 3,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
+ },
],
}),
- // warns for out of order unassigned imports (warnOnUnassignedImports enabled)
- test(withoutAutofixOutput({
+ // Documentation failing example #2 for newlines-between
+ test({
code: `
- import './local1';
- import global from 'global1';
- import local from './local2';
- import 'global2';
+ import fs from 'fs';
+
+ import path from 'path';
+ import sibling from './foo';
+ import index from './';
+ `,
+ output: `
+ import fs from 'fs';
+
+ import path from 'path';
+
+ import sibling from './foo';
+
+ import index from './';
`,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ },
+ ],
errors: [
{
- message: '`global1` import should occur before import of `./local1`',
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
},
{
- message: '`global2` import should occur before import of `./local1`',
+ message: 'There should be at least one empty line between import groups',
+ line: 5,
},
],
- options: [{ warnOnUnassignedImports: true }],
- })),
- // fix cannot move below unassigned import (warnOnUnassignedImports enabled)
- test(withoutAutofixOutput({
+ }),
+ // Documentation failing example #3 for newlines-between
+ test({
code: `
- import local from './local';
+ import fs from 'fs';
+ import path from 'path';
- import 'global1';
+ import sibling from './foo';
- import global2 from 'global2';
- import global3 from 'global3';
+ import index from './';
`,
- errors: [{
- message: '`./local` import should occur after import of `global3`',
- }],
- options: [{ warnOnUnassignedImports: true }],
- })),
- // Imports inside module declaration
+ output: `
+ import fs from 'fs';
+ import path from 'path';
+ import sibling from './foo';
+ import index from './';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'never',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be no empty line between import groups',
+ line: 3,
+ },
+ {
+ message: 'There should be no empty line between import groups',
+ line: 5,
+ },
+ ],
+ }),
+ // Multiple errors
+ ...semver.satisfies(eslintPkg.version, '< 3.0.0') ? [] : [
+ // Documentation failing example #1 for alphabetize
+ test({
+ code: `
+ import React, { PureComponent } from 'react';
+ import aTypes from 'prop-types';
+ import { compose, apply } from 'xcompose';
+ import * as classnames from 'classnames';
+ import blist2 from 'blist';
+ import blist from 'BList';
+ `,
+ // The reason why this output does not match the success example after being fixed is because eslint will leave overlapping errors alone, so only one import gets reordered when fixes are applied
+ output: `
+ import aTypes from 'prop-types';
+ import React, { PureComponent } from 'react';
+ import { compose, apply } from 'xcompose';
+ import * as classnames from 'classnames';
+ import blist2 from 'blist';
+ import blist from 'BList';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: {
+ order: 'asc',
+ caseInsensitive: true,
+ },
+ },
+ ],
+ errors: [
+ {
+ message: '`prop-types` import should occur before import of `react`',
+ line: 3,
+ },
+ {
+ message: '`classnames` import should occur before import of `react`',
+ line: 5,
+ },
+ {
+ message: '`blist` import should occur before import of `react`',
+ line: 6,
+ },
+ {
+ message: '`BList` import should occur before import of `react`',
+ line: 7,
+ },
+ ],
+ }),
+ ],
+ // Documentation failing example #1 for named
test({
code: `
- import type { ParsedPath } from 'path';
- import type { CopyOptions } from 'fs';
-
- declare module 'my-module' {
- import type { ParsedPath } from 'path';
- import type { CopyOptions } from 'fs';
- }
+ import { compose, apply } from 'xcompose';
`,
output: `
- import type { CopyOptions } from 'fs';
- import type { ParsedPath } from 'path';
-
- declare module 'my-module' {
- import type { CopyOptions } from 'fs';
- import type { ParsedPath } from 'path';
- }
+ import { apply, compose } from 'xcompose';
`,
- errors: [
- { message: '`fs` type import should occur before type import of `path`' },
- { message: '`fs` type import should occur before type import of `path`' },
- ],
...parserConfig,
options: [
{
- alphabetize: { order: 'asc' },
+ named: true,
+ alphabetize: {
+ order: 'asc',
+ },
+ },
+ ],
+ errors: [
+ {
+ message: '`apply` import should occur before import of `compose`',
+ line: 2,
},
],
}),
- // named import order
+ // Documentation failing example #1 for warnOnUnassignedImports
test({
code: `
- import { type Z, A } from "./Z";
- import type N, { E, D } from "./Z";
- import type { L, G } from "./Z";
- `,
- output: `
- import { A, type Z } from "./Z";
- import type N, { D, E } from "./Z";
- import type { G, L } from "./Z";
+ import fs from 'fs';
+ import './styles.css';
+ import path from 'path';
`,
+ // Should not be fixed (eslint@>=9 expects null)
+ output: semver.satisfies(eslintPkg.version, '< 9.0.0') ? `
+ import fs from 'fs';
+ import './styles.css';
+ import path from 'path';
+ ` : null,
...parserConfig,
- options: [{
- named: true,
- alphabetize: { order: 'asc' },
- }],
+ options: [
+ {
+ warnOnUnassignedImports: true,
+ },
+ ],
errors: [
- { message: `\`A\` import should occur before${supportsImportTypeSpecifiers ? ' type' : ''} import of \`Z\`` },
- { message: '`D` import should occur before import of `E`' },
- { message: '`G` import should occur before import of `L`' },
+ {
+ message: '`path` import should occur before import of `./styles.css`',
+ line: 4,
+ },
],
}),
+ // Documentation failing example #1 for sortTypesGroup
test({
code: `
- const { B, /* Hello World */ A } = require("./Z");
- export { B, A } from "./Z";
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
`,
- output: `
- const { /* Hello World */ A, B } = require("./Z");
- export { A, B } from "./Z";
+ // This is the "correct" behavior, but it's the wrong outcome (expectedly)
+ output: semver.satisfies(eslintPkg.version, '< 3.0.0')
+ // eslint@2 apparently attempts to fix multiple errors in one pass,
+ // which results in different erroneous output
+ ? `
+ import type E from './';
+ import type A from "fs";
+ import type B from "path";
+ import type C from "../foo.js";
+ import type D from "./bar.js";
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
+ ` : `
+ import type C from "../foo.js";
+ import type A from "fs";
+ import type B from "path";
+ import type D from "./bar.js";
+ import type E from './';
+
+ import a from "fs";
+ import b from "path";
+ import c from "../foo.js";
+ import d from "./bar.js";
+ import e from "./";
`,
...parserConfig,
- options: [{
- named: true,
- alphabetize: { order: 'asc' },
- }],
- errors: [{
- message: '`A` import should occur before import of `B`',
- }, {
- message: '`A` export should occur before export of `B`',
- }],
+ options: [
+ {
+ groups: ['type', 'builtin', 'parent', 'sibling', 'index'],
+ alphabetize: { order: 'asc' },
+ },
+ ],
+ errors: [
+ {
+ message: '`../foo.js` type import should occur before type import of `fs`',
+ line: 4,
+ },
+ {
+ message: '`./bar.js` type import should occur before type import of `fs`',
+ line: 5,
+ },
+ {
+ message: '`./` type import should occur before type import of `fs`',
+ line: 6,
+ },
+ ],
}),
-
- // Options: sortTypesGroup + newlines-between-types example #1 from the documentation (fail)
+ // Documentation failing example #1 for newlines-between-types
test({
code: `
import type A from "fs";
@@ -4081,8 +6286,7 @@ context('TypeScript', function () {
},
],
}),
-
- // Options: sortTypesGroup + newlines-between-types example #2 from the documentation (fail)
+ // Documentation failing example #2 for newlines-between-types
test({
code: `
import type A from "fs";
@@ -4131,6 +6335,320 @@ context('TypeScript', function () {
},
],
}),
+ // Documentation failing example #1 for consolidateIslands
+ test({
+ code: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+ var async = require('async');
+ var relParent1 = require('../foo');
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+ var relParent3 = require('../bar');
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ output: `
+ var fs = require('fs');
+ var path = require('path');
+ var { util1, util2, util3 } = require('util');
+
+ var async = require('async');
+
+ var relParent1 = require('../foo');
+
+ var {
+ relParent21,
+ relParent22,
+ relParent23,
+ relParent24,
+ } = require('../');
+
+ var relParent3 = require('../bar');
+
+ var { sibling1,
+ sibling2, sibling3 } = require('./foo');
+
+ var sibling2 = require('./bar');
+ var sibling3 = require('./foobar');
+ `,
+ ...parserConfig,
+ options: [
+ {
+ 'newlines-between': 'always-and-inside-groups',
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ errors: [
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 4,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 5,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 6,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 12,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 13,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 15,
+ },
+ ],
+ }),
+ // Documentation failing example #2 for consolidateIslands
+ test({
+ code: `
+ import c from 'Bar';
+ import d from 'bar';
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+ import a from 'foo';
+ import b from 'dirA/bar';
+ import index from './';
+ import type { AA,
+ BB, CC } from 'abc';
+ import type { Z } from 'fizz';
+ import type {
+ A,
+ B
+ } from 'foo';
+ import type { C2 } from 'dirB/Bar';
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ output: `
+ import c from 'Bar';
+ import d from 'bar';
+
+ import {
+ aa,
+ bb,
+ cc,
+ dd,
+ ee,
+ ff,
+ gg
+ } from 'baz';
+
+ import {
+ hh,
+ ii,
+ jj,
+ kk,
+ ll,
+ mm,
+ nn
+ } from 'fizz';
+
+ import a from 'foo';
+
+ import b from 'dirA/bar';
+
+ import index from './';
+
+ import type { AA,
+ BB, CC } from 'abc';
+
+ import type { Z } from 'fizz';
+
+ import type {
+ A,
+ B
+ } from 'foo';
+
+ import type { C2 } from 'dirB/Bar';
+
+ import type {
+ D2,
+ X2,
+ Y2
+ } from 'dirB/bar';
+
+ import type { E2 } from 'dirB/baz';
+ import type { C3 } from 'dirC/Bar';
+
+ import type {
+ D3,
+ X3,
+ Y3
+ } from 'dirC/bar';
+
+ import type { E3 } from 'dirC/baz';
+ import type { F3 } from 'dirC/caz';
+ import type { C1 } from 'dirA/Bar';
+
+ import type {
+ D1,
+ X1,
+ Y1
+ } from 'dirA/bar';
+
+ import type { E1 } from 'dirA/baz';
+ import type { F } from './index.js';
+ import type { G } from './aaa.js';
+ import type { H } from './bbb';
+ `,
+ ...parserConfig,
+ options: [
+ {
+ alphabetize: { order: 'asc' },
+ groups: ['external', 'internal', 'index', 'type'],
+ pathGroups: [
+ {
+ pattern: 'dirA/**',
+ group: 'internal',
+ position: 'after',
+ },
+ {
+ pattern: 'dirB/**',
+ group: 'internal',
+ position: 'before',
+ },
+ {
+ pattern: 'dirC/**',
+ group: 'internal',
+ },
+ ],
+ 'newlines-between': 'always-and-inside-groups',
+ 'newlines-between-types': 'never',
+ pathGroupsExcludedImportTypes: [],
+ sortTypesGroup: true,
+ consolidateIslands: 'inside-groups',
+ },
+ ],
+ errors: [
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 3,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 4,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 13,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 22,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 23,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 24,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 25,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 27,
+ },
+ {
+ message: 'There should be at least one empty line between import groups',
+ line: 28,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 32,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 33,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 39,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 40,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this import and the multi-line import that follows it',
+ line: 47,
+ },
+ {
+ message:
+ 'There should be at least one empty line between this multi-line import and the import that follows it',
+ line: 48,
+ },
+ ],
+ }),
supportsExportTypeSpecifiers ? [
test({
From 243606dc24fe324c6d7add00f699a80b86db0b6f Mon Sep 17 00:00:00 2001
From: "Xunnamius (Romulus)" <Xunnamius@users.noreply.github.com>
Date: Mon, 17 Mar 2025 18:10:42 -0700
Subject: [PATCH 197/199] [Fix] `order`: resolve undefined property access
issue when using `named` ordering
Fixes #3159.
---
CHANGELOG.md | 2 ++
src/rules/order.js | 4 +++-
tests/src/rules/order.js | 12 ++++++++++++
3 files changed, 17 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e72b3ca39e..ce804fef3e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present ([#3116], thanks [@michaelfaith])
- configs: added missing name attribute for eslint config inspector ([#3151], thanks [@NishargShah])
- [`order`]: ensure arcane imports do not cause undefined behavior ([#3128], thanks [@Xunnamius])
+- [`order`]: resolve undefined property access issue when using `named` ordering ([#3166], thanks [@Xunnamius])
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
@@ -1173,6 +1174,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3166]: https://github.com/import-js/eslint-plugin-import/pull/3166
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
[#3129]: https://github.com/import-js/eslint-plugin-import/pull/3129
diff --git a/src/rules/order.js b/src/rules/order.js
index b34efd0275..a9b41c2f3d 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -1219,7 +1219,9 @@ module.exports = {
if (node.right.type === 'ObjectExpression') {
for (let i = 0; i < node.right.properties.length; i++) {
if (
- node.right.properties[i].key.type !== 'Identifier'
+ !node.right.properties[i].key
+ || node.right.properties[i].key.type !== 'Identifier'
+ || !node.right.properties[i].value
|| node.right.properties[i].value.type !== 'Identifier'
) {
return;
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
index fa592c9b19..362fa595a1 100644
--- a/tests/src/rules/order.js
+++ b/tests/src/rules/order.js
@@ -3944,6 +3944,18 @@ context('TypeScript', function () {
},
],
}),
+ // Ensure the rule doesn't choke and die when right-hand-side AssignmentExpression properties lack a "key" attribute (e.g. SpreadElement)
+ test({
+ code: `
+ // https://prettier.io/docs/en/options.html
+
+ module.exports = {
+ ...require('@xxxx/.prettierrc.js'),
+ };
+ `,
+ ...parserConfig,
+ options: [{ named: { enabled: true } }],
+ }),
// Option: sortTypesGroup: true and newlines-between-types: 'always-and-inside-groups' and consolidateIslands: 'inside-groups'
test({
code: `
From 6e49a58751455bab5f693fff0ee16501fced6952 Mon Sep 17 00:00:00 2001
From: JounQin <admin@1stg.me>
Date: Wed, 19 Mar 2025 06:04:20 +0800
Subject: [PATCH 198/199] [Refactor] `order`: remove unnecessary negative check
---
CHANGELOG.md | 2 ++
src/rules/order.js | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ce804fef3e..74cd1c1034 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -25,6 +25,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- [Docs] add flat config guide for using `tseslint.config()` ([#3125], thanks [@lnuvy])
- [Docs] add missing comma ([#3122], thanks [@RyanGst])
- [readme] Update flatConfig example to include typescript config ([#3138], thanks [@intellix])
+- [Refactor] [`order`]: remove unnecessary negative check ([#3167], thanks [@JounQin])
## [2.31.0] - 2024-10-03
@@ -1174,6 +1175,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3167]: https://github.com/import-js/eslint-plugin-import/pull/3167
[#3166]: https://github.com/import-js/eslint-plugin-import/pull/3166
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
[#3138]: https://github.com/import-js/eslint-plugin-import/pull/3138
diff --git a/src/rules/order.js b/src/rules/order.js
index a9b41c2f3d..ee339e14f8 100644
--- a/src/rules/order.js
+++ b/src/rules/order.js
@@ -770,7 +770,7 @@ function makeNewlinesBetweenReport(context, imported, newlinesBetweenImports_, n
if (shouldAssertNewlineBetweenGroups) {
if (currentImport.rank !== previousImport.rank && emptyLinesBetween === 0) {
- if (distinctGroup || !distinctGroup && isStartOfDistinctGroup) {
+ if (distinctGroup || isStartOfDistinctGroup) {
alreadyReported = true;
context.report({
node: previousImport.node,
From da5f6ec13160cb288338db0c2a00c34b2d932f0d Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Wed, 9 Apr 2025 23:42:13 -0700
Subject: [PATCH 199/199] [Fix] `enforce-node-protocol-usage`: avoid a crash
with some TS code
---
CHANGELOG.md | 2 ++
src/rules/enforce-node-protocol-usage.js | 4 +--
.../src/rules/enforce-node-protocol-usage.js | 27 ++++++++++++++++++-
3 files changed, 30 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 74cd1c1034..d8fe04c274 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
- configs: added missing name attribute for eslint config inspector ([#3151], thanks [@NishargShah])
- [`order`]: ensure arcane imports do not cause undefined behavior ([#3128], thanks [@Xunnamius])
- [`order`]: resolve undefined property access issue when using `named` ordering ([#3166], thanks [@Xunnamius])
+- [`enforce-node-protocol-usage`]: avoid a crash with some TS code ([#3173], thanks [@ljharb])
### Changed
- [Docs] [`extensions`], [`order`]: improve documentation ([#3106], thanks [@Xunnamius])
@@ -1175,6 +1176,7 @@ for info on changes for earlier releases.
[`memo-parser`]: ./memo-parser/README.md
+[#3173]: https://github.com/import-js/eslint-plugin-import/pull/3173
[#3167]: https://github.com/import-js/eslint-plugin-import/pull/3167
[#3166]: https://github.com/import-js/eslint-plugin-import/pull/3166
[#3151]: https://github.com/import-js/eslint-plugin-import/pull/3151
diff --git a/src/rules/enforce-node-protocol-usage.js b/src/rules/enforce-node-protocol-usage.js
index 88c31fc727..603f740586 100644
--- a/src/rules/enforce-node-protocol-usage.js
+++ b/src/rules/enforce-node-protocol-usage.js
@@ -29,7 +29,7 @@ function replaceStringLiteral(
}
function isStringLiteral(node) {
- return node.type === 'Literal' && typeof node.value === 'string';
+ return node && node.type === 'Literal' && typeof node.value === 'string';
}
function isStaticRequireWith1Param(node) {
@@ -44,7 +44,7 @@ function isStaticRequireWith1Param(node) {
function checkAndReport(src, context) {
// TODO use src.quasis[0].value.raw
- if (src.type === 'TemplateLiteral') { return; }
+ if (!src || src.type === 'TemplateLiteral') { return; }
const moduleName = 'value' in src ? src.value : src.name;
if (typeof moduleName !== 'string') { console.log(src, moduleName); }
const { settings } = context;
diff --git a/tests/src/rules/enforce-node-protocol-usage.js b/tests/src/rules/enforce-node-protocol-usage.js
index f9bbcbad1f..7bced2d1ba 100644
--- a/tests/src/rules/enforce-node-protocol-usage.js
+++ b/tests/src/rules/enforce-node-protocol-usage.js
@@ -2,7 +2,7 @@ import { RuleTester } from '../rule-tester';
import flatMap from 'array.prototype.flatmap';
import { satisfies } from 'semver';
-import { test, testVersion } from '../utils';
+import { getTSParsers, test, testVersion } from '../utils';
const ruleTester = new RuleTester();
const rule = require('rules/enforce-node-protocol-usage');
@@ -343,3 +343,28 @@ ruleTester.run('enforce-node-protocol-usage', rule, {
})),
),
});
+
+context('TypeScript', function () {
+ getTSParsers().forEach((parser) => {
+ ruleTester.run('enforce-node-protocol-usage', rule, {
+ valid: [
+ test({
+ code: `
+ export class Thing {
+ constructor(public readonly name: string) {
+ // Do nothing.
+ }
+
+ public sayHello(): void {
+ console.log(\`Hello, \${this.name}!\`);
+ }
+ }
+ `,
+ parser,
+ options: preferUsingProtocol,
+ }),
+ ],
+ invalid: [],
+ });
+ });
+});