interfaceNameRule.js
3.73 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
"use strict";
var __extends = (this && this.__extends) || function (d, b) {
for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
var Lint = require("../lint");
var OPTION_ALWAYS = "always-prefix";
var OPTION_NEVER = "never-prefix";
var Rule = (function (_super) {
__extends(Rule, _super);
function Rule() {
_super.apply(this, arguments);
}
Rule.prototype.apply = function (sourceFile) {
return this.applyWithWalker(new NameWalker(sourceFile, this.getOptions()));
};
Rule.metadata = {
ruleName: "interface-name",
description: "Requires interface names to begin with a capital 'I'",
rationale: "Makes it easy to differentitate interfaces from regular classes at a glance.",
optionsDescription: (_a = ["\n One of the following two options must be provided:\n\n * `\"", "\"` requires interface names to start with an \"I\"\n * `\"", "\"` requires interface names to not have an \"I\" prefix"], _a.raw = ["\n One of the following two options must be provided:\n\n * \\`\"", "\"\\` requires interface names to start with an \"I\"\n * \\`\"", "\"\\` requires interface names to not have an \"I\" prefix"], Lint.Utils.dedent(_a, OPTION_ALWAYS, OPTION_NEVER)),
options: {
type: "string",
enum: [OPTION_ALWAYS, OPTION_NEVER],
},
optionExamples: [("[true, \"" + OPTION_ALWAYS + "\"]"), ("[true, \"" + OPTION_NEVER + "\"]")],
type: "style",
};
Rule.FAILURE_STRING = "interface name must start with a capitalized I";
Rule.FAILURE_STRING_NO_PREFIX = "interface name must not have an \"I\" prefix";
return Rule;
var _a;
}(Lint.Rules.AbstractRule));
exports.Rule = Rule;
var NameWalker = (function (_super) {
__extends(NameWalker, _super);
function NameWalker() {
_super.apply(this, arguments);
}
NameWalker.prototype.visitInterfaceDeclaration = function (node) {
var interfaceName = node.name.text;
var always = this.hasOption(OPTION_ALWAYS) || (this.getOptions() && this.getOptions().length === 0);
if (always) {
if (!this.startsWithI(interfaceName)) {
this.addFailureAt(node.name.getStart(), node.name.getWidth(), Rule.FAILURE_STRING);
}
}
else if (this.hasOption(OPTION_NEVER)) {
if (this.hasPrefixI(interfaceName)) {
this.addFailureAt(node.name.getStart(), node.name.getWidth(), Rule.FAILURE_STRING_NO_PREFIX);
}
}
_super.prototype.visitInterfaceDeclaration.call(this, node);
};
NameWalker.prototype.startsWithI = function (name) {
if (name.length <= 0) {
return true;
}
var firstCharacter = name.charAt(0);
return (firstCharacter === "I");
};
NameWalker.prototype.hasPrefixI = function (name) {
if (name.length <= 0) {
return true;
}
var firstCharacter = name.charAt(0);
if (firstCharacter !== "I") {
return false;
}
var secondCharacter = name.charAt(1);
if (secondCharacter === "") {
return false;
}
else if (secondCharacter !== secondCharacter.toUpperCase()) {
return false;
}
if (name.indexOf("IDB") === 0) {
return false;
}
return true;
};
NameWalker.prototype.addFailureAt = function (position, width, failureString) {
var failure = this.createFailure(position, width, failureString);
this.addFailure(failure);
};
return NameWalker;
}(Lint.RuleWalker));