sort-vars.js
3.97 KB
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
/**
* @fileoverview Rule to require sorting of variables within a single Variable Declaration block
* @author Ilya Volodin
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "require variables within the same declaration block to be sorted",
category: "Stylistic Issues",
recommended: false,
url: "https://eslint.org/docs/rules/sort-vars"
},
schema: [
{
type: "object",
properties: {
ignoreCase: {
type: "boolean",
default: false
}
},
additionalProperties: false
}
],
fixable: "code"
},
create(context) {
const configuration = context.options[0] || {},
ignoreCase = configuration.ignoreCase || false,
sourceCode = context.getSourceCode();
return {
VariableDeclaration(node) {
const idDeclarations = node.declarations.filter(decl => decl.id.type === "Identifier");
const getSortableName = ignoreCase ? decl => decl.id.name.toLowerCase() : decl => decl.id.name;
const unfixable = idDeclarations.some(decl => decl.init !== null && decl.init.type !== "Literal");
let fixed = false;
idDeclarations.slice(1).reduce((memo, decl) => {
const lastVariableName = getSortableName(memo),
currentVariableName = getSortableName(decl);
if (currentVariableName < lastVariableName) {
context.report({
node: decl,
message: "Variables within the same declaration block should be sorted alphabetically.",
fix(fixer) {
if (unfixable || fixed) {
return null;
}
return fixer.replaceTextRange(
[idDeclarations[0].range[0], idDeclarations[idDeclarations.length - 1].range[1]],
idDeclarations
// Clone the idDeclarations array to avoid mutating it
.slice()
// Sort the array into the desired order
.sort((declA, declB) => {
const aName = getSortableName(declA);
const bName = getSortableName(declB);
return aName > bName ? 1 : -1;
})
// Build a string out of the sorted list of identifier declarations and the text between the originals
.reduce((sourceText, identifier, index) => {
const textAfterIdentifier = index === idDeclarations.length - 1
? ""
: sourceCode.getText().slice(idDeclarations[index].range[1], idDeclarations[index + 1].range[0]);
return sourceText + sourceCode.getText(identifier) + textAfterIdentifier;
}, "")
);
}
});
fixed = true;
return memo;
}
return decl;
}, idDeclarations[0]);
}
};
}
};