tempestphp / highlight

🎨 Fast, extensible, server-side code highlighting for web and terminal

Fast, extensible, server-side code highlighting

Quickstart

composer require tempest/highlight

Highlight code like this:

$highlighter = new \Tempest\Highlight\Highlighter();

$code = $highlighter->parse($code, 'php');

Continue reading in the docs: https://tempest.stitcher.io/highlight/01-getting-started.

highlight's Issues

collision between `hl-em` tag `{-` and blade's comment tag `{{--`

PHP: `implements ArrayAccess, ContainerContract`

CSS: `--pixel-color`

Variable with -

Blade: split echo and raw echo tags into two patterns

So that {{ !!} doesn't match

PHP: `abstract public function test(int $input): int;`

trait Test {
    abstract public function test(int $input): int;
}

PHP: `$abstract`

Highlight inline code blocks

`{php}public sting $bar`

Will render public sting $bar as PHP

PHP: `// Instead of this:`

Let's not color comments

PHP: values `return '\@php(?<match>(.|\n)*?)\@endphp';`

For strings and numbers

PHP: `$name = 'BAR';`

Language: `DocComment`

To be injected within /** */ tags in PHP and JS

PHP: `const BAR = 'bar';`

PHP: `public function setStatus(Status $status): void`

PHP: Broken keywords

if (is_null($callback) && $abstract instanceof Closure) {

• && is type
• ) is type
• static::$instance static is type
• value instanceof Closure ? $value : fn () => $value) ? is type

blur support

PHP: `public function bar(mixed $input): mixed;`

Use `Escape::injection` for all injections?

PHP: `instanceof Closure`

JS: doc comments

I'll need to create a separate implementation for PHP and JS, since types are written differently.

PHP: `($point->x % 10 === 0 && $point->y % 10 === 0)`

&& is colored as a type

PHP: `for($x = 0; $x < 150; $x++) {`

PHP: DNFTs don't work

(Foo&Bar)|null

The problem is with the brackets, which sometimes also match the function definition:

(Foo $bar

PHP: `catch (MySpecialException) {`

PHP `protected $beforeResolvingCallbacks` property without type

PHP: null, true, false as keywords

highlight support

{_highlight_}
{*higlhight*}
{~blur~}

<span class="hl-em">highlight</span>
<span class="hl-strong">highlight</span>
<span class="hl-blur">highlight</span>

PHP: `case Pending;` in enums

PHP: `fn&($x) => $x`

PHP: `const string BAR = 'baz';`

PHP `while (1) {`

PHP `trait Test {`

PHP: `int $pad_type = STR_PAD_RIGHT, `

PHP: `#[PatternTest(input: 'new Foo()', output: 'Foo')]`

PHP: `$class`

PHP: `$this->extends('View/base.view.php');`

extends is keyword

PHP: `=&` operator

PHP: `enum Status {`

PHP: `$array = [];`

PHP: `string|\Stringable $message, `

Needs a list of supported languages

Missing from the README is a list of supported languages.

SQL highlighting is needed

SQL is one of the core multi-discipline 4th generation programming languages.

I'd suggest SQL 92 as the base. Here are the keywords:

• SELECT
• FROM
• WHERE
• INSERT INTO
• UPDATE
• DELETE
• CREATE DATABASE
• ALTER DATABASE
• CREATE TABLE
• ALTER TABLE
• DROP TABLE
• CREATE INDEX
• DROP INDEX
• JOIN
• INNER JOIN
• LEFT JOIN
• RIGHT JOIN
• FULL JOIN
• UNION
• UNION ALL
• INTERSECT
• EXCEPT
• IN
• BETWEEN
• LIKE
• NOT
• AND
• OR
• AS
• DISTINCT
• GROUP BY
• ORDER BY
• HAVING
• LIMIT
• OFFSET
• CASE
• WHEN
• THEN
• ELSE
• END
• NULL
• IS NULL
• IS NOT NULL
• EXISTS
• ANY
• ALL
• SOME
• CAST
• CONVERT
• CHAR
• VARCHAR
• INT
• DATE
• TIMESTAMP

Change class tag to `{. .}`

PHP: `#[\AllowDynamicProperties]`

PHP: `use Illuminate\Contracts\Container\Container as ContainerContract`

PHP: `TypeError`

PHP: `is_int($e->getCode()) ? $e->getCode() : 0, $e`

? is type instead of keyword

PHP: `?string $encoding = null,`

PHP: Heredoc with injection support

Broken highlighting

use Tempest\Highlight\IsPattern;
use Tempest\Highlight\Pattern;
use Tempest\Highlight\Tokens\TokenType;

final readonly class NamespacePattern implements Pattern
{
    use IsPattern;

    public function getPattern(): string
    {
        return 'namespace (?<match>[\w\\\\]+)';
    }

    public function getTokenType(): TokenType
    {
        return TokenType::TYPE;
    }
}

PHP: `::class`