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.

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

fix(eslint-plugin): [ban-types] update message to suggest object instead of Record<string, unknown> #6079

Merged
merged 19 commits into from Dec 7, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
27 changes: 13 additions & 14 deletions packages/eslint-plugin/src/rules/ban-types.ts
Expand Up @@ -3,16 +3,14 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';

import * as util from '../util';

type Types = Record<
string,
| null
| false
| string
type Types =
| object
| {
message: string;
fixWith?: string;
}
>;
[key: string]: {
message: string;
fixWith?: string;
};
};

export type Options = [
{
Expand All @@ -33,9 +31,10 @@ function stringifyNode(
return removeSpaces(sourceCode.getText(node));
}

function getCustomMessage(
bannedType: null | string | { message?: string; fixWith?: string },
): string {
function getCustomMessage(bannedType: {
message?: string;
fixWith?: string;
}): string {
if (bannedType === null) {
return '';
}
Expand Down Expand Up @@ -86,14 +85,14 @@ const defaultTypes: Types = {
Object: {
message: [
'The `Object` type actually means "any non-nullish value", so it is marginally better than `unknown`.',
'- If you want a type meaning "any object", you probably want `Record<string, unknown>` instead.',
'- If you want a type meaning "any object", you probably want `object` instead.',
'- If you want a type meaning "any value", you probably want `unknown` instead.',
].join('\n'),
},
'{}': {
message: [
'`{}` actually means "any non-nullish value".',
'- If you want a type meaning "any object", you probably want `Record<string, unknown>` instead.',
'- If you want a type meaning "any object", you probably want `object` instead.',
'- If you want a type meaning "any value", you probably want `unknown` instead.',
'- If you want a type meaning "empty object", you probably want `Record<string, never>` instead.',
].join('\n'),
Expand Down
33 changes: 33 additions & 0 deletions packages/eslint-plugin/tests/rules/ban-types.test.ts
Expand Up @@ -388,6 +388,39 @@ let b: Foo<NS.Good>;
},
],
},

{
code: noFormat`
declare let j: unknown;
let m3 = { ...(j as Record<string, never>) };
`,
output: `
declare let j: unknown;
let m3 = { ...(j as object) };
`,
options: [
{
types: {
'Record<string, never>': {
message: 'Use object instead.',
fixWith: 'object',
},
},
},
],
errors: [
{
messageId: 'bannedTypeMessage',
data: {
name: 'Record<string,never>',
customMessage: ' Use object instead.',
},
line: 3,
column: 21,
},
],
},

JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
{
code: noFormat`
let foo: {} = {};
Expand Down