ramsey/pygments

A PHP wrapper for Pygments, the Python syntax highlighter, forked from kzykhys/pygments.

2.0.2 2021-03-07 19:15 UTC

Requires

• php: ^7.3 || ^8.0
• symfony/process: ^3.0 || ^4.0 || ^5.0

Requires (Dev)

• captainhook/captainhook: ^5.4
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
• ergebnis/composer-normalize: ^2.13
• mockery/mockery: ^1.3
• php-parallel-lint/php-parallel-lint: ^1.2
• phpcsstandards/phpcsextra: ^1.0@alpha
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^0.12.80
• phpstan/phpstan-mockery: ^0.12.13
• phpstan/phpstan-phpunit: ^0.12.18
• phpunit/phpunit: ^9.4
• psalm/plugin-mockery: ^0.7.0
• psalm/plugin-phpunit: ^0.15.1
• slevomat/coding-standard: ^6.4
• squizlabs/php_codesniffer: ^3.5
• symfony/finder: ^5.2
• vimeo/psalm: ^4.6

MIT

• Kazuyuki Hayashi
• Ben Ramsey

• syntax
• highlight
• pygments

README

A PHP wrapper for Pygments, the Python syntax highlighter.

About

ramsey/pygments is a PHP wrapper for Pygments, the Python syntax highlighter, forked from the Pygments.php project.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a dependency using Composer.

composer require ramsey/pygments

Requirements

• PHP 7.4 or greater (including PHP 8)
• Python
• Pygments (pip install Pygments)

Python and Pygments versions supported:

Pygments:	2.2	2.3	2.4	2.5	2.6	2.7	2.8
Python 3.6	✔	✔	✔	✔	✔	✔	✔
Python 3.7	✔	✔	✔	✔	✔	✔	✔
Python 3.8	✔	✔	✔	✔	✔	✔	✔
Python 3.9	✔	✔	✔	✔	✔	✔	✔

Usage

Highlight source code

use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$html = $pygments->highlight(file_get_contents('index.php'), 'php', 'html');
$console = $pygments->highlight('package main', 'go', 'ansi');

Generate CSS

use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$css = $pygments->getCss('monokai');
$prefixedCss = $pygments->getCss('default', '.syntax');

Guess lexer name

use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$pygments->guessLexer('foo.rb'); // ruby

Get a list of lexers/formatters/styles

use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$pygments->getLexers()
$pygments->getFormatters();
$pygments->getStyles();

Set a custom pygmentize path

use Ramsey\Pygments\Pygments;

$pygments = new Pygments('/path/to/pygmentize');

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

Copyright and License

The ramsey/pygments library is copyright © Ben Ramsey and licensed for use under the terms of the MIT License (MIT).

ramsey/pygments is a fork of Pygments.php. The Pygments.php library is copyright © Kazuyuki Hayashi and licensed for use under the terms of the MIT License (MIT).

Please see LICENSE for more information.