aboutsummaryrefslogtreecommitdiffstats
path: root/packages/tslint-config/rules
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2017-12-21 07:59:46 +0800
committerBrandon Millman <brandon.millman@gmail.com>2017-12-21 08:08:11 +0800
commit2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce (patch)
tree2b2354dbdd9686b598035a8211ab808e5974af92 /packages/tslint-config/rules
parent23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a (diff)
downloaddexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar.gz
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar.bz2
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar.lz
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar.xz
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.tar.zst
dexon-sol-tools-2d53b7d9a499e4fb5791fe34cae5ef118bdfc0ce.zip
Add some missed underscores, update changelog and comments
Diffstat (limited to 'packages/tslint-config/rules')
-rw-r--r--packages/tslint-config/rules/underscorePrivatesRule.ts17
1 files changed, 5 insertions, 12 deletions
diff --git a/packages/tslint-config/rules/underscorePrivatesRule.ts b/packages/tslint-config/rules/underscorePrivatesRule.ts
index d00f9696c..472ea09ff 100644
--- a/packages/tslint-config/rules/underscorePrivatesRule.ts
+++ b/packages/tslint-config/rules/underscorePrivatesRule.ts
@@ -1,7 +1,7 @@
import * as Lint from 'tslint';
import * as ts from 'typescript';
-const UNDERSCORE = '_'.charCodeAt(0);
+const UNDERSCORE = '_';
type RelevantClassMember =
| ts.MethodDeclaration
@@ -9,15 +9,15 @@ type RelevantClassMember =
| ts.GetAccessorDeclaration
| ts.SetAccessorDeclaration;
-// Based on: https://github.com/DanielRosenwasser/underscore-privates-tslint-rule
+// Copied from: https://github.com/DanielRosenwasser/underscore-privates-tslint-rule
+// The version on github is not published on npm
export class Rule extends Lint.Rules.AbstractRule {
- public static FAILURE_STRING = 'private members name must be prefixed with an underscore';
+ public static FAILURE_STRING = 'private members must be prefixed with an underscore';
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithFunction(sourceFile, walk);
}
}
-
function walk(ctx: Lint.WalkContext<void>): void {
traverse(ctx.sourceFile);
@@ -26,23 +26,19 @@ function walk(ctx: Lint.WalkContext<void>): void {
return ts.forEachChild(node, traverse);
}
}
-
function checkNodeForViolations(ctx: Lint.WalkContext<void>, node: ts.Node): void {
if (!isRelevantClassMember(node)) {
return;
}
-
// The declaration might have a computed property name or a numeric name.
const name = node.name;
if (!nameIsIdentifier(name)) {
return;
}
-
if (!nameStartsWithUnderscore(name.text) && memberIsPrivate(node)) {
ctx.addFailureAtNode(name, Rule.FAILURE_STRING);
}
}
-
function isRelevantClassMember(node: ts.Node): node is RelevantClassMember {
switch (node.kind) {
case ts.SyntaxKind.MethodDeclaration:
@@ -54,15 +50,12 @@ function isRelevantClassMember(node: ts.Node): node is RelevantClassMember {
return false;
}
}
-
function nameStartsWithUnderscore(text: string) {
- return text.charCodeAt(0) === UNDERSCORE;
+ return text.charCodeAt(0) === UNDERSCORE.charCodeAt(0);
}
-
function memberIsPrivate(node: ts.Declaration) {
return Lint.hasModifier(node.modifiers, ts.SyntaxKind.PrivateKeyword);
}
-
function nameIsIdentifier(node: ts.Node): node is ts.Identifier {
return node.kind === ts.SyntaxKind.Identifier;
}