Description
Is your feature request related to a problem? Please describe.
A properly configured editor will format-on-save to ensure a consistent coding style. However, when entering this monorepo, there's no information about the formatter used, so saving generates unnecessary diffs.
Describe the solution you'd like
- Projects should indicate in their
README.md
which formatter they use and provide a setting file (ex:pyproject.toml
) - Projects should have an
.editorconfig
file to help formatting with editors that are not configured to support Python or Scala or that project's particular programming language
Describe alternatives you've considered
Projects could share recommended IDE-specific configurations that ease the onboarding of new developers to the project (ex: .vscode
, but not .idea
)
Additional context
For example, SvelteKit have a .prettierrc
file, so new developers know to install Prettier and use that.
Another example is GitHub Desktop, which has a .vscode
that recommends Prettier and ESLint and enforces format on save.
Another example from a very popular repository is gitflow-avh
. It has an .editorconfig
file that allows editors which don't support Shell to use the project's tab preferences by default.