feat: Add '--scope-case-insensitive' optional argument

Closes #25

Author: petermESP

README.md

@@ -43,10 +43,10 @@ Each component is checked for compliance with the provided or default configurat
 
 If your commit message does not meet the required format, the hook will fail, producing a **report that shows which part of your commit message needs correction**:
 
-<img src="docs/example-output-default-args.jpg" width="800">
+<img src="docs/example-output-default-args.png" width="800">
 
 For a custom configuration, the report might look like this:
-<img src="docs/example-output-custom-args.jpg" width="800">
+<img src="docs/example-output-custom-args.png" width="800">
 
 The hint message suggests that you can preserve your original message and simply edit it in your default editor, without the need to type the whole message again.
 
@@ -109,6 +109,7 @@ The linter accepts several configurable parameters to tailor commit message vali
 
 - `--types`: Define the types of commits allowed (default: [`change`, `ci`, `docs`, `feat`, `fix`, `refactor`, `remove`, `revert`, `test`]).
 - `--scopes`: Specifies a list of allowed scopes. If not defined, all scopes are allowed (restriction is `disabled`).
+- `--scope-case-insensitive`: Allows uppercase letters in scope.
 - `--subject-min-length`: Set the minimum length for the summary (default: `20`).
 - `--subject-max-length`: Set the maximum length for the summary (default: `72`).
 - `--body-max-line-length`: Set the maximum line length for the body (default: `100`).

conventional_precommit_linter/hook.py

@@ -103,6 +103,9 @@ def check_allowed_types(commit_type: str, args: argparse.Namespace) -> None:
 def check_scope(commit_scope: str, args: argparse.Namespace) -> None:
     """Check for scope capitalization and allowed characters"""
     regex_scope = r'^[a-z0-9_/.,*-]*$'
+    if args.scope_case_insensitive:
+        regex_scope = r'^[a-zA-Z0-9_/.,*-]*$'  # adds A-Z to the allowed character set
+
     if commit_scope and not re.match(regex_scope, commit_scope):
         rules_output_status['error_scope_capitalization'] = True
 
