Skip to content

πŸ“š [2.0] Improvements and fixes to the useConsistentObjectDefinition rule pageΒ #2354

@dy0gu

Description

@dy0gu

Documentation URL

https://next.biomejs.dev/linter/rules/use-consistent-object-definition/

Description

Hi!

I was the author of the original PR for the useConsistentObjectDefinition implementation and now that the documentation is live I believe some things need to fixed/improved in that area.

  1. The rule description currently includes the phrase:

Defaults to explicit definitions.

However, this is redundant, as the default values for each option are already clearly documented in the Options section, which is generated through macros in the Rust code. This approach is more scalable and automatically maintained, making it unnecessary to repeat defaults in the rule description.

  1. The Valid/Invalid examples for "syntax": "shorthand" look good, but for "syntax": "explicit" the Invalid example does not show any Biome error output. I probably forgot to make Biome use the JSON options above those 2nd Valid/Invalid examples.

Expectations

The Invalid examples with the "syntax": "explicit" option should show the respective Biome error output.

Code of Conduct

  • I agree to follow Biome's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions