Skip to content

fix noInputRenameRule #585

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

Merged
mgechev merged 2 commits into from
Apr 29, 2018
Merged

fix noInputRenameRule #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1770703
fix noInputRenameRule
wKoza Feb 10, 2018
6412be7
refact noInputRenameRuler
wKoza Apr 29, 2018
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
12 changes: 10 additions & 2 deletions src/noInputRenameRule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ export class Rule extends Lint.Rules.AbstractRule {
typescriptOnly: true
};

static FAILURE_STRING = 'In the class "%s", the directive input property "%s" should not be renamed.';
static FAILURE_STRING = 'In the class "%s", the directive input property "%s" should not be renamed. ' +
'However, you should use an alias when the directive name is also an input property, and the directive name' +
" doesn't describe the property. In this last case, you can disable this rule with `tslint:disable-next-line:no-input-rename`.";

apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithWalker(new InputMetadataWalker(sourceFile, this.getOptions()));
Expand All @@ -34,7 +36,13 @@ export class InputMetadataWalker extends NgWalker {
const className = (property.parent as ts.PropertyAccessExpression).name.getText();
const memberName = property.name.getText();

if (args.length === 0 || (this.directiveSelector && this.directiveSelector.indexOf(memberName) !== -1)) {
if (
args.length === 0 ||
(this.directiveSelector &&
(input.expression as ts.CallExpression).arguments.some(
(arg: ts.Identifier) => this.directiveSelector.indexOf(arg.text) !== -1 && memberName !== arg.text
))
) {
return;
}

Expand Down
87 changes: 68 additions & 19 deletions test/noInputRenameRule.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
import { assertSuccess, assertAnnotated } from './testHelper';
import { sprintf } from 'sprintf-js';
import { Rule } from '../src/noInputRenameRule';

const ruleName = 'no-input-rename';

const getMessage = (className: string, propertyName: string): string => {
return `In the class "${className}", the directive input property "${propertyName}" should not be renamed.`;
return sprintf(Rule.FAILURE_STRING, className, propertyName);
};

describe(ruleName, () => {
describe('failure', () => {
describe('Component', () => {
it('should fail when a input property is renamed', () => {
it('should fail when an input property is renamed', () => {
const source = `
@Component
@Component({
selector: 'foo'
})
class TestComponent {
@Input('labelAttribute') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@Input('bar') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}
`;
assertAnnotated({
Expand All @@ -26,10 +30,12 @@ describe(ruleName, () => {

it('should fail when input property is fake renamed', () => {
const source = `
@Component
@Component({
selector: 'foo'
})
class TestComponent {
@Input('label') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@Input('foo') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}
`;
assertAnnotated({
Expand All @@ -41,9 +47,11 @@ describe(ruleName, () => {
});

describe('Directive', () => {
it('should fail when a input property is renamed', () => {
it('should fail when an input property is renamed', () => {
const source = `
@Directive
@Directive({
selector: '[foo]
})
class TestDirective {
@Input('labelText') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -56,19 +64,36 @@ describe(ruleName, () => {
});
});

it("should fail when input property is renamed and it's different from directive's selector", () => {
it('should fail when an input property has the same name that the alias', () => {
const source = `
@Directive({
selector: '[label], label2'
selector: '[label]
})
class TestDirective {
@Input('label') labelText: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@Input('label') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}
`;
assertAnnotated({
ruleName,
message: getMessage('TestDirective', 'label'),
source
});
});

it('should fail when an input property has the same name that the alias', () => {
const source = `
@Directive({
selector: '[foo]
})
class TestDirective {
@Input('label') label: string;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}
`;
assertAnnotated({
ruleName,
message: getMessage('TestDirective', 'labelText'),
message: getMessage('TestDirective', 'label'),
source
});
});
Expand All @@ -77,7 +102,7 @@ describe(ruleName, () => {

describe('success', () => {
describe('Component', () => {
it('should succeed when a input property is not renamed', () => {
it('should succeed when an input property is not renamed', () => {
const source = `
@Component
class TestComponent {
Expand All @@ -89,13 +114,37 @@ describe(ruleName, () => {
});

describe('Directive', () => {
it('should succeed when the directive name is also an input property', () => {
it("should succeed when the directive's selector is also an input metadata property", () => {
const source = `
@Directive({
selector: '[label], label2'
selector: '[foo], label2'
})
class TestDirective {
@Input('labelText') label: string;
@Input('foo') bar: string;
}
`;
assertSuccess(ruleName, source);
});

it("should succeed when the directive's selector is also an input metadata property", () => {
const source = `
@Directive({
selector: '[foo], myselector'
})
class TestDirective {
@Input('myselector') bar: string;
}
`;
assertSuccess(ruleName, source);
});

it("should succeed when the directive's selector is also an input property", () => {
const source = `
@Directive({
selector: '[foo], label2'
})
class TestDirective {
@Input() foo: string;
}
`;
assertSuccess(ruleName, source);
Expand Down