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

Jump to bottom

feat(eslint-plugin): add prefer-enum-initializers rule #2326

Merged
merged 12 commits into from Aug 2, 2020
Merged

feat(eslint-plugin): add prefer-enum-initializers rule #2326

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
da45a94
feat(eslint-plugin): add prefer-enum-initializers rule
bobstrange Jul 25, 2020
5e50f09
feat(eslint-plugin): add prefer-enum-initializers doc
bobstrange Jul 25, 2020
f7acc75
feat(eslint-plugin): run yarn run generate:configs
bobstrange Jul 25, 2020
a964e52
feat(eslint-plugin): provide suggestion
bobstrange Jul 28, 2020
f060e77
feat(eslint-plugin): fix tests
bobstrange Jul 28, 2020
9edb2b2
feat(eslint-plugin): suppress eslint violations
bobstrange Jul 28, 2020
80fd8aa
Merge 'eslint/master' into feature/prefer-enum-initializers
bobstrange Jul 28, 2020
52f08ec
feat(eslint-plugin): use exhaustive switch
bobstrange Jul 28, 2020
262e299
feat(eslint-plugin): fix lint
bobstrange Jul 28, 2020
a24c335
feat(eslint-plugin): suggest 3 variations at once
bobstrange Jul 28, 2020
4d58e38
feat(eslint-plugin): fix tests
bobstrange Jul 28, 2020
22c90c9
feat(eslint-plugin): use trimRight() instead of disabling eslint rule
bobstrange Jul 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 45 additions & 14 deletions packages/eslint-plugin/src/rules/prefer-enum-initializers.ts
View file
Open in desktop
@@ -1,41 +1,72 @@
import { TSESTree } from '@typescript-eslint/experimental-utils';
import * as util from '../util';
import { RuleFix } from '@typescript-eslint/experimental-utils/dist/ts-eslint';

export default util.createRule({
type Option = '0-based' | '1-based' | 'key-name';
type MessageIds = 'defineInitializer' | 'defineInitializerSuggestion';

export default util.createRule<Option[], MessageIds>({
name: 'prefer-enum-initializers',
meta: {
type: 'suggestion',
docs: {
description: 'Prefer initializing each enums member value',
category: 'Best Practices',
recommended: false,
suggestion: true,
},
messages: {
defineInitializer:
"The value of the member '{{ name }}' should be explicitly defined",
defineInitializerSuggestion:
'can be suggestion fixed to {{ name }} = {{ suggestedValue }}',
},
schema: [],
schema: [
{
enum: ['0-based', '1-based', 'key-name'],
},
],
},
defaultOptions: [],
create(context) {
const sourceCode = context.getSourceCode();
const config = context.options[0];

return {
TSEnumDeclaration(node: TSESTree.TSEnumDeclaration): void {
const { members } = node;
const violatingMembers = members.filter(member => {
return member.initializer == null;
members.forEach((member, index) => {
if (member.initializer == null) {
const name = sourceCode.getText(member);
context.report({
node: member,
messageId: 'defineInitializer',
data: {
name,
},
suggest: [
{
messageId: 'defineInitializerSuggestion',
data: { name },
fix: (fixer): RuleFix | null => {
if (config === '0-based') {
return fixer.replaceText(member, `${name} = ${index}`);
} else if (config === '1-based') {
return fixer.replaceText(
member,
`${name} = ${index + 1}`,
);
} else if (config === 'key-name') {
return fixer.replaceText(member, `${name} = '${name}'`);
} else {
return null;
}
},
},
],
bradzacher marked this conversation as resolved.
Show resolved Hide resolved
});
}
});

for (const member of violatingMembers) {
context.report({
node: member,
messageId: 'defineInitializer',
data: {
name: sourceCode.getText(member),
},
});
}
},
};
},
Expand Down
133 changes: 114 additions & 19 deletions packages/eslint-plugin/tests/rules/prefer-enum-initializers.test.ts
View file
Open in desktop
Expand Up @@ -25,12 +25,6 @@ enum Direction {
enum Direction {
Up = 'Up',
Down = 'Down',
}
`,
`
enum Direction {
Up = 1,
Down = 'Up',
}
`,
],
Expand All @@ -41,11 +35,24 @@ enum Direction {
Up,
}
`,
options: ['key-name'],
errors: [
{
messageId: 'defineInitializer',
data: { name: 'Up' },
line: 3,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up = 'Up',
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
],
},
Expand All @@ -56,76 +63,164 @@ enum Direction {
Down,
}
`,
options: ['key-name'],
errors: [
{
messageId: 'defineInitializer',
data: { name: 'Up' },
line: 3,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up = 'Up',
Down,
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
{
messageId: 'defineInitializer',
data: { name: 'Down' },
line: 4,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up,
Down = 'Down',
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
],
},
{
code: `
enum Direction {
Up = 1,
Down,
Up,
}
`,
options: ['0-based'],
errors: [
{
messageId: 'defineInitializer',
data: { name: 'Down' },
line: 4,
data: { name: 'Up' },
line: 3,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up = 0,
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
],
},
{
code: `
enum Direction {
Up,
Down = 2,
Down,
}
`,
options: ['0-based'],
errors: [
{
messageId: 'defineInitializer',
data: { name: 'Up' },
line: 3,
},
],
},
{
code: `
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up = 'Up',
Up = 0,
Down,
}
`,
errors: [
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
{
messageId: 'defineInitializer',
data: { name: 'Down' },
line: 4,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up,
Down = 1,
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
],
},
{
code: `
enum Direction {
Up,
Down = 'Down',
Down,
}
`,
options: ['1-based'],
errors: [
{
messageId: 'defineInitializer',
data: { name: 'Up' },
line: 3,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up = 1,
Down,
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
{
messageId: 'defineInitializer',
data: { name: 'Down' },
line: 4,
suggestions: [
{
messageId: 'defineInitializerSuggestion',
/* eslint-disable @typescript-eslint/internal/plugin-test-formatting */
output: `
enum Direction {
Up,
Down = 2,
}
`,
/* eslint-enable @typescript-eslint/internal/plugin-test-formatting */
},
],
},
],
},
Expand Down