conventional-pre-commit 2.4.0__tar.gz → 3.1.0__tar.gz

conventional_pre_commit-3.1.0/.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.11
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    USER=compiler
+
+# create $USER and home directory
+RUN useradd --create-home --shell /bin/bash $USER && \
+    chown -R $USER /home/$USER
+
+# switch to non-root $USER
+USER $USER
+
+# enter src directory
+WORKDIR /home/$USER/src
+
+# update PATH for local pip installs
+ENV PATH "$PATH:/home/$USER/.local/bin"
+
+# update pip
+RUN python -m pip install --upgrade pip

conventional_pre_commit-3.1.0/.devcontainer/compose.yml

@@ -0,0 +1,10 @@
+services:
+  dev:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    entrypoint: []
+    command: sleep infinity
+    image: compilerla/conventional-pre-commit:dev
+    volumes:
+      - ../:/home/compiler/src

conventional_pre_commit-3.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+{
+  "name": "compilerla/conventional-pre-commit",
+  "dockerComposeFile": ["./compose.yml"],
+  "service": "dev",
+  "runServices": ["dev"],
+  "workspaceFolder": "/home/compiler/src",
+  "postCreateCommand": "pip install -e .[dev]",
+  "customizations": {
+    "vscode": {
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "/bin/bash"
+          }
+        }
+      },
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "eamodio.gitlens",
+        "esbenp.prettier-vscode",
+        "mhutchie.git-graph",
+        "ms-python.python",
+        "ms-python.black-formatter",
+        "ms-python.flake8",
+        "tamasfe.even-better-toml"
+      ]
+    }
+  }
+}

conventional_pre_commit-3.1.0/.dockerignore

@@ -0,0 +1 @@
+*.egg-info

conventional_pre_commit-3.1.0/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 127

conventional_pre_commit-3.1.0/.github/dependabot.yaml

@@ -0,0 +1,27 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/" # pyproject.toml
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the
+    # default location of `.github/workflows`
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"

conventional_pre_commit-3.1.0/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release to GitHub and PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[2-9].[0-9]+.[0-9]+"
+      - "v[2-9].[0-9]+.[0-9]+-pre[0-9]?"
+
+jobs:
+  test:
+    uses: ./.github/workflows/tests.yml
+
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    needs: test
+    permissions:
+      # https://github.com/softprops/action-gh-release#permissions
+      contents: write
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+          cache-dependency-path: "**/pyproject.toml"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Release
+        id: release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            ./dist/*.whl
+            ./dist/*.tar.gz
+          prerelease: ${{ contains(github.ref, '-pre') }}
+          generate_release_notes: ${{ !contains(github.ref, '-pre') }}
+
+      - name: Publish to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ contains(github.ref, '-pre') }}
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          print-hash: true
+          skip-existing: true
+          verbose: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ !contains(github.ref, '-pre') }}
+        with:
+          print-hash: true

conventional_pre_commit-3.1.0/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+  workflow_call:
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for pushing data to the
+      # python-coverage-comment-action branch, and for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: "**/pyproject.toml"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+
+      - name: Run tests
+        run: ./tests/run.sh
+
+      - name: Coverage comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        if: github.event_name != 'workflow_call' && matrix.python-version == '3.11'
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+          MINIMUM_GREEN: 90
+          MINIMUM_ORANGE: 80

conventional_pre_commit-3.1.0/.gitignore

@@ -0,0 +1,4 @@
+*.egg-info
+*.py[co]
+.coverage
+dist

conventional_pre_commit-3.1.0/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+ci:
+  autofix_commit_msg: "chore(pre-commit): autofix run"
+  autoupdate_commit_msg: "chore(pre-commit): autoupdate hooks"
+
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: requirements-txt-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+        types:
+          - python
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        types:
+          - python
+
+  - repo: https://github.com/pycqa/bandit
+    rev: 1.7.6
+    hooks:
+      - id: bandit
+        args: ["-ll"]
+        files: .py$
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        types_or: [javascript]
+
+  - repo: local
+    hooks:
+      - id: conventional-pre-commit
+        name: Conventional Commit (local)
+        entry: conventional-pre-commit
+        language: python
+        stages: [commit-msg]

conventional_pre_commit-3.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: conventional-pre-commit
+  name: Conventional Commit
+  entry: conventional-pre-commit
+  language: python
+  description: Checks commit message for Conventional Commits formatting
+  always_run: true
+  stages: [commit-msg]

conventional_pre_commit-3.1.0/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "files.encoding": "utf8",
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter"
+  },
+  "python.languageServer": "Pylance",
+  "python.testing.pytestArgs": ["tests"],
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false
+}

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conventional_pre_commit
-Version: 2.4.0
+Version: 3.1.0
 Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
 Author-email: Compiler LLC <dev@compiler.la>
 License:                                  Apache License
@@ -209,16 +209,25 @@ Project-URL: code, https://github.com/compilerla/conventional-pre-commit
 Project-URL: tracker, https://github.com/compilerla/conventional-pre-commit/issues
 Keywords: git,pre-commit,conventional-commits
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
 
 # conventional-pre-commit
 
 A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
 [Conventional Commits](https://conventionalcommits.org) formatting.
 
+Works with Python >= 3.8.
+
 ## Usage
 
 Make sure `pre-commit` is [installed](https://pre-commit.com#install).
@@ -240,7 +249,7 @@ repos:
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
-        args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
+        args: []
 ```
 
 Install the `pre-commit` script:
@@ -278,9 +287,15 @@ Example commit message fixing an issue:
 
     fix: remove infinite loop
 
-Optionally, include a scope in parentheses after the type for more context:
+Example commit with scope in parentheses after the type for more context:
 
     fix(account): remove infinite loop
+
+Example commit with a body:
+
+    fix: remove infinite loop
+
+    Additional information on the issue caused by the infinite loop
 ```
 
 Make a (conventional) commit :heavy_check_mark::
@@ -331,6 +346,40 @@ print(is_conventional("nope: this is not a conventional commit"))
 print(is_conventional("custom: this is a conventional commit", types=["custom"]))
 ```
 
+## Passing `args`
+
+`conventional-pre-commit` supports a number of arguments to configure behavior:
+
+```shell
+$ conventional-pre-commit -h
+usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
+
+Check a git commit message for Conventional Commits formatting.
+
+positional arguments:
+  types          Optional list of types to support
+  input          A file containing a git commit message
+
+options:
+  -h, --help     show this help message and exit
+  --force-scope  Force commit to have scope defined.
+  --strict       Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
+```
+
+Supply arguments on the command-line, or via the pre-commit `hooks.args` property:
+
+```yaml
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: <git sha or tag>
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--strict, --force-scope, feat, fix, chore, test, custom]
+```
+
+**NOTE:** when using as a pre-commit hook, `input` is supplied automatically (with the current commit's message).
+
 ## Development
 
 `conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
@@ -354,22 +403,11 @@ Versioning generally follows [Semantic Versioning](https://semver.org/).
 
 ## Making a release
 
-Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
-
-1. Create a branch `chore/release`
-1. Bump the version in `pyproject.toml`
-1. PR, merge `chore/release` into `main`
-1. Tag `main` with the new version (prefixed by `v`):
-
-   ```bash
-   git fetch
-   git reset --hard origin/main
-   git tag vX.Y.Z
-   git push origin vX.Y.Z
-   ```
+Releases to PyPI and GitHub are triggered by pushing a tag.
 
-1. Publish a pre-release to push the new package to TestPyPI
-1. Publish a regular Release to push the new package to PyPI
+1. Ensure all changes for the release are present in the `main` branch
+1. Tag with the new version: `git tag vX.Y.Z` for regular release, `git tag vX.Y.Z-preN` for pre-release
+1. Push the new version tag: `git push origin vX.Y.Z`
 
 ## License
 

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/README.md

@@ -3,6 +3,8 @@
 A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
 [Conventional Commits](https://conventionalcommits.org) formatting.
 
+Works with Python >= 3.8.
+
 ## Usage
 
 Make sure `pre-commit` is [installed](https://pre-commit.com#install).
@@ -24,7 +26,7 @@ repos:
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
-        args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
+        args: []
 ```
 
 Install the `pre-commit` script:
@@ -62,9 +64,15 @@ Example commit message fixing an issue:
 
     fix: remove infinite loop
 
-Optionally, include a scope in parentheses after the type for more context:
+Example commit with scope in parentheses after the type for more context:
 
     fix(account): remove infinite loop
+
+Example commit with a body:
+
+    fix: remove infinite loop
+
+    Additional information on the issue caused by the infinite loop
 ```
 
 Make a (conventional) commit :heavy_check_mark::
@@ -115,6 +123,40 @@ print(is_conventional("nope: this is not a conventional commit"))
 print(is_conventional("custom: this is a conventional commit", types=["custom"]))
 ```
 
+## Passing `args`
+
+`conventional-pre-commit` supports a number of arguments to configure behavior:
+
+```shell
+$ conventional-pre-commit -h
+usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
+
+Check a git commit message for Conventional Commits formatting.
+
+positional arguments:
+  types          Optional list of types to support
+  input          A file containing a git commit message
+
+options:
+  -h, --help     show this help message and exit
+  --force-scope  Force commit to have scope defined.
+  --strict       Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
+```
+
+Supply arguments on the command-line, or via the pre-commit `hooks.args` property:
+
+```yaml
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: <git sha or tag>
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--strict, --force-scope, feat, fix, chore, test, custom]
+```
+
+**NOTE:** when using as a pre-commit hook, `input` is supplied automatically (with the current commit's message).
+
 ## Development
 
 `conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
@@ -138,22 +180,11 @@ Versioning generally follows [Semantic Versioning](https://semver.org/).
 
 ## Making a release
 
-Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
-
-1. Create a branch `chore/release`
-1. Bump the version in `pyproject.toml`
-1. PR, merge `chore/release` into `main`
-1. Tag `main` with the new version (prefixed by `v`):
-
-   ```bash
-   git fetch
-   git reset --hard origin/main
-   git tag vX.Y.Z
-   git push origin vX.Y.Z
-   ```
+Releases to PyPI and GitHub are triggered by pushing a tag.
 
-1. Publish a pre-release to push the new package to TestPyPI
-1. Publish a regular Release to push the new package to PyPI
+1. Ensure all changes for the release are present in the `main` branch
+1. Tag with the new version: `git tag vX.Y.Z` for regular release, `git tag vX.Y.Z-preN` for pre-release
+1. Push the new version tag: `git push origin vX.Y.Z`
 
 ## License
 

conventional_pre_commit-3.1.0/conventional_pre_commit/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("conventional-pre-commit")
+except PackageNotFoundError:
+    # package is not installed
+    pass

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/conventional_pre_commit/format.py

@@ -29,9 +29,9 @@ def r_types(types):
 def r_scope(optional=True):
     """Regex str for an optional (scope)."""
     if optional:
-        return r"(\([\w \/:-]+\))?"
+        return r"(\([\w \/:,-]+\))?"
     else:
-        return r"(\([\w \/:-]+\))"
+        return r"(\([\w \/:,-]+\))"
 
 
 def r_delim():
@@ -40,8 +40,13 @@ def r_delim():
 
 
 def r_subject():
-    """Regex str for subject line, body, footer."""
-    return r" .+"
+    """Regex str for subject line."""
+    return r" .+$"
+
+
+def r_body():
+    """Regex str for the body"""
+    return r"(?P<multi>\r?\n(?P<sep>^$\r?\n)?.+)?"
 
 
 def r_autosquash_prefixes():
@@ -49,6 +54,15 @@ def r_autosquash_prefixes():
     return "|".join(AUTOSQUASH_PREFIXES)
 
 
+def r_comment():
+    """Regex str for comment"""
+    return r"^#.*\r?\n?"
+
+
+def strip_comments(input):
+    return re.sub(r_comment(), "", input, flags=re.MULTILINE)
+
+
 def conventional_types(types=[]):
     """Return a list of Conventional Commits types merged with the given types."""
     if set(types) & set(CONVENTIONAL_TYPES) == set():
@@ -63,11 +77,17 @@ def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True):
 
     Optionally provide a list of additional custom types.
     """
+    input = strip_comments(input)
     types = conventional_types(types)
-    pattern = f"^({r_types(types)}){r_scope(optional_scope)}{r_delim()}{r_subject()}$"
-    regex = re.compile(pattern, re.DOTALL)
+    pattern = f"^({r_types(types)}){r_scope(optional_scope)}{r_delim()}{r_subject()}{r_body()}"
+    regex = re.compile(pattern, re.MULTILINE)
 
-    return bool(regex.match(input))
+    result = regex.match(input)
+    is_valid = bool(result)
+    if is_valid and result.group("multi") and not result.group("sep"):
+        is_valid = False
+
+    return is_valid
 
 
 def has_autosquash_prefix(input):

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/conventional_pre_commit/hook.py

@@ -24,7 +24,9 @@ def main(argv=[]):
         "--force-scope", action="store_false", default=True, dest="optional_scope", help="Force commit to have scope defined."
     )
     parser.add_argument(
-        "--strict", action="store_true", help="Force commit to strictly follow Conventional Commits formatting."
+        "--strict",
+        action="store_true",
+        help="Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.",
     )
 
     if len(argv) < 1:
@@ -64,7 +66,7 @@ See {Colors.LBLUE}https://git-scm.com/docs/git-commit/#_discussion{Colors.RESTOR
         {Colors.LBLUE}https://www.conventionalcommits.org/{Colors.YELLOW}
 
         Conventional Commits start with one of the below types, followed by a colon,
-        followed by the commit message:{Colors.RESTORE}
+        followed by the commit subject and an optional body seperated by a blank line:{Colors.RESTORE}
 
             {" ".join(format.conventional_types(args.types))}
 
@@ -78,7 +80,14 @@ See {Colors.LBLUE}https://git-scm.com/docs/git-commit/#_discussion{Colors.RESTOR
 
         {Colors.YELLOW}Example commit with scope in parentheses after the type for more context:{Colors.RESTORE}
 
-            fix(account): remove infinite loop"""
+            fix(account): remove infinite loop
+
+        {Colors.YELLOW}Example commit with a body:{Colors.RESTORE}
+
+            fix: remove infinite loop
+
+            Additional information on the issue caused by the infinite loop
+            """
         )
         return RESULT_FAIL
 

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/conventional_pre_commit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: conventional-pre-commit
-Version: 2.4.0
+Name: conventional_pre_commit
+Version: 3.1.0
 Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
 Author-email: Compiler LLC <dev@compiler.la>
 License:                                  Apache License
@@ -209,16 +209,25 @@ Project-URL: code, https://github.com/compilerla/conventional-pre-commit
 Project-URL: tracker, https://github.com/compilerla/conventional-pre-commit/issues
 Keywords: git,pre-commit,conventional-commits
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
 
 # conventional-pre-commit
 
 A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
 [Conventional Commits](https://conventionalcommits.org) formatting.
 
+Works with Python >= 3.8.
+
 ## Usage
 
 Make sure `pre-commit` is [installed](https://pre-commit.com#install).
@@ -240,7 +249,7 @@ repos:
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
-        args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
+        args: []
 ```
 
 Install the `pre-commit` script:
@@ -278,9 +287,15 @@ Example commit message fixing an issue:
 
     fix: remove infinite loop
 
-Optionally, include a scope in parentheses after the type for more context:
+Example commit with scope in parentheses after the type for more context:
 
     fix(account): remove infinite loop
+
+Example commit with a body:
+
+    fix: remove infinite loop
+
+    Additional information on the issue caused by the infinite loop
 ```
 
 Make a (conventional) commit :heavy_check_mark::
@@ -331,6 +346,40 @@ print(is_conventional("nope: this is not a conventional commit"))
 print(is_conventional("custom: this is a conventional commit", types=["custom"]))
 ```
 
+## Passing `args`
+
+`conventional-pre-commit` supports a number of arguments to configure behavior:
+
+```shell
+$ conventional-pre-commit -h
+usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
+
+Check a git commit message for Conventional Commits formatting.
+
+positional arguments:
+  types          Optional list of types to support
+  input          A file containing a git commit message
+
+options:
+  -h, --help     show this help message and exit
+  --force-scope  Force commit to have scope defined.
+  --strict       Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
+```
+
+Supply arguments on the command-line, or via the pre-commit `hooks.args` property:
+
+```yaml
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: <git sha or tag>
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--strict, --force-scope, feat, fix, chore, test, custom]
+```
+
+**NOTE:** when using as a pre-commit hook, `input` is supplied automatically (with the current commit's message).
+
 ## Development
 
 `conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
@@ -354,22 +403,11 @@ Versioning generally follows [Semantic Versioning](https://semver.org/).
 
 ## Making a release
 
-Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
-
-1. Create a branch `chore/release`
-1. Bump the version in `pyproject.toml`
-1. PR, merge `chore/release` into `main`
-1. Tag `main` with the new version (prefixed by `v`):
-
-   ```bash
-   git fetch
-   git reset --hard origin/main
-   git tag vX.Y.Z
-   git push origin vX.Y.Z
-   ```
+Releases to PyPI and GitHub are triggered by pushing a tag.
 
-1. Publish a pre-release to push the new package to TestPyPI
-1. Publish a regular Release to push the new package to PyPI
+1. Ensure all changes for the release are present in the `main` branch
+1. Tag with the new version: `git tag vX.Y.Z` for regular release, `git tag vX.Y.Z-preN` for pre-release
+1. Push the new version tag: `git push origin vX.Y.Z`
 
 ## License
 

conventional_pre_commit-3.1.0/conventional_pre_commit.egg-info/SOURCES.txt

@@ -0,0 +1,38 @@
+.dockerignore
+.flake8
+.gitignore
+.pre-commit-config.yaml
+.pre-commit-hooks.yaml
+LICENSE
+README.md
+pyproject.toml
+.devcontainer/Dockerfile
+.devcontainer/compose.yml
+.devcontainer/devcontainer.json
+.github/dependabot.yaml
+.github/workflows/release.yml
+.github/workflows/tests.yml
+.vscode/settings.json
+conventional_pre_commit/__init__.py
+conventional_pre_commit/format.py
+conventional_pre_commit/hook.py
+conventional_pre_commit.egg-info/PKG-INFO
+conventional_pre_commit.egg-info/SOURCES.txt
+conventional_pre_commit.egg-info/dependency_links.txt
+conventional_pre_commit.egg-info/entry_points.txt
+conventional_pre_commit.egg-info/requires.txt
+conventional_pre_commit.egg-info/top_level.txt
+tests/__init__.py
+tests/conftest.py
+tests/run.sh
+tests/test_format.py
+tests/test_hook.py
+tests/messages/bad_commit
+tests/messages/conventional_commit
+tests/messages/conventional_commit_bad_multi_line
+tests/messages/conventional_commit_gbk
+tests/messages/conventional_commit_multi_line
+tests/messages/conventional_commit_utf-8
+tests/messages/conventional_commit_with_scope
+tests/messages/custom_commit
+tests/messages/fixup_commit

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/conventional_pre_commit.egg-info/requires.txt

@@ -2,7 +2,8 @@
 [dev]
 black
 build
+coverage
 flake8
 pre-commit
 pytest
-pytest-cov
+setuptools_scm

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "conventional_pre_commit"
-version = "2.4.0"
+dynamic = ["version"]
 description = "A pre-commit hook that checks commit messages for Conventional Commits formatting."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -9,7 +9,7 @@ keywords = ["git", "pre-commit", "conventional-commits"]
 authors = [
     { name = "Compiler LLC", email = "dev@compiler.la" }
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 dependencies = []
 
 [project.urls]
@@ -20,17 +20,18 @@ tracker = "https://github.com/compilerla/conventional-pre-commit/issues"
 dev = [
     "black",
     "build",
+    "coverage",
     "flake8",
     "pre-commit",
     "pytest",
-    "pytest-cov"
+    "setuptools_scm",
 ]
 
 [project.scripts]
 conventional-pre-commit = "conventional_pre_commit.hook:main"
 
 [build-system]
-requires = ["setuptools>=64", "wheel"]
+requires = ["setuptools>=65", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [tool.black]
@@ -38,6 +39,14 @@ line-length = 127
 target-version = ['py311']
 include = '\.pyi?$'
 
+[tool.coverage.run]
+branch = true
+relative_files = true
+source = ["conventional_pre_commit"]
+
+[tool.pyright]
+include = ["conventional_pre_commit", "tests"]
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 norecursedirs = [
@@ -46,3 +55,9 @@ norecursedirs = [
     ".pytest_cache",
     ".vscode",
 ]
+
+[tool.setuptools]
+packages = ["conventional_pre_commit"]
+
+[tool.setuptools_scm]
+# intentionally left blank, but we need the section header to activate the tool

conventional_pre_commit-3.1.0/tests/conftest.py

@@ -0,0 +1,54 @@
+import os.path
+
+import pytest
+
+TEST_DIR = os.path.abspath(os.path.dirname(__file__))
+
+
+def get_message_path(path):
+    return os.path.join(TEST_DIR, "messages", path)
+
+
+@pytest.fixture
+def bad_commit_path():
+    return get_message_path("bad_commit")
+
+
+@pytest.fixture
+def conventional_commit_path():
+    return get_message_path("conventional_commit")
+
+
+@pytest.fixture
+def conventional_commit_with_scope_path():
+    return get_message_path("conventional_commit_with_scope")
+
+
+@pytest.fixture
+def custom_commit_path():
+    return get_message_path("custom_commit")
+
+
+@pytest.fixture
+def conventional_utf8_commit_path():
+    return get_message_path("conventional_commit_utf-8")
+
+
+@pytest.fixture
+def conventional_gbk_commit_path():
+    return get_message_path("conventional_commit_gbk")
+
+
+@pytest.fixture
+def fixup_commit_path():
+    return get_message_path("fixup_commit")
+
+
+@pytest.fixture
+def conventional_commit_bad_multi_line_path():
+    return get_message_path("conventional_commit_bad_multi_line")
+
+
+@pytest.fixture
+def conventional_commit_multi_line_path():
+    return get_message_path("conventional_commit_multi_line")

conventional_pre_commit-3.1.0/tests/messages/bad_commit

@@ -0,0 +1 @@
+bad: message

conventional_pre_commit-3.1.0/tests/messages/conventional_commit

@@ -0,0 +1 @@
+feat: message

conventional_pre_commit-3.1.0/tests/messages/conventional_commit_bad_multi_line

@@ -0,0 +1,2 @@
+fix: message
+no blank line

conventional_pre_commit-3.1.0/tests/messages/conventional_commit_gbk

@@ -0,0 +1 @@
+feat: utf-8 test ����

conventional_pre_commit-3.1.0/tests/messages/conventional_commit_multi_line

@@ -0,0 +1,3 @@
+fix: message
+
+A blank line is there

conventional_pre_commit-3.1.0/tests/messages/conventional_commit_utf-8

@@ -0,0 +1 @@
+feat: utf-8 test 测试

conventional_pre_commit-3.1.0/tests/messages/conventional_commit_with_scope

@@ -0,0 +1 @@
+feat(scope): message

conventional_pre_commit-3.1.0/tests/messages/custom_commit

@@ -0,0 +1 @@
+custom: message

conventional_pre_commit-3.1.0/tests/messages/fixup_commit

@@ -0,0 +1 @@
+fixup! feature: implement something cool

conventional_pre_commit-3.1.0/tests/run.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -eux
+
+# run normal pytests
+coverage run -m pytest
+
+# clean out old coverage results
+rm -rf ./tests/coverage
+
+# regenerate coverate report
+coverage html --directory ./tests/coverage

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/tests/test_format.py

@@ -61,6 +61,7 @@ def test_r_scope__special_chars():
     assert regex.match("(some/thing)")
     assert regex.match("(some thing)")
     assert regex.match("(some:thing)")
+    assert regex.match("(some,thing)")
 
 
 def test_r_delim():
@@ -122,6 +123,34 @@ def test_conventional_types__custom():
     assert set(["custom", *format.CONVENTIONAL_TYPES]) == set(result)
 
 
+def test_r_comment_single():
+    regex = re.compile(format.r_comment())
+    assert regex.match("# Some comment")
+    assert not regex.match("Some comment")
+    assert not regex.match(" # Some comment")
+
+
+def test_strip_comments__consecutive():
+    input = """feat(scope): message
+# Please enter the commit message for your changes.
+# These are comments usually added by editors, f.ex. with export EDITOR=vim
+    """
+    result = format.strip_comments(input)
+    assert result.count("\n") == 1
+    assert result.strip() == "feat(scope): message"
+
+
+def test_strip_comments__spaced():
+    input = """feat(scope): message
+# Please enter the commit message for your changes.
+
+# These are comments usually added by editors, f.ex. with export EDITOR=vim
+    """
+    result = format.strip_comments(input)
+    assert result.count("\n") == 2
+    assert result.strip() == "feat(scope): message"
+
+
 @pytest.mark.parametrize("type", format.DEFAULT_TYPES)
 def test_is_conventional__default_type(type):
     input = f"{type}: message"
@@ -162,6 +191,23 @@ def test_is_conventional__with_scope():
     assert format.is_conventional(input)
 
 
+def test_is_conventional__body_multiline_body_bad_type():
+    input = """wrong: message
+
+    more_message
+    """
+
+    assert not format.is_conventional(input)
+
+
+def test_is_conventional__bad_body_multiline():
+    input = """feat(scope): message
+    more message
+    """
+
+    assert not format.is_conventional(input)
+
+
 def test_is_conventional__body_multiline():
     input = """feat(scope): message
 
@@ -171,6 +217,24 @@ def test_is_conventional__body_multiline():
     assert format.is_conventional(input)
 
 
+def test_is_conventional__bad_body_multiline_paragraphs():
+    input = """feat(scope): message
+    more message
+
+    more body message
+    """
+
+    assert not format.is_conventional(input)
+
+
+def test_is_conventional__comment():
+    input = """feat(scope): message
+# Please enter the commit message for your changes.
+# These are comments usually added by editors, f.ex. with export EDITOR=vim
+"""
+    assert format.is_conventional(input)
+
+
 @pytest.mark.parametrize("char", ['"', "'", "`", "#", "&"])
 def test_is_conventional__body_special_char(char):
     input = f"feat: message with {char}"

{conventional_pre_commit-2.4.0 → conventional_pre_commit-3.1.0}/tests/test_hook.py

@@ -2,7 +2,7 @@ import subprocess
 
 import pytest
 
-from conventional_pre_commit.hook import RESULT_SUCCESS, RESULT_FAIL, main
+from conventional_pre_commit.hook import RESULT_FAIL, RESULT_SUCCESS, main
 
 
 @pytest.fixture
@@ -46,6 +46,54 @@ def test_main_success__custom_conventional(conventional_commit_path):
     assert result == RESULT_SUCCESS
 
 
+def test_main_success__conventional_utf8(conventional_utf8_commit_path):
+    result = main([conventional_utf8_commit_path])
+
+    assert result == RESULT_SUCCESS
+
+
+def test_main_fail__conventional_gbk(conventional_gbk_commit_path):
+    result = main([conventional_gbk_commit_path])
+
+    assert result == RESULT_FAIL
+
+
+def test_main_fail__conventional_with_scope(conventional_commit_path):
+    result = main(["--force-scope", conventional_commit_path])
+
+    assert result == RESULT_FAIL
+
+
+def test_main_success__conventional_with_scope(cmd, conventional_commit_with_scope_path):
+    result = main(["--force-scope", conventional_commit_with_scope_path])
+
+    assert result == RESULT_SUCCESS
+
+
+def test_main_success__fixup_commit(fixup_commit_path):
+    result = main([fixup_commit_path])
+
+    assert result == RESULT_SUCCESS
+
+
+def test_main_fail__fixup_commit(fixup_commit_path):
+    result = main(["--strict", fixup_commit_path])
+
+    assert result == RESULT_FAIL
+
+
+def test_main_success__conventional_commit_multi_line(conventional_commit_multi_line_path):
+    result = main([conventional_commit_multi_line_path])
+
+    assert result == RESULT_SUCCESS
+
+
+def test_main_fail__conventional_commit_bad_multi_line(conventional_commit_bad_multi_line_path):
+    result = main([conventional_commit_bad_multi_line_path])
+
+    assert result == RESULT_FAIL
+
+
 def test_subprocess_fail__missing_args(cmd):
     result = subprocess.call(cmd)
 
@@ -82,37 +130,37 @@ def test_subprocess_success__custom_conventional(cmd, conventional_commit_path):
     assert result == RESULT_SUCCESS
 
 
-def test_main_success__conventional_utf8(conventional_utf8_commit_path):
-    result = main([conventional_utf8_commit_path])
-
-    assert result == RESULT_SUCCESS
-
-
-def test_main_fail__conventional_gbk(conventional_gbk_commit_path):
-    result = main([conventional_gbk_commit_path])
-
-    assert result == RESULT_FAIL
-
-
-def test_main_fail__conventional_with_scope(cmd, conventional_commit_path):
+def test_subprocess_fail__conventional_with_scope(cmd, conventional_commit_path):
     result = subprocess.call((cmd, "--force-scope", conventional_commit_path))
 
     assert result == RESULT_FAIL
 
 
-def test_main_success__conventional_with_scope(cmd, conventional_commit_with_scope_path):
+def test_subprocess_success__conventional_with_scope(cmd, conventional_commit_with_scope_path):
     result = subprocess.call((cmd, "--force-scope", conventional_commit_with_scope_path))
 
     assert result == RESULT_SUCCESS
 
 
-def test_main_success__fixup_commit(cmd, fixup_commit_path):
+def test_subprocess_success__fixup_commit(cmd, fixup_commit_path):
     result = subprocess.call((cmd, fixup_commit_path))
 
     assert result == RESULT_SUCCESS
 
 
-def test_main_success__fail_commit(cmd, fixup_commit_path):
+def test_subprocess_fail__fixup_commit(cmd, fixup_commit_path):
     result = subprocess.call((cmd, "--strict", fixup_commit_path))
 
     assert result == RESULT_FAIL
+
+
+def test_subprocess_success__conventional_commit_multi_line(cmd, conventional_commit_multi_line_path):
+    result = subprocess.call((cmd, conventional_commit_multi_line_path))
+
+    assert result == RESULT_SUCCESS
+
+
+def test_subprocess_fail__conventional_commit_bad_multi_line(cmd, conventional_commit_bad_multi_line_path):
+    result = subprocess.call((cmd, conventional_commit_bad_multi_line_path))
+
+    assert result == RESULT_FAIL

conventional_pre_commit-2.4.0/conventional_pre_commit.egg-info/SOURCES.txt

@@ -1,14 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-conventional_pre_commit/__init__.py
-conventional_pre_commit/format.py
-conventional_pre_commit/hook.py
-conventional_pre_commit.egg-info/PKG-INFO
-conventional_pre_commit.egg-info/SOURCES.txt
-conventional_pre_commit.egg-info/dependency_links.txt
-conventional_pre_commit.egg-info/entry_points.txt
-conventional_pre_commit.egg-info/requires.txt
-conventional_pre_commit.egg-info/top_level.txt
-tests/test_format.py
-tests/test_hook.py