6 KiB
graph LR
Language_Provisioning_Modules["Language Provisioning Modules"]
Language_Base_Utilities["Language Base Utilities"]
Environment_Context_Management["Environment Context Management"]
Shebang_Parsing["Shebang Parsing"]
Prefix_Management["Prefix Management"]
General_Utilities["General Utilities"]
Constants["Constants"]
Language_Provisioning_Modules -- "uses" --> Language_Base_Utilities
Language_Provisioning_Modules -- "uses" --> Environment_Context_Management
Language_Provisioning_Modules -- "uses" --> Prefix_Management
Language_Base_Utilities -- "uses" --> Shebang_Parsing
Language_Base_Utilities -- "uses" --> General_Utilities
Language_Base_Utilities -- "uses" --> Constants
Environment_Context_Management -- "uses" --> General_Utilities
Shebang_Parsing -- "uses" --> General_Utilities
Prefix_Management -- "uses" --> Constants
General_Utilities -- "uses" --> Constants
Component Details
The Hook Environment Provisioning subsystem is crucial for pre-commit's ability to run hooks reliably and in isolation across various programming languages. It ensures that each hook operates within a clean, self-contained environment, preventing conflicts and ensuring consistent execution regardless of the user's local system setup.
Language Provisioning Modules
These are the individual modules (e.g., python.py, node.py, docker.py) responsible for the concrete implementation of environment setup, dependency installation, and execution context preparation for hooks written in their respective languages. They orchestrate the use of other core provisioning components to achieve language-specific isolation.
Related Classes/Methods:
Language Base Utilities
Provides foundational, language-agnostic utilities and base functions commonly used by the language-specific modules. This includes functions for managing environment directories, setting up commands, and interacting with the file system, ensuring a consistent approach to environment management across different languages. It defines the common interface and shared logic for language provisioning.
Related Classes/Methods:
Environment Context Management
This module is solely responsible for managing and manipulating environment variables. It sets up the correct execution context for language-specific tools and hooks by ensuring that necessary environment variables (e.g., PATH modifications) are correctly configured to locate executables and dependencies within the isolated environment.
Related Classes/Methods:
Shebang Parsing
This module handles the parsing of shebang lines (e.g., #!/usr/bin/env python) in scripts and finding the corresponding executables. It is essential for determining which interpreter should be used to run a script-based hook within its provisioned environment.
Related Classes/Methods:
Prefix Management
This module manages the base directories and installation prefixes where language-specific virtual environments, tools, and dependencies are installed. It is crucial for maintaining the isolation of different hook environments and ensuring that each hook operates within its designated, clean context.
Related Classes/Methods:
General Utilities
A collection of general-purpose utility functions heavily relied upon by the environment provisioning components. This includes functions for robust command execution (cmd_output), file system operations (rmtree, make_executable), and platform-specific adjustments, all of which are essential for setting up and cleaning isolated environments.
Related Classes/Methods:
Constants
This module defines various system-wide constants, such as default paths, version numbers, and configuration values, that are critical for the consistent and correct setup of isolated environments across different languages and platforms.
Related Classes/Methods: