Языки

shikiphp включает полный набор языков Shiki: все грамматики из tm-grammars 1.31.15 — набора, который поставляет Shiki 3.23.0. Это 235 языков и 18 вспомогательных грамматик, которые они встраивают, — всего 253 грамматик. Это те же грамматики TextMate, с которыми работают VS Code и Shiki, поэтому набор поддерживаемых языков, псевдонимы и названия областей совпадают.

Ссылка на язык указывается по его идентификатору или одному из псевдонимов, например ts или typescript, js или javascript, php, rust, python, html, yaml, json и так далее. Идентификаторы сопоставляются точно, поэтому используйте их в нижнем регистре, как указано ниже. Если сборка не знает идентификатор, выбрасывается Shikiphp\Exceptions\Highlight с сообщением Unknown language "…".

Специальный идентификатор 'ansi' — это не грамматика, а подсветка вывода терминала. См. раздел ANSI.

Текстовые идентификаторы Shiki text, txt, plain и plaintext пока не поддерживаются, поэтому выбрасывается Unknown language (#2).

Список встроенных языков

Вызовите подсветчик из PHP:

use Shikiphp\Shikiphp;

$highlighter = Shikiphp::highlighter();

$highlighter->bundledLanguages(); // list<string> — ids shipped in the box
$highlighter->loadedLanguages();  // list<string> — bundled plus any you registered

Оба списка содержат все разрешаемые идентификаторы: сначала идентификаторы грамматик 253, затем 97 псевдонимов; всего 350 записей в комплекте.

Или из командной строки, по одному идентификатору в строке:

vendor/bin/shikiphp langs

Каталог

Все встроенные языки 235 отсортированы по названию. Любой идентификатор или псевдоним в строке выбирает одну и ту же грамматику.

Вспомогательные грамматики

Эти 18 грамматик нужны, чтобы другие грамматики могли встраивать или внедрять их (Angular, Vue, макросы C++, Jinja, Nix и литералы шаблонов с тегами в ts-tags). Они загружаются автоматически вместе с нуждающимся в них языком; их идентификаторы также отображаются в bundledLanguages() и shikiphp langs:

angular-expression, angular-let-declaration, angular-template, angular-template-blocks, angular-inline-style, angular-inline-template, cpp-macro, jinja-html, markdown-nix, es-tag-css, es-tag-glsl, es-tag-html, es-tag-sql, es-tag-xml, markdown-vue, vue-directives, vue-interpolations, vue-sfc-style-variable-injection.

Добавление собственных языков

Нужен язык, которого нет во встроенном наборе, или закрытая грамматика? Зарегистрируйте её с помощью loadGrammar. См. раздел Пользовательские языки и темы.