sindresorhus/eslint-plugin-unicorn

`no-object-as-default-parameter` should ignore for objects with required parameters

Open

#2,199 opened on 2023年10月9日

GitHub で見る
 (0 comments) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
bughelp wantedtypes

説明

Sometimes a method has a required set of option parameters. e.g. min and max.

function valueBetween(range: {min: number, max: number} = { min: 0, max: 10 }) {} ✔️

In this case it should be OK to use object default parameters because both min and max are required. Or to be more precise, it should be ok if defined default properties === required properties. It is not OK if any optional property is provided.

Yes, it it possible for plain JS users to fall through, but they are also likely to fail with the types in general or cause conflicts due to mismatching boundaries:

valueBetween({min: 'a', max: 10}); ❌
valueBetween({min: 100}); ❌

Otherwise it is impossible to implement the method parameter default in a type safe way.

function valueBetween(range: {min: number, max: number} = {} ❌) { // ts-error
    const { min = 0, max = 10 } = options;
}

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-object-as-default-parameter.md

function valueBetween(range: {min: number, max: number} = { min: 0, max: 10 }) {} :check ✔️
function valueBetween(range: {min: number, max: number, step: number} = { min: 0, max: 10 }) {} ❌
function valueBetween(range: {min: number, max: number, step?: number} = { min: 0, max: 10, step: 1 }) {} ❌

https://github.com/faker-js/faker/blob/fe3fb5dd3b8949d952aa8eb3830f58fc9cc4adcc/src/modules/lorem/index.ts#L377

コントリビューターガイド

`no-object-as-default-parameter` should ignore for objects with required parameters · sindresorhus/eslint-plugin-unicorn#2199 | Good First Issue