Вышла новая версия библиотеки shikiji для синтаксической подсветки фрагментов кода

Anthony Fu портировал пакет shiki.js на ESM. Данная библиотека предназначено для синтаксической подсветки фрагментов кода, аналог highlight.js. Использует hast для токенизации и VS Code Oniguruma, которая написана на C и компилируется в WebAssembly. Данная часть переписана на ESM, является tree-shakable и работает и в Node.js, и в браузере.

shikiji использует тот же движок, что и VS Code, работает быстрее распространенных подсветчиков кода, занимает меньше места и более функциональна (например, включает препроцессор для TypeScript TwoSlash нотаций). Доступны множество языков (включая вариации Vue и Vue HTML) и все темы VS Code (на данный момент около 5000). VitePress уже переехал на новую библиотеку.

#antfu #shikiji #vitepress

Что умеет новая `shikiji` от Anthony Fu?

Показывать всплывающую подсказку с информацией о наведенной сущности. Для этого в коде она должна быть типизирована с помощью JSDoc, либо информация о ней должна быть в библиотеке, если она подключается через неё (в данном примере shikiji лезет в markdown-it)

Рекомендация от команды Vue и VitePress - использовать в документациях на VitePress во фрагментах кода JSDoc для повышения их информативности. Более подробные инструкции будут даны позднее.

#shikiji #antfu #vitepress

Anthony Fu показал законченный вариант библиотеки для синтаксической подсветки фрагментов кода shikiji с подсказками от TypeScript пакета twoslashes на примере SFC кода в VitePress.

По мнению автора это сильно улучшит воспринимаемость информации. Ну и такого ни у кого пока нет.

#twoslashes #shikiji #vitepress #antfu

История shikiji - библиотеки для синтаксической подсветки фрагментов кода, о которой мы писали несколько раз, - скоропостижно завершилась.

Напомним, Anthony Fu форкнул и портировал пакет shiki.js на ESM. Данная библиотека предназначено для синтаксической подсветки фрагментов кода, аналог highlight.js. Использует hast для токенизации и VS Code Oniguruma, которая написана на C и компилируется в WebAssembly. Данная часть переписана Anthony на ESM, является tree-shakable и работает и в Node.js, и в браузере.

Использование того же движка, что и в VS Code, позволяет работать быстрее распространенных подсветчиков кода, занимать меньше места и быть более функциональна (например, включает препроцессор для TypeScript TwoSlash нотаций). Доступны множество языков (включая вариации Vue и Vue HTML) и все темы VS Code (на данный момент около 5000). VitePress переехал на новую библиотеку для подсветки блоков кода в декабре 2023 года.

На прошлой неделе владельцы shiki сделали Pull request и забрали себе все улучшения, добавленные Anthony. Теперь он работает над shiki, проект shikiji архивирован.

#antfu #shiki #shikiji #vitepress