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: Missing metadata property (fixes #13349) #13412

Closed
wants to merge 1 commit into from

Conversation

ajkovar
Copy link

@ajkovar ajkovar commented Jun 12, 2020

If metadata property is missing, fixable essentially gets defaulted
to true. Described this behavior in the docs as well as added
recommendations to include metadata/type properties

Prerequisites checklist

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

[ ] 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
[X] Other, please explain:
Imrpoved docs (see commit message).

What changes did you make? (Give an overview)

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

If metadata property is missing, `fixable` essentially gets defaulted
to true.  Described this behavior in the docs as well as added
recommendations to include metadata/type properties
@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jun 12, 2020
@kaicataldo kaicataldo added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Jun 12, 2020
@nzakas
Copy link
Member

nzakas commented Jun 18, 2020

If metadata property is missing, fixable essentially gets defaulted
to true.

Hmm, that seems like a bug. Can you open an issue with a reproduction case?

@ajkovar
Copy link
Author

ajkovar commented Jun 18, 2020

If metadata property is missing, fixable essentially gets defaulted
to true.

Hmm, that seems like a bug. Can you open an issue with a reproduction case?

That was what #13349 was about, no?

A rule without meta is successfully fixed when it has a fixer.

Unless I'm misunderstanding. Seemed like the consensus there was to change the docs.

@ajkovar
Copy link
Author

ajkovar commented Jun 18, 2020

And by the way, I am (of course) open to any suggestions regarding the content of this PR or for closing it in favor of behavioral changes (although I think that original issue would need to be updated to reflect that). I only made changes here based on my interpretation of the discussion in that issue.

@nzakas
Copy link
Member

nzakas commented Jun 19, 2020

Oops thanks, I missed that. Let me dig in deeper.

@nzakas
Copy link
Member

nzakas commented Jun 19, 2020

Okay, so it looks like even though the issue was marked as "accepted" for a documentation change that there is still some debate whether that is the correct course of action or not. We can leave this PR open while we try to figure that out.

@nzakas nzakas added the do not merge This pull request should not be merged yet label Jun 19, 2020
@mdjermanovic
Copy link
Member

After further analysis in #13349, we realized this issue needs a completely different course of action, so I'm closing this PR.

@ajkovar Thanks for your contribution, and apologies. The fix you made was indeed in line with the solution that was accepted at that time.

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 18, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion do not merge This pull request should not be merged yet documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants