oct.hooks.oct_hooks Namespace Reference

Functions
int	install_hooks (Path root, bool force=False)

Variables
str	_PRE_COMMIT_TEMPLATE

Detailed Description

Purpose
-------
Generate pre-commit hook configuration for Option C projects.

Responsibilities
----------------
- Generate a ``.pre-commit-config.yaml`` with ``oct lint --profile strict``
  as a pre-commit hook.
- Support ``--force`` to overwrite existing configuration.

Diagnostics
-----------
Domain: OCT-HOOKS
Levels:
    L2 — lifecycle
    L3 — semantic details
    L4 — deep tracing

Contracts
---------
- Must not overwrite existing ``.pre-commit-config.yaml`` without ``--force``.
- Generated configuration must be valid YAML.

Dependencies
------------

Function Documentation

install_hooks()

int oct.hooks.oct_hooks.install_hooks	(	Path	root,
		bool	force = False )

Generate .pre-commit-config.yaml in the project root.

Returns exit code: 0 on success, 1 on failure.

Definition at line 59 of file oct_hooks.py.

Variable Documentation

_PRE_COMMIT_TEMPLATE

str oct.hooks.oct_hooks._PRE_COMMIT_TEMPLATE

protected

Initial value:

=  """\
# Option C pre-commit configuration
# Generated by: oct install-hooks
# See https://pre-commit.com for more information
 
repos:
  - repo: local
    hooks:
      - id: oct-lint
        name: Option C Linter
        entry: oct lint --profile strict
        language: system
        types: [python]
        pass_filenames: false
 
      - id: oct-format-check
        name: Option C Format Check
        entry: oct format --dry-run
        language: system
        types: [python]
        pass_filenames: false
"""

Definition at line 35 of file oct_hooks.py.