Skip to content

feat(eslint-plugin): allow using void as a default type for a generic argument if allowInGenericTypeArguments is specified #5671

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
merged 15 commits into from
Oct 2, 2022
Merged

feat(eslint-plugin): allow using void as a default type for a generic argument if allowInGenericTypeArguments is specified #5671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0a7ccac
feat: allow using void as a default type for a generic argument
kazizi55 Sep 19, 2022
86b42da
test: allow using void as a default type for a generic argument
kazizi55 Sep 19, 2022
f2a4732
Merge branch 'main' into allow-using-void-as-default-for-generic
kazizi55 Sep 19, 2022
d889d9f
fix: build error
kazizi55 Sep 19, 2022
9b8ce1e
Merge branch 'main' into allow-using-void-as-default-for-generic
kazizi55 Sep 24, 2022
d03c941
fix: replace any
kazizi55 Sep 24, 2022
5225063
test: remove duplicate error
kazizi55 Sep 27, 2022
2ed96e1
fix: report invalidVoidNotReturnOrGeneric only one time
kazizi55 Sep 27, 2022
f0b5e70
Merge branch 'main' into allow-using-void-as-default-for-generic
kazizi55 Sep 27, 2022
be5c6f4
Update packages/eslint-plugin/src/rules/no-invalid-void-type.ts
kazizi55 Oct 2, 2022
a142182
Update packages/eslint-plugin/src/rules/no-invalid-void-type.ts
kazizi55 Oct 2, 2022
e0b9b0a
fix: rename function name
kazizi55 Oct 2, 2022
4b7ad41
refactor: delete isTSTypeParameter and inline
kazizi55 Oct 2, 2022
cfab851
Merge branch 'main' into allow-using-void-as-default-for-generic
kazizi55 Oct 2, 2022
508ab8f
refactor: checkDefaultVoid
kazizi55 Oct 2, 2022
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
25 changes: 25 additions & 0 deletions packages/eslint-plugin/src/rules/no-invalid-void-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,21 @@ export default util.createRule<[Options], MessageIds>({
}
}

/**
* @brief checks if the generic type parameter defaults to void
*/
function checkDefaultVoid(
node: TSESTree.TSVoidKeyword,
parentNode: TSESTree.TSTypeParameter,
): void {
if (parentNode.default !== node) {
context.report({
messageId: 'invalidVoidNotReturnOrGeneric',
node,
});
}
}

/**
* @brief checks that a union containing void is valid
* @return true if every member of the union is specified as a valid type in
Expand Down Expand Up @@ -162,6 +177,16 @@ export default util.createRule<[Options], MessageIds>({
return;
}

// allow <T = void> if allowInGenericTypeArguments is specified, and report if the generic type parameter extends void
if (
allowInGenericTypeArguments &&
node.parent.type === AST_NODE_TYPES.TSTypeParameter &&
node.parent.default?.type === AST_NODE_TYPES.TSVoidKeyword
) {
checkDefaultVoid(node, node.parent);
return;
}

// union w/ void must contain types from validUnionMembers, or a valid generic void type
if (
node.parent.type === AST_NODE_TYPES.TSUnionType &&
Expand Down
47 changes: 2 additions & 45 deletions packages/eslint-plugin/tests/rules/no-invalid-void-type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
'type Generic<T> = [T];',
'type voidPromiseUnion = void | Promise<void>;',
'type promiseNeverUnion = Promise<void> | never;',
'const arrowGeneric1 = <T = void>(arg: T) => {};',
'declare function functionDeclaration1<T = void>(arg: T): void;',
],
invalid: [
{
Expand All @@ -141,16 +143,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
},
],
},
{
code: 'const arrowGeneric1 = <T = void>(arg: T) => {};',
errors: [
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 28,
},
],
},
{
code: 'const arrowGeneric2 = <T extends void = void>(arg: T) => {};',
errors: [
Expand All @@ -159,11 +151,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
line: 1,
column: 34,
},
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 41,
},
],
},
{
Expand All @@ -176,16 +163,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
},
],
},
{
code: 'function functionGeneric1<T = void>(arg: T) {}',
errors: [
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 31,
},
],
},
{
code: 'function functionGeneric2<T extends void = void>(arg: T) {}',
errors: [
Expand All @@ -194,11 +171,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
line: 1,
column: 37,
},
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 44,
},
],
},
{
Expand All @@ -211,16 +183,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
},
],
},
{
code: 'declare function functionDeclaration1<T = void>(arg: T): void;',
errors: [
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 43,
},
],
},
{
code: 'declare function functionDeclaration2<T extends void = void>(arg: T): void;',
errors: [
Expand All @@ -229,11 +191,6 @@ ruleTester.run('allowInGenericTypeArguments: true', rule, {
line: 1,
column: 49,
},
{
messageId: 'invalidVoidNotReturnOrGeneric',
line: 1,
column: 56,
},
],
},
{
Expand Down