|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +import yaml |
| 4 | +import sys # Import the sys module to access command-line arguments |
| 5 | + |
| 6 | + |
| 7 | +def generate_pre_commit_table(yaml_path): |
| 8 | + """ |
| 9 | + Generates a Markdown table from a pre-commit-config.yaml file. |
| 10 | +
|
| 11 | + Args: |
| 12 | + yaml_path (str): The path to the pre-commit-config.yaml file. |
| 13 | +
|
| 14 | + Returns: |
| 15 | + str: A Markdown formatted table string or an error message. |
| 16 | + """ |
| 17 | + try: |
| 18 | + with open(yaml_path, 'r', encoding='utf-8') as f: # Added encoding for better compatibility |
| 19 | + config = yaml.safe_load(f) |
| 20 | + except FileNotFoundError: |
| 21 | + return f"Error: The file '{yaml_path}' was not found." |
| 22 | + except yaml.YAMLError as e: |
| 23 | + return f"Error parsing YAML file '{yaml_path}': {e}" |
| 24 | + except Exception as e: |
| 25 | + return f"An unexpected error occurred while reading '{yaml_path}': {e}" |
| 26 | + |
| 27 | + table_header = "| Hook ID | Language | Name | Description | Version |\n" |
| 28 | + table_separator = "|---|---|---|---|---|\n" |
| 29 | + table_rows = [] |
| 30 | + |
| 31 | + # Ensure config is a dictionary and has a 'repos' key that is a list |
| 32 | + if not isinstance(config, dict) or 'repos' not in config or not isinstance(config['repos'], list): |
| 33 | + return f"Error: Invalid pre-commit config structure in '{yaml_path}'. 'repos' section is missing or not a list." |
| 34 | + |
| 35 | + for repo_index, repo in enumerate(config.get("repos", [])): |
| 36 | + if not isinstance(repo, dict): |
| 37 | + print(f"Warning: Repository at index {repo_index} is not a valid dictionary. Skipping.") |
| 38 | + continue |
| 39 | + |
| 40 | + version = repo.get("rev", "N/A") |
| 41 | + url = repo.get("repo", "N/A") |
| 42 | + |
| 43 | + if 'hooks' not in repo or not isinstance(repo['hooks'], list): |
| 44 | + print( |
| 45 | + f"Warning: 'hooks' section not found or is not a list for repo '{url}'. Skipping hooks processing for this repo.") |
| 46 | + continue |
| 47 | + |
| 48 | + for hook_index, hook in enumerate(repo.get("hooks", [])): |
| 49 | + if not isinstance(hook, dict): |
| 50 | + print(f"Warning: Hook at index {hook_index} in repo '{url}' is not a valid dictionary. Skipping.") |
| 51 | + continue |
| 52 | + |
| 53 | + hook_id = hook.get("id", "N/A") |
| 54 | + name = hook.get("name", "N/A") |
| 55 | + description = hook.get("description", "N/A") |
| 56 | + language = hook.get("language", "N/A") |
| 57 | + |
| 58 | + # Construct the entry for the Hook ID column |
| 59 | + if url and url not in ["local", "meta"]: |
| 60 | + entry = f"[{hook_id}]({url})" |
| 61 | + else: |
| 62 | + entry = f"{hook_id}" |
| 63 | + |
| 64 | + table_rows.append(f"| {entry} | {language} | {name} | {description} | {version} |\n") |
| 65 | + |
| 66 | + if not table_rows: |
| 67 | + return f"No hooks found in '{yaml_path}' to generate a table." |
| 68 | + |
| 69 | + return table_header + table_separator + "".join(table_rows) |
| 70 | + |
| 71 | + |
| 72 | +def create_markdown_file(target_file_path, content_to_append): |
| 73 | + """ |
| 74 | + Creates or overwrites a Markdown file with the provided content. |
| 75 | +
|
| 76 | + Args: |
| 77 | + target_file_path (str): The path to the output Markdown file. |
| 78 | + content_to_append (str): The Markdown content to write to the file. |
| 79 | +
|
| 80 | + Returns: |
| 81 | + str: A success message or an error message. |
| 82 | + """ |
| 83 | + try: |
| 84 | + # Ensure the directory exists before writing the file |
| 85 | + import os |
| 86 | + os.makedirs(os.path.dirname(target_file_path), exist_ok=True) |
| 87 | + |
| 88 | + with open(target_file_path, "w", encoding='utf-8') as f: # Changed to 'w' to overwrite, added encoding |
| 89 | + f.write("# pre-commit hook documentation\n\n") |
| 90 | + f.write(content_to_append) |
| 91 | + return f"File content successfully created at '{target_file_path}'." |
| 92 | + except OSError as e: |
| 93 | + return f"Error creating file '{target_file_path}': {e}" |
| 94 | + except Exception as e: |
| 95 | + return f"An unexpected error occurred while writing to '{target_file_path}': {e}" |
| 96 | + |
| 97 | + |
| 98 | +if __name__ == "__main__": |
| 99 | + # Check if a command-line argument for the config file path is provided |
| 100 | + if len(sys.argv) > 1: |
| 101 | + pre_commit_yaml_path = sys.argv[1] |
| 102 | + else: |
| 103 | + # Default file path if no argument is provided |
| 104 | + pre_commit_yaml_path = ".pre-commit-config.yaml" |
| 105 | + print(f"No pre-commit config file path provided. Attempting to use default: '{pre_commit_yaml_path}'") |
| 106 | + |
| 107 | + output_markdown_path = "doc/guides/pre-commit-hooks.md" |
| 108 | + |
| 109 | + # Generate the Markdown table |
| 110 | + markdown_table = generate_pre_commit_table(pre_commit_yaml_path) |
| 111 | + |
| 112 | + # Add the table to the target Markdown file if no error occurred during table generation |
| 113 | + if markdown_table.startswith("Error:"): |
| 114 | + print(markdown_table) # Print the error message from generate_pre_commit_table |
| 115 | + sys.exit(1) # Exit with a non-zero code to indicate failure |
| 116 | + elif markdown_table.startswith("No hooks found:"): |
| 117 | + print(markdown_table) # Print the message if no hooks are found |
| 118 | + sys.exit(0) # Exit with success if no hooks but no other error |
| 119 | + else: |
| 120 | + result = create_markdown_file(output_markdown_path, markdown_table) |
| 121 | + print(result) |
| 122 | + if "Error" in result: |
| 123 | + sys.exit(1) # Exit with failure if create_markdown_file had an error |
| 124 | + else: |
| 125 | + sys.exit(0) # Exit with success |
0 commit comments