마이그레이션

Shiki v1.0 릴리스는 주요 리팩토링으로, 과거에 내렸던 모든 설계 결정을 재검토한 버전입니다. 원래는 새로운 설계를 실험하기 위해 Shikiji라는 별도의 패키지 이름을 사용했으나, 이제 Shiki v1.0으로 다시 통합되었습니다.

더 알아보기

v1.0에 대한 이야기와 자세한 내용은 블로그 게시물을 확인하세요.

v0.14에서 마이그레이션

[email protected]에서 변경된 사항은 다음과 같습니다:

수동으로 마이그레이션해야 하는 주요 변경 사항:

주 패키지 shiki에 적용된 변경 사항이지만, 호환성 빌드 @shikijs/compat로 셔밍되었습니다:

최상위 네임드 내보내기 setCDN, loadLanguage, loadTheme, setWasm이 제거되었습니다. 더 이상 필요하지 않기 때문입니다.
BUNDLED_LANGUAGES, BUNDLED_THEMES는 각각 shiki/langs와 shiki/themes로 이동했고, 이름이 bundledLanguages, bundledThemes로 변경되었습니다.
createHighlighter의 theme 옵션이 제거되었으며, 이제 배열로 된 themes 옵션을 사용합니다.
하이라이터는 더 이상 기본 테마 컨텍스트를 유지하지 않습니다. codeToHtml 및 codeToTokens에 theme 옵션이 필요합니다.
codeToThemedTokens는 codeToTokensBase로 이름이 변경되었고, 상위 레벨 codeToTokens가 추가되었습니다.
codeToTokens는 기본적으로 includeExplanation을 false로 설정합니다.
.ansiToHtml은 이제 .codeToHtml에 ansi라는 특수 언어로 병합되었습니다. codeToHtml(code, { lang: 'ansi' })를 사용하세요.
lineOptions는 완전히 사용자 정의 가능한 transforms 옵션으로 대체되었습니다.
LanguageRegistration의 grammar 필드는 LanguageRegistration 자체로 플래트닝되었습니다. 자세한 내용은 타입 정의를 참조하세요.

shiki-twoslash는 완전히 새로 작성되었습니다. 이제는 Shiki 하이라이터의 래퍼가 아니며, Shiki 트랜스포머로 변환되어 Shiki 트랜스포머를 지원하는 모든 통합에 플러그인으로 사용할 수 있습니다. 패키지는 이제 @shikijs/twoslash입니다.
shiki-twoslash의 통합 패키지, 예를 들어 gatsby-remark-shiki-twoslash 등은 점차 일반 Shiki 버전으로 이전될 예정입니다. 그 전에 @shikijs/rehype 또는 @shikijs/markdown-it를 사용하여 이러한 메타 프레임워크에 Shiki를 통합할 수 있습니다.
@shikijs/monaco, @shikijs/cli, @shikijs/rehype, @shikijs/markdown-it와 같은 새로운 공식 통합이 도입되었습니다.
shiki-renderer-path 및 shiki-renderer-svg 패키지는 사용이 적어 폐기될 예정입니다. 필요하다면 사용 사례를 기재하여 이슈를 열어주세요. 다시 도입하는 것에 대해 열려 있습니다.
vuepress-plugin-shiki는 VuePress가 더 이상 권장되지 않기 때문에 폐기되었습니다. 그 후속작인 VitePress에는 Shiki 통합이 내장되어 있습니다.

이미 Shikiji를 사용하고 있는 경우, 먼저 최신 마이너 버전 v0.10으로 업데이트하세요. 그런 다음 패키지 이름을 변경하는 간단한 작업으로 마이그레이션할 수 있습니다: