honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(core): better failure message for explicit-query timing tslint rule (#29258) 

Improves the failure message for the `explicit-query` timing TSLint rule
that is used within Google. Currently it's not very clear what action
developers need to take in order to resolve the lint failure manually.

PR Close #29258
This commit is contained in:
Paul Gschwendtner 2019-03-13 16:46:06 +01:00 committed by Matias Niemelä
parent 8ef46f38f4
commit 90df7de54d
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
packages/core/schematics/migrations/static-queries/google3/explicitQueryTimingRule.ts
View File

@ -14,6 +14,9 @@ import {NgQueryResolveVisitor} from '../angular/ng_query_visitor';
import {QueryTiming} from '../angular/query-definition';
import {getTransformedQueryCallExpr} from '../transform';
const FAILURE_MESSAGE = 'Query does explicitly specify its timing. Read more here: ' +
'https://github.com/angular/angular/pull/28810';
/**
* Rule that reports if an Angular "ViewChild" or "ContentChild" query is not explicitly
* specifying its timing. The rule also provides TSLint automatic replacements that can
@ -55,10 +58,12 @@ export class Rule extends Rules.TypedRule {
// updated call expression node.
const fix = new Replacement(queryExpr.getStart(), queryExpr.getWidth(), newText);
const timingStr = timing === QueryTiming.STATIC ? 'static' : 'dynamic';
const failureMessage = `${FAILURE_MESSAGE}. Based on analysis of the query it can be ` +
`marked as "${timingStr}".`;
failures.push(new RuleFailure(
sourceFile, queryExpr.getStart(), queryExpr.getWidth(),
`Query is not explicitly marked as "${timingStr}"`, this.ruleName, fix));
sourceFile, queryExpr.getStart(), queryExpr.getWidth(), failureMessage, this.ruleName,
fix));
});
return failures;

4
packages/core/schematics/test/google3/explicit_query_timing_rule_spec.ts
View File

@ -109,7 +109,7 @@ describe('Google3 explicitQueryTiming TSLint rule', () => {
const failures = linter.getResult().failures;
expect(failures.length).toBe(1);
expect(failures[0].getFailure()).toContain('Query is not explicitly marked as "static"');
expect(failures[0].getFailure()).toMatch(/analysis of the query.*"static"/);
});
it('should report non-explicit dynamic query definitions', () => {
@ -126,6 +126,6 @@ describe('Google3 explicitQueryTiming TSLint rule', () => {
const failures = linter.getResult().failures;
expect(failures.length).toBe(1);
expect(failures[0].getFailure()).toContain('Query is not explicitly marked as "dynamic"');
expect(failures[0].getFailure()).toMatch(/analysis of the query.*"dynamic"/);
});
});