Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Commit

Permalink
Replace node.getSourceFile(), which climbs ancestors, with the `sou…
Browse files Browse the repository at this point in the history 
…rceFile` field on a RuleWalker. (#1896)
  • Loading branch information
@andy-hanson @nchen63
andy-hanson authored and nchen63 committed Dec 18, 2016
1 parent 624d12b commit 4677686
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 41 deletions.
4 changes: 4 additions & 0 deletions src/language/walker/ruleWalker.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ export class RuleWalker extends SyntaxWalker {
return this.sourceFile;
}

public getLineAndCharacterOfPosition(position: number): ts.LineAndCharacter {
return this.sourceFile.getLineAndCharacterOfPosition(position);
}

public getFailures(): RuleFailure[] {
return this.failures;
}
Expand Down
14 changes: 2 additions & 12 deletions src/rules/alignRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,6 @@ export class Rule extends Lint.Rules.AbstractRule {
}
}

type SourcePosition = {
line: number;
character: number;
};

class AlignWalker extends Lint.RuleWalker {
public visitConstructorDeclaration(node: ts.ConstructorDeclaration) {
this.checkAlignment(Rule.PARAMETERS_OPTION, node.parameters);
Expand Down Expand Up @@ -104,22 +99,17 @@ class AlignWalker extends Lint.RuleWalker {
return;
}

let prevPos = getPosition(nodes[0]);
let prevPos = this.getLineAndCharacterOfPosition(nodes[0].getStart());
const alignToColumn = prevPos.character;

// skip first node in list
for (let node of nodes.slice(1)) {
const curPos = getPosition(node);
const curPos = this.getLineAndCharacterOfPosition(node.getStart());
if (curPos.line !== prevPos.line && curPos.character !== alignToColumn) {
this.addFailureAtNode(node, kind + Rule.FAILURE_STRING_SUFFIX);
break;
}
prevPos = curPos;
}
}

}

function getPosition(node: ts.Node): SourcePosition {
return node.getSourceFile().getLineAndCharacterOfPosition(node.getStart());
}
6 changes: 3 additions & 3 deletions src/rules/jsdocFormatRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ class JsdocWalker extends Lint.SkippableTokenAwareRuleWalker {
if (scanner.getToken() === ts.SyntaxKind.MultiLineCommentTrivia) {
const commentText = scanner.getTokenText();
const startPosition = scanner.getTokenPos();
this.findFailuresForJsdocComment(commentText, startPosition, node);
this.findFailuresForJsdocComment(commentText, startPosition);
}
});
}

private findFailuresForJsdocComment(commentText: string, startingPosition: number, sourceFile: ts.SourceFile) {
private findFailuresForJsdocComment(commentText: string, startingPosition: number) {
const currentPosition = startingPosition;
// the file may be different depending on the OS it was originally authored on
// can't rely on require('os').EOL or process.platform as that is the execution env
Expand All @@ -88,7 +88,7 @@ class JsdocWalker extends Lint.SkippableTokenAwareRuleWalker {
return;
}

const indexToMatch = firstLine.indexOf("**") + sourceFile.getLineAndCharacterOfPosition(currentPosition).character;
const indexToMatch = firstLine.indexOf("**") + this.getLineAndCharacterOfPosition(currentPosition).character;
// all lines but the first and last
const otherLines = lines.splice(1, lines.length - 2);
jsdocPosition += firstLine.length + 1; // + 1 for the splitted-out newline
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noEmptyRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class BlockWalker extends Lint.RuleWalker {
public visitBlock(node: ts.Block) {
const openBrace = node.getChildAt(0);
const closeBrace = node.getChildAt(node.getChildCount() - 1);
const sourceFileText = node.getSourceFile().text;
const sourceFileText = this.getSourceFile().text;
const hasCommentAfter = ts.getTrailingCommentRanges(sourceFileText, openBrace.getEnd()) != null;
const hasCommentBefore = ts.getLeadingCommentRanges(sourceFileText, closeBrace.getFullStart()) != null;
const isSkipped = this.ignoredBlocks.indexOf(node) !== -1;
Expand Down
4 changes: 2 additions & 2 deletions src/rules/noMergeableNamespaceRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ class NoMergeableNamespaceWalker extends Lint.RuleWalker {
}

private findLocationToMerge(currentPosition: number, highlightSpans: ts.HighlightSpan[]): ts.LineAndCharacter {
const { line } = ts.getLineAndCharacterOfPosition(this.getSourceFile(), currentPosition);
const { line } = this.getLineAndCharacterOfPosition(currentPosition);

for (const span of highlightSpans) {
const lineAndCharacter = ts.getLineAndCharacterOfPosition(this.getSourceFile(), span.textSpan.start);
const lineAndCharacter = this.getLineAndCharacterOfPosition(span.textSpan.start);
if (lineAndCharacter.line !== line) {
return lineAndCharacter;
}
Expand Down
8 changes: 4 additions & 4 deletions src/rules/noSwitchCaseFallThroughRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@ export class NoSwitchCaseFallThroughWalker extends Lint.RuleWalker {
// no break statements and no statements means the fallthrough is expected.
// last item doesn't need a break
if (isFallingThrough && switchClause.statements.length > 0 && ((switchClauses.length - 1) > i)) {
if (!isFallThroughAllowed(switchClauses[i + 1])) {
if (!isFallThroughAllowed(this.getSourceFile(), switchClauses[i + 1])) {
this.addFailureAt(switchClauses[i + 1].getStart(), "case".length, `${Rule.FAILURE_STRING_PART}'case'`);
}
}
} else {
// case statement falling through a default
if (isFallingThrough && !isFallThroughAllowed(child)) {
if (isFallingThrough && !isFallThroughAllowed(this.getSourceFile(), child)) {
this.addFailureAt(switchClauses[i].getStart(), "default".length, Rule.FAILURE_STRING_PART + "'default'");
}
}
Expand All @@ -103,8 +103,8 @@ function fallsThrough(statements: ts.NodeArray<ts.Statement>) {
});
}

function isFallThroughAllowed(nextCaseOrDefaultStatement: ts.Node) {
const sourceFileText = nextCaseOrDefaultStatement.getSourceFile().text;
function isFallThroughAllowed(sourceFile: ts.SourceFile, nextCaseOrDefaultStatement: ts.Node) {
const sourceFileText = sourceFile.text;
const firstChild = nextCaseOrDefaultStatement.getChildAt(0);
const commentRanges = ts.getLeadingCommentRanges(sourceFileText, firstChild.getFullStart());
if (commentRanges != null) {
Expand Down
4 changes: 2 additions & 2 deletions src/rules/objectLiteralSortKeysRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ class ObjectLiteralSortKeysWalker extends Lint.RuleWalker {
}

private isMultilineListNode(node: ts.ObjectLiteralExpression) {
const startLineOfNode = this.getSourceFile().getLineAndCharacterOfPosition(node.getStart()).line;
const endLineOfNode = this.getSourceFile().getLineAndCharacterOfPosition(node.getEnd()).line;
const startLineOfNode = this.getLineAndCharacterOfPosition(node.getStart()).line;
const endLineOfNode = this.getLineAndCharacterOfPosition(node.getEnd()).line;
return endLineOfNode !== startLineOfNode;
}
}
Expand Down
19 changes: 8 additions & 11 deletions src/rules/oneLineRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ export class Rule extends Lint.Rules.AbstractRule {

class OneLineWalker extends Lint.RuleWalker {
public visitIfStatement(node: ts.IfStatement) {
const sourceFile = node.getSourceFile();
const thenStatement = node.thenStatement;
const thenIsBlock = thenStatement.kind === ts.SyntaxKind.Block;
if (thenIsBlock) {
Expand All @@ -85,8 +84,8 @@ class OneLineWalker extends Lint.RuleWalker {
this.handleOpeningBrace(elseKeyword, elseOpeningBrace);
}
if (thenIsBlock && this.hasOption(OPTION_ELSE)) {
const thenStatementEndLine = sourceFile.getLineAndCharacterOfPosition(thenStatement.getEnd()).line;
const elseKeywordLine = sourceFile.getLineAndCharacterOfPosition(elseKeyword.getStart()).line;
const thenStatementEndLine = this.getLineAndCharacterOfPosition(thenStatement.getEnd()).line;
const elseKeywordLine = this.getLineAndCharacterOfPosition(elseKeyword.getStart()).line;
if (thenStatementEndLine !== elseKeywordLine) {
this.addFailureAtNode(elseKeyword, Rule.ELSE_FAILURE_STRING);
}
Expand All @@ -104,7 +103,6 @@ class OneLineWalker extends Lint.RuleWalker {
}

public visitTryStatement(node: ts.TryStatement) {
const sourceFile = node.getSourceFile();
const catchClause = node.catchClause;
const finallyBlock = node.finallyBlock;
const finallyKeyword = node.getChildren().filter((n) => n.kind === ts.SyntaxKind.FinallyKeyword)[0];
Expand All @@ -118,8 +116,8 @@ class OneLineWalker extends Lint.RuleWalker {
if (this.hasOption(OPTION_CATCH) && catchClause != null) {
const tryClosingBrace = node.tryBlock.getChildAt(node.tryBlock.getChildCount() - 1);
const catchKeyword = catchClause.getChildAt(0);
const tryClosingBraceLine = sourceFile.getLineAndCharacterOfPosition(tryClosingBrace.getEnd()).line;
const catchKeywordLine = sourceFile.getLineAndCharacterOfPosition(catchKeyword.getStart()).line;
const tryClosingBraceLine = this.getLineAndCharacterOfPosition(tryClosingBrace.getEnd()).line;
const catchKeywordLine = this.getLineAndCharacterOfPosition(catchKeyword.getStart()).line;
if (tryClosingBraceLine !== catchKeywordLine) {
this.addFailureAtNode(catchKeyword, Rule.CATCH_FAILURE_STRING);
}
Expand All @@ -132,8 +130,8 @@ class OneLineWalker extends Lint.RuleWalker {
if (this.hasOption(OPTION_FINALLY)) {
const previousBlock = catchClause != null ? catchClause.block : node.tryBlock;
const closingBrace = previousBlock.getChildAt(previousBlock.getChildCount() - 1);
const closingBraceLine = sourceFile.getLineAndCharacterOfPosition(closingBrace.getEnd()).line;
const finallyKeywordLine = sourceFile.getLineAndCharacterOfPosition(finallyKeyword.getStart()).line;
const closingBraceLine = this.getLineAndCharacterOfPosition(closingBrace.getEnd()).line;
const finallyKeywordLine = this.getLineAndCharacterOfPosition(finallyKeyword.getStart()).line;
if (closingBraceLine !== finallyKeywordLine) {
this.addFailureAtNode(finallyKeyword, Rule.FINALLY_FAILURE_STRING);
}
Expand Down Expand Up @@ -291,9 +289,8 @@ class OneLineWalker extends Lint.RuleWalker {
return;
}

const sourceFile = previousNode.getSourceFile();
const previousNodeLine = sourceFile.getLineAndCharacterOfPosition(previousNode.getEnd()).line;
const openBraceLine = sourceFile.getLineAndCharacterOfPosition(openBraceToken.getStart()).line;
const previousNodeLine = this.getLineAndCharacterOfPosition(previousNode.getEnd()).line;
const openBraceLine = this.getLineAndCharacterOfPosition(openBraceToken.getStart()).line;
let failure: string;

if (this.hasOption(OPTION_BRACE) && previousNodeLine !== openBraceLine) {
Expand Down
12 changes: 6 additions & 6 deletions src/rules/orderedImportsRule.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ class OrderedImportsWalker extends Lint.RuleWalker {
source = removeQuotes(source);
source = this.importSourcesOrderTransform(source);
const previousSource = this.currentImportsBlock.getLastImportSource();
this.currentImportsBlock.addImportDeclaration(node, source);
this.currentImportsBlock.addImportDeclaration(this.getSourceFile(), node, source);

if (previousSource && compare(source, previousSource) === -1) {
this.lastFix = new Lint.Fix(Rule.metadata.ruleName, []);
Expand Down Expand Up @@ -244,10 +244,10 @@ interface ImportDeclaration {
class ImportsBlock {
private importDeclarations: ImportDeclaration[] = [];

public addImportDeclaration(node: ts.ImportDeclaration, sourcePath: string) {
public addImportDeclaration(sourceFile: ts.SourceFile, node: ts.ImportDeclaration, sourcePath: string) {
const start = this.getStartOffset(node);
const end = this.getEndOffset(node);
const text = node.getSourceFile().text.substring(start, end);
const end = this.getEndOffset(sourceFile, node);
const text = sourceFile.text.substring(start, end);

if (start > node.getStart() || end === 0) {
// skip block if any statements don't end with a newline to simplify implementation
Expand Down Expand Up @@ -309,8 +309,8 @@ class ImportsBlock {
}

// gets the offset of the end of the import's line, including newline, to include comment to the right
private getEndOffset(node: ts.ImportDeclaration) {
let endLineOffset = node.getSourceFile().text.indexOf("\n", node.end) + 1;
private getEndOffset(sourceFile: ts.SourceFile, node: ts.ImportDeclaration) {
let endLineOffset = sourceFile.text.indexOf("\n", node.end) + 1;
return endLineOffset;
}

Expand Down

0 comments on commit 4677686

Please sign in to comment.