feat(scope): add optional restriction to available scopes

Author: tomassebestik

README.md

@@ -80,6 +80,7 @@ After modifying `.pre-commit-config.yaml`, re-run the install command (`pre-comm
 
 The linter accepts several configurable parameters to tailor commit message validation:
 - `--types`: Define the types of commits allowed (default: [`change`, `ci`, `docs`, `feat`, `fix`, `refactor`, `remove`, `revert`]).
+- `--scopes`: Specifies a list of allowed scopes. If not defined, all scopes are allowed (restriction is `disabled`).
 - `--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`).
@@ -96,6 +97,7 @@ The **custom configuration** can be specified in `.pre-commit-config.yaml` like
       stages: [commit-msg]
       args:
         - --types=change,ci,docs,feat,fix,refactor,remove,revert,fox
+        - --scopes=bt,wifi,ethernet
         - --subject-min-length=10
 ```
 
@@ -137,7 +139,7 @@ We welcome contributions! To contribute to this repository, please follow these
 
   ... or with arguments:
   ```sh
-  python -m conventional_precommit_linter.hook --subject-min-length 20 --subject-max-length 72 --body-max-line-length 100 test_message.txt
+  python -m conventional_precommit_linter.hook test_message.txt --subject-min-length="12" --subject-max-length="55" --body-max-line-length="88" --types="feat,change,style" --scopes="bt,wifi,ethernet"
   ```
 
 

conventional_precommit_linter/hook.py

@@ -16,6 +16,7 @@
     'empty_message': False,
     'error_body_format': False,
     'error_body_length': False,
+    'error_scope_allowed': False,
     'error_scope_capitalization': False,
     'error_scope_format': False,
     'error_summary_capitalization': False,
@@ -26,11 +27,17 @@
 }
 
 
-def allowed_types(args: argparse.Namespace) -> str:
+def get_allowed_types(args: argparse.Namespace) -> List[str]:
     default_types = ['change', 'ci', 'docs', 'feat', 'fix', 'refactor', 'remove', 'revert']
     # Provided types take precedence over default types
-    types = args.types[0].split(',') if args.types else default_types
-    return ', '.join(types)
+    types: List[str] = args.types[0].split(',') if args.types else default_types
+    return types
+
+
+def get_allowed_scopes(args: argparse.Namespace) -> List[str]:
+    default_scopes: List[str] = []
+    scopes: List[str] = args.scopes[0].split(',') if args.scopes else default_scopes
+    return scopes
 
 
 def read_commit_message(file_path: str) -> str:
@@ -69,17 +76,22 @@ def check_colon_after_type(message_title: str) -> bool:
 
 def check_allowed_types(commit_type: str, args: argparse.Namespace) -> None:
     """Check for allowed types."""
-    types = allowed_types(args)
+    types: List[str] = get_allowed_types(args)
     if commit_type not in types:
         rules_output_status['error_type'] = True
 
 
-def check_scope(commit_scope: str) -> 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 commit_scope and not re.match(regex_scope, commit_scope):
         rules_output_status['error_scope_capitalization'] = True
 
+    # Check against the list of allowed scopes if provided
+    allowed_scopes: List[str] = get_allowed_scopes(args)
+    if allowed_scopes and commit_scope not in allowed_scopes:
+        rules_output_status['error_scope_allowed'] = True
+
 
 def check_summary_length(commit_summary: str, args: argparse.Namespace) -> None:
     """Check for summary length (between min and max allowed characters)"""
@@ -125,23 +137,45 @@ def print_report(commit_type: str, commit_scope: Optional[str], commit_summary:
             f'{_color_purple(commit_type)}({ _color_blue( commit_scope)}): { _color_orange( commit_summary)}'
         )
 
-    # Rule messages that are always included
-    rule_messages = [
-        f"{_get_icon_for_rule(rules_output_status['error_type'])} {_color_purple('<type>')} is mandatory, use one of the following: [{_color_purple(allowed_types(args))}]",
-        f"{_get_icon_for_rule(rules_output_status['error_scope_format'])} {_color_blue('(<optional-scope>)')} if used, must be enclosed in parentheses",
-        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",
-        f"{_get_icon_for_rule(rules_output_status['error_summary_period'])} {_color_orange('<summary>')} must not end with a period",
-        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",
-        f"{_get_icon_for_rule(rules_output_status['error_body_length'])} {_color_grey('<body>')} lines must be no longer than {args.body_max_line_length} characters",
-        f"{_get_icon_for_rule(rules_output_status['error_body_format'])} {_color_grey('<body>')} must be separated from the 'summary' by a blank line",
-    ]
-
-    # Dynamically add the additional rules set by arguments
+    rule_messages: List[str] = []
+
+    # TYPES messages
+    rule_messages.append(
+        f"{_get_icon_for_rule(rules_output_status['error_type'])} {_color_purple('<type>')} is mandatory, use one of the following: [{_color_purple(', '.join(get_allowed_types(args)))}]"
+    )
+
+    # SCOPE messages
+    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.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_length'])} {_color_orange('<summary>')} must be between {args.subject_min_length} and {args.subject_max_length} characters long"
+    )
     if args.summary_uppercase:
         rule_messages.append(
             f"{_get_icon_for_rule(rules_output_status['error_summary_capitalization'])} {_color_orange('<summary>')} must start with an uppercase letter"
         )
 
