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

fix: mark --rulesdir option as deprecated in CLI docs #15310

Merged
merged 1 commit into from Nov 30, 2021

Conversation

platinumazure
Copy link
Member

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: Update docs and CLI option guide to note that --rulesdir is deprecated. (It has been considered deprecated for some time but these docs were missing that info.)

What changes did you make? (Give an overview)

Update docs and CLI option guide to note that --rulesdir is deprecated. (It has been considered deprecated for some time but these docs were missing that info.)

This is effectively a docs change, but commit is tagged as fix: due to changing code. The code change is just to reorder options (moving deprecated option to bottom of category) and adding deprecation note to help string.

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

Any concerns with reordering the options?

Can the CLI help string changes be improved, to maximize both readability and brevity?

@linux-foundation-easycla
Copy link

CLA Not Signed

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Nov 13, 2021
@platinumazure platinumazure reopened this Nov 13, 2021
@platinumazure
Copy link
Member Author

Created a new gpg key and had some trouble with getting EasyCLA and GitHub commit verification to pass. Should be good now, but please let me know if anything looks suspicious.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a bit of cleanup needed.

docs/user-guide/command-line-interface.md Show resolved Hide resolved
docs/user-guide/command-line-interface.md Show resolved Hide resolved
@nzakas nzakas merged commit 4940cc5 into eslint:main Nov 30, 2021
@platinumazure platinumazure deleted the deprecate-rulesdir branch November 30, 2021 13:08
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 30, 2022
@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 May 30, 2022
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 triage An ESLint team member will look at this issue soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants