-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
dependenciesPull requests that update a dependency filePull requests that update a dependency fileenhancementNew feature or requestNew feature or requestgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codesemver:minoraddressing/merging the change would necessitate a minor semver releaseaddressing/merging the change would necessitate a minor semver release
Description
👁️🗨️ Conventions on indentation and ending new lines aren't consistent across and sometimes within a project. This issue hopes to discuss tooling we might use to improve this!
We might find this useful to avoid extraneous changes from appearing in PRs due to editor configurations.
Proposal
.editorconfig: https://editorconfig.org. An editor independent and configured formatter. Seems useful to guarantee lines end as expected and that indentation of bash files (for example) matches. IMHO language specific formatters should still be preferred when available -biomeorruff?- Editor support seems solid: VSCode has an extension and
neovimincludes this as a default. - Running in CI seems possible: https://github.com/editorconfig-checker/action-editorconfig-checker
- Editor support seems solid: VSCode has an extension and
To start I think a small set of checks can be useful:
[*]
end_of_line = lf
insert_final_newline = true
[*.json]
indent_style = space
indent_size = 2
[*.sh]
indent_style = space
indent_size = 4Metadata
Metadata
Assignees
Labels
dependenciesPull requests that update a dependency filePull requests that update a dependency fileenhancementNew feature or requestNew feature or requestgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codesemver:minoraddressing/merging the change would necessitate a minor semver releaseaddressing/merging the change would necessitate a minor semver release