/
imports.js
158 lines (143 loc) · 4.21 KB
/
imports.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
"use strict";
const shared = require("./shared");
const defaultGroups = [
// Side effect imports.
["^\\u0000"],
// Node.js builtins prefixed with `node:`.
["^node:"],
// Packages.
// Things that start with a letter (or digit or underscore), or `@` followed by a letter.
["^@?\\w"],
// Absolute imports and other imports such as Vue-style `@/foo`.
// Anything not matched in another group.
["^"],
// Relative imports.
// Anything that starts with a dot.
["^\\."],
];
module.exports = {
meta: {
type: "layout",
fixable: "code",
schema: [
{
type: "object",
properties: {
groups: {
type: "array",
items: {
type: "array",
items: {
type: "string",
},
},
},
},
additionalProperties: false,
},
],
docs: {
url: "https://github.com/lydell/eslint-plugin-simple-import-sort#sort-order",
},
messages: {
sort: "Run autofix to sort these imports!",
},
},
create: (context) => {
const { groups: rawGroups = defaultGroups } = context.options[0] || {};
const outerGroups = rawGroups.map((groups) =>
groups.map((item) => RegExp(item, "u"))
);
const parents = new Set();
return {
ImportDeclaration: (node) => {
parents.add(node.parent);
},
"Program:exit": () => {
for (const parent of parents) {
for (const chunk of shared.extractChunks(parent, (node) =>
isImport(node) ? "PartOfChunk" : "NotPartOfChunk"
)) {
maybeReportChunkSorting(chunk, context, outerGroups);
}
}
parents.clear();
},
};
},
};
function maybeReportChunkSorting(chunk, context, outerGroups) {
const sourceCode = context.getSourceCode();
const items = shared.getImportExportItems(
chunk,
sourceCode,
isSideEffectImport,
getSpecifiers
);
const sortedItems = makeSortedItems(items, outerGroups);
const sorted = shared.printSortedItems(sortedItems, items, sourceCode);
const { start } = items[0];
const { end } = items[items.length - 1];
shared.maybeReportSorting(context, sorted, start, end);
}
function makeSortedItems(items, outerGroups) {
const itemGroups = outerGroups.map((groups) =>
groups.map((regex) => ({ regex, items: [] }))
);
const rest = [];
for (const item of items) {
const { originalSource } = item.source;
const source = item.isSideEffectImport
? `\0${originalSource}`
: item.source.kind !== "value"
? `${originalSource}\0`
: originalSource;
const [matchedGroup] = shared
.flatMap(itemGroups, (groups) =>
groups.map((group) => [group, group.regex.exec(source)])
)
.reduce(
([group, longestMatch], [nextGroup, nextMatch]) =>
nextMatch != null &&
(longestMatch == null || nextMatch[0].length > longestMatch[0].length)
? [nextGroup, nextMatch]
: [group, longestMatch],
[undefined, undefined]
);
if (matchedGroup == null) {
rest.push(item);
} else {
matchedGroup.items.push(item);
}
}
return itemGroups
.concat([[{ regex: /^/, items: rest }]])
.map((groups) => groups.filter((group) => group.items.length > 0))
.filter((groups) => groups.length > 0)
.map((groups) =>
groups.map((group) => shared.sortImportExportItems(group.items))
);
}
// Exclude "ImportDefaultSpecifier" – the "def" in `import def, {a, b}`.
function getSpecifiers(importNode) {
return importNode.specifiers.filter((node) => isImportSpecifier(node));
}
// Full import statement.
function isImport(node) {
return node.type === "ImportDeclaration";
}
// import def, { a, b as c, type d } from "A"
// ^ ^^^^^^ ^^^^^^
function isImportSpecifier(node) {
return node.type === "ImportSpecifier";
}
// import "setup"
// But not: import {} from "setup"
// And not: import type {} from "setup"
function isSideEffectImport(importNode, sourceCode) {
return (
importNode.specifiers.length === 0 &&
(!importNode.importKind || importNode.importKind === "value") &&
!shared.isPunctuator(sourceCode.getFirstToken(importNode, { skip: 1 }), "{")
);
}