Make VS Code autoformat QL files on save #6809
Open
Conversation
Marcono1234
reviewed
Oct 4, 2021
| "omnisharp.autoStart": false | ||
| "omnisharp.autoStart": false, | ||
| "[ql]": { | ||
| "editor.formatOnSave": true, |
Note: When I typed this in VS Code it recommended "editor.wordBasedSuggestions": false, probably because the VS Code extension specifies that, see github/vscode-codeql#217. But it looks like this does not have to be specified here explicitly, it is apparently inherited from the extension settings.
|
Would a pre-commit hook be better? |
|
The Git documentation says:
Additionally it would require users to have the CodeQL CLI on their PATH, which might not be the case for everyone. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Specifies that VS Code autoformats QL files on save. This VS Code feature might not work correctly in some cases when used with auto-saving (see microsoft/vscode#45997 (comment)), but it hopefully works most of the time.
Autoformatting is quite useful because this repository enforces formatted QL files, and it is easy to forget manually formatting them.
Would it make sense to enable this for a 'trial' period and see what effects it has on regular development in this repository? E.g. whether it helps speeding up the work, or whether it hinder the work.
I am also not sure if for the queries of all programming languages in this repository formatting is enforced yet; if not, this pull request might cause undesired formatting changes.
The text was updated successfully, but these errors were encountered: