Skip to content

Commit

Permalink
Add documentation about prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
kenibrewer authored Oct 17, 2023
1 parent b199311 commit 51f48b0
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
1 change: 1 addition & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[*]
max_line_length = 120

[*.json]
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down
14 changes: 14 additions & 0 deletions docs/features/linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 51f48b0

Please sign in to comment.