feat(pkge): Add pre-commit badge to README #163 (#164)

Pre-commit badge communicates to potential users.
Updated README with pre-commit information.
Add pre-commit information to reference-project-inputs.

closes #163

README.rst

@@ -68,6 +68,8 @@ Features
    you choose to version and publish your package manually.
 #. An optional GitHub action to run your `Tox`_ package test suite when a
    pull request to the main branch starts.
+#. Optional to use to use `pre-commit`_ to identuify simple coding issues
+   before submission, with a badge to communicate quickly.
 #. `Tox`_ configuration for your package includes an OS and Python test matrix.
    OS includes Linux, macOS and Windows. Python 3.6 - 3.9. (Uses GitHub actions.)
 #. An optional suite of custom GitHub issue templates. The four custom issue
@@ -165,6 +167,7 @@ make my own packaging experience better.
 .. _Diataxis: https://diataxis.fr/
 .. _Mkdocs: https://pypi.org/project/mkdocs/
 .. _Poetry: https://python-poetry.org/
+.. _pre-commit: https://pre-commit.com/
 .. _Projects: https://github.com/imAsparky/cookiecutter-py3-package/projects
 .. _PyPi: https://pypi.python.org/pypi
 .. _pyup.io: https://pyup.io/

cookiecutter.json

@@ -11,14 +11,14 @@
   "use_repo_status_badge": ["no", "concept", "wip", "active"],
   "add_pyup_badge": "n",
   "use_readthedocs": ["y", "n"],
+  "use_pre_commit": "y",
   "command_line_interface": ["Click", "Argparse", "No command-line interface"],
   "create_author_file": "y",
   "create_conventional_commits_edit_message": "y",
   "create_repo_auto_test_workflow": "y",
   "create_auto_CHANGELOG": "n",
   "github_CHANGELOG_access_token": ["secrets.GITHUB_TOKEN", "secrets.CHANGELOG_UPDATE"],
   "use_GH_action_semantic_version": "y",
-  "use_pre_commit": "y",
   "use_GH_custom_issue_templates": "y",
   "automatic_set_up_git_and_initial_commit": "y",
   "use_release_to_test_pypi_with_tags": "n",

docs/source/reference/reference-project-inputs.rst

@@ -94,6 +94,12 @@ project.
 
   Requires a free Read the Docs account.
 
+**use_pre_commit**
+  *default = y*
+
+  Pre-commit  is useful for identifying simple issues before submission
+  to code review.
+
 
 **command_line_interface**
   *default = Click*

tests/test_bake_project.py

@@ -577,6 +577,8 @@ def test_bake_with_pre_commit(cookies):
 
         pre_commit_with_files = [f.basename for f in result.project.listdir()]
         assert ".pre-commit-config.yaml" in pre_commit_with_files
+        assert "pre--commit-enabled" in result.project.join("README.rst").read()
+        assert "pre-commit==" in result.project.join("requirements_dev.txt").read()
 
 
 def test_bake_without_pre_commit(cookies):
@@ -587,6 +589,8 @@ def test_bake_without_pre_commit(cookies):
 
         pre_commit_without_files = [f.basename for f in result.project.listdir()]
         assert ".pre-commit-config.yaml" not in pre_commit_without_files
+        assert "pre--commit-enabled" not in result.project.join("README.rst").read()
+        assert "pre-commit==" not in result.project.join("requirements_dev.txt").read()
 
 
 def test_bake_with_git_init_success(cookies):

{{cookiecutter.git_project_name}}/README.rst

@@ -15,6 +15,12 @@
    :alt: Updates
 {%- endif %}
 
+{%- if cookiecutter.use_pre_commit == "y" %}
+.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: pre-commit
+{%- endif %}
+
 {%- if cookiecutter.use_readthedocs == "y" %}
 .. image:: https://readthedocs.org/projects/{{cookiecutter.git_project_name}}/badge/?version=latest
    :target: https://{{cookiecutter.git_project_name}}.readthedocs.io/en/latest/?badge=latest

{{cookiecutter.git_project_name}}/requirements_dev.txt

@@ -2,7 +2,6 @@ cookiecutter==1.4.0
 flake8==3.7.8
 furo==2021.8.11b42
 myst-parser==0.15.2
-pre-commit==2.14.1
 pytest==6.2.4
 python-semantic-release==7.19.2
 Sphinx==4.1.2
@@ -12,5 +11,8 @@ wheel==0.37.0
 watchdog==2.1.5
 
 
+{% if cookiecutter.use_pre_commit == 'y' -%}
+pre-commit==2.14.1{% endif %}
+
 {% if cookiecutter.command_line_interface|lower == 'click' -%}
 Click==8.0.1{% endif %}