require-array-sort-compare.js
3.09 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
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const util = __importStar(require("../util"));
exports.default = util.createRule({
name: 'require-array-sort-compare',
defaultOptions: [
{
ignoreStringArrays: false,
},
],
meta: {
type: 'problem',
docs: {
description: 'Requires `Array#sort` calls to always provide a `compareFunction`',
category: 'Best Practices',
recommended: false,
requiresTypeChecking: true,
},
messages: {
requireCompare: "Require 'compare' argument.",
},
schema: [
{
type: 'object',
properties: {
ignoreStringArrays: {
type: 'boolean',
},
},
},
],
},
create(context, [options]) {
const service = util.getParserServices(context);
const checker = service.program.getTypeChecker();
/**
* Check if a given node is an array which all elements are string.
* @param node
*/
function isStringArrayNode(node) {
const type = checker.getTypeAtLocation(service.esTreeNodeToTSNodeMap.get(node));
if (checker.isArrayType(type) || checker.isTupleType(type)) {
const typeArgs = checker.getTypeArguments(type);
return typeArgs.every(arg => util.getTypeName(checker, arg) === 'string');
}
return false;
}
return {
"CallExpression[arguments.length=0] > MemberExpression[property.name='sort'][computed=false]"(callee) {
const tsNode = service.esTreeNodeToTSNodeMap.get(callee.object);
const calleeObjType = util.getConstrainedTypeAtLocation(checker, tsNode);
if (options.ignoreStringArrays && isStringArrayNode(callee.object)) {
return;
}
if (util.isTypeArrayTypeOrUnionOfArrayTypes(calleeObjType, checker)) {
context.report({ node: callee.parent, messageId: 'requireCompare' });
}
},
};
},
});
//# sourceMappingURL=require-array-sort-compare.js.map