-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add settings.json linter documentation #3368
base: master
Are you sure you want to change the base?
Conversation
Add a JSON example of how to enable linting in settings.json
As mentioned in #3366, I spent months trying to figure out how to get linting working. I definitely referenced the documentation, but there wasn't any clear documentation on how to set it up (via |
@@ -24,6 +24,14 @@ following filetypes and linters: | |||
* **swift**: swiftc (MacOS and Linux only) | |||
* **yaml**: yamllint | |||
|
|||
You can easily enable linting in your `settings.json` file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also mention the set linter on|off
command which is the easier way to do this.
This is already documented in Lines 465 to 486 in dc77592
I guess it doesn't hurt to repeat the same thing in the plugins own help file, but should we then add it to the help for the other built-in plugins too? It is also worth mentioning that linter is enabled by default when the "linter" key is absent from settings.json. |
I saw that, but the way I read it was more of these plugins with these names are available, and they each have some undisclosed setting name to enable/disable them. Especially since each key is followed by a description, that read more like a list of plugin names and descriptions than keys that go in the There is also a sample
That just makes me feel even more braindead... I probably copied all the settings to my
If that makes this addition make more sense, I'd be happy to do that :) Or if others feel this is indeed unnecessary redundancy, that's fair, too 😛 |
Add a JSON example of how to enable linting in settings.json