62 lines
2.0 KiB
TypeScript
62 lines
2.0 KiB
TypeScript
import * as Lint from 'tslint';
|
|
import * as ts from 'typescript';
|
|
|
|
const UNDERSCORE = '_';
|
|
|
|
type RelevantClassMember =
|
|
| ts.MethodDeclaration
|
|
| ts.PropertyDeclaration
|
|
| ts.GetAccessorDeclaration
|
|
| ts.SetAccessorDeclaration;
|
|
|
|
// 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 and protected 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);
|
|
|
|
function traverse(node: ts.Node): void {
|
|
checkNodeForViolations(ctx, node);
|
|
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:
|
|
case ts.SyntaxKind.PropertyDeclaration:
|
|
case ts.SyntaxKind.GetAccessor:
|
|
case ts.SyntaxKind.SetAccessor:
|
|
return true;
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
function nameStartsWithUnderscore(text: string) {
|
|
return text.charCodeAt(0) === UNDERSCORE.charCodeAt(0);
|
|
}
|
|
function memberIsPrivate(node: ts.Declaration) {
|
|
return Lint.hasModifier(node.modifiers, ts.SyntaxKind.PrivateKeyword, ts.SyntaxKind.ProtectedKeyword);
|
|
}
|
|
function nameIsIdentifier(node: ts.Node): node is ts.Identifier {
|
|
return node.kind === ts.SyntaxKind.Identifier;
|
|
}
|