Skip to content

Commit

Permalink
feat(eslint-plugin): [no-type-alias]: add allowGenerics option (#3865)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottohara authored and rafaelss95 committed Sep 21, 2021
1 parent 25a42c0 commit 85b7de5
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 5 deletions.
23 changes: 23 additions & 0 deletions packages/eslint-plugin/docs/rules/no-type-alias.md
Expand Up @@ -89,6 +89,7 @@ or more of the following you may pass an object with the options set as follows:
- `allowLiterals` set to `"always"` will allow you to use type aliases with literal objects (Defaults to `"never"`)
- `allowMappedTypes` set to `"always"` will allow you to use type aliases as mapping tools (Defaults to `"never"`)
- `allowTupleTypes` set to `"always"` will allow you to use type aliases with tuples (Defaults to `"never"`)
- `allowGenerics` set to `"always"` will allow you to use type aliases with generics (Defaults to `"never"`)

### `allowAliases`

Expand Down Expand Up @@ -555,6 +556,28 @@ type Foo = [number] & [number, number];
type Foo = [string] | [number];
```

### `allowGenerics`

This applies to generic types, including TypeScript provided global utility types (`type Foo = Record<string, number>`).

The setting accepts the following options:

- `"always"` or `"never"` to active or deactivate the feature.

Examples of **correct** code for the `{ "allowGenerics": "always" }` options:

```ts
type Foo = Bar<string>;

type Foo = Record<string, number>;

type Foo = Readonly<Bar>;

type Foo = Partial<Bar>;

type Foo = Omit<Bar, 'a' | 'b'>;
```

## When Not To Use It

When you can't express some shape with an interface or you need to use a union, tuple type,
Expand Down
17 changes: 17 additions & 0 deletions packages/eslint-plugin/src/rules/no-type-alias.ts
Expand Up @@ -27,6 +27,7 @@ type Options = [
allowLiterals?: Values;
allowMappedTypes?: Values;
allowTupleTypes?: Values;
allowGenerics?: 'always' | 'never';
},
];
type MessageIds = 'noTypeAlias' | 'noCompositionAlias';
Expand Down Expand Up @@ -79,6 +80,9 @@ export default util.createRule<Options, MessageIds>({
allowTupleTypes: {
enum: enumValues,
},
allowGenerics: {
enum: ['always', 'never'],
},
},
additionalProperties: false,
},
Expand All @@ -93,6 +97,7 @@ export default util.createRule<Options, MessageIds>({
allowLiterals: 'never',
allowMappedTypes: 'never',
allowTupleTypes: 'never',
allowGenerics: 'never',
},
],
create(
Expand All @@ -106,6 +111,7 @@ export default util.createRule<Options, MessageIds>({
allowLiterals,
allowMappedTypes,
allowTupleTypes,
allowGenerics,
},
],
) {
Expand Down Expand Up @@ -203,6 +209,13 @@ export default util.createRule<Options, MessageIds>({
return false;
};

const isValidGeneric = (type: TypeWithLabel): boolean => {
return (
type.node.type === AST_NODE_TYPES.TSTypeReference &&
type.node.typeParameters !== undefined
);
};

const checkAndReport = (
optionValue: Values,
isTopLevel: boolean,
Expand Down Expand Up @@ -260,6 +273,10 @@ export default util.createRule<Options, MessageIds>({
} else if (isValidTupleType(type)) {
// tuple types
checkAndReport(allowTupleTypes!, isTopLevel, type, 'Tuple Types');
} else if (isValidGeneric(type)) {
if (allowGenerics === 'never') {
reportError(type.node, type.compositionType, isTopLevel, 'Generics');
}
} else if (
// eslint-disable-next-line @typescript-eslint/internal/prefer-ast-types-enum
type.node.type.endsWith('Keyword') ||
Expand Down
27 changes: 23 additions & 4 deletions packages/eslint-plugin/src/rules/prefer-regexp-exec.ts
Expand Up @@ -75,13 +75,31 @@ export default createRule({
return result;
}

function isLikelyToContainGlobalFlag(
node: TSESTree.CallExpressionArgument,
): boolean {
if (
node.type === AST_NODE_TYPES.CallExpression ||
node.type === AST_NODE_TYPES.NewExpression
) {
const [, flags] = node.arguments;
return (
flags.type === AST_NODE_TYPES.Literal &&
typeof flags.value === 'string' &&
flags.value.includes('g')
);
}

return node.type === AST_NODE_TYPES.Identifier;
}

return {
"CallExpression[arguments.length=1] > MemberExpression.callee[property.name='match'][computed=false]"(
memberNode: TSESTree.MemberExpression,
): void {
const objectNode = memberNode.object;
const callNode = memberNode.parent as TSESTree.CallExpression;
const argumentNode = callNode.arguments[0];
const [argumentNode] = callNode.arguments;
const argumentValue = getStaticValue(argumentNode, globalScope);

if (
Expand All @@ -96,9 +114,10 @@ export default createRule({

// Don't report regular expressions with global flag.
if (
argumentValue &&
argumentValue.value instanceof RegExp &&
argumentValue.value.flags.includes('g')
(!argumentValue && isLikelyToContainGlobalFlag(argumentNode)) ||
(argumentValue &&
argumentValue.value instanceof RegExp &&
argumentValue.value.flags.includes('g'))
) {
return;
}
Expand Down
17 changes: 17 additions & 0 deletions packages/eslint-plugin/tests/rules/no-type-alias.test.ts
Expand Up @@ -481,6 +481,10 @@ type KeyNames = keyof typeof SCALARS;
code: 'type Foo = new (bar: number) => string | null;',
options: [{ allowConstructors: 'always' }],
},
{
code: 'type Foo = Record<string, number>;',
options: [{ allowGenerics: 'always' }],
},
],
invalid: [
{
Expand Down Expand Up @@ -3329,5 +3333,18 @@ type Foo<T> = {
},
],
},
{
code: 'type Foo = Record<string, number>;',
errors: [
{
messageId: 'noTypeAlias',
data: {
alias: 'generics',
},
line: 1,
column: 12,
},
],
},
],
});
58 changes: 57 additions & 1 deletion packages/eslint-plugin/tests/rules/prefer-regexp-exec.test.ts
@@ -1,5 +1,5 @@
import rule from '../../src/rules/prefer-regexp-exec';
import { RuleTester, getFixturesRootDir } from '../RuleTester';
import { getFixturesRootDir, RuleTester } from '../RuleTester';

const rootPath = getFixturesRootDir();

Expand Down Expand Up @@ -56,6 +56,24 @@ const matchers = [{ match: (s: RegExp) => false }];
const file = '';
matchers.some(matcher => !!file.match(matcher));
`,
// https://github.com/typescript-eslint/typescript-eslint/issues/3477
`
function test(pattern: string) {
'hello hello'.match(RegExp(pattern, 'g'))?.reduce(() => []);
}
`,
// https://github.com/typescript-eslint/typescript-eslint/issues/3477
`
function test(pattern: string) {
'hello hello'.match(new RegExp(pattern, 'gi'))?.reduce(() => []);
}
`,
// https://github.com/typescript-eslint/typescript-eslint/issues/3477
`
const matchCount = (str: string, re: RegExp) => {
return (str.match(re) || []).length;
};
`,
],
invalid: [
{
Expand Down Expand Up @@ -174,6 +192,44 @@ function f<T extends 'a' | 'b'>(s: T) {
output: `
function f<T extends 'a' | 'b'>(s: T) {
/thing/.exec(s);
}
`,
},
{
code: `
const text = 'something';
const search = new RegExp('test', '');
text.match(search);
`,
errors: [
{
messageId: 'regExpExecOverStringMatch',
line: 4,
column: 6,
},
],
output: `
const text = 'something';
const search = new RegExp('test', '');
search.exec(text);
`,
},
{
code: `
function test(pattern: string) {
'check'.match(new RegExp(pattern, undefined));
}
`,
errors: [
{
messageId: 'regExpExecOverStringMatch',
line: 3,
column: 11,
},
],
output: `
function test(pattern: string) {
new RegExp(pattern, undefined).exec('check');
}
`,
},
Expand Down

0 comments on commit 85b7de5

Please sign in to comment.