Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: support validation directives and extra suffixes #407

Merged
merged 2 commits into from
Sep 11, 2017
Merged

fix: support validation directives and extra suffixes #407

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28ecbdd
fix: support validation directives and extra suffixes
mgechev Sep 8, 2017
cdfd3d0
fix: proper check for interface name
mgechev Sep 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions src/directiveClassSuffixRule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ import { NgWalker } from './angular/ngWalker';

import { DirectiveMetadata } from './angular/metadata';

const getInterfaceName = (t: any): string => {
if (t.expression && t.expression.name) {
return t.expression.name.text;
}
return t.expression.text;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

t.expression is never null ? if this is the case => if (t.expression.name)

};

const ValidatorSuffix = 'Validator';

export class Rule extends Lint.Rules.AbstractRule {

public static metadata: Lint.IRuleMetadata = {
Expand All @@ -29,8 +38,8 @@ export class Rule extends Lint.Rules.AbstractRule {

static FAILURE: string = 'The name of the class %s should end with the suffix %s (https://angular.io/styleguide#style-02-03)';

static validate(className: string, suffix: string): boolean {
return className.endsWith(suffix);
static validate(className: string, suffixes: string[]): boolean {
return suffixes.some(s => className.endsWith(s));
}

public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
Expand All @@ -44,13 +53,21 @@ export class ClassMetadataWalker extends NgWalker {
visitNgDirective(meta: DirectiveMetadata) {
let name = meta.controller.name;
let className: string = name.text;
const suffix = this.getOptions()[0] || 'Directive';
if (!Rule.validate(className, suffix)) {
const options = this.getOptions();
const suffixes: string[] = options.length ? options : ['Directive'];
const heritageClauses = meta.controller.heritageClauses;
if (heritageClauses) {
const i = heritageClauses.filter(h => h.token === ts.SyntaxKind.ImplementsKeyword);
if (i.length !== 0 && i[0].types.map(getInterfaceName).some(name => name.endsWith(ValidatorSuffix))) {
suffixes.push(ValidatorSuffix);
}
}
if (!Rule.validate(className, suffixes)) {
this.addFailure(
this.createFailure(
name.getStart(),
name.getWidth(),
sprintf.apply(this, [Rule.FAILURE, className, suffix])));
sprintf.apply(this, [Rule.FAILURE, className, suffixes.join(', ')])));
}
}
}
158 changes: 96 additions & 62 deletions test/directiveClassSuffix.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,122 +1,156 @@
import { assertAnnotated, assertSuccess } from './testHelper';

describe('directive-class-suffix', () => {
describe('invalid directive class suffix', () => {
it('should fail when directive class is with the wrong suffix', () => {
let source = `
describe('invalid directive class suffix', () => {
it('should fail when directive class is with the wrong suffix', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class Test {}
~~~~
`;
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class Test should end with the suffix Directive (https://angular.io/styleguide#style-02-03)',
source
});
});
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class Test should end with the suffix Directive (https://angular.io/styleguide#style-02-03)',
source
});
});

describe('valid directive class name', () => {
it('should succeed when the directive class name ends with Directive', () => {
let source = `
it('should fail when directive class is with the wrong suffix', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class Test {}
~~~~
`;
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class Test should end with the suffix Directive, Page, Validator (https://angular.io/styleguide#style-02-03)',
source,
options: ['Directive', 'Page', 'Validator']
});
});
});

describe('valid directive class name', () => {
it('should succeed when the directive class name ends with Directive', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class TestDirective {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});

it('should succeed when the directive class name ends with Validator and implements Validator', () => {
const source = `
@Directive({
selector: 'sgBarFoo'
})
class TestValidator implements Validator {}`;
assertSuccess('directive-class-suffix', source);
});

describe('not called decorator', () => {
it('should not fail when @Directive is not called', () => {
let source = `
it('should succeed when the directive class name ends with Validator and implements AsyncValidator', () => {
const source = `
@Directive({
selector: 'sgBarFoo'
})
class TestValidator implements AsyncValidator {}`;
assertSuccess('directive-class-suffix', source);
});
});

describe('not called decorator', () => {
it('should not fail when @Directive is not called', () => {
let source = `
@Directive
class TestDirective {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});
});

describe('valid directive class', () => {
it('should succeed when is used @Component decorator', () => {
let source = `
describe('valid directive class', () => {
it('should succeed when is used @Component decorator', () => {
let source = `
@Component({
selector: 'sg-foo-bar'
})
class TestComponent {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});
});

describe('valid pipe class', () => {
it('should succeed when is used @Pipe decorator', () => {
let source = `
describe('valid pipe class', () => {
it('should succeed when is used @Pipe decorator', () => {
let source = `
@Pipe({
selector: 'sg-test-pipe'
})
class TestPipe {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});
});

describe('valid service class', () => {
it('should succeed when is used @Injectable decorator', () => {
let source = `
describe('valid service class', () => {
it('should succeed when is used @Injectable decorator', () => {
let source = `
@Injectable()
class TestService {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});
});

describe('valid empty class', () => {
it('should succeed when the class is empty', () => {
let source = `
describe('valid empty class', () => {
it('should succeed when the class is empty', () => {
let source = `
class TestEmpty {}`;
assertSuccess('directive-class-suffix', source);
});
assertSuccess('directive-class-suffix', source);
});
});

describe('changed suffix', () => {
it('should suceed when different sufix is set', () => {
let source = `
describe('changed suffix', () => {
it('should suceed when different sufix is set', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class TestPage {}`;
assertSuccess('directive-class-suffix', source, ['Page']);
});
assertSuccess('directive-class-suffix', source, ['Page']);
});

it('should fail when different sufix is set and doesnt match', () => {
let source = `
it('should fail when different sufix is set and doesnt match', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class TestPage {}
~~~~~~~~
`;
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class TestPage should end with the suffix Directive (https://angular.io/styleguide#style-02-03)',
source,
options: ['Directive']
});
});
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class TestPage should end with the suffix Directive (https://angular.io/styleguide#style-02-03)',
source,
options: ['Directive']
});
});

it('should fail when different sufix is set and doesnt match', () => {
let source = `
it('should fail when different sufix is set and doesnt match', () => {
let source = `
@Directive({
selector: 'sgBarFoo'
})
class TestDirective {}
~~~~~~~~~~~~~
`;
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class TestDirective should end with the suffix Page (https://angular.io/styleguide#style-02-03)',
source,
options: ['Page']
});
});
assertAnnotated({
ruleName: 'directive-class-suffix',
message: 'The name of the class TestDirective should end with the suffix Page (https://angular.io/styleguide#style-02-03)',
source,
options: ['Page']
});
});
});
});