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

Jump to bottom

Docs: On maxEOF with eol-last (fixes #12742) #13374

Merged
merged 6 commits into from Jun 11, 2020
Merged

Docs: On maxEOF with eol-last (fixes #12742) #13374

merged 6 commits into from Jun 11, 2020

Conversation

arthurdias-trad
Copy link
Contributor

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

I added a section in the documentation for the rule no-multiple-empty-lines explaining how and why maxEOF to zero when using the Airbnb style guide rule eol-last.

Is there anything you'd like reviewers to focus on?

@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
59d5d5c 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
e2faac1 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label May 30, 2020
@kaicataldo
Copy link
Member

eol-last is a core rule, so I'm not sure what this has to do with Airbnb. Do you mind clarifying?

@kaicataldo kaicataldo added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels May 30, 2020
@arthurdias-trad
Copy link
Contributor Author

arthurdias-trad commented May 30, 2020 •
edited

eol-last is a core rule, so I'm not sure what this has to do with Airbnb. Do you mind clarifying?

It was based on the discussion on the issue, so I thought it was worth mentioning. If you prefer, I can remove the mention to the Airbnb style guide (which requires the use of the eol-last core rule and simply leave the clarification on how best to use both rules together.

@kaicataldo
Copy link
Member

Yeah, since we're talking about two core rules here, I think it's best not to mention the Airbnb style guide. I think it's confusing, since it makes it sound like eol-last is an Airbnb rule. It can also introduce extra maintenance burden down the road, since we'll have to ensure that this documentation is kept up-to-date with changes Airbnb makes to their shared configuration.

@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
fa4a396 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@arthurdias-trad
Copy link
Contributor Author

Yeah, since we're talking about two core rules here, I think it's best not to mention the Airbnb style guide. I think it's confusing, since it makes it sound like eol-last is an Airbnb rule. It can also introduce extra maintenance burden down the road, since we'll have to ensure that this documentation is kept up-to-date with changes Airbnb makes to their shared configuration.

Done. Let me know if there are any other changes required.

@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
6ce9e96 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
0d47c93 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion rule Relates to ESLint's core rules labels Jun 5, 2020
@arthurdias-trad
Docs: On maxEOF with eol-last (fixes eslint#12742)
0e8cf53 
Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule.
@nzakas nzakas merged commit 1ee3c42 into eslint:master Jun 11, 2020
@mdjermanovic mdjermanovic mentioned this pull request Jun 22, 2020
Merged
1 task
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Dec 9, 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 Dec 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mdjermanovic mdjermanovic mdjermanovic requested changes

@nzakas nzakas nzakas approved these changes

@kaicataldo kaicataldo kaicataldo approved these changes

Assignees
No one assigned
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 rule Relates to ESLint's core rules
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@arthurdias-trad @kaicataldo @nzakas @mdjermanovic