-
Notifications
You must be signed in to change notification settings - Fork 206
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 vscode defaults #1806
base: master
Are you sure you want to change the base?
add vscode defaults #1806
Conversation
It seems people are still removing newlines from files. Try to prevent. Signed-off-by: Rosen Penev <[email protected]>
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.
Multiplication of editor-specific configuration files for this kind of thing are an absolute antipattern. Let's not do this.
Please strongly urge vscode users that in order to respect the project coding standards they must install https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig |
As a vscode user I highly suggest editorconfig as well. I wonder if it would be better to add a linting checker to the MR that will fail if the final newline is removed? |
It is possible to use vscode extension suggestion file to recommand vscode users to use EditorConfig, And there are existing tools to apply editor config check on files: https://github.com/editorconfig-checker/editorconfig-checker |
You could also use something similar to https://pre-commit.com/ and do a a pre github action for checking result of pre-commit before launching other actions for building something similar to https://github.com/openslide/openslide-python/blob/602ddd8642e30d43cf5faaf27ee639b7ff1eb911/.github/workflows/python.yml#L18 https://github.com/openslide/openslide-python/blob/main/.pre-commit-config.yaml |
There's nothing "also" about that. pre-commit.com is just an inferior hijack of the concept of git pre-commit hooks, using an unreasonably restrictive and insecure dev workflow. The actual thing you end up running inside pre-commit.com would still be the same lint tool you would otherwise use directly in GitHub Actions. So that's really just a reiteration of
I think adding a linting checker in CI is the correct way to handle the concern that people aren't always enabling the editorconfig extension in their text editors. Although I'm opposed to using pre-commit.com as the entrypoint loader for such a CI, for several reasons. |
It seems people are still removing newlines from files. Try to prevent.