PHPackages                             kadet/keylighter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. kadet/keylighter

ActiveLibrary[Utility & Helpers](/categories/utility)

kadet/keylighter
================

Yet another syntax highlighter for PHP

v0.9.0(2y ago)333.2k2[9 PRs](https://github.com/kadet1090/KeyLighter/pulls)1MITPHPPHP ^7.3|^8.0

Since Mar 27Pushed 2y ago4 watchersCompare

[ Source](https://github.com/kadet1090/KeyLighter)[ Packagist](https://packagist.org/packages/kadet/keylighter)[ RSS](/packages/kadet-keylighter/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (7)Versions (19)Used By (1)

[![Logo](https://raw.githubusercontent.com/kadet1090/KeyLighter/master/Docs/assets/logo.png)](https://raw.githubusercontent.com/kadet1090/KeyLighter/master/Docs/assets/logo.png)

[![Packagist](https://camo.githubusercontent.com/2c4d63dfd1b7f4e74c0f708f1e147686dbb3b5810f6b4f69aa0b713987334111/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b616465742f6b65796c6967687465722e7376673f7374796c653d666c6174)](https://packagist.org/packages/kadet/keylighter)[![GitHub Actions](https://github.com/kadet1090/keylighter/actions/workflows/tests.yml/badge.svg?event=push)](https://github.com/kadet1090/KeyLighter/actions?query=branch:master)[![GitHub Actions](https://github.com/kadet1090/keylighter/actions/workflows/phpstan.yml/badge.svg?event=push)](https://github.com/kadet1090/KeyLighter/actions?query=branch:master)[![Try it](https://camo.githubusercontent.com/61c082d1a905e67824e62a1706608de092986304cf2bba129dca8e9753e9425f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7777772d74727925323069742d4646393730302e7376673f7374796c653d666c6174)](https://keylighter.kadet.net)

[![stability: stable](https://camo.githubusercontent.com/0dffce8bdad91d123dba663d9d563813203d3bd73405f30386affbfd10fb15bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5075626c69632532304150492d737461626c652d677265656e2e7376673f7374796c653d666c6174)](Docs/2-basic-usage.md)[![stability: unstable](https://camo.githubusercontent.com/e8b1415c745144fa68672309f08dc475842cfaf6ea8234d2a8229f62ec07c3f6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f496e7465726e616c2532304150492d756e737461626c652d79656c6c6f772e7376673f7374796c653d666c6174)](Docs/3-advanced-usage.md)

Yet another Syntax Highlighter in PHP meant to be as extensible and easy to use as it only can, but with performance in mind.

You can try it live with the most recent version on .

Name
----

[](#name)

Name "KeyLighter" is inspired by Key Light concept in photography and cinematography.

> The key light is the first and usually most important light a photographer, cinematographer, lighting cameraman, or other scene composer will use in a lighting setup. The purpose of the key light is to highlight the form and dimension of the subject.

KeyLighter is supposed to do the same thing - for code.

Installation
============

[](#installation)

```
$ composer require kadet/keylighter
```

To use **KeyLighter** you just need PHP 7.3 or later, no special extensions required.

Global installation
-------------------

[](#global-installation)

It's possible to install **KeyLighter** as a global composer library

```
$ composer global require kadet/keylighter
```

Then you can use builtin simple cli highlighting app:

```
$ keylighter [command = highlight] [-l|--language [LANGUAGE]] [-f|--format [FORMAT]] [-d|--debug [DEBUG]] [--]  ...
```

If you want pipe into **KeyLighter** just specify `php://stdin` as path. You can use `list` command to see all available commands, and `--help` argument for detailed help. You don't have to specify `highlight` command explicitly.

### PowerShell

[](#powershell)

You're using PowerShell on Windows? Cool! **KeyLighter** comes with integrated PowerShell module that makes CLI usage even better. Just import module (For example in profile), and you're ready to go.

```
PS> Import-Module "${env:APPDATA}\Composer\vendor\kadet\keylighter\bin\KeyLighter.psd1"
```

To use autocompletion features you will need PowerShell v5 (Comes with windows 10) or install [TabExpansion++](https://github.com/lzybkr/TabExpansionPlusPlus)Module.

[![Powershell Support](https://camo.githubusercontent.com/4fed1e7d343b2676d9abd7cee27042cfc792c36c3413b967a16673c53fdfb24a/68747470733a2f2f692e696d6775722e636f6d2f6a4832565241382e676966)](https://camo.githubusercontent.com/4fed1e7d343b2676d9abd7cee27042cfc792c36c3413b967a16673c53fdfb24a/68747470733a2f2f692e696d6775722e636f6d2f6a4832565241382e676966)

Why KeyLighter?
---------------

[](#why-keylighter)

### Simple to use

[](#simple-to-use)

```
use Kadet\Highlighter\Language;

echo \Kadet\Highlighter\highlight($source, new Language\Php(), $formatter);
// or
echo \Kadet\Highlighter\KeyLighter::get()->highlight($source, new Language\Php(), $formatter);
// or
$keylighter = new \Kadet\Highlighter\KeyLighter([options]);
echo $keylighter->highlight($source, new Language\Php(), $formatter);
```

You can find all available languages [here](https://github.com/kadet1090/KeyLighter/tree/master/Language)and formatters [here](https://github.com/kadet1090/KeyLighter/tree/master/Formatter).

### It works on CLI! And more!

[](#it-works-on-cli-and-more)

**KeyLighter** was originally designed as CLI highlighter for my own usage, but then I decided that it should be able to generate any possible output, currently supported:

#### Cli `\Kadet\Highlighter\Formatter\CliFormatter`

[](#cli-kadethighlighterformattercliformatter)

[![CLI](https://camo.githubusercontent.com/c057b58cdd7ec9882d763a9e6ad12beebb4ec59fdaf341aec240d83c85f1f4c7/68747470733a2f2f692e696d6775722e636f6d2f6232624d5672772e706e67)](https://camo.githubusercontent.com/c057b58cdd7ec9882d763a9e6ad12beebb4ec59fdaf341aec240d83c85f1f4c7/68747470733a2f2f692e696d6775722e636f6d2f6232624d5672772e706e67)

It can even be styled, default styles are stored in `Styles\Cli\Default.php`, but you can just pass additional argument into a constructor:

```
new \Kadet\Highlighter\Formatter\CliFormatter([
    'string'      => ['color' => 'green'],
    'keyword'     => ['color' => 'yellow'],
    ...
])
```

#### HTML `\Kadet\Highlighter\Formatter\HtmlFormatter`

[](#html-kadethighlighterformatterhtmlformatter)

[![HTML](https://camo.githubusercontent.com/69e68912ce86c3b689011842b5b308c4e51daf422131b5a45f54c9d3af369185/68747470733a2f2f692e696d6775722e636f6d2f425254687358322e706e67)](https://camo.githubusercontent.com/69e68912ce86c3b689011842b5b308c4e51daf422131b5a45f54c9d3af369185/68747470733a2f2f692e696d6775722e636f6d2f425254687358322e706e67)

Every token is placed inside it's own `span` and classes are prefixed so it can be easily styled with css and should not interfere with any of your existing classes

```
$maxOption
```

```
pre > span.kl-variable { color: #F7750D; }
```

#### Your own?

[](#your-own)

It's easy to write your own formatters. Documentation coming soon.

### Context sensitive

[](#context-sensitive)

Some tokens are valid in some contexts, some are not. This library is context sensitive, and you can define when they are valid.

In this case, context mean just "inside of other token", for example lets assume that `string` token is defined as everything from " to the next " and `keyword`is defined as 'sit' substring.

```
↓ string:start     ↓ keyword:start
"Lorem ipsum dolor sit amtet"
         keyword:end ↑      ↑ string:end

Token tree:

Token.name           Token.pos
------------------------------
string:start         0
    keyword:start    21
    keyword:end      23
string:end           30
```

So as you can see `keyword` is inside of `string`, and therefore is not valid and should be deleted. You can define tokens valid only in some context, or invalid in other.

Oh, and token names cascade, it means that `string.single` is `string`, but `string` is necessarily not `string.single`.

### Write your own language definitions easily

[](#write-your-own-language-definitions-easily)

It's possible to easily extend `KeyLighter` with new languages, more detailed documentation coming soon.

For example XML definition looks like this:

```
class Xml extends GreedyLanguage
{
    private const IDENTIFIER = '(?P[\w\.-]+:)?(?P[\w\.-]+)';

    /**
     * Tokenization rules
     */
    public function setupRules()
    {
        $this->rules->addMany([
            'tag.open'  => [
                new OpenRule(new RegexMatcher('/(:\s]/')),
                new CloseRule(new SubStringMatcher('>'), ['context' => ['!string', '!comment']])
            ],
            'tag.close' => new Rule(new RegexMatcher('/()/')),

            'symbol.tag' => new Rule(new RegexMatcher('/ '"'], ['context' => ['tag']]),
        ]);
    }

    /** {@inheritdoc} */
    public function getIdentifier()
    {
        return 'xml';
    }

    public static function getMetadata()
    {
        return [
            'name'      => ['xml'],
            'mime'      => ['application/xml', 'text/xml'],
            'extension' => ['*.xml']
        ];
    }
}
```

I will try to write as many definitions as I only can, but any PRs are welcome.

### Embedding languages

[](#embedding-languages)

Many languages can be used simultaneously, *css* or *js* inside *html*, *sql* in
*php* and so on. **KeyLighter** can handle and highlight embedded languages without any problem.

[![Embedded languages](https://camo.githubusercontent.com/0e92c4ded851aa718c5f8a72dc1da42384016cb903dd459109f922208db2594b/68747470733a2f2f692e696d6775722e636f6d2f674a72367368792e706e67)](https://camo.githubusercontent.com/0e92c4ded851aa718c5f8a72dc1da42384016cb903dd459109f922208db2594b/68747470733a2f2f692e696d6775722e636f6d2f674a72367368792e706e67)

### Fast

[](#fast)

Even though it wasn't supposed to be fastest code highlighter in PHP it is still quite fast, more than 2x faster than [GeSHi](https://geshi.org/).

Testing
-------

[](#testing)

**KeyLighter** uses `phpunit` for testing:

```
$ ./vendor/bin/phpunit
```

Roadmap
-------

[](#roadmap)

There are still few things to do, you can find all on [trello](https://trello.com/b/9I4CO0Te/highlighter).

Contributing
------------

[](#contributing)

See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.

Thanks
------

[](#thanks)

For [Maciej](https://github.com/ksiazkowicz), [Maciej](https://github.com/sobak)and Monika for all support, moral too.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 87.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~408 days

Recently: every ~672 days

Total

8

Last Release

843d ago

PHP version history (2 changes)v0.7.0PHP >=5.5.0

0.9.x-devPHP ^7.3|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/e7113b0385cd7e51daf6144d435554cfca689e1d82291e2ba33abe31dbe881aa?d=identicon)[Kadet](/maintainers/Kadet)

---

Top Contributors

[![kadet1090](https://avatars.githubusercontent.com/u/747404?v=4)](https://github.com/kadet1090 "kadet1090 (380 commits)")[![Sobak](https://avatars.githubusercontent.com/u/1347533?v=4)](https://github.com/Sobak "Sobak (52 commits)")[![AydinHassan](https://avatars.githubusercontent.com/u/2817002?v=4)](https://github.com/AydinHassan "AydinHassan (1 commits)")

---

Tags

highlighterphpphp-librarysyntax-highlighting

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/kadet-keylighter/health.svg)

```
[![Health](https://phpackages.com/badges/kadet-keylighter/health.svg)](https://phpackages.com/packages/kadet-keylighter)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)