Don't force "format on save" setting on contributors #31
+0
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `editor.formatOnSave` VS Code setting controls whether file are automatically formatted when saved. Checking a VS Code workspace settings configuration file into the repository with this setting enabled seems like it would increase the likelihood of contributions being properly formatted. Unfortunately, in this case it does just the opposite. The reason is that no formatter and configuration is provided, so VS Code formats the code according to whatever formatter and configuration the contributor happens to have set up for TypeScript. In my case, that is Prettier, the default configuration of which causes extensive formatting changes on save. This will result in the following scenarios: - Conscientious contributors waste time reverting unexpected diffs and figuring out how to prevent future ones - Other contributors submit low quality contributions - Maintainers waste time review contributions with large diffs unrelated to the proposal - Conscientious maintainers waste time cajoling contributors into removing unrelated changes from their contributions - Other maintainers allow large unrelated diffs to be introduced into the repository Ideally, the infrastructure of the project would be set up to enforce standard code style compliance from contributions. But until that happens, it is best to remove this harmful setting.
per1234
added
topic: infrastructure
kittaakos
approved these changes
Jul 11, 2022
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
editor.formatOnSaveVS Code setting controls whether file are automatically formatted when saved.Checking a VS Code workspace settings configuration file into the repository with this setting enabled seems like it would increase the likelihood of contributions being properly formatted. Unfortunately, in this case it does just the opposite. The reason is that no formatter and configuration is provided, so VS Code formats the code according to
whatever formatter and configuration the contributor happens to have set up for TypeScript. In my case, that is Prettier, the default configuration of which causes extensive formatting changes on save.
This will result in the following scenarios:
Ideally, the infrastructure of the project would be set up to enforce standard code style compliance from contributions. But until that happens, it is best to remove this harmful setting.