Merge pull request #42 from claui/format-check

Add task for format checks

Author: claui

{{ cookiecutter.pypi_package_name }}/.github/workflows/ci.yml

@@ -58,6 +58,9 @@ jobs:
       - name: Run linter
         run: poetry run poe linter
 
+      - name: Check for formatting style violations not covered by the linter
+        run: poetry run poe formatcheck
+
       - name: Run unit tests
         run: poetry run poe tests
 

{{ cookiecutter.pypi_package_name }}/CONTRIBUTING.md

@@ -147,6 +147,15 @@ To execute the linter, run:
 poetry run poe linter
 ```
 
+### Running the code formatting style check
+
+To check the code base for formatting style violations that are not
+covered by the linter, run:
+
+```shell
+poetry run poe formatcheck
+```
+
 ### Running the static type check
 
 To execute the static type check, run:

{{ cookiecutter.pypi_package_name }}/doc/sphinx/conf.py

@@ -42,6 +42,7 @@
     'deflist',
 ]
 
+
 def skip_module(app, what, name, obj, skip, options):
     if what != 'module':
         return skip

{{ cookiecutter.pypi_package_name }}/pyproject.toml

@@ -50,6 +50,7 @@ mypy = ">=1.8"
 poethepoet = ">=0.24"
 pylint = ">=3.0"
 pytest = "*"
+ruff = "*"
 {%- if cookiecutter.include_executable == "y" %}
 types-colorama = "*"
 {%- endif %}
@@ -83,6 +84,8 @@ doc.shell = """
     sphinx-build -qW -b man doc/sphinx build/man
 """
 doc.help = "Generate documentation"
+formatcheck.cmd = "ruff format --check"
+formatcheck.help = "Check for formatting style violations not covered by the linter"
 {% if cookiecutter.include_executable == "y" -%}
 hello.script = "{{ cookiecutter.python_package_name }}.cli:hello"
 hello.help = "Run hello"

{{ cookiecutter.pypi_package_name }}/tests/test_{{ cookiecutter.first_module_name }}.py

@@ -15,5 +15,6 @@ def test_hello({{ cookiecutter.first_module_name }}: {{ cookiecutter.first_modul
 
 
 def test_hello_with_author_name({{ cookiecutter.first_module_name }}: {{ cookiecutter.first_module_name.capitalize() }}) -> None:
-    assert {{ cookiecutter.first_module_name }}.hello('{{ cookiecutter.author_full_name }}') \
-        == 'Hello, {{ cookiecutter.author_full_name }}!'
+    assert (
+        {{ cookiecutter.first_module_name }}.hello('{{ cookiecutter.author_full_name }}') == 'Hello, {{ cookiecutter.author_full_name }}!'
+    )

{{ cookiecutter.pypi_package_name }}/{{ cookiecutter.python_package_name }}/__main__.py

@@ -1,6 +1,5 @@
 """Run the command line interface by default."""
 
-
 from {{ cookiecutter.python_package_name }} import cli
 
 cli.run()

{{ cookiecutter.pypi_package_name }}/{{ cookiecutter.python_package_name }}/errors.py

@@ -1,5 +1,6 @@
 """Custom error types."""
 {% if cookiecutter.include_executable == "y" %}
+
 class CliError(Exception):
     """An user-facing error message."""
 {% endif -%}

{{ cookiecutter.pypi_package_name }}/{{ cookiecutter.python_package_name }}/version.py

@@ -26,12 +26,15 @@ def version() -> Optional[str]:
         with open(PYPROJECT_TOML, encoding='utf-8') as pyproject_toml:
             # Parse manually due to Debian 11 missing a `tomli` package
             version_lines = (
-                line for line in pyproject_toml
-                if line.startswith('version '))
-            return next(version_lines).split('=')[1].strip("'\"\n ")
+                line
+                for line in pyproject_toml
+                if line.startswith('version ')
+            )
+            return next(version_lines).split('=')[1].strip('\'"\n ')
 
     with suppress(FileNotFoundError):
         return importlib.metadata.version(
-            __package__ or __name__.split('.', maxsplit=1)[0])
+            __package__ or __name__.split('.', maxsplit=1)[0]
+        )
 
     return None

{{ cookiecutter.pypi_package_name }}/{{ cookiecutter.python_package_name }}/{{ cookiecutter.first_module_name }}.py

@@ -26,26 +26,32 @@ class {{ cookiecutter.first_module_name.capitalize() }}:
         The default value is: `/path/to/qux`
     """
 
-    def __init__(self,
+    def __init__(
+        self,
         {% if cookiecutter.use_alternative_union_syntax == "y" -%}
-        foobar: str | None=None,
+        foobar: str | None = None,
         {%- else -%}
-        foobar: Optional[str]=None,
+        foobar: Optional[str] = None,
         {%- endif %}
-        qux: str='/path/to/qux',
+        qux: str = '/path/to/qux',
     ) -> None:
-        if (merged_foobar := foobar or os.environ.get('FOOBAR', None)) is None:
+        if (
+            merged_foobar := foobar or os.environ.get('FOOBAR', None)
+        ) is None:
             {% if cookiecutter.include_executable == "y" -%}
-            raise CliError('The `--foobar` switch must be given if ' +
-                'no `FOOBAR` environment variable is defined.')
+            raise CliError(
+                'The `--foobar` switch must be given if '
+                + 'no `FOOBAR` environment variable is defined.'
+            )
             {%- else -%}
-            raise ValueError('The `foobar` argument must be given if ' +
-                'no `FOOBAR` environment variable is defined.')
+            raise ValueError(
+                'The `foobar` argument must be given if '
+                + 'no `FOOBAR` environment variable is defined.'
+            )
             {%- endif %}
         self._foobar = merged_foobar
         self._qux = qux
 
-
     def hello(self, name: str = 'world') -> str:  # pylint: disable=no-self-use
         """Says hello to someone.
 
@@ -63,12 +69,10 @@ def hello(self, name: str = 'world') -> str:  # pylint: disable=no-self-use
         logger.debug('Printing name: %s', name)
         return f'Hello, {name}!'
 
-
     def off(self) -> None:  # pylint: disable=no-self-use
         """Disables {{ cookiecutter.project_title }}."""
         logger.info('Disabling {{ cookiecutter.project_title }}')
 
-
     def on(self) -> None:  # pylint: disable=no-self-use
         """Enables {{ cookiecutter.project_title }}."""
         logger.info('Enabling {{ cookiecutter.project_title }}')
@@ -77,9 +81,9 @@ def on(self) -> None:  # pylint: disable=no-self-use
 def hello(
     name: str = 'world',
     {% if cookiecutter.use_alternative_union_syntax == "y" -%}
-    foobar: str | None=None,
+    foobar: str | None = None,
     {%- else -%}
-    foobar: Optional[str]=None,
+    foobar: Optional[str] = None,
     {%- endif %}
     qux: str = '/path/to/qux',
 ) -> str: