-
Notifications
You must be signed in to change notification settings - Fork 825
pre-commit add hook to ensure all hooks have descriptions #6693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jbampton
wants to merge
1
commit into
mruby:master
Choose a base branch
from
jbampton:pre-commit-check-for-descriptions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| #!/usr/bin/env python3 | ||
| import sys | ||
| import yaml | ||
| import os | ||
|
|
||
| # Configuration Constants | ||
| CONFIG_FILE = os.environ.get('PRE_COMMIT_CONFIG', '.pre-commit-config.yaml') | ||
| MIN_DESC_LENGTH = 15 | ||
|
|
||
|
|
||
| def validate_hook(repo_url, hook, min_length): | ||
| """Validates a single hook and returns an error message or None.""" | ||
| hook_id = hook.get('id', 'unknown-id') | ||
| description = hook.get('description', '') | ||
|
|
||
| # Ensure description is a string and strip whitespace | ||
| clean_desc = str(description).strip() if description is not None else "" | ||
|
|
||
| if not clean_desc: | ||
| return f"Repo: {repo_url} | Hook: {hook_id} -> Missing 'description' key." | ||
|
|
||
| if len(clean_desc) < min_length: | ||
| return (f"Repo: {repo_url} | Hook: {hook_id} -> Description too short " | ||
| f"({len(clean_desc)} chars). Minimum required: {min_length}.") | ||
|
|
||
| return None | ||
|
|
||
|
|
||
| def main(): | ||
| if not os.path.exists(CONFIG_FILE): | ||
| print(f"ERROR: Configuration file '{CONFIG_FILE}' not found.") | ||
| return 1 | ||
|
|
||
| try: | ||
| with open(CONFIG_FILE, 'r', encoding='utf-8') as f: | ||
| # Use CSafeLoader if available for better performance on large files | ||
| loader = getattr(yaml, 'CSafeLoader', yaml.SafeLoader) | ||
| config = yaml.load(f, Loader=loader) | ||
| except yaml.YAMLError as exc: | ||
| print(f"ERROR: Failed to parse YAML in {CONFIG_FILE}: {exc}") | ||
| return 1 | ||
|
|
||
| if not config or 'repos' not in config: | ||
| print(f"INFO: No repos found in {CONFIG_FILE}. Nothing to check.") | ||
| return 0 | ||
|
|
||
| errors = [] | ||
| for repo in config.get('repos', []): | ||
| repo_url = repo.get('repo', 'local') | ||
| for hook in repo.get('hooks', []): | ||
| error = validate_hook(repo_url, hook, MIN_DESC_LENGTH) | ||
| if error: | ||
| errors.append(error) | ||
|
|
||
| if errors: | ||
| print(f"FAIL: {len(errors)} hook(s) failed documentation requirements.") | ||
| print("=" * 80) | ||
| for error in errors: | ||
| print(f" [!] {error}") | ||
| print("=" * 80) | ||
| print(f"Tip: Ensure each hook has a 'description' of {MIN_DESC_LENGTH}+ chars.") | ||
| return 1 | ||
|
|
||
| print(f"PASS: All hooks in {CONFIG_FILE} are properly documented.") | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| sys.exit(main()) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For improved code clarity and to adhere to modern PyYAML API usage, it's better to use
yaml.safe_load()directly. This function is the recommended safe way to parse YAML and it will automatically use the faster C-based loader (CSafeLoader) if it's available, so the explicit check is not necessary.