Merge pull request #487 from NLeSC/457-optional-precommit

Make pre-commit optional

Author: lyashevska

CHANGELOG.md

@@ -15,6 +15,7 @@
 
 ### Changed
 
+* pre-commit script is optional ([#457](https://github.com/NLeSC/python-template/issues/457))
 * CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
 * Moved to src/ based layout for generated packages
 * Moved from setup.cfg/.py to pyproject.toml [#351](https://github.com/NLeSC/python-template/issues/351)

copier.yml

@@ -101,6 +101,12 @@ AddOnlineDocumentation:
   default: "{{ template_profile != 'minimum' }}"
   help: Online documentation using Read the Docs
 
+AddPreCommit:
+  when: "{{ template_profile == 'ask' }}"
+  type: bool
+  default: "{{ template_profile != 'minimum' }}"
+  help: Add pre-commit hook to check code style and format on every commit?
+
 # internal fields
 _subdirectory: template
 

template/README.dev.md.jinja

@@ -77,11 +77,13 @@ ruff . --fix
 
 To fix readability of your code style you can use [yapf](https://github.com/google/yapf).
 
+{%- if AddPreCommit -%}
 You can enable automatic linting with `ruff` on commit by enabling the git hook from `.githooks/pre-commit`, like so:
 
 ```shell
 git config --local core.hooksPath .githooks
 ```
+{%- endif -%}
 
 ## Generating the API docs