Skip to content

feat(eslint-plugin): [restrict-template-expressions] improve error message #1926

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 3 commits into from
May 17, 2020
Merged

feat(eslint-plugin): [restrict-template-expressions] improve error message #1926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f76a42
fix(eslint-plugin): [restrict-template-expressions] Add missing defau…
ulrichb Apr 22, 2020
e49b80f
feat(eslint-plugin): [restrict-template-expressions] Improve message …
ulrichb Apr 22, 2020
6188e88
Merge branch 'master' into feat/ImproveRestrictTemplateMessage
bradzacher May 17, 2020
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/docs/rules/restrict-template-expressions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ type Options = {
const defaults = {
allowNumber: false,
allowBoolean: false,
allowAny: false,
allowNullable: false,
};
```
Expand Down
38 changes: 18 additions & 20 deletions packages/eslint-plugin/src/rules/restrict-template-expressions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default util.createRule<Options, MessageId>({
requiresTypeChecking: true,
},
messages: {
invalidType: 'Invalid type of template literal expression.',
invalidType: 'Invalid type "{{type}}" of template literal expression.',
},
schema: [
{
Expand Down Expand Up @@ -90,46 +90,44 @@ export default util.createRule<Options, MessageId>({
}

for (const expression of node.expressions) {
const expressionType = util.getConstrainedTypeAtLocation(
typeChecker,
service.esTreeNodeToTSNodeMap.get(expression),
);

if (
!isUnderlyingExpressionTypeConfirmingTo(
expression,
!isInnerUnionOrIntersectionConformingTo(
expressionType,
isUnderlyingTypePrimitive,
)
) {
context.report({
node: expression,
messageId: 'invalidType',
data: { type: typeChecker.typeToString(expressionType) },
});
}
}
},
};

function isUnderlyingExpressionTypeConfirmingTo(
expression: TSESTree.Expression,
function isInnerUnionOrIntersectionConformingTo(
type: ts.Type,
predicate: (underlyingType: ts.Type) => boolean,
): boolean {
return rec(getExpressionNodeType(expression));
return rec(type);

function rec(type: ts.Type): boolean {
if (type.isUnion()) {
return type.types.every(rec);
function rec(innerType: ts.Type): boolean {
if (innerType.isUnion()) {
return innerType.types.every(rec);
}

if (type.isIntersection()) {
return type.types.some(rec);
if (innerType.isIntersection()) {
return innerType.types.some(rec);
}

return predicate(type);
return predicate(innerType);
}
}

/**
* Helper function to extract the TS type of an TSESTree expression.
*/
function getExpressionNodeType(node: TSESTree.Expression): ts.Type {
const tsNode = service.esTreeNodeToTSNodeMap.get(node);
return util.getConstrainedTypeAtLocation(typeChecker, tsNode);
}
},
});
87 changes: 78 additions & 9 deletions packages/eslint-plugin/tests/rules/restrict-template-expressions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,48 +214,92 @@ ruleTester.run('restrict-template-expressions', rule, {
code: `
const msg = \`arg = \${123}\`;
`,
errors: [{ messageId: 'invalidType', line: 2, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: '123' },
line: 2,
column: 30,
},
],
},
{
code: `
const msg = \`arg = \${false}\`;
`,
errors: [{ messageId: 'invalidType', line: 2, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: 'false' },
line: 2,
column: 30,
},
],
},
{
code: `
const msg = \`arg = \${null}\`;
`,
errors: [{ messageId: 'invalidType', line: 2, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: 'null' },
line: 2,
column: 30,
},
],
},
{
code: `
declare const arg: number;
const msg = \`arg = \${arg}\`;
`,
errors: [{ messageId: 'invalidType', line: 3, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: 'number' },
line: 3,
column: 30,
},
],
},
{
code: `
declare const arg: boolean;
const msg = \`arg = \${arg}\`;
`,
errors: [{ messageId: 'invalidType', line: 3, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: 'boolean' },
line: 3,
column: 30,
},
],
},
{
options: [{ allowNumber: true, allowBoolean: true, allowNullable: true }],
code: `
const arg = {};
const msg = \`arg = \${arg}\`;
`,
errors: [{ messageId: 'invalidType', line: 3, column: 30 }],
errors: [
{ messageId: 'invalidType', data: { type: '{}' }, line: 3, column: 30 },
],
},
{
code: `
declare const arg: { a: string } & { b: string };
const msg = \`arg = \${arg}\`;
`,
errors: [{ messageId: 'invalidType', line: 3, column: 30 }],
errors: [
{
messageId: 'invalidType',
data: { type: '{ a: string; } & { b: string; }' },
line: 3,
column: 30,
},
],
},
{
options: [{ allowNumber: true, allowBoolean: true, allowNullable: true }],
Expand All @@ -264,7 +308,25 @@ ruleTester.run('restrict-template-expressions', rule, {
return \`arg = \${arg}\`;
}
`,
errors: [{ messageId: 'invalidType', line: 3, column: 27 }],
errors: [
{ messageId: 'invalidType', data: { type: '{}' }, line: 3, column: 27 },
],
},
{
options: [{ allowNumber: true, allowBoolean: true, allowNullable: true }],
code: `
function test<TWithNoConstraint>(arg: T) {
return \`arg = \${arg}\`;
}
`,
errors: [
{
messageId: 'invalidType',
data: { type: 'any' },
line: 3,
column: 27,
},
],
},
{
options: [{ allowNumber: true, allowBoolean: true, allowNullable: true }],
Expand All @@ -273,7 +335,14 @@ ruleTester.run('restrict-template-expressions', rule, {
return \`arg = \${arg}\`;
}
`,
errors: [{ messageId: 'invalidType', line: 3, column: 27 }],
errors: [
{
messageId: 'invalidType',
data: { type: 'any' },
line: 3,
column: 27,
},
],
},
],
});