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

Docs: Clarify option "multiline" for object-curly-newline #11634

Closed
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue rule Relates to ESLint's core rules

Comments

@golopot
Copy link
Contributor

golopot commented Apr 19, 2019

The problem you want to solve.
The docs for option multiline for object-curly-newline failed to mention that when the contained properties is single line, line breaks are disallowed.

Your take on the correct solution to problem.

- "multiline": true requires line breaks if there are line breaks inside properties or between properties
+ "multiline": true requires line breaks if there are line breaks inside properties or between properties. Otherwise, it disallows line breaks.

The same issue holds for array-bracket-newline.
Are you willing to submit a pull request to implement this change?
Yes.

@golopot golopot added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Apr 19, 2019
@golopot golopot changed the title Clarify option "multiline" for object-curly-newline Docs: Clarify option "multiline" for object-curly-newline Apr 19, 2019
@platinumazure platinumazure added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules and removed core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Apr 19, 2019
@platinumazure
Copy link
Member

Hi @golopot, thanks for the issue.

This is just a documentation change to existing behavior, so I don't think we need to evaluate this as an enhancement proposal. I've marked this issue as accepted. Please feel free to submit a pull request at your convenience. Thanks!

@eslint-deprecated eslint-deprecated bot added the auto closed The bot closed this issue label Jul 19, 2019
@eslint-deprecated
Copy link

Unfortunately, it looks like there wasn't enough interest from the team
or community to implement this change. While we wish we'd be able to
accommodate everyone's requests, we do need to prioritize. We've found
that accepted issues failing to be implemented after 90 days tend to
never be implemented, and as such, we close those issues.
This doesn't mean the idea isn't interesting or useful, just that it's
not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.

@kaicataldo
Copy link
Member

Reopening since this is an accepted documentation change.

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Jan 18, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 18, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.