Skip to content

fix(eslint-plugin): [no-unsafe-assignment] be more specific about error types #8304

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 18 commits into from
Jun 5, 2024
Merged

fix(eslint-plugin): [no-unsafe-assignment] be more specific about error types #8304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
880eb39
fix: error assignment type issue
tobySolutions Jan 26, 2024
0d14cc4
refactor: error assignment type
tobySolutions Jan 26, 2024
1cecfef
refactor: error assignment type
tobySolutions Jan 26, 2024
af01290
refactor: error assignment type
tobySolutions Jan 26, 2024
61457cb
chore: resolve comments
tobySolutions Mar 25, 2024
4764ce3
fix: error type assignment tests
tobySolutions Jun 2, 2024
53ed246
Merge branch 'main' of https://github.com/tobySolutions/typescript-es…
tobySolutions Jun 2, 2024
e79ae86
fix: error type assignment tests
tobySolutions Jun 2, 2024
207d905
chore: change yarn lock
tobySolutions Jun 2, 2024
4b14cd0
fix: errot type assignments tests
tobySolutions Jun 2, 2024
da001c9
chore: remove unnecessary error type check function
tobySolutions Jun 2, 2024
809c291
refactor: rename every error ocurrence to error typed
tobySolutions Jun 2, 2024
602f6d9
refactor: rename every error ocurrence to error typed
tobySolutions Jun 2, 2024
ccb4d43
refactor: rename every error ocurrence to error typed
tobySolutions Jun 2, 2024
7ef8aef
fix CI issues
tobySolutions Jun 3, 2024
48e03a0
fix CI issues
tobySolutions Jun 3, 2024
7ef85ee
refactor: change create data from types function and add test data fo…
tobySolutions Jun 3, 2024
b70a2ca
refactor: remove unnecessary else
tobySolutions Jun 3, 2024
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
39 changes: 30 additions & 9 deletions packages/eslint-plugin/src/rules/no-unsafe-assignment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,18 @@ export default createRule({
requiresTypeChecking: true,
},
messages: {
anyAssignment: 'Unsafe assignment of an `any` value.',
anyAssignment: 'Unsafe assignment of an {{sender}} value.',
anyAssignmentThis: [
'Unsafe assignment of an `any` value. `this` is typed as `any`.',
'Unsafe assignment of an {{sender}} value. `this` is typed as `any`.',
'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.',
].join('\n'),
unsafeArrayPattern: 'Unsafe array destructuring of an `any` array value.',
unsafeArrayPattern:
'Unsafe array destructuring of an {{sender}} array value.',
unsafeArrayPatternFromTuple:
'Unsafe array destructuring of a tuple element with an `any` value.',
'Unsafe array destructuring of a tuple element with an {{sender}} value.',
unsafeAssignment:
'Unsafe assignment of type {{sender}} to a variable of type {{receiver}}.',
unsafeArraySpread: 'Unsafe spread of an `any` value in an array.',
unsafeArraySpread: 'Unsafe spread of an {{sender}} value in an array.',
},
schema: [],
},
Expand Down Expand Up @@ -88,6 +89,7 @@ export default createRule({
context.report({
node: receiverNode,
messageId: 'unsafeArrayPattern',
data: createData(senderType),
});
return false;
}
Expand Down Expand Up @@ -126,6 +128,7 @@ export default createRule({
context.report({
node: receiverElement,
messageId: 'unsafeArrayPatternFromTuple',
data: createData(senderType),
});
// we want to report on every invalid element in the tuple
didReport = true;
Expand Down Expand Up @@ -212,6 +215,7 @@ export default createRule({
context.report({
node: receiverProperty.value,
messageId: 'unsafeArrayPatternFromTuple',
data: createData(senderType),
});
didReport = true;
} else if (
Expand Down Expand Up @@ -275,7 +279,9 @@ export default createRule({
context.report({
node: reportingNode,
messageId,
data: createData(senderType),
});

return true;
}

Expand All @@ -297,10 +303,7 @@ export default createRule({
context.report({
node: reportingNode,
messageId: 'unsafeAssignment',
data: {
sender: checker.typeToString(sender),
receiver: checker.typeToString(receiver),
},
data: createData(sender, receiver),
});
return true;
}
Expand All @@ -315,6 +318,23 @@ export default createRule({
ComparisonType.None;
}

function createData(
senderType: ts.Type,
receiverType?: ts.Type,
): Readonly<Record<string, unknown>> | undefined {
if (receiverType) {
return {
sender: '`' + checker.typeToString(senderType) + '`',
receiver: '`' + checker.typeToString(receiverType) + '`',
};
}
return {
sender: tsutils.isIntrinsicErrorType(senderType)
? 'error typed'
: '`any`',
};
}

return {
'VariableDeclarator[init != null]'(
node: TSESTree.VariableDeclarator,
Expand Down Expand Up @@ -383,6 +403,7 @@ export default createRule({
context.report({
node: node,
messageId: 'unsafeArraySpread',
data: createData(restType),
});
}
},
Expand Down
8 changes: 4 additions & 4 deletions packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-unsafe-assignment.shot
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

74 changes: 64 additions & 10 deletions packages/eslint-plugin/tests/rules/no-unsafe-assignment.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ declare function Foo(props: Props): never;
},
},
},

{
code: `
declare function Foo(props: { a: string }): never;
Expand Down Expand Up @@ -195,7 +196,60 @@ class Foo {
`,
errors: [{ messageId: 'anyAssignment' }],
},
{
code: `
const [x] = spooky;
`,
errors: [
{
messageId: 'anyAssignment',
data: { sender: 'error typed', receiver: 'error typed' },
},
],
},
{
code: `
const [[[x]]] = [spooky];
`,
errors: [
{
messageId: 'unsafeArrayPatternFromTuple',
data: { sender: 'error typed', receiver: 'error typed' },
},
],
},
{
code: `
const {
x: { y: z },
} = { x: spooky };
`,
errors: [
{
messageId: 'unsafeArrayPatternFromTuple',
data: { sender: 'error typed', receiver: 'error typed' },
},
{
messageId: 'anyAssignment',
data: { sender: 'error typed', receiver: 'error typed' },
},
],
},
{
code: `
let value: number;

value = spooky;
`,
errors: [
{
messageId: 'anyAssignment',
data: {
sender: 'error typed',
},
},
],
},
{
code: `
const [x] = 1 as any;
Expand All @@ -215,8 +269,8 @@ const [x] = [] as any[];
{
messageId: 'unsafeAssignment',
data: {
sender: 'Set<any>',
receiver: 'Set<string>',
sender: '`Set<any>`',
receiver: '`Set<string>`',
},
},
],
Expand All @@ -227,8 +281,8 @@ const [x] = [] as any[];
{
messageId: 'unsafeAssignment',
data: {
sender: 'Map<string, any>',
receiver: 'Map<string, string>',
sender: '`Map<string, any>`',
receiver: '`Map<string, string>`',
},
},
],
Expand All @@ -239,8 +293,8 @@ const [x] = [] as any[];
{
messageId: 'unsafeAssignment',
data: {
sender: 'Set<any[]>',
receiver: 'Set<string[]>',
sender: '`Set<any[]>`',
receiver: '`Set<string[]>`',
},
},
],
Expand All @@ -251,8 +305,8 @@ const [x] = [] as any[];
{
messageId: 'unsafeAssignment',
data: {
sender: 'Set<Set<Set<any>>>',
receiver: 'Set<Set<Set<string>>>',
sender: '`Set<Set<Set<any>>>`',
receiver: '`Set<Set<Set<string>>>`',
},
},
],
Expand Down Expand Up @@ -327,8 +381,8 @@ const x = [...([] as any[])];
column: 43,
endColumn: 70,
data: {
sender: 'Set<Set<Set<any>>>',
receiver: 'Set<Set<Set<string>>>',
sender: '`Set<Set<Set<any>>>`',
receiver: '`Set<Set<Set<string>>>`',
},
},
],
Expand Down
Loading