@@ -171,16 +174,22 @@ def print_report(commit_type: str, commit_scope: Optional[str], commit_summary:
     rule_messages.append(
         f"{_get_icon_for_rule(rules_output_status['error_scope_format'])} {_color_blue('(<optional-scope>)')} if used, must be enclosed in parentheses"
     )
-    rule_messages.append(
-        f"{_get_icon_for_rule(rules_output_status['error_scope_capitalization'])} {_color_blue('(<optional-scope>)')} if used, must be written in lower case without whitespace"
-    )
+
+    if args.scope_case_insensitive:
+        rule_messages.append(
+            f"{_get_icon_for_rule(rules_output_status['error_scope_capitalization'])} {_color_blue('(<optional-scope>)')} if used, must not contain whitespace"
+        )
+    else:
+        rule_messages.append(
+            f"{_get_icon_for_rule(rules_output_status['error_scope_capitalization'])} {_color_blue('(<optional-scope>)')} if used, must be written in lower case without whitespace"
+        )
     if args.scopes:
         rule_messages.append(
             f"{_get_icon_for_rule(rules_output_status['error_scope_allowed'])} {_color_blue('(<optional-scope>)')} if used, must be one of the following allowed scopes: [{_color_blue(', '.join(args.scopes))}]"
         )
 
     # SUMMARY messages
-    rule_messages.append(f"{_get_icon_for_rule(rules_output_status['error_summary_period'])} {_color_orange('<summary>')} must not end with a period")
+    rule_messages.append(f"{_get_icon_for_rule(rules_output_status['error_summary_period'])} {_color_orange('<summary>')} must not end with a period '.'")
     rule_messages.append(
         f"{_get_icon_for_rule(rules_output_status['error_summary_length'])} {_color_orange('<summary>')} must be between {args.subject_min_length} and {args.subject_max_length} characters long"
     )
@@ -222,6 +231,7 @@ def parse_args(argv: List[str]) -> argparse.Namespace:
     parser.add_argument('--subject-max-length', type=int, default=72, help="Maximum length of the 'Summary'")
     parser.add_argument('--body-max-line-length', type=int, default=100, help="Maximum length of the 'Body' line")
     parser.add_argument('--summary-uppercase', action='store_true', help="'Summary' must start with an uppercase letter")
+    parser.add_argument('--scope-case-insensitive', action='store_true', help='Allow uppercase letters in the optional scope.')
     parser.add_argument('--allow-breaking', action='store_true', help='Allow exclamation mark in the commit type')
     parser.add_argument('input', type=str, help='A file containing a git commit message')
     return parser.parse_args(argv)

docs/example-output-custom-args.jpg

@@ -3,6 +3,6 @@
 from conventional_precommit_linter.hook import rules_output_status
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture()
 def default_rules_output_status():
     return rules_output_status.copy()

docs/example-output-custom-args.png

@@ -1,4 +1,6 @@
 import tempfile
+from typing import List
+from typing import Tuple
 
 import pytest
 
@@ -7,10 +9,34 @@
 
 # Default values for the commit message format
 TYPES = 'change,ci,docs,feat,fix,refactor,remove,revert,fox'
-SCOPES = 'bootloader,bt,esp32,esp-rom,examples,examples*storage,rom,wifi'
+SCOPES = 'bootloader,bt,Bt,esp32,esp-rom,examples,examples*storage,rom,wifi'
 SUBJECT_MIN_LENGTH = 21
 SUBJECT_MAX_LENGTH = 53
 BODY_MAX_LINE_LENGTH = 107
+DEFAULT_ARGV_TUPLE: Tuple[str, ...] = (
+    '--types',
+    TYPES,
+    '--scopes',
+    SCOPES,
+    '--subject-min-length',
+    str(SUBJECT_MIN_LENGTH),
+    '--subject-max-length',
+    str(SUBJECT_MAX_LENGTH),
+    '--body-max-line-length',
+    str(BODY_MAX_LINE_LENGTH),
+    '--summary-uppercase',
+    '--allow-breaking',
+)
+
+
+# Construct the argument list for main with the new constants
+def get_argv_list(scope_case_insensitive_arg=False) -> List:
+    argv_list: List = list(DEFAULT_ARGV_TUPLE)
+    if scope_case_insensitive_arg:
+        argv_list.append('--scope-case-insensitive')
+
+    print(argv_list)
+    return argv_list
 
 
 # Dynamic test naming based on the commit message
@@ -24,109 +50,121 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
             # Expected PASS: Message with scope and body
             'feat(bootloader): This is commit message with scope and body\n\nThis is a text of body',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message with scope, without body
             'change(wifi): This is commit message with scope without body',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message with scope (with hyphen in scope), without body
             'change(esp-rom): This is commit message with hyphen in scope',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message with scope (with asterisk in scope), without body
             'change(examples*storage): This is commit message with asterisk in scope',
             {},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: Message with not allowed scope and body
             'feat(tomas): This is commit message with scope and body\n\nThis is a text of body',
             {'error_scope_allowed': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: Message with scope (with comma in scope), without body
             'change(examples,storage): This is commit message with comma in scope',
             {'error_scope_allowed': True},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message with scope (with slash in scope), without body
             'change(examples/storage): This is commit message with slash in scope',
             {'error_scope_allowed': True},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message without scope, with body
             "change: This is commit message without scope with body\n\nThis is a text of body\n# Please enter the commit message for your changes. Lines starting\n# with '#' will be ignored, and an empty message aborts the commit.\n#",
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message without scope, without body
             'change: This is commit message without scope and body',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Test of additional types
             'fox(esp32): Testing additional types\n\nThis is a text of body',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: 'body' line longer (custom arg 107 chars)
             'fix(bt): Update database schemas\n\nUpdating the database schema to include fields and user profile preferences, cleaning up unnecessary calls',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message without scope with exclamation mark
             'change!: This is commit with exclamation mark',
             {},
+            get_argv_list(),
         ),
         (
             # Expected PASS: Message with scope with exclamation mark
             'change(rom)!: This is commit with exclamation mark',
             {},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: Message with scope with 2 exclamation marks
             'change(rom)!!: This is commit message with 2 exclamations',
             {'error_type': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: missing colon between 'type' (and 'scope') and 'summary'
             'change this is commit message without body',
             {'missing_colon': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: empty commit message
             '   \n\n   \n',
             {'empty_message': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'summary' too short
             'fix: Fix bug',
             {'error_summary_length': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'summary' too long
             'change(rom): Refactor authentication flow for enhanced security measures',
             {'error_summary_length': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'summary' ends with period
             'change(rom): Fixed the another bug.',
             {'error_summary_period': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'summary' starts with lowercase
             'change(rom): this message starts with lowercase',
             {'error_summary_capitalization': True},
-        ),
-        (
-            # Expected FAIL: uppercase in 'scope', with body
-            'change(Bt): Added new feature with change\n\nThis feature adds functionality',
-            {
-                'error_scope_capitalization': True,
-                'error_scope_allowed': True,
-            },
+            get_argv_list(),
         ),
         (
             # Expected FAIL: uppercase in 'scope', no body
@@ -136,41 +174,49 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
                 'error_summary_length': True,
                 'error_scope_allowed': True,
             },
+            get_argv_list(),
         ),
         (
             # Expected FAIL: not allowed 'type' with scope and body
             'delete(bt): Added new feature with change\n\nThis feature adds functionality',
             {'error_type': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: not allowed 'type' without scope and without body
             'delete: Added new feature with change',
             {'error_type': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: not allowed 'type' without scope and without body
             'wip: Added new feature with change',
             {'error_type': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: not allowed 'type' (type starts with uppercase)
             'Fix(bt): Added new feature with change\n\nThis feature adds functionality',
             {'error_type': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: missing blank line between 'summary' and 'body'
             'change: Added new feature with change\nThis feature adds functionality',
             {'error_body_format': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'body' line too long
             'fix(bt): Update database schemas\n\nUpdating the database schema to include new fields and user profile preferences, cleaning up unnecessary calls',
             {'error_body_length': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: 'scope' missing parentheses
             'fix(bt: Update database schemas\n\nUpdating the database schema to include new fields.',
             {'error_scope_format': True},
+            get_argv_list(),
         ),
         (
             # Expected FAIL: allowed special 'type', uppercase in 'scope' required, 'summary' too long, 'summary' ends with period
@@ -182,6 +228,27 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
                 'error_summary_length': True,
                 'error_summary_period': True,
             },
+            get_argv_list(),
+        ),
+        (
+            # Expected FAIL: uppercase in 'scope'
+            'change(Bt): Added new feature with change\n\nThis feature adds functionality',
+            {
+                'error_scope_capitalization': True,
+            },
+            get_argv_list(),
+        ),
+        (
+            # Expected Pass: Allowed uppercase in 'scope'.
+            'change(Bt): Added new feature with change\n\nThis feature adds functionality',
+            {},
+            get_argv_list(scope_case_insensitive_arg=True),
+        ),
+        (
+            # Expected Fail: Summary ending with a period '.'
+            'change(Bt): Added new feature with change.',
+            {'error_summary_period': True},
+            get_argv_list(scope_case_insensitive_arg=True),
         ),
     ],
     # Use the commit message to generate IDs for each test case
@@ -190,11 +257,11 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
 def commit_message(request, default_rules_output_status):
     # Combine the default dictionary with the test-specific dictionary
     combined_output = {**default_rules_output_status, **request.param[1]}
-    return request.param[0], combined_output
+    return request.param[0], combined_output, request.param[2]
 
 
 def test_commit_message_with_args(commit_message, default_rules_output_status):  # pylint: disable=redefined-outer-name
-    message_text, expected_output = commit_message
+    message_text, expected_output, cli_arguments = commit_message
 
     # Reset rules_output_status to its default state before each test case
     rules_output_status.clear()
@@ -205,30 +272,10 @@ def test_commit_message_with_args(commit_message, default_rules_output_status):
         temp.write(message_text)
         temp_file_name = temp.name
 
-    # Construct the argument list for main with the new constants
-    argv = [
-        '--types',
-        TYPES,
-        '--scopes',
-        SCOPES,
-        '--subject-min-length',
-        str(SUBJECT_MIN_LENGTH),
-        '--subject-max-length',
-        str(SUBJECT_MAX_LENGTH),
-        '--body-max-line-length',
-        str(BODY_MAX_LINE_LENGTH),
-        '--summary-uppercase',
-        '--allow-breaking',
-        temp_file_name,
-    ]
+    cli_arguments.append(temp_file_name)
 
     # Run the main function of your script with the temporary file and arguments
-    try:
-        main(argv)
-
-    finally:
-        # Clean up the temporary file after the test
-        temp.close()
+    main(cli_arguments)
 
     # Retrieve the actual rules_output_status after running the main function
     actual_output = rules_output_status

docs/example-output-default-args.jpg

@@ -186,11 +186,7 @@ def test_commit_message(commit_message, default_rules_output_status):  # pylint:
         temp.write(message_text)
         temp_file_name = temp.name
 
-    # Run the main function of your script with the temporary file
-    try:
-        main([temp_file_name])  # Pass the file name as a positional argument
-    finally:
-        temp.close()  # Clean up the temporary file after the test
+    main([temp_file_name])  # Pass the file name as a positional argument
 
     # Retrieve the actual rules_output_status after running the main function
     actual_output = rules_output_status