Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/eslint-plugin/src/configs/all.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"@angular-eslint/contextual-lifecycle": "error",
"@angular-eslint/directive-class-suffix": "error",
"@angular-eslint/directive-selector": "error",
"@angular-eslint/input-not-event-emitter": "error",
"@angular-eslint/no-attribute-decorator": "error",
"@angular-eslint/no-conflicting-lifecycle": "error",
"@angular-eslint/no-empty-lifecycle-method": "error",
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ import directiveClassSuffix, {
import directiveSelector, {
RULE_NAME as directiveSelectorRuleName,
} from './rules/directive-selector';
import inputNotEventEmitter, {
RULE_NAME as inputNotEventEmitterRuleName,
} from './rules/input-not-event-emitter';
import noAttributeDecorator, {
RULE_NAME as noAttributeDecoratorRuleName,
} from './rules/no-attribute-decorator';
Expand Down Expand Up @@ -119,6 +122,7 @@ export default {
[contextualLifecycleRuleName]: contextualLifecycle,
[directiveClassSuffixRuleName]: directiveClassSuffix,
[directiveSelectorRuleName]: directiveSelector,
[inputNotEventEmitterRuleName]: inputNotEventEmitter,
[noAttributeDecoratorRuleName]: noAttributeDecorator,
[noConflictingLifecycleRuleName]: noConflictingLifecycle,
[noForwardRefRuleName]: noForwardRef,
Expand Down
46 changes: 46 additions & 0 deletions packages/eslint-plugin/src/rules/input-not-event-emitter.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { Selectors } from '@angular-eslint/utils';
import type { TSESTree } from '@typescript-eslint/utils';
import { createESLintRule } from '../utils/create-eslint-rule';

type Options = [];
export type MessageIds = 'inputNotEventEmitter' | 'suggestChangeInputToOutput';
export const RULE_NAME = 'input-not-event-emitter';

export default createESLintRule<Options, MessageIds>({
name: RULE_NAME,
meta: {
type: 'suggestion',
docs: {
description: 'Prefer to not declare `@Input` with an `EventEmitter`',
recommended: false,
},
hasSuggestions: true,
schema: [],
messages: {
inputNotEventEmitter:
'Prefer to not declare `@Input` with an `EventEmitter`',
suggestChangeInputToOutput: 'Change `@Input` to `@Output`',
},
},
defaultOptions: [],
create(context) {
return {
[`${Selectors.INPUT_DECORATOR} > ${Selectors.OUTPUT_DECORATOR}`]({
parent: type,
}: {
parent: TSESTree.Decorator;
}) {
context.report({
node: type,
messageId: 'inputNotEventEmitter',
suggest: [
{
messageId: 'suggestChangeInputToOutput',
fix: (fixer) => fixer.replaceText(type, '@Output '),
},
],
});
},
};
},
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { convertAnnotatedSourceToFailureCase } from '@angular-eslint/utils';
import type { MessageIds } from '../../../src/rules/input-not-event-emitter';

const messageId: MessageIds = 'inputNotEventEmitter';
const suggestChangeInputToOutput: MessageIds = 'suggestChangeInputToOutput';

export const valid = [
`
class Test {
testEmitter = new EventEmitter<string>();
}
`,
`
class Test {
@Output() readonly testEmitter = new EventEmitter<string>();
}
`,
];

export const invalid = [
convertAnnotatedSourceToFailureCase({
description: 'should fail when an @Input is declared as an `EventEmitter`',
annotatedSource: `
class Test {
@Input() readonly testEmitter = new EventEmitter<string>();
~~~~~~~~
}
`,
messageId,
suggestions: [
{
messageId: suggestChangeInputToOutput,
output: `
class Test {
@Output() readonly testEmitter = new EventEmitter<string>();

}
`,
},
],
}),
];
12 changes: 12 additions & 0 deletions packages/eslint-plugin/tests/rules/input-not-event-emitter/spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { RuleTester } from '@angular-eslint/utils';
import rule, { RULE_NAME } from '../../../src/rules/input-not-event-emitter';
import { invalid, valid } from './cases';

const ruleTester = new RuleTester({
parser: '@typescript-eslint/parser',
});

ruleTester.run(RULE_NAME, rule, {
valid,
invalid,
});