Allow for auto-formatting on save when using VSCode #981
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
make fmt
runs bothisort
andblack
on all files in the repository; however, it would also be nice for individual files to be formatted automatically on save. This PR updates the configuration applied bymake vscode-config
to include settings to run the equivalent of whatmake fmt
runs when saving a file.This PR also updates the
README
file with a link to the required VSCode extension and makes a note of the added functionality for the Make target and also adds theblack
andisort
configuration topyproject.toml
.Changes
make fmt
equivalents toexample_settings.json
README.md
pyproject.toml
Testing
make vscode-config
, installing the formatting extension, and saving a modified file with obvious formatting issues which were then resolved on save.