conventional-pre-commit 3.0.0__tar.gz → 3.2.0__tar.gz

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.0}/.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
           cache: pip
@@ -38,7 +38,7 @@ jobs:
 
       - name: Release
         id: release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: |
             ./dist/*.whl

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.0}/.github/workflows/tests.yml

@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: pip
@@ -44,7 +44,7 @@ jobs:
 
       - name: Coverage comment
         uses: py-cov-action/python-coverage-comment-action@v3
-        if: github.event_name != 'workflow_call' && matrix.version == '3.11'
+        if: github.event_name != 'workflow_call' && matrix.python-version == '3.11'
         with:
           GITHUB_TOKEN: ${{ github.token }}
           MINIMUM_GREEN: 90

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.0}/.pre-commit-config.yaml

@@ -18,28 +18,28 @@ repos:
       - id: check-added-large-files
 
   - repo: https://github.com/psf/black
-    rev: 23.11.0
+    rev: 24.3.0
     hooks:
       - id: black
         types:
           - python
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         types:
           - python
 
   - repo: https://github.com/pycqa/bandit
-    rev: 1.7.5
+    rev: 1.7.8
     hooks:
       - id: bandit
         args: ["-ll"]
         files: .py$
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.1.0
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         types_or: [javascript]

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conventional_pre_commit
-Version: 3.0.0
+Version: 3.2.0
 Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
 Author-email: Compiler LLC <dev@compiler.la>
 License:                                  Apache License

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.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():
@@ -54,6 +54,24 @@ def r_autosquash_prefixes():
     return "|".join(AUTOSQUASH_PREFIXES)
 
 
+def r_verbose_diff():
+    """Regex str for verbose diff"""
+    return r"(?P<diff>(^# -* >8 -*$\r?\n)(^# .*$\r?\n)+(diff ){1}(.*\r?\n)*)"
+
+
+def strip_verbose_diff(input):
+    return re.sub(r_verbose_diff(), "", input, flags=re.MULTILINE)
+
+
+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():
@@ -68,6 +86,8 @@ def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True):
 
     Optionally provide a list of additional custom types.
     """
+    input = strip_verbose_diff(input)
+    input = strip_comments(input)
     types = conventional_types(types)
     pattern = f"^({r_types(types)}){r_scope(optional_scope)}{r_delim()}{r_subject()}{r_body()}"
     regex = re.compile(pattern, re.MULTILINE)

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.0}/conventional_pre_commit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: conventional-pre-commit
-Version: 3.0.0
+Name: conventional_pre_commit
+Version: 3.2.0
 Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
 Author-email: Compiler LLC <dev@compiler.la>
 License:                                  Apache License

{conventional_pre_commit-3.0.0 → conventional_pre_commit-3.2.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,101 @@ 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"
+
+
+def test_r_verbose_diff__has_diff():
+    regex = re.compile(format.r_verbose_diff(), re.MULTILINE)
+    input = """# ----------- >8 -----------
+# Some comment
+# Some comment
+diff --git a/file b/file
+"""
+
+    assert regex.match(input)
+
+
+def test_r_verbose_diff__no_diff():
+    regex = re.compile(format.r_verbose_diff(), re.MULTILINE)
+    input = """# ----------- >8 -----------
+# Some comment
+# Some comment
+"""
+
+    assert not regex.match(input)
+
+
+def test_r_verbose_diff__no_extra_comments():
+    regex = re.compile(format.r_verbose_diff(), re.MULTILINE)
+    input = """# ----------- >8 -----------
+diff --git a/file b/file
+"""
+
+    assert not regex.match(input)
+
+
+def test_strip_verbose_diff__has_diff():
+    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
+# ----------- >8 -----------
+# Some comment
+# Some comment
+diff --git a/file b/file
+"""
+
+    result = format.strip_verbose_diff(input)
+    assert result.count("\n") == 4
+    assert (
+        result
+        == """feat(scope): message
+# Please enter the commit message for your changes.
+
+# These are comments usually added by editors, f.ex. with export EDITOR=vim
+"""
+    )
+
+
+def test_strip_verbose_diff__no_diff():
+    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
+# ----------- >8 -----------
+# Some comment
+# Some comment
+"""
+
+    result = format.strip_verbose_diff(input)
+    assert result == input
+
+
 @pytest.mark.parametrize("type", format.DEFAULT_TYPES)
 def test_is_conventional__default_type(type):
     input = f"{type}: message"
@@ -198,6 +294,14 @@ def test_is_conventional__bad_body_multiline_paragraphs():
     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}"