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
Documenting configuration hierarchy for CLIEngine options and 'useEslintrc: true' #9526
Documenting configuration hierarchy for CLIEngine options and 'useEslintrc: true' #9526
Comments
Hi @edmorley, thanks for the issue! The CLIEngine @eslint/eslint-team Anyone else have any thoughts? |
Ah true :-) Perhaps replacing:
...with:
...might be sufficient? |
@edmorley I'm so sorry for letting this slip through the cracks. I agree, we should just replace that header as you suggested in your comment. That would be a good start. I'll write a PR in a few days if nobody beats me to it. |
Hi, I'm new to this. But would like to give it a try, if that's ok with you all. |
@PilsFour Absolutely, please go ahead! If you haven't already, please check out our Contribution Guidelines on our website (I'll edit a link in here when I get to a PC). If it's not too much trouble, please just leave a comment here when you're starting work (or planning to work) on this. If something comes up and you can no longer work on this, just let us know. Absolutely no rush and no pressure either way; we just want to communicate with other people on this issue if the status changes. Thanks again for volunteering, and let us know if we can help with anything. Good luck! |
@platinumazure I have made the change to the documentation. Under Configuration Cascading and Hierarchy the preview looks fine to me. But being my first change I'm a bit unsure if thats fine. Could you please take a look if the commit is ok? I did try to run: Thank you for your help. |
@PiIsFour The change looks good to me. Don't worry, our Travis Continuous Integration service will check for issues when you create the pull request. I think |
Update documentation about configuration hierarchy for CLIEngine options
Update documentation about configuration hierarchy for CLIEngine options
Update documentation about configuration hierarchy for CLIEngine options
Hi! Many thanks for a great tool :-)
I was trying to work out from the docs, which options take precedence in the following example:
The CLIEngine docs just say:
And the docs on configuration hierarchy/precedence don't mention
CLIEngine
at all:From experimentation, I've found that the options passed to
CLIEngine
take priority over the ones in.eslintrc
, however I think it would be good to document this.I'm happy to open a PR to do so, but it would be useful to know whether I should do so on the configuration page, the API page, or both?
Many thanks!
The text was updated successfully, but these errors were encountered: