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
|
"use strict";
/**
* @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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
var fs = require("fs");
var path = require("path");
var configuration_1 = require("./configuration");
var error_1 = require("./error");
var utils_1 = require("./utils");
var moduleDirectory = path.dirname(module.filename);
var CORE_RULES_DIRECTORY = path.resolve(moduleDirectory, ".", "rules");
var cachedRules = new Map();
function loadRules(ruleOptionsList, rulesDirectories, isJs) {
if (isJs === void 0) { isJs = false; }
var rules = [];
var notFoundRules = [];
var notAllowedInJsRules = [];
for (var _i = 0, ruleOptionsList_1 = ruleOptionsList; _i < ruleOptionsList_1.length; _i++) {
var ruleOptions = ruleOptionsList_1[_i];
if (ruleOptions.ruleSeverity === "off") {
// Perf: don't bother finding the rule if it's disabled.
continue;
}
var ruleName = ruleOptions.ruleName;
var Rule = findRule(ruleName, rulesDirectories);
if (Rule === undefined) {
notFoundRules.push(ruleName);
}
else if (isJs && Rule.metadata !== undefined && Rule.metadata.typescriptOnly) {
notAllowedInJsRules.push(ruleName);
}
else {
var rule = new Rule(ruleOptions);
if (rule.isEnabled()) {
rules.push(rule);
}
if (Rule.metadata !== undefined && Boolean(Rule.metadata.deprecationMessage)) {
error_1.showWarningOnce(Rule.metadata.ruleName + " is deprecated. " + Rule.metadata.deprecationMessage);
}
}
}
if (notFoundRules.length > 0) {
var warning = (_a = ["\n Could not find implementations for the following rules specified in the configuration:\n ", "\n Try upgrading TSLint and/or ensuring that you have all necessary custom rules installed.\n If TSLint was recently upgraded, you may have old rules configured which need to be cleaned up.\n "], _a.raw = ["\n Could not find implementations for the following rules specified in the configuration:\n ", "\n Try upgrading TSLint and/or ensuring that you have all necessary custom rules installed.\n If TSLint was recently upgraded, you may have old rules configured which need to be cleaned up.\n "], utils_1.dedent(_a, notFoundRules.join("\n ")));
error_1.showWarningOnce(warning);
}
if (notAllowedInJsRules.length > 0) {
var warning = (_b = ["\n Following rules specified in configuration couldn't be applied to .js or .jsx files:\n ", "\n Make sure to exclude them from \"jsRules\" section of your tslint.json.\n "], _b.raw = ["\n Following rules specified in configuration couldn't be applied to .js or .jsx files:\n ", "\n Make sure to exclude them from \"jsRules\" section of your tslint.json.\n "], utils_1.dedent(_b, notAllowedInJsRules.join("\n ")));
error_1.showWarningOnce(warning);
}
if (rules.length === 0) {
error_1.showWarningOnce("No valid rules have been specified");
}
return rules;
var _a, _b;
}
exports.loadRules = loadRules;
function findRule(name, rulesDirectories) {
var camelizedName = transformName(name);
// first check for core rules
var Rule = loadCachedRule(CORE_RULES_DIRECTORY, camelizedName);
return Rule !== undefined ? Rule :
// then check for rules within the first level of rulesDirectory
utils_1.find(utils_1.arrayify(rulesDirectories), function (dir) { return loadCachedRule(dir, camelizedName, true); });
}
exports.findRule = findRule;
function transformName(name) {
// 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)
var nameMatch = name.match(/^([-_]*)(.*?)([-_]*)$/);
if (nameMatch === null) {
return name + "Rule";
}
return "" + nameMatch[1] + utils_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, ruleName) {
var ruleFullPath = getRuleFullPath(directory, ruleName);
if (ruleFullPath !== undefined) {
var ruleModule = require(ruleFullPath);
if (ruleModule !== undefined) {
return ruleModule.Rule;
}
}
return "not-found";
}
/**
* Returns the full path to a rule file. Path to rules are resolved using nodes path resolution.
* This allows developers to write custom rules in TypeScript, which then can be loaded by TS-Node.
* @param directory - An absolute path to a directory of rules
* @param ruleName - A name of a rule in filename format. ex) "someLintRule"
*/
function getRuleFullPath(directory, ruleName) {
try {
return require.resolve(path.join(directory, ruleName));
}
catch (e) {
return undefined;
}
}
function loadCachedRule(directory, ruleName, isCustomPath) {
// use cached value if available
var fullPath = path.join(directory, ruleName);
var cachedRule = cachedRules.get(fullPath);
if (cachedRule !== undefined) {
return cachedRule === "not-found" ? undefined : cachedRule;
}
// get absolute path
var absolutePath = directory;
if (isCustomPath) {
absolutePath = configuration_1.getRelativePath(directory);
if (absolutePath !== undefined && !fs.existsSync(absolutePath)) {
throw new error_1.FatalError("Could not find custom rule directory: " + directory);
}
}
var Rule = absolutePath === undefined ? "not-found" : loadRule(absolutePath, ruleName);
cachedRules.set(fullPath, Rule);
return Rule === "not-found" ? undefined : Rule;
}
|
