forked from palantir/tslint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ruleLoader.ts
166 lines (141 loc) · 6.23 KB
/
ruleLoader.ts
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
159
160
161
162
163
164
165
166
/**
* @license
* Copyright 2013 Palantir Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as fs from "fs";
import * as path from "path";
import {getRulesDirectories} from "./configuration";
import {IDisabledInterval, IRule} from "./language/rule/rule";
import {camelize, dedent} from "./utils";
const moduleDirectory = path.dirname(module.filename);
const CORE_RULES_DIRECTORY = path.resolve(moduleDirectory, ".", "rules");
const shownDeprecations: string[] = [];
export interface IEnableDisablePosition {
isEnabled: boolean;
position: number;
}
export function loadRules(ruleConfiguration: {[name: string]: any},
enableDisableRuleMap: {[rulename: string]: IEnableDisablePosition[]},
rulesDirectories?: string | string[],
isJs?: boolean): IRule[] {
const rules: IRule[] = [];
const notFoundRules: string[] = [];
const notAllowedInJsRules: string[] = [];
for (const ruleName in ruleConfiguration) {
if (ruleConfiguration.hasOwnProperty(ruleName)) {
const ruleValue = ruleConfiguration[ruleName];
const Rule = findRule(ruleName, rulesDirectories);
if (Rule == null) {
notFoundRules.push(ruleName);
} else {
if (isJs && Rule.metadata && Rule.metadata.typescriptOnly != null && Rule.metadata.typescriptOnly) {
notAllowedInJsRules.push(ruleName);
} else {
const ruleSpecificList = (ruleName in enableDisableRuleMap ? enableDisableRuleMap[ruleName] : []);
const disabledIntervals = buildDisabledIntervalsFromSwitches(ruleSpecificList);
rules.push(new Rule(ruleName, ruleValue, disabledIntervals));
if (Rule.metadata && Rule.metadata.deprecationMessage && shownDeprecations.indexOf(Rule.metadata.ruleName) === -1) {
console.warn(`${Rule.metadata.ruleName} is deprecated. ${Rule.metadata.deprecationMessage}`);
shownDeprecations.push(Rule.metadata.ruleName);
}
}
}
}
}
if (notFoundRules.length > 0) {
const warning = dedent`
Could not find implementations for the following rules specified in the configuration:
${notFoundRules.join("\n ")}
Try upgrading TSLint and/or ensuring that you have all necessary custom rules installed.
If TSLint was recently upgraded, you may have old rules configured which need to be cleaned up.
`;
console.warn(warning);
}
if (notAllowedInJsRules.length > 0) {
const warning = dedent`
Following rules specified in configuration couldn't be applied to .js or .jsx files:
${notAllowedInJsRules.join("\n ")}
Make sure to exclude them from "jsRules" section of your tslint.json.
`;
console.warn(warning);
}
if (rules.length === 0) {
console.warn("No valid rules have been specified");
}
return rules;
}
export function findRule(name: string, rulesDirectories?: string | string[]) {
const camelizedName = transformName(name);
// first check for core rules
let Rule = loadRule(CORE_RULES_DIRECTORY, camelizedName);
if (Rule != null) {
return Rule;
}
const directories = getRulesDirectories(rulesDirectories);
for (const rulesDirectory of directories) {
// then check for rules within the first level of rulesDirectory
if (rulesDirectory != null) {
Rule = loadRule(rulesDirectory, camelizedName);
if (Rule != null) {
return Rule;
}
}
}
return undefined;
}
function transformName(name: string) {
// camelize strips out leading and trailing underscores and dashes, so make sure they aren't passed to camelize
// the regex matches the groups (leading underscores and dashes)(other characters)(trailing underscores and dashes)
const nameMatch = name.match(/^([-_]*)(.*?)([-_]*)$/);
if (nameMatch == null) {
return name + "Rule";
}
return nameMatch[1] + camelize(nameMatch[2]) + nameMatch[3] + "Rule";
}
/**
* @param directory - An absolute path to a directory of rules
* @param ruleName - A name of a rule in filename format. ex) "someLintRule"
*/
function loadRule(directory: string, ruleName: string) {
const fullPath = path.join(directory, ruleName);
if (fs.existsSync(fullPath + ".js")) {
const ruleModule = require(fullPath);
if (ruleModule && ruleModule.Rule) {
return ruleModule.Rule;
}
}
return undefined;
}
/**
* creates disabled intervals for rule based on list of switchers for it
* @param ruleSpecificList - contains all switchers for rule states sorted top-down and strictly alternating between enabled and disabled
*/
function buildDisabledIntervalsFromSwitches(ruleSpecificList: IEnableDisablePosition[]) {
const disabledIntervalList: IDisabledInterval[] = [];
// starting from second element in the list since first is always enabled in position 0;
let i = 1;
while (i < ruleSpecificList.length) {
const startPosition = ruleSpecificList[i].position;
// rule enabled state is always alternating therefore we can use position of next switch as end of disabled interval
// set endPosition as Infinity in case when last switch for rule in a file is disabled
const endPosition = ruleSpecificList[i + 1] ? ruleSpecificList[i + 1].position : Infinity;
disabledIntervalList.push({
endPosition,
startPosition,
});
i += 2;
}
return disabledIntervalList;
}