diff --git a/.editorconfig b/.editorconfig index 9395b54..64b7dff 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,3 +1,4 @@ +[*] max_line_length = 120 [*.json] diff --git a/README.md b/README.md index 134d33d..f846a99 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,12 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro - [Poetry](https://python-poetry.org/) for dependency management - CI/CD with [GitHub Actions](https://github.com/features/actions) - Pre-commit hooks with [pre-commit](https://pre-commit.com/) -- Code quality with [black](https://pypi.org/project/black/), [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), and [deptry](https://github.com/fpgmaas/deptry/) +- Code quality with: + - [black](https://pypi.org/project/black/) + - [ruff](https://github.com/charliermarsh/ruff) + - [mypy](https://mypy.readthedocs.io/en/stable/) + - [deptry](https://github.com/fpgmaas/deptry/) + - [prettier](https://prettier.io/) - Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub - Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/) - Documentation with [MkDocs](https://www.mkdocs.org/) diff --git a/docs/features/linting.md b/docs/features/linting.md index 00f5e73..2135402 100644 --- a/docs/features/linting.md +++ b/docs/features/linting.md @@ -119,6 +119,20 @@ exclude = [ ] ``` +# Prettier + +[Prettier](https://prettier.io/) is used to format the markdown documentation, along with any json and yaml files. +Its options can be configured in the included `.editorconfig` file or in greater detail by adding a `.prettierrc` file ([See Docs](https://prettier.io/docs/en/configuration)). + +```yaml +[*] +max_line_length = 120 + +[*.json] +indent_style = space +indent_size = 4 +``` + ## Github Actions If `include_github_actions` is set to `"y"`, code formatting is checked