Preskočiť na obsah

API

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 22946a5

shikiphp poskytuje dva vstupné body: statickú fasádu Shikiphp pre bežné prípady a inštanciu Highlighter pre všetko ostatné (výstup HAST, vlastné gramatiky a témy, varianty tém a prehľad obsahu balíka).

Fasáda Shikiphp

Shikiphp\Shikiphp je jednoduchá statická fasáda nad zvýrazňovačom z balíka, ktorý sa vytvorí pri prvom použití a následne uloží do vyrovnávacej pamäte.

Shikiphp::codeToHtml

PHP
public static function codeToHtml(string $code, array $options): string

Tokenizuje $code a vykreslí úplný blok <pre class="shiki …"> HTML. Pole možností vždy obsahuje lang a tiež buď theme, alebo mapu themes, ako aj ľubovoľné možnosti vykresľovania.

PHP
use Shikiphp\Shikiphp;

echo Shikiphp::codeToHtml($code, ['lang' => 'php', 'theme' => 'github-dark']);

Shikiphp::codeToTokens

PHP
/** @return list<list<ThemedToken>> */
public static function codeToTokens(string $code, array $options): array

Vráti čistú 2D mriežku tokenov (jeden vnorený zoznam na riadok) objektov Shikiphp\Render\ThemedToken namiesto HTML.

PHP
use Shikiphp\Shikiphp;

$lines = Shikiphp::codeToTokens($code, ['lang' => 'js', 'theme' => 'nord']);

foreach ($lines as $line) {
    foreach ($line as $token) {
        // $token->content, $token->color, $token->fontStyle,
        // $token->bgColor, $token->htmlStyle, $token->offset
    }
}

Shikiphp::codeToTokensBase

PHP
/** @return list<list<ThemedToken>> */
public static function codeToTokensBase(string $code, array $options): array

Alias codeToTokens, ktorý zodpovedá názvu codeToTokensBase Shiki.

Shikiphp::codeToTokensResult

PHP
public static function codeToTokensResult(string $code, array $options): TokensResult

Vráti rozšírený výsledok zodpovedajúci najvyššej úrovni codeToTokens objektu Shiki: mriežku tokenov spolu s vyriešenými farbami, názvom témy, koreňovým štýlom pre dve témy a konečným stavom gramatiky. Pozrite si nižšie TokensResult.

PHP
use Shikiphp\Shikiphp;

$result = Shikiphp::codeToTokensResult($code, [
    'lang'  => 'php',
    'theme' => 'github-dark',
]);

$result->tokens;       // list<list<ThemedToken>>
$result->fg;           // "#e1e4e8"
$result->bg;           // "#24292e"
$result->themeName;    // "github-dark"
$result->grammarState; // GrammarState

Shikiphp::getLastGrammarState

PHP
public static function getLastGrammarState(string $code, array $options): GrammarState

Tokenizuje $code a vráti stav gramatiky dosiahnutý na konci (ShikigetLastGrammarState). Odovzdajte ho späť cez možnosť grammarState, aby tokenizácia neskoršieho fragmentu pokračovala z rovnakého stavu — užitočné pri prírastkovom zvýrazňovaní. Vyvolá výnimku, ak je lang 'ansi' (ANSI nemá stav gramatiky).

PHP
use Shikiphp\Shikiphp;

$state = Shikiphp::getLastGrammarState("/* unterminated comment", [
    'lang'  => 'js',
    'theme' => 'nord',
]);

$html = Shikiphp::codeToHtml("still inside the comment */", [
    'lang'         => 'js',
    'theme'        => 'nord',
    'grammarState' => $state,
]);

Shikiphp::highlighter

PHP
public static function highlighter(): Highlighter

Vráti zdieľaný zabalený Highlighter a pri prvom použití ho vytvorí. Použite ho na prístup k nižšie uvedeným metódam inštancie.

Shikiphp::use a Shikiphp::reset

PHP
public static function use(Highlighter $highlighter): void
public static function reset(): void

use nastaví vlastnú inštanciu Highlighter (napríklad takú, do ktorej ste načítali vlastné gramatiky alebo témy), aby jej fasáda odovzdávala požiadavky. reset vymaže inštanciu z vyrovnávacej pamäte, takže pri ďalšom volaní sa znova vytvorí predvolený zvýrazňovač z balíka.

Highlighter

Shikiphp\Highlighter poskytuje úplné rozhranie. Zdieľanú inštanciu z balíka získate pomocou Shikiphp::highlighter() alebo si ju vytvoríte explicitne:

PHP
use Shikiphp\Highlighter;

$highlighter = Highlighter::createBundled();

Implementuje codeToHtml, codeToTokens, codeToTokensBase, codeToTokensResult a getLastGrammarState s rovnakými signatúrami ako fasáda a navyše poskytuje nasledujúce možnosti.

Highlighter::codeToHast

PHP
public function codeToHast(string $code, array $options): \Shikiphp\Hast\Element

Vytvorí strom HAST pre.shiki > code > (span.line > span)* presne tak, ako ho vytvára Shiki, pripravený na prechádzanie, úpravy alebo vlastnú serializáciu. Práve ten codeToHtml interne serializuje.

PHP
use Shikiphp\Shikiphp;

$hast = Shikiphp::highlighter()->codeToHast($code, [
    'lang'  => 'rust',
    'theme' => 'nord',
]);

Highlighter::codeToTokensWithThemes

PHP
/** @return list<list<ThemedTokenWithVariants>> */
public function codeToTokensWithThemes(string $code, array $options): array

Tokenizuje raz pre každú tému a zlúči výsledky do variants pre každý token, usporiadaných podľa kľúča témy, v súlade s ShikicodeToTokensWithThemes. Vyžaduje mapu themes.

PHP
use Shikiphp\Shikiphp;

$lines = Shikiphp::highlighter()->codeToTokensWithThemes($code, [
    'lang'   => 'ts',
    'themes' => ['light' => 'github-light', 'dark' => 'github-dark'],
]);

$lines[0][0]->content;            // token text
$lines[0][0]->variants['light'];  // ThemedTokenStyle for the light theme
$lines[0][0]->variants['dark'];   // ThemedTokenStyle for the dark theme

Highlighter::loadGrammar a Highlighter::loadTheme

PHP
public function loadGrammar(
    array $rawTmLanguage,
    ?string $langId = null,
    array $aliases = [],
    array $embedded = [],
): void

public function loadTheme(array $rawTheme): void

Zaregistrujte vlastnú gramatiku TextMate alebo tému VS Code z dekódovaného JSON. Pozrite si Vlastné jazyky a témy.

Prehľad obsahu balíka

PHP
/** @return list<string> */ public function loadedLanguages(): array
/** @return list<string> */ public function loadedThemes(): array
/** @return list<string> */ public function bundledLanguages(): array
/** @return list<string> */ public function bundledThemes(): array

loadedLanguages/loadedThemes uvádzajú všetky aktuálne použiteľné ID (z balíka aj vlastné, ktoré ste zaregistrovali). bundledLanguages/bundledThemes uvádzajú iba ID dodané v balíku. Pozrite si Jazyky a Témy.

Hodnotové objekty

ThemedToken

Shikiphp\Render\ThemedToken predstavuje jeden štylizovaný úsek textu:

PHP
final class ThemedToken
{
    public readonly string $content;
    public readonly ?string $color;
    public readonly int $fontStyle;      // FontStyle bitmask
    public readonly ?string $bgColor;
    public readonly ?string $htmlStyle;  // pre-built inline style (dual themes / ANSI)
    public readonly int $offset;         // UTF-16 code-unit offset into the source
}

fontStyle je bitová maska z Shikiphp\Theme\FontStyle (NONE, ITALIC, BOLD, UNDERLINE, STRIKETHROUGH).

TokensResult

Shikiphp\TokensResult je návratová hodnota codeToTokensResult:

PHP
final class TokensResult
{
    public readonly array $tokens;             // list<list<ThemedToken>>
    public readonly ?string $fg;               // resolved foreground
    public readonly ?string $bg;               // resolved background
    public readonly ?string $themeName;        // single id, or "shiki-themes …"
    public readonly string|false|null $rootStyle; // dual-theme root style (or null)
    public readonly ?GrammarState $grammarState;
}

GrammarState

Shikiphp\GrammarState uchováva zásobník pravidiel tokenizátora (indexovaný podľa názvu témy), aby bolo možné pokračovať vo zvýrazňovaní od priebežného bodu.

PHP
final class GrammarState
{
    public readonly string $lang;

    public function theme(): string;          // first theme name
    public function themes(): array;          // list<string>
    public function getScopes(?string $theme = null): array; // scopes in effect, innermost first
    public function withTheme(string $theme): self;
}