diff --git a/.commit-check.yml b/.commit-check.yml
index ad339d0..d215d90 100644
--- a/.commit-check.yml
+++ b/.commit-check.yml
@@ -32,3 +32,8 @@ checks:
regex: main # it can be master, develop, devel etc based on your project.
error: Current branch is not rebased onto target branch
suggest: Please ensure your branch is rebased with the target branch
+
+ - check: imperative
+ regex: '' # Not used for imperative mood check
+ error: 'Commit message should use imperative mood (e.g., "Add feature" not "Added feature")'
+ suggest: 'Use imperative mood in commit message like "Add", "Fix", "Update", "Remove"'
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index 95bb02f..755e981 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -5,10 +5,6 @@
version: 2
updates:
- - package-ecosystem: docker
- directory: /
- schedule:
- interval: "weekly"
- package-ecosystem: github-actions
directory: /
schedule:
diff --git a/.github/workflows/publish-image.yml b/.github/workflows/publish-image.yml
deleted file mode 100644
index 6e4fe40..0000000
--- a/.github/workflows/publish-image.yml
+++ /dev/null
@@ -1,36 +0,0 @@
-name: publish image
-
-permissions:
- contents: read
- packages: write
-
-on:
- push:
- paths:
- - 'Dockerfile'
- workflow_dispatch:
- inputs:
- tag:
- description: 'Which tag want to build'
- default: ''
- required: false
-
-jobs:
- publish:
- runs-on: ubuntu-24.04
- steps:
- - uses: actions/checkout@v4
- - name: Build to check Dockerfile
- if: github.event.inputs.tag == ''
- run: |
- docker build -f Dockerfile -t commit-check .
- - name: Build and publish docker image
- if: github.event.inputs.tag != ''
- run: |
- echo "tag = ${{ github.event.inputs.tag }}"
- docker build -f Dockerfile --build-arg VERSION=${{ github.event.inputs.tag }} -t commit-check:${{ github.event.inputs.tag }} .
- echo $CR_PAT | docker login ghcr.io -u shenxianpeng --password-stdin
- docker tag commit-check:${{ github.event.inputs.tag }} ghcr.io/commit-check/commit-check:${{ github.event.inputs.tag }}
- docker push ghcr.io/commit-check/commit-check:${{ github.event.inputs.tag }}
- env:
- CR_PAT: ${{ secrets.CR_PAT }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 8f6f962..58c47aa 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -42,4 +42,5 @@ repos:
- id: check-author-name # uncomment if you need.
- id: check-author-email # uncomment if you need.
# - id: check-commit-signoff # uncomment if you need.
- # - id: check-merge-base # requires download all git history
+ # - id: check-merge-base # requires download all git history
+ # - id: check-imperative # uncomment if you need.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
index 1fca51a..6a73596 100644
--- a/.pre-commit-hooks.yaml
+++ b/.pre-commit-hooks.yaml
@@ -41,3 +41,10 @@
args: [--merge-base]
pass_filenames: false
language: python
+- id: check-imperative
+ name: check imperative mood
+ description: ensures commit message uses imperative mood
+ entry: commit-check
+ args: [--imperative]
+ pass_filenames: true
+ language: python
diff --git a/Dockerfile b/Dockerfile
deleted file mode 100644
index 7776999..0000000
--- a/Dockerfile
+++ /dev/null
@@ -1,21 +0,0 @@
-FROM python:3.13-slim
-
-ARG VERSION
-
-LABEL com.github.actions.name="Commit Check"
-LABEL com.github.actions.description="Check commit message formatting, branch naming, commit author, email, and more."
-LABEL com.github.actions.icon="code"
-LABEL com.github.actions.color="gray-dark"
-
-LABEL repository="https://github.com/commit-check/commit-check"
-LABEL maintainer="shenxianpeng <20297606+shenxianpeng@users.noreply.github.com>"
-
-RUN if [ -z "$VERSION" ]; then \
- pip3 install commit-check; \
- else \
- pip3 install commit-check==$VERSION; \
- fi
-
-USER nobody
-
-ENTRYPOINT [ "commit-check" ]
diff --git a/README.rst b/README.rst
index b9ac03a..bfda1a0 100644
--- a/README.rst
+++ b/README.rst
@@ -77,6 +77,7 @@ Running as pre-commit hook
- id: check-author-email
- id: check-commit-signoff
- id: check-merge-base # requires download all git history
+ - id: check-imperative
Running as CLI
~~~~~~~~~~~~~~
@@ -109,7 +110,7 @@ To configure the hook, create a script file in the ``.git/hooks/`` directory.
.. code-block:: bash
#!/bin/sh
- commit-check --message --branch --author-name --author-email --commit-signoff --merge-base
+ commit-check --message --branch --author-name --author-email --commit-signoff --merge-base --imperative
Save the script file as ``pre-push`` and make it executable:
@@ -156,14 +157,14 @@ Check Branch Naming Failed
Commit rejected by Commit-Check.
- (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
- / ._. \ / ._. \ / ._. \ / ._. \ / ._. \
- __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
+ (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
+ / ._. \ / ._. \ / ._. \ / ._. \ / ._. \
+ __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
- || E || || R || || R || || O || || R ||
- _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
+ || E || || R || || R || || O || || R ||
+ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
- `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
+ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
Commit rejected.
@@ -179,14 +180,14 @@ Check Commit Signature Failed
Commit rejected by Commit-Check.
- (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
- / ._. \ / ._. \ / ._. \ / ._. \ / ._. \
- __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
+ (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
+ / ._. \ / ._. \ / ._. \ / ._. \ / ._. \
+ __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
- || E || || R || || R || || O || || R ||
- _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
+ || E || || R || || R || || O || || R ||
+ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
- `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
+ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
Commit rejected.
@@ -196,6 +197,28 @@ Check Commit Signature Failed
Suggest: run command `git commit -m "conventional commit message" --signoff`
+Check Imperative Mood Failed
+
+.. code-block:: text
+
+ Commit rejected by Commit-Check.
+
+ (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
+ / ._. \ / ._. \ / ._. \ / ._. \ / ._. \
+ __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
+ (_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
+ || E || || R || || R || || O || || R ||
+ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
+ (.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
+ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
+
+ Commit rejected.
+
+ Type imperative check failed => Added file
+ It doesn't match regex: imperative mood pattern
+ Commit message should use imperative mood (e.g., "Add feature" not "Added feature")
+ Suggest: Use imperative mood in commit message like "Add", "Fix", "Update", "Remove"
+
Badging your repository
-----------------------
diff --git a/commit_check/__init__.py b/commit_check/__init__.py
index 521f68f..8b78762 100644
--- a/commit_check/__init__.py
+++ b/commit_check/__init__.py
@@ -54,6 +54,12 @@
'error': 'Current branch is not rebased onto target branch',
'suggest': 'Please ensure your branch is rebased with the target branch',
},
+ {
+ 'check': 'imperative',
+ 'regex': r'', # Not used for imperative mood check
+ 'error': 'Commit message should use imperative mood (e.g., "Add feature" not "Added feature")',
+ 'suggest': 'Use imperative mood in commit message like "Add", "Fix", "Update", "Remove"',
+ },
],
}
diff --git a/commit_check/commit.py b/commit_check/commit.py
index ac1c63a..05a08e3 100644
--- a/commit_check/commit.py
+++ b/commit_check/commit.py
@@ -3,6 +3,12 @@
from pathlib import PurePath
from commit_check import YELLOW, RESET_COLOR, PASS, FAIL
from commit_check.util import cmd_output, get_commit_info, print_error_header, print_error_message, print_suggestion, has_commits
+from commit_check.imperatives import IMPERATIVES
+
+
+def _load_imperatives() -> set:
+ """Load imperative verbs from imperatives module."""
+ return IMPERATIVES
def get_default_commit_msg_file() -> str:
@@ -84,3 +90,92 @@ def check_commit_signoff(checks: list, commit_msg_file: str = "") -> int:
return FAIL
return PASS
+
+
+def check_imperative(checks: list, commit_msg_file: str = "") -> int:
+ """Check if commit message uses imperative mood."""
+ if has_commits() is False:
+ return PASS # pragma: no cover
+
+ if commit_msg_file is None or commit_msg_file == "":
+ commit_msg_file = get_default_commit_msg_file()
+
+ for check in checks:
+ if check['check'] == 'imperative':
+ commit_msg = read_commit_msg(commit_msg_file)
+
+ # Extract the subject line (first line of commit message)
+ subject = commit_msg.split('\n')[0].strip()
+
+ # Skip if empty or merge commit
+ if not subject or subject.startswith('Merge'):
+ return PASS
+
+ # For conventional commits, extract description after the colon
+ if ':' in subject:
+ description = subject.split(':', 1)[1].strip()
+ else:
+ description = subject
+
+ # Check if the description uses imperative mood
+ if not _is_imperative(description):
+ if not print_error_header.has_been_called:
+ print_error_header() # pragma: no cover
+ print_error_message(
+ check['check'], 'imperative mood pattern',
+ check['error'], subject,
+ )
+ if check['suggest']:
+ print_suggestion(check['suggest'])
+ return FAIL
+
+ return PASS
+
+
+def _is_imperative(description: str) -> bool:
+ """Check if a description uses imperative mood."""
+ if not description:
+ return True
+
+ # Get the first word of the description
+ first_word = description.split()[0].lower()
+
+ # Load imperative verbs from file
+ imperatives = _load_imperatives()
+
+ # Check for common past tense pattern (-ed ending) but be more specific
+ if (first_word.endswith('ed') and len(first_word) > 3 and
+ first_word not in {'red', 'bed', 'fed', 'led', 'wed', 'shed', 'fled'}):
+ return False
+
+ # Check for present continuous pattern (-ing ending) but be more specific
+ if (first_word.endswith('ing') and len(first_word) > 4 and
+ first_word not in {'ring', 'sing', 'king', 'wing', 'thing', 'string', 'bring'}):
+ return False
+
+ # Check for third person singular (-s ending) but be more specific
+ # Only flag if it's clearly a verb in third person singular form
+ if first_word.endswith('s') and len(first_word) > 3:
+ # Common nouns ending in 's' that should be allowed
+ common_nouns_ending_s = {'process', 'access', 'address', 'progress', 'express', 'stress', 'success', 'class', 'pass', 'mass', 'loss', 'cross', 'gross', 'boss', 'toss', 'less', 'mess', 'dress', 'press', 'bless', 'guess', 'chess', 'glass', 'grass', 'brass'}
+
+ # Words ending in 'ss' or 'us' are usually not third person singular verbs
+ if first_word.endswith('ss') or first_word.endswith('us'):
+ return True # Allow these
+
+ # If it's a common noun, allow it
+ if first_word in common_nouns_ending_s:
+ return True
+
+ # Otherwise, it's likely a third person singular verb
+ return False
+
+ # If we have imperatives loaded, check if the first word is imperative
+ if imperatives:
+ # Check if the first word is in our imperative list
+ if first_word in imperatives:
+ return True
+
+ # If word is not in imperatives list, apply some heuristics
+ # If it passes all the negative checks above, it's likely imperative
+ return True
diff --git a/commit_check/imperatives.py b/commit_check/imperatives.py
new file mode 100644
index 0000000..0c3d091
--- /dev/null
+++ b/commit_check/imperatives.py
@@ -0,0 +1,237 @@
+# https://github.com/crate-ci/imperative/blob/master/assets/imperatives.txt
+# Imperative forms of verbs
+#
+# This file contains the imperative form of frequently encountered
+# docstring verbs. Some of these may be more commonly encountered as
+# nouns, but blacklisting them for this may cause false positives.
+
+IMPERATIVES = {
+ 'accept',
+ 'access',
+ 'add',
+ 'adjust',
+ 'aggregate',
+ 'allow',
+ 'append',
+ 'apply',
+ 'archive',
+ 'assert',
+ 'assign',
+ 'attempt',
+ 'authenticate',
+ 'authorize',
+ 'break',
+ 'build',
+ 'cache',
+ 'calculate',
+ 'call',
+ 'cancel',
+ 'capture',
+ 'change',
+ 'check',
+ 'clean',
+ 'clear',
+ 'close',
+ 'collect',
+ 'combine',
+ 'commit',
+ 'compare',
+ 'compute',
+ 'configure',
+ 'confirm',
+ 'connect',
+ 'construct',
+ 'control',
+ 'convert',
+ 'copy',
+ 'count',
+ 'create',
+ 'customize',
+ 'declare',
+ 'decode',
+ 'decorate',
+ 'define',
+ 'delegate',
+ 'delete',
+ 'deprecate',
+ 'derive',
+ 'describe',
+ 'detect',
+ 'determine',
+ 'display',
+ 'download',
+ 'drop',
+ 'dump',
+ 'emit',
+ 'empty',
+ 'enable',
+ 'encapsulate',
+ 'encode',
+ 'end',
+ 'ensure',
+ 'enumerate',
+ 'establish',
+ 'evaluate',
+ 'examine',
+ 'execute',
+ 'exit',
+ 'expand',
+ 'expect',
+ 'export',
+ 'extend',
+ 'extract',
+ 'feed',
+ 'fetch',
+ 'fill',
+ 'filter',
+ 'finalize',
+ 'find',
+ 'fire',
+ 'fix',
+ 'flag',
+ 'force',
+ 'format',
+ 'forward',
+ 'generate',
+ 'get',
+ 'give',
+ 'go',
+ 'group',
+ 'handle',
+ 'help',
+ 'hold',
+ 'identify',
+ 'implement',
+ 'import',
+ 'indicate',
+ 'init',
+ 'initialise',
+ 'initialize',
+ 'initiate',
+ 'input',
+ 'insert',
+ 'instantiate',
+ 'intercept',
+ 'invoke',
+ 'iterate',
+ 'join',
+ 'keep',
+ 'launch',
+ 'list',
+ 'listen',
+ 'load',
+ 'log',
+ 'look',
+ 'make',
+ 'manage',
+ 'manipulate',
+ 'map',
+ 'mark',
+ 'match',
+ 'merge',
+ 'mock',
+ 'modify',
+ 'monitor',
+ 'move',
+ 'normalize',
+ 'note',
+ 'obtain',
+ 'open',
+ 'output',
+ 'override',
+ 'overwrite',
+ 'package',
+ 'pad',
+ 'parse',
+ 'partial',
+ 'pass',
+ 'perform',
+ 'persist',
+ 'pick',
+ 'plot',
+ 'poll',
+ 'populate',
+ 'post',
+ 'prepare',
+ 'print',
+ 'process',
+ 'produce',
+ 'provide',
+ 'publish',
+ 'pull',
+ 'put',
+ 'query',
+ 'raise',
+ 'read',
+ 'record',
+ 'refer',
+ 'refresh',
+ 'register',
+ 'reload',
+ 'remove',
+ 'rename',
+ 'render',
+ 'replace',
+ 'reply',
+ 'report',
+ 'represent',
+ 'request',
+ 'require',
+ 'reset',
+ 'resolve',
+ 'retrieve',
+ 'return',
+ 'roll',
+ 'rollback',
+ 'round',
+ 'run',
+ 'sample',
+ 'save',
+ 'scan',
+ 'search',
+ 'select',
+ 'send',
+ 'serialise',
+ 'serialize',
+ 'serve',
+ 'set',
+ 'show',
+ 'simulate',
+ 'source',
+ 'specify',
+ 'split',
+ 'start',
+ 'step',
+ 'stop',
+ 'store',
+ 'strip',
+ 'submit',
+ 'subscribe',
+ 'sum',
+ 'swap',
+ 'sync',
+ 'synchronise',
+ 'synchronize',
+ 'take',
+ 'tear',
+ 'test',
+ 'time',
+ 'transform',
+ 'translate',
+ 'transmit',
+ 'truncate',
+ 'try',
+ 'turn',
+ 'tweak',
+ 'update',
+ 'upload',
+ 'use',
+ 'validate',
+ 'verify',
+ 'view',
+ 'wait',
+ 'walk',
+ 'wrap',
+ 'write',
+ 'yield',
+}
diff --git a/commit_check/main.py b/commit_check/main.py
index 6faa070..f81af48 100644
--- a/commit_check/main.py
+++ b/commit_check/main.py
@@ -92,6 +92,14 @@ def get_parser() -> argparse.ArgumentParser:
required=False,
)
+ parser.add_argument(
+ '-i',
+ '--imperative',
+ help='check commit message uses imperative mood',
+ action="store_true",
+ required=False,
+ )
+
return parser
@@ -122,6 +130,8 @@ def main() -> int:
check_results.append(commit.check_commit_signoff(checks))
if args.merge_base:
check_results.append(branch.check_merge_base(checks))
+ if args.imperative:
+ check_results.append(commit.check_imperative(checks, args.commit_msg_file))
return PASS if all(val == PASS for val in check_results) else FAIL
diff --git a/tests/commit_test.py b/tests/commit_test.py
index c733968..9a1235d 100644
--- a/tests/commit_test.py
+++ b/tests/commit_test.py
@@ -1,6 +1,6 @@
import pytest
from commit_check import PASS, FAIL
-from commit_check.commit import check_commit_msg, get_default_commit_msg_file, read_commit_msg, check_commit_signoff
+from commit_check.commit import check_commit_msg, get_default_commit_msg_file, read_commit_msg, check_commit_signoff, check_imperative
# used by get_commit_info mock
FAKE_BRANCH_NAME = "fake_commits_info"
@@ -177,3 +177,224 @@ def test_check_commit_signoff_with_empty_checks(mocker):
retval = check_commit_signoff(checks)
assert retval == PASS
assert m_re_match.call_count == 0
+
+
+@pytest.mark.benchmark
+def test_check_imperative_pass(mocker):
+ """Test imperative mood check passes for valid imperative mood."""
+ checks = [{
+ "check": "imperative",
+ "regex": "",
+ "error": "Commit message should use imperative mood",
+ "suggest": "Use imperative mood"
+ }]
+
+ mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="feat: Add new feature\n\nThis adds a new feature to the application."
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == PASS
+
+
+@pytest.mark.benchmark
+def test_check_imperative_fail_past_tense(mocker):
+ """Test imperative mood check fails for past tense."""
+ checks = [{
+ "check": "imperative",
+ "regex": "",
+ "error": "Commit message should use imperative mood",
+ "suggest": "Use imperative mood"
+ }]
+
+ mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="feat: Added new feature"
+ )
+
+ m_print_error_message = mocker.patch(
+ f"{LOCATION}.print_error_message"
+ )
+ m_print_suggestion = mocker.patch(
+ f"{LOCATION}.print_suggestion"
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == FAIL
+ assert m_print_error_message.call_count == 1
+ assert m_print_suggestion.call_count == 1
+
+
+@pytest.mark.benchmark
+def test_check_imperative_fail_present_continuous(mocker):
+ """Test imperative mood check fails for present continuous."""
+ checks = [{
+ "check": "imperative",
+ "regex": "",
+ "error": "Commit message should use imperative mood",
+ "suggest": "Use imperative mood"
+ }]
+
+ mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="feat: Adding new feature"
+ )
+
+ m_print_error_message = mocker.patch(
+ f"{LOCATION}.print_error_message"
+ )
+ m_print_suggestion = mocker.patch(
+ f"{LOCATION}.print_suggestion"
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == FAIL
+ assert m_print_error_message.call_count == 1
+ assert m_print_suggestion.call_count == 1
+
+
+@pytest.mark.benchmark
+def test_check_imperative_skip_merge_commit(mocker):
+ """Test imperative mood check skips merge commits."""
+ checks = [{
+ "check": "imperative",
+ "regex": "",
+ "error": "Commit message should use imperative mood",
+ "suggest": "Use imperative mood"
+ }]
+
+ mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="Merge branch 'feature/test' into main"
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == PASS
+
+
+@pytest.mark.benchmark
+def test_check_imperative_different_check_type(mocker):
+ """Test imperative mood check skips different check types."""
+ checks = [{
+ "check": "message",
+ "regex": "dummy_regex"
+ }]
+
+ m_read_commit_msg = mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="feat: Added new feature"
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == PASS
+ assert m_read_commit_msg.call_count == 0
+
+
+@pytest.mark.benchmark
+def test_check_imperative_no_commits(mocker):
+ """Test imperative mood check passes when there are no commits."""
+ checks = [{
+ "check": "imperative",
+ "regex": "",
+ "error": "Commit message should use imperative mood",
+ "suggest": "Use imperative mood"
+ }]
+
+ mocker.patch("commit_check.commit.has_commits", return_value=False)
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == PASS
+
+
+@pytest.mark.benchmark
+def test_check_imperative_empty_checks(mocker):
+ """Test imperative mood check with empty checks list."""
+ checks = []
+
+ m_read_commit_msg = mocker.patch(
+ "commit_check.commit.read_commit_msg",
+ return_value="feat: Added new feature"
+ )
+
+ retval = check_imperative(checks, MSG_FILE)
+ assert retval == PASS
+ assert m_read_commit_msg.call_count == 0
+
+
+@pytest.mark.benchmark
+def test_is_imperative_valid_cases():
+ """Test _is_imperative function with valid imperative mood cases."""
+ from commit_check.commit import _is_imperative
+
+ valid_cases = [
+ "Add new feature",
+ "Fix bug in authentication",
+ "Update documentation",
+ "Remove deprecated code",
+ "Refactor user service",
+ "Optimize database queries",
+ "Create new component",
+ "Delete unused files",
+ "Improve error handling",
+ "Enhance user experience",
+ "Implement new API",
+ "Configure CI/CD pipeline",
+ "Setup testing framework",
+ "Handle edge cases",
+ "Process user input",
+ "Validate form data",
+ "Transform data format",
+ "Initialize application",
+ "Load configuration",
+ "Save user preferences",
+ "", # Empty description should pass
+ ]
+
+ for case in valid_cases:
+ assert _is_imperative(case), f"'{case}' should be imperative mood"
+
+
+@pytest.mark.benchmark
+def test_is_imperative_invalid_cases():
+ """Test _is_imperative function with invalid imperative mood cases."""
+ from commit_check.commit import _is_imperative
+
+ invalid_cases = [
+ "Added new feature",
+ "Fixed bug in authentication",
+ "Updated documentation",
+ "Removed deprecated code",
+ "Refactored user service",
+ "Optimized database queries",
+ "Created new component",
+ "Deleted unused files",
+ "Improved error handling",
+ "Enhanced user experience",
+ "Implemented new API",
+ "Adding new feature",
+ "Fixing bug in authentication",
+ "Updating documentation",
+ "Removing deprecated code",
+ "Refactoring user service",
+ "Optimizing database queries",
+ "Creating new component",
+ "Deleting unused files",
+ "Improving error handling",
+ "Enhancing user experience",
+ "Implementing new API",
+ "Adds new feature",
+ "Fixes bug in authentication",
+ "Updates documentation",
+ "Removes deprecated code",
+ "Refactors user service",
+ "Optimizes database queries",
+ "Creates new component",
+ "Deletes unused files",
+ "Improves error handling",
+ "Enhances user experience",
+ "Implements new API",
+ ]
+
+ for case in invalid_cases:
+ assert not _is_imperative(case), f"'{case}' should not be imperative mood"
diff --git a/tests/main_test.py b/tests/main_test.py
index c232efd..4e277a6 100644
--- a/tests/main_test.py
+++ b/tests/main_test.py
@@ -8,20 +8,22 @@
class TestMain:
@pytest.mark.benchmark
- @pytest.mark.parametrize("argv, check_commit_call_count, check_branch_call_count, check_author_call_count, check_commit_signoff_call_count, check_merge_base_call_count", [
- ([CMD, "--message"], 1, 0, 0, 0, 0),
- ([CMD, "--branch"], 0, 1, 0, 0, 0),
- ([CMD, "--author-name"], 0, 0, 1, 0, 0),
- ([CMD, "--author-email"], 0, 0, 1, 0, 0),
- ([CMD, "--commit-signoff"], 0, 0, 0, 1, 0),
- ([CMD, "--merge-base"], 0, 0, 0, 0, 1),
- ([CMD, "--message", "--author-email"], 1, 0, 1, 0, 0),
- ([CMD, "--branch", "--message"], 1, 1, 0, 0, 0),
- ([CMD, "--author-name", "--author-email"], 0, 0, 2, 0, 0),
- ([CMD, "--message", "--branch", "--author-email"], 1, 1, 1, 0, 0),
- ([CMD, "--branch", "--message", "--author-name", "--author-email"], 1, 1, 2, 0, 0),
- ([CMD, "--message", "--branch", "--author-name", "--author-email", "--commit-signoff", "--merge-base"], 1, 1, 2, 1, 1),
- ([CMD, "--dry-run"], 0, 0, 0, 0, 0),
+ @pytest.mark.parametrize("argv, check_commit_call_count, check_branch_call_count, check_author_call_count, check_commit_signoff_call_count, check_merge_base_call_count, check_imperative_call_count", [
+ ([CMD, "--message"], 1, 0, 0, 0, 0, 0),
+ ([CMD, "--branch"], 0, 1, 0, 0, 0, 0),
+ ([CMD, "--author-name"], 0, 0, 1, 0, 0, 0),
+ ([CMD, "--author-email"], 0, 0, 1, 0, 0, 0),
+ ([CMD, "--commit-signoff"], 0, 0, 0, 1, 0, 0),
+ ([CMD, "--merge-base"], 0, 0, 0, 0, 1, 0),
+ ([CMD, "--imperative"], 0, 0, 0, 0, 0, 1),
+ ([CMD, "--message", "--author-email"], 1, 0, 1, 0, 0, 0),
+ ([CMD, "--branch", "--message"], 1, 1, 0, 0, 0, 0),
+ ([CMD, "--author-name", "--author-email"], 0, 0, 2, 0, 0, 0),
+ ([CMD, "--message", "--branch", "--author-email"], 1, 1, 1, 0, 0, 0),
+ ([CMD, "--branch", "--message", "--author-name", "--author-email"], 1, 1, 2, 0, 0, 0),
+ ([CMD, "--message", "--branch", "--author-name", "--author-email", "--commit-signoff", "--merge-base"], 1, 1, 2, 1, 1, 0),
+ ([CMD, "--message", "--imperative"], 1, 0, 0, 0, 0, 1),
+ ([CMD, "--dry-run"], 0, 0, 0, 0, 0, 0),
])
def test_main(
self,
@@ -32,6 +34,7 @@ def test_main(
check_author_call_count,
check_commit_signoff_call_count,
check_merge_base_call_count,
+ check_imperative_call_count,
):
mocker.patch(
"commit_check.main.validate_config",
@@ -46,6 +49,7 @@ def test_main(
m_check_author = mocker.patch("commit_check.author.check_author")
m_check_commit_signoff = mocker.patch("commit_check.commit.check_commit_signoff")
m_check_merge_base = mocker.patch("commit_check.branch.check_merge_base")
+ m_check_imperative = mocker.patch("commit_check.commit.check_imperative")
sys.argv = argv
main()
assert m_check_commit.call_count == check_commit_call_count
@@ -53,6 +57,7 @@ def test_main(
assert m_check_author.call_count == check_author_call_count
assert m_check_commit_signoff.call_count == check_commit_signoff_call_count
assert m_check_merge_base.call_count == check_merge_base_call_count
+ assert m_check_imperative.call_count == check_imperative_call_count
@pytest.mark.benchmark
def test_main_help(self, mocker, capfd):
@@ -168,6 +173,7 @@ def test_main_multiple_checks(
mocker.patch(
"commit_check.branch.check_merge_base", return_value=merge_base_result
)
+ mocker.patch("commit_check.commit.check_imperative", return_value=PASS)
# this is messy. why isn't this a private implementation detail with a
# public check_author_name and check_author email?
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy