eslint-plugin-turmag-special-rules 0.0.5 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/lib/rules/import-right-order.js +105 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -76,6 +76,7 @@ TODO: Run eslint-doc-generator to generate the configs list (or delete this sect
|
|
|
76
76
|
| :----------------------------------------------------------------------------------- | :------------------------------------------------------------- | :- |
|
|
77
77
|
| [add-vue-extension](docs/rules/add-vue-extension.md) | Require .vue in vue files | 🔧 |
|
|
78
78
|
| [import-entities-by-column-or-line](docs/rules/import-entities-by-column-or-line.md) | Prefered column or line import | 🔧 |
|
|
79
|
+
| [import-right-order](docs/rules/import-right-order.md) | Prefered right import order | 🔧 |
|
|
79
80
|
| [prefer-true-attribute-shorthand](docs/rules/prefer-true-attribute-shorthand.md) | Require shorthand form attribute when `v-bind` value is `true` | 🔧 |
|
|
80
81
|
| [use-shortest-alias](docs/rules/use-shortest-alias.md) | There are can be used shortest alias | 🔧 |
|
|
81
82
|
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
const entitiesOrder = ['external', 'vue', 'component', 'composable', 'store', 'mixin', 'type', 'constant', 'method', 'api'];
|
|
2
|
+
const determineEntity = (value, specifiers) => {
|
|
3
|
+
let entity = 'external';
|
|
4
|
+
value = value.toLowerCase();
|
|
5
|
+
|
|
6
|
+
if (value === 'vue') entity = 'vue';
|
|
7
|
+
else if (value.includes('mixin')) entity = 'mixin';
|
|
8
|
+
else if (value.includes('.vue') || value.includes('kit')) entity = 'component';
|
|
9
|
+
else if (value.includes('composable') || specifiers && specifiers[0]?.local.name.toLowerCase().includes('use')) entity = 'composable';
|
|
10
|
+
else if (value.includes('store')) entity = 'store';
|
|
11
|
+
else if (value.includes('type')) entity = 'type';
|
|
12
|
+
else if (value.includes('constant')) entity = 'constant';
|
|
13
|
+
else if (value.includes('helper') || value.includes('utils')) entity = 'method';
|
|
14
|
+
else if (value.includes('api')) entity = 'api';
|
|
15
|
+
|
|
16
|
+
return entity;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
module.exports = {
|
|
20
|
+
meta: {
|
|
21
|
+
fixable: 'code',
|
|
22
|
+
type: 'suggestion',
|
|
23
|
+
docs: {
|
|
24
|
+
description: 'Prefered right import order',
|
|
25
|
+
},
|
|
26
|
+
messages: {
|
|
27
|
+
order: 'Use right import order',
|
|
28
|
+
},
|
|
29
|
+
|
|
30
|
+
schema: [],
|
|
31
|
+
},
|
|
32
|
+
create(context) {
|
|
33
|
+
let prevNode = null;
|
|
34
|
+
const nodesArr = [];
|
|
35
|
+
let isErrorOrderNode = false;
|
|
36
|
+
let startReplaceRange = 0;
|
|
37
|
+
let endReplaceRange = 0;
|
|
38
|
+
|
|
39
|
+
return {
|
|
40
|
+
ImportDeclaration(node) {
|
|
41
|
+
nodesArr.push(node);
|
|
42
|
+
|
|
43
|
+
if (prevNode) {
|
|
44
|
+
const prevNodeEntity = determineEntity(prevNode.source.value, prevNode.specifiers);
|
|
45
|
+
const currentNodeEntity = determineEntity(node.source.value, node.specifiers);
|
|
46
|
+
|
|
47
|
+
const prevNodeIndex = entitiesOrder.indexOf(prevNodeEntity);
|
|
48
|
+
const currentNodeIndex = entitiesOrder.indexOf(currentNodeEntity);
|
|
49
|
+
|
|
50
|
+
prevNode.sortIndex = prevNodeIndex;
|
|
51
|
+
node.sortIndex = currentNodeIndex;
|
|
52
|
+
|
|
53
|
+
if (prevNodeIndex > currentNodeIndex && !isErrorOrderNode) {
|
|
54
|
+
isErrorOrderNode = true;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
prevNode = node;
|
|
59
|
+
|
|
60
|
+
if (isErrorOrderNode) {
|
|
61
|
+
context.report({
|
|
62
|
+
node,
|
|
63
|
+
messageId: 'order',
|
|
64
|
+
fix: fixer => {
|
|
65
|
+
const sortedNodesArr = structuredClone(nodesArr).sort((a, b) => a.sortIndex - b.sortIndex);
|
|
66
|
+
|
|
67
|
+
const replacedNodesArr = [];
|
|
68
|
+
sortedNodesArr.forEach((node, i) => {
|
|
69
|
+
if (replacedNodesArr.length) replacedNodesArr.push(node);
|
|
70
|
+
if (node.source.value !== nodesArr[i].source.value && !replacedNodesArr.length) {
|
|
71
|
+
replacedNodesArr.push(node);
|
|
72
|
+
startReplaceRange = nodesArr[i].range[0];
|
|
73
|
+
}
|
|
74
|
+
if (i === sortedNodesArr.length - 1) endReplaceRange = nodesArr[i].range[1];
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
let replaceText = '';
|
|
78
|
+
|
|
79
|
+
replaceText = '';
|
|
80
|
+
replacedNodesArr.forEach((node, i) => {
|
|
81
|
+
if (!node.specifiers[0]) {
|
|
82
|
+
replaceText += `import '${node.source.value}';`;
|
|
83
|
+
} else if (node.specifiers[0].type === 'ImportDefaultSpecifier') {
|
|
84
|
+
replaceText += `import ${node.specifiers[0].local.name} from '${node.source.value}';`;
|
|
85
|
+
} else if (node.specifiers[0].type === 'ImportNamespaceSpecifier') {
|
|
86
|
+
replaceText += `import * as ${node.specifiers[0].local.name} from '${node.source.value}';`;
|
|
87
|
+
} else {
|
|
88
|
+
const specifiersArr = [];
|
|
89
|
+
node.specifiers.forEach(specifier => specifiersArr.push(specifier.local.name));
|
|
90
|
+
|
|
91
|
+
const replaceSign = specifiersArr.length > 2 ? '\n' : ' ';
|
|
92
|
+
const replaceShiftSign = specifiersArr.length > 2 ? '\n ' : ' ';
|
|
93
|
+
replaceText += `import {${replaceShiftSign}${specifiersArr.join(`,${replaceShiftSign}`)}${specifiersArr.length > 2 ? ',' : ''}${replaceSign}} from '${node.source.value}';`;
|
|
94
|
+
}
|
|
95
|
+
if (i < replacedNodesArr.length - 1) replaceText += '\n';
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
return fixer.replaceTextRange([startReplaceRange, endReplaceRange], replaceText);
|
|
99
|
+
},
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
},
|
|
103
|
+
};
|
|
104
|
+
},
|
|
105
|
+
}
|