+    # BODY messages
+    rule_messages.append(
+        f"{_get_icon_for_rule(rules_output_status['error_body_length'])} {_color_grey('<body>')} lines must be no longer than {args.body_max_line_length} characters"
+    )
+    rule_messages.append(
+        f"{_get_icon_for_rule(rules_output_status['error_body_format'])} {_color_grey('<body>')} must be separated from the 'summary' by a blank line"
+    )
+
     # Combine the rule messages into the final report block
     message_rules_block = '    ' + '\n        '.join(rule_messages)
 
@@ -165,11 +199,14 @@ def parse_args(argv: List[str]) -> argparse.Namespace:
     parser = argparse.ArgumentParser(
         prog='conventional-pre-commit', description='Check a git commit message for Conventional Commits formatting.'
     )
-    parser.add_argument('--types', type=str, nargs='*', help='Optional list of types to support')
+    parser.add_argument('--types', type=str, nargs='*', help="Redefine the list of allowed 'Types'")
+    parser.add_argument('--scopes', type=str, nargs='*', help="Setting the list of allowed 'Scopes'")
     parser.add_argument('--subject-min-length', type=int, default=20, help="Minimum length of the 'Summary'")
     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('--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('input', type=str, help='A file containing a git commit message')
     return parser.parse_args(argv)
 
@@ -200,7 +237,7 @@ def main(argv: Optional[List[str]] = None) -> int:
     # Commit message title (first line) checks
     check_allowed_types(commit_type, args)
     if commit_scope:
-        check_scope(commit_scope)
+        check_scope(commit_scope, args)
     check_summary_length(commit_summary, args)
     check_summary_period(commit_summary)
     if args.summary_uppercase:

tests/test_custom_args.py

@@ -6,7 +6,8 @@
 from conventional_precommit_linter.hook import rules_output_status
 
 # Default values for the commit message format
-TYPES = 'change, ci, docs, feat, fix, refactor, remove, revert, fox'
+TYPES = 'change,ci,docs,feat,fix,refactor,remove,revert,fox'
+SCOPES = 'bootloader,bt,esp32,esp-rom,examples,examples*storage,rom,wifi'
 SUBJECT_MIN_LENGTH = 21
 SUBJECT_MAX_LENGTH = 53
 BODY_MAX_LINE_LENGTH = 107
@@ -17,6 +18,7 @@
     'empty_message': False,
     'error_body_format': False,
     'error_body_length': False,
+    'error_scope_allowed': False,
     'error_scope_capitalization': False,
     'error_scope_format': False,
     'error_summary_capitalization': False,
@@ -55,14 +57,19 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
             {},
         ),
         (
-            # Expected PASS: Message with scope (with comma in scope), without body
+            # 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},
+        ),
+        (
+            # 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},
         ),
         (
             # 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},
         ),
         (
             # Expected PASS: Message without scope, with body
@@ -117,12 +124,19 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
         (
             # 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_capitalization': True,
+                'error_scope_allowed': True,
+            },
         ),
         (
             # Expected FAIL: uppercase in 'scope', no body
             'fix(dangerGH): Update token permissions - allow Danger to add comments to PR',
-            {'error_scope_capitalization': True, 'error_summary_length': True},
+            {
+                'error_scope_capitalization': True,
+                'error_summary_length': True,
+                'error_scope_allowed': True,
+            },
         ),
         (
             # Expected FAIL: not allowed 'type' with scope and body
@@ -155,7 +169,7 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
             {'error_body_length': True},
         ),
         (
-            # Expected FAIL: 'scope' missing parenthese
+            # Expected FAIL: 'scope' missing parentheses
             'fix(bt: Update database schemas\n\nUpdating the database schema to include new fields.',
             {'error_scope_format': True},
         ),
@@ -164,6 +178,7 @@ def commit_message_id(commit_message):  # pylint: disable=redefined-outer-name
             'fox(BT): update database schemas. Updating the database schema to include new fields and user profile preferences, cleaning up unnecessary calls.',
             {
                 'error_summary_capitalization': True,
+                'error_scope_allowed': True,
                 'error_scope_capitalization': True,
                 'error_summary_length': True,
                 'error_summary_period': True,
@@ -195,6 +210,8 @@ def test_commit_message_with_args(commit_message):  # pylint: disable=redefined-
     argv = [
         '--types',
         TYPES,
+        '--scopes',
+        SCOPES,
         '--subject-min-length',
         str(SUBJECT_MIN_LENGTH),
         '--subject-max-length',