Skip to content

no-unneeded-ternary incorrect documentation for defaultAssignment option #12098

@mdjermanovic

Description

@mdjermanovic

This is a "documentation bug".

The version of ESLint you are using.

6.1.0

The problem you want to solve.

Documentation for defaultAssignment option of the no-unneeded-ternary rule is incorrect.

defaultAssignment = true means don't report expressions such as x ? x : y.

defaultAssignment = false means report expressions such as x ? x : y.

Default is true.

The rule doesn't actually check if the expression is in an assignment context. That's by design from the start (#3232 and #3260). It simply searches for all ternary expressions where test and consequent are same identifier.

Incorrect parts of the documentation are:

  1. The incorrect example:
/*eslint no-unneeded-ternary: "error"*/

var a = x === 2 ? true : false;

var a = x ? true : false;

var a = f(x ? x : 1);

The example is wrong, var a = f(x ? x : 1); is not a warning because of the default option value.

  1. The correct example:
/*eslint no-unneeded-ternary: "error"*/

var a = x === 2 ? "Yes" : "No";

var a = x !== false;

var a = x ? "Yes" : "No";

var a = x ? y : x;

var a = x ? x : 1;  // Note that this is only allowed as it on the right hand side of an assignment; this type of ternary is disallowed everywhere else. See defaultAssignment option below for more details.

The comment is wrong.

  1. defaultAssignment section

The defaultAssignment option allows expressions of the form x ? x : expr (where x is any identifier and expr is any expression) as the right hand side of assignments (but nowhere else).

The option (when true) allows such expressions everywhere.

Your take on the correct solution to problem.

Fix the documentation.

Perhaps also consider changing the name of the option for two reasons:

  • The Assignment part is confusing.
  • When the option name doesn't have an explicit prefix, true ususally means "enforce on", rather than "allow".

Maybe allowSameConsequent or allowSameIfTrue.

Are you willing to submit a pull request to implement this change?

Yes, I would be glad to do it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    acceptedThere is consensus among the team that this change meets the criteria for inclusionarchived due to ageThis issue has been archived; please open a new issue for any further discussionbugESLint is working incorrectlydocumentationRelates to ESLint's documentationruleRelates to ESLint's core rules

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions