Skip to content

Commit

Permalink
refactor(templates): use coatl-dev/docformatter pre-commit hook (#37)
Browse files Browse the repository at this point in the history
PyCQA/docformatter v1.7.5 pre-commit hook is not compatible with pre-commit 4
  • Loading branch information
cesarcoatl authored Jan 8, 2025
1 parent 77272e0 commit 3bd6e1e
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ignition-devs [copier] templates for Ignition projects.

- Git
- [Python 2.7.18] (for `jython-package` and `python2-package`)
- [Python 3.12]
- Python 3.12 (for [mypy])
- [copier]

```sh
Expand All @@ -17,6 +17,7 @@ ignition-devs [copier] templates for Ignition projects.

### ignition-project

- Automated code checks before committing to version control using [pre-commit]
- Pre-configured tools for code formatting, quality analysis and testing:
- [black]
- [docformatter]
Expand All @@ -32,6 +33,7 @@ ignition-devs [copier] templates for Ignition projects.

### jython-package

- Automated code checks before committing to version control using [pre-commit]
- Pre-configured tools for code formatting, quality analysis and testing:
- [black]
- [docformatter]
Expand All @@ -48,6 +50,7 @@ ignition-devs [copier] templates for Ignition projects.

### python2-package

- Automated code checks before committing to version control using [pre-commit]
- Pre-configured tools for code formatting, quality analysis and testing:
- [black]
- [docformatter]
Expand All @@ -64,6 +67,7 @@ ignition-devs [copier] templates for Ignition projects.

### python3-stubs

- Automated code checks before committing to version control using [pre-commit]
- Pre-configured tools for code formatting, quality analysis and testing:
- [black]
- [docformatter]
Expand Down Expand Up @@ -96,14 +100,14 @@ copier update --defaults
[copier]: https://copier.readthedocs.io/en/stable/
[Jython 2.7.3]: https://repo1.maven.org/maven2/org/python/jython-installer/2.7.3/
[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/
[Python 3.12]: https://www.python.org/downloads/release/python-3214/
<!-- Tools -->
[black]: https://black.readthedocs.io/en/stable/
[docformatter]: https://docformatter.readthedocs.io/en/stable/
[flake8]: https://flake8.pycqa.org/en/5.0.4/
[isort]: https://pycqa.github.io/isort/
[make]: https://www.gnu.org/software/make/
[mypy]: https://coatl-mypy.readthedocs.io/en/v0.971/
[pre-commit]: https://pre-commit.com/
[pydocstyle]: https://www.pydocstyle.org/en/6.3.0/
[pylint]: https://pylint.readthedocs.io/en/stable/
[sort-all]: https://github.com/aio-libs/sort-all
Expand Down
4 changes: 2 additions & 2 deletions ignition-project/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ repos:
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/PyCQA/docformatter
rev: v1.7.5
- repo: https://github.com/coatl-dev/docformatter
rev: v1.7.6
hooks:
- id: docformatter
args: [--in-place, --close-quotes-on-newline, --wrap-summaries=72]
Expand Down
4 changes: 2 additions & 2 deletions jython-package/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ repos:
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/PyCQA/docformatter
rev: v1.7.5
- repo: https://github.com/coatl-dev/docformatter
rev: v1.7.6
hooks:
- id: docformatter
args: [--in-place, --close-quotes-on-newline, --wrap-summaries=72]
Expand Down
4 changes: 2 additions & 2 deletions python2-package/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ repos:
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/PyCQA/docformatter
rev: v1.7.5
- repo: https://github.com/coatl-dev/docformatter
rev: v1.7.6
hooks:
- id: docformatter
args: [--in-place, --close-quotes-on-newline, --wrap-summaries=72]
Expand Down

0 comments on commit 3bd6e1e

Please sign in to comment.