/pygments-pre-commit

A pygments lexer for pre-commit output.

Primary LanguagePythonMIT LicenseMIT

build status Build Status pre-commit.ci status

pygments-pre-commit

A pygments lexer for pre-commit output

See some demos! Or see it in action on pre-commit.com.

Installation

pip install pygments-pre-commit

Usage

This library provides a pygments lexer called pre-commit.

.. code-block:: pre-commit

    $ pre-commit run
    passing..................................................................Passed
    failing..................................................................Failed
    - hook id: failing
    - exit code: 1

    ['.pre-commit-config.yaml', 'a']

    skipped (no files)...................................(no files to check)Skipped
    skip me.................................................................Skipped

This library also provides a sphinx extension. It can be enabled by adding 'pygments_pre_commit' to the extensions setting in your conf.py.

The colors can be tweaked using the sphinx setting (in conf.py) pygments_pre_commit_ansi_colors:

pygments_pre_commit_ansi_colors = {
    'Black': '#2e3436',
    'Cyan': '#06989a',
    'Green': '#4e9a06',
    'Red': '#c00',
    'Yellow': '#c4A000',
    'Faint': '#ccc',
}