Use ruff, wps@1.1, pre-commit CI (#532)

Author: sobolevn

.github/dependabot.yml

@@ -6,18 +6,13 @@ updates:
     interval: daily
     time: "02:00"
   open-pull-requests-limit: 10
+
 - package-ecosystem: pip
   directory: "/{{cookiecutter.project_name}}"
   schedule:
     interval: daily
     time: "02:00"
   open-pull-requests-limit: 10
-- package-ecosystem: pip
-  directory: "/{{cookiecutter.project_name}}/docs"
-  schedule:
-    interval: daily
-    time: "02:00"
-  open-pull-requests-limit: 10
 
 - package-ecosystem: github-actions
   directory: "/"

.github/workflows/test.yml

@@ -20,10 +20,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -34,7 +37,7 @@ jobs:
         curl -sSL "https://install.python-poetry.org" | python
 
         # Adding `poetry` to `$PATH`:
-        echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+        echo "$HOME/.poetry/bin" >> "$GITHUB_PATH"
 
     - name: Install dependencies
       run: |
@@ -44,8 +47,14 @@ jobs:
 
     - name: Run checks
       run: |
+        poetry run ruff check --exit-non-zero-on-fix --diff
+        poetry run ruff format --check --diff
         poetry run flake8 .
+        poetry run mypy .
         poetry run pytest
         poetry run poetry check
         poetry run pip check
+
+    - name: Run integration test
+      run: |
         poetry run sh tests/test_integration.sh

.github/zizmor.yml

@@ -0,0 +1,5 @@
+rules:
+  unpinned-uses:
+    config:
+      policies:
+        "*": ref-pin

.gitignore

@@ -212,3 +212,37 @@ com_crashlytics_export_strings.xml
 crashlytics.properties
 crashlytics-build.properties
 fabric.properties
+
+
+#####=== Custom ===#####
+# File types:
+*.sqlite3
+*.db
+
+# Configuration file with private data:
+*.env
+.env
+
+# Artifacts:
+.gitlab/.svn/
+artifacts/
+
+# mypy:
+.mypy_cache/
+
+# pytest and hypothesis
+.pytest_cache/
+.hypothesis/
+
+# ipython:
+.ipython/
+.python_history
+
+# ruff:
+.ruff_cache/
+
+# import-linter:
+.import_linter_cache/
+
+# safety:
+.safety/

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-xml
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-illegal-windows-names
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: check-case-conflict
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.0
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-github-actions
+      - id: check-gitlab-ci
+        args: ["--format-regex", "python"]
+      - id: check-renovate
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+        additional_dependencies:
+          - "github.com/wasilibs/go-shellcheck/cmd/shellcheck@latest"
+
+  - repo: https://github.com/woodruffw/zizmor-pre-commit
+    rev: v1.6.0
+    hooks:
+      - id: zizmor
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        args: ["--severity=style"]
+
+  # Should be the last:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+
+exclude: ^(\{\{cookiecutter\.project_name\}\})
+
+ci:
+  autofix_prs: true
+  autoupdate_schedule: weekly
+  submodules: false

README.md

@@ -17,11 +17,12 @@ Just like `poetry new` but better.
 ## Features
 
 - Always [`up-to-date`](https://github.com/wemake-services/wemake-python-package/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot) dependencies with the help of [`@dependabot`](https://dependabot.com/)
-- Supports latest `python3.8+`
+- Supports latest `python3.10+`
 - [`poetry`](https://github.com/python-poetry/poetry) for managing dependencies
 - [`mypy`](https://mypy.readthedocs.io) for optional static typing
 - [`pytest`](https://github.com/pytest-dev/pytest) for testing
-- [`flake8`](https://github.com/PyCQA/flake8) and [`wemake-python-styleguide`](https://github.com/wemake-services/wemake-python-styleguide) for linting
+- [`ruff`](https://github.com/astral-sh/ruff) and [`wemake-python-styleguide`](https://github.com/wemake-services/wemake-python-styleguide) for linting
+- [`pre-commit` CI](https://pre-commit.ci) with autofixes for your PRs
 - [`Github Actions`](https://docs.github.com/en/actions) as the default CI
 - [`sphinx`](http://www.sphinx-doc.org/en/master/) and [`readthedocs.org`](https://readthedocs.org/) for documentation
 - Easy update process, so your template will always be up-to-date

hooks/post_gen_project.py

@@ -6,23 +6,24 @@
 
 """
 
-import os
 import subprocess  # noqa: S404
 import textwrap
+from pathlib import Path
+from typing import Final
 
 # Get the root project directory:
-PROJECT_DIRECTORY = os.path.realpath(os.path.curdir)
-PROJECT_NAME = '{{ cookiecutter.project_name }}'
+PROJECT_DIRECTORY = Path.cwd().resolve(strict=True)
+PROJECT_NAME: Final = '{{ cookiecutter.project_name }}'
 
 # We need these values to generate correct license:
-LICENSE = '{{ cookiecutter.license }}'
-ORGANIZATION = '{{ cookiecutter.organization }}'
+LICENSE: Final = '{{ cookiecutter.license }}'
+ORGANIZATION: Final = '{{ cookiecutter.organization }}'
 
 
-def generate_license():
+def generate_license() -> None:
     """Generates license file for the project."""
-    license_result = subprocess.check_output(  # noqa: S603, S607
-        [
+    license_result = subprocess.check_output(  # noqa: S603
+        [  # noqa: S607
             'lice',
             LICENSE.lower(),
             '-o',
@@ -33,15 +34,19 @@ def generate_license():
         universal_newlines=True,
         encoding='utf8',
     )
-    with open(
-        os.path.join(PROJECT_DIRECTORY, 'LICENSE'),
+    with (PROJECT_DIRECTORY / 'LICENSE').open(
         mode='w',
         encoding='utf8',
     ) as license_file:
-        license_file.write(license_result)
+        license_file.write(
+            license_result.strip()
+            .replace(' \n ', ' \n')
+            .replace('\n \n', '\n\n'),
+        )
+        license_file.write('\n')
 
 
-def print_futher_instuctions():
+def print_futher_instuctions() -> None:
     """Shows user what to do next after project creation."""
     message = """
     Your project {0} is created.

hooks/pre_gen_project.py

@@ -1,11 +1,12 @@
 import re
 import sys
+from typing import Final
 
-MODULE_REGEX = r'^[a-z][a-z0-9\-]+[a-z0-9]$'
-MODULE_NAME = '{{ cookiecutter.project_name }}'
+MODULE_REGEX: Final = r'^[a-z][a-z0-9\-]+[a-z0-9]$'
+MODULE_NAME: Final = '{{ cookiecutter.project_name }}'
 
 
-def validate_project_name():
+def validate_project_name() -> None:
     """
     This validator is used to ensure that `project_name` is valid.
 
@@ -28,13 +29,11 @@ def validate_project_name():
         raise ValueError(' '.join(message).format(MODULE_NAME))
 
 
-validators = (
-    validate_project_name,
-)
+validators = (validate_project_name,)
 
 for validator in validators:
     try:
         validator()
-    except ValueError as ex:
+    except ValueError as ex:  # noqa: PERF203
         print(ex)  # noqa: WPS421
         sys.exit(1)