feat!: rename to shiki

Author: antfu

.gitignore

@@ -9,7 +9,7 @@ lib-cov
 logs
 node_modules
 temp
-packages/shikiji/src/assets/langs
-packages/shikiji/src/assets/themes
-packages/shikiji/src/assets/*.json
+packages/shiki/src/assets/langs
+packages/shiki/src/assets/themes
+packages/shiki/src/assets/*.json
 cache

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "packages/shikiji-core/vendor/vscode-textmate"]
-	path = packages/shikiji-core/vendor/vscode-textmate
+[submodule "packages/core/vendor/vscode-textmate"]
+	path = packages/core/vendor/vscode-textmate
 	url = https://github.com/microsoft/vscode-textmate

.vscode/settings.json

@@ -37,5 +37,8 @@
     "jsonc",
     "yaml"
   ],
-  "references.preferredLocation": "peek"
+  "references.preferredLocation": "peek",
+  "cSpell.words": [
+    "shikijs"
+  ]
 }

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Please refer to https://github.com/antfu/contribute
 This repository contains a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to `vscode-textmate`. By default `git clone` does not clone submodules. To clone this repository and its submodules, use:
 
 ```bash
-git clone --recursive https://github.com/antfu/shikiji
+git clone --recursive https://github.com/shikijs/shiki
 ```
 
 Or if you have already cloned it, use:

README.md

@@ -1,14 +1,14 @@
-<img src="https://raw.githubusercontent.com/antfu/shikiji/main/docs/public/logo.svg" width="150" alt="Shikiji Logo" />
+<img src="https://raw.githubusercontent.com/shikijs/shiki/main/docs/public/logo.svg" width="150" alt="Shiki Logo" />
 
-# Shikiji 式辞
+# Shiki 式
 
-[![NPM version](https://img.shields.io/npm/v/shikiji?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/shikiji)
-[![NPM downloads](https://img.shields.io/npm/dm/shikiji?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/shikiji)
-[![Codecov](https://img.shields.io/codecov/c/github/antfu/shikiji?token=B85J0E2I7I&style=flat&labelColor=1B3C4A&color=32A9C3&precision=1)](https://app.codecov.io/gh/antfu/shikiji)
+[![NPM version](https://img.shields.io/npm/v/shiki?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/shiki)
+[![NPM downloads](https://img.shields.io/npm/dm/shiki?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/shiki)
+[![Codecov](https://img.shields.io/codecov/c/github/shikijs/shiki?token=B85J0E2I7I&style=flat&labelColor=1B3C4A&color=32A9C3&precision=1)](https://app.codecov.io/gh/shikijs/shiki)
 
-An ESM-focused rewrite of [shiki](https://github.com/shikijs/shiki), a beautiful syntax highlighter based on TextMate grammars, with more features and capabilities.
+A beautiful syntax highlighter based on TextMate grammars, accurate and powerful.
 
-[📚 **Documentation**](https://shikiji.netlify.app)
+[📚 **Documentation**](https://shiki.netlify.app)
 
 ## License
 

docs/.vitepress/components/Badges.vue

@@ -8,6 +8,6 @@ defineProps<{
   <p flex="~ gap-2" h-5>
     <a :href="`https://www.npmjs.com/package/${name}`" target="_blank"><img :src="`https://img.shields.io/npm/v/${name}?color=32A9C3&amp;labelColor=1B3C4A&amp;label=npm`" alt="NPM version"></a>
     <a :href="`https://www.npmjs.com/package/${name}`" target="_blank"><img :src="`https://img.shields.io/npm/dm/${name}?color=32A9C3&amp;labelColor=1B3C4A&amp;label=downloads`" alt="NPM downloads"></a>
-    <a :href="`https://github.com/antfu/shikiji/tree/main/packages/${name}`" target="_blank"><img src="https://img.shields.io/badge/source-a?logo=github&color=1B3C4A" alt="GitHub"></a>
+    <a :href="`https://github.com/shikijs/shiki/tree/main/packages/${name}`" target="_blank"><img src="https://img.shields.io/badge/source-a?logo=github&color=1B3C4A" alt="GitHub"></a>
   </p>
 </template>

docs/.vitepress/components/HomeDemo.vue

@@ -1,5 +1,5 @@
 <template>
   <div class="container max-w-250 mx-a my-10 min-h-250 vp-doc p4" of-hidden>
-    <ShikijiMiniPlayground />
+    <ShikiMiniPlayground />
   </div>
 </template>

docs/.vitepress/components/LanguagesList.vue

@@ -62,7 +62,7 @@ const langs = computed(() => {
     </table>
     <div v-if="showModel" fixed inset-0 z-100 flex items-center justify-center>
       <div bg-black:50 absolute inset-0 backdrop-blur-sm @click="showModel = false" />
-      <ShikijiMiniPlayground max-h-80vh w-full md:w-150 lg:w-200 />
+      <ShikiMiniPlayground max-h-80vh w-full md:w-150 lg:w-200 />
     </div>
   </div>
 </template>

docs/.vitepress/components/ShikijiMiniPlayground.vue docs/.vitepress/components/ShikiMiniPlayground.vue

@@ -8,7 +8,7 @@ const play = usePlayground()
   <div class="vp-doc">
     <div grid="~ cols-2 gap-4" p4>
       <textarea v-model="play.input" font-mono rounded p4 my4.5 />
-      <ShikijiMiniPlayground />
+      <ShikiMiniPlayground />
     </div>
   </div>
 </template>

docs/.vitepress/components/ShikijiPlayground.vue docs/.vitepress/components/ShikiPlayground.vue

@@ -41,7 +41,7 @@ function preview(id: string) {
     </table>
     <div v-if="showModel" fixed inset-0 z-100 flex items-center justify-center>
       <div bg-black:50 absolute inset-0 backdrop-blur-sm @click="showModel = false" />
-      <ShikijiMiniPlayground max-h-80vh w-full md:w-150 lg:w-200 />
+      <ShikiMiniPlayground max-h-80vh w-full md:w-150 lg:w-200 />
     </div>
   </div>
 </template>

docs/.vitepress/components/ThemesList.vue

@@ -1,8 +1,8 @@
 import type { DefaultTheme } from 'vitepress'
 import { defineConfig } from 'vitepress'
-import { bundledThemes } from 'shikiji'
-import { transformerMetaWordHighlight, transformerNotationWordHighlight } from '../../packages/shikiji-transformers/src'
-import { defaultHoverInfoProcessor, transformerTwoslash } from '../../packages/vitepress-plugin-twoslash/src/index'
+import { bundledThemes } from 'shiki'
+import { transformerMetaWordHighlight, transformerNotationWordHighlight } from '../../packages/transformers/src'
+import { defaultHoverInfoProcessor, transformerTwoslash } from '../../packages/vitepress-twoslash/src/index'
 import { version } from '../../package.json'
 import vite from './vite.config'
 
@@ -36,30 +36,30 @@ const INTEGRATIONS: DefaultTheme.NavItemWithLink[] = [
 
 const VERSIONS: DefaultTheme.NavItemWithLink[] = [
   { text: `v${version} (current)`, link: '/' },
-  { text: `Release Notes`, link: 'https://github.com/antfu/shikiji/releases' },
-  { text: `Contributing`, link: 'https://github.com/antfu/shikiji/blob/main/CONTRIBUTING.md' },
+  { text: `Release Notes`, link: 'https://github.com/shikijs/shiki/releases' },
+  { text: `Contributing`, link: 'https://github.com/shikijs/shiki/blob/main/CONTRIBUTING.md' },
 ]
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: 'Shikiji',
+  title: 'Shiki',
   description: 'A beautiful and powerful syntax highlighter',
   markdown: {
     theme: {
       light: 'vitesse-light',
       dark: 'vitesse-dark',
     },
-    async shikijiSetup(shikiji) {
+    async shikijiSetup(shiki) {
       await Promise.all(Object.keys(bundledThemes).map(async (theme) => {
-        await shikiji.loadTheme(theme as any)
+        await shiki.loadTheme(theme as any)
       }))
     },
     codeTransformers: [
       transformerMetaWordHighlight(),
       transformerNotationWordHighlight(),
       {
         // Render custom themes with codeblocks
-        name: 'shikiji:inline-theme',
+        name: 'shiki:inline-theme',
         preprocess(code, options) {
           const reg = /\btheme:([\w,-]+)\b/
           const match = options.meta?.__raw?.match(reg)
@@ -93,14 +93,14 @@ export default defineConfig({
       transformerTwoslash({
         processHoverInfo(info) {
           return defaultHoverInfoProcessor(info)
-            // Remove shikiji_core namespace
-            .replace(/shikiji_core\./g, '')
+            // Remove shiki_core namespace
+            .replace(/shiki_core\./g, '')
             // Remove member access
             .replace(/^[a-zA-Z0-9_]*(\<[^\>]*\>)?\./, '')
         },
       }),
       {
-        name: 'shikiji:remove-escape',
+        name: 'shiki:remove-escape',
         postprocess(code) {
           return code.replace(/\[\\\!code/g, '[!code')
         },
@@ -160,15 +160,15 @@ export default defineConfig({
     ),
 
     editLink: {
-      pattern: 'https://github.com/antfu/shikiji/edit/main/docs/:path',
+      pattern: 'https://github.com/shikijs/shiki/edit/main/docs/:path',
       text: 'Suggest changes to this page',
     },
     search: {
       provider: 'local',
     },
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/antfu/shikiji' },
+      { icon: 'github', link: 'https://github.com/shikijs/shiki' },
     ],
 
     footer: {
@@ -181,11 +181,11 @@ export default defineConfig({
     ['meta', { name: 'theme-color', content: '#ffffff' }],
     ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
     ['meta', { name: 'author', content: 'Pine Wu, Anthony Fu' }],
-    ['meta', { property: 'og:title', content: 'Shikiji' }],
-    ['meta', { property: 'og:image', content: 'https://shikiji.netlify.app/og.png' }],
+    ['meta', { property: 'og:title', content: 'Shiki' }],
+    ['meta', { property: 'og:image', content: 'https://shiki.netlify.app/og.png' }],
     ['meta', { property: 'og:description', content: 'A beautiful and powerful syntax highlighter' }],
     ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
-    ['meta', { name: 'twitter:image', content: 'https://shikiji.netlify.app/og.png' }],
+    ['meta', { name: 'twitter:image', content: 'https://shiki.netlify.app/og.png' }],
     ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0, viewport-fit=cover' }],
   ],
 })

docs/.vitepress/config.ts

@@ -1,13 +1,13 @@
 /// <reference types="vite/client" />
 
 import { acceptHMRUpdate, defineStore } from 'pinia'
-import type { BundledLanguageInfo, BundledThemeInfo } from 'shikiji'
+import type { BundledLanguageInfo, BundledThemeInfo } from 'shiki'
 import { useLocalStorage } from '@vueuse/core'
 import { ref, shallowRef, watch } from 'vue'
 
 export const usePlayground = defineStore('playground', () => {
-  const lang = useLocalStorage('shikiji-playground-lang', 'typescript')
-  const theme = useLocalStorage('shikiji-playground-theme', 'vitesse-dark')
+  const lang = useLocalStorage('shiki-playground-lang', 'typescript')
+  const theme = useLocalStorage('shiki-playground-theme', 'vitesse-dark')
   const allThemes = shallowRef<BundledThemeInfo[]>([
     {
       id: 'vitesse-dark',
@@ -26,7 +26,7 @@ export const usePlayground = defineStore('playground', () => {
   const bundledLangsFull = shallowRef<BundledLanguageInfo[]>([])
   const bundledLangsWeb = shallowRef<BundledLanguageInfo[]>([])
 
-  const input = useLocalStorage('shikiji-playground-input', '')
+  const input = useLocalStorage('shiki-playground-input', '')
   const output = ref('<pre></pre>')
   const preStyle = ref('')
   const isLoading = ref(true)
@@ -39,10 +39,10 @@ export const usePlayground = defineStore('playground', () => {
   }
 
   ;(async () => {
-    const { getHighlighter, addClassToHast } = await import('shikiji')
-    const { bundledLanguagesInfo: bundleFull } = await import('shikiji/bundle/full')
-    const { bundledLanguagesInfo: bundleWeb } = await import('shikiji/bundle/web')
-    const { bundledThemesInfo } = await import('shikiji/themes')
+    const { getHighlighter, addClassToHast } = await import('shiki')
+    const { bundledLanguagesInfo: bundleFull } = await import('shiki/bundle/full')
+    const { bundledLanguagesInfo: bundleWeb } = await import('shiki/bundle/web')
+    const { bundledThemesInfo } = await import('shiki/themes')
 
     const samplesCache = new Map<string, Promise<string | undefined>>()
 

docs/.vitepress/store/playground.ts

@@ -2,11 +2,11 @@
 import Theme from 'vitepress/theme'
 import type { EnhanceAppContext } from 'vitepress'
 import { createPinia } from 'pinia'
-import TwoslashFloatingVue from '../../../packages/vitepress-plugin-twoslash/src/client'
+import TwoslashFloatingVue from '../../../packages/vitepress-twoslash/src/client'
 
-import '../../../packages/shikiji-twoslash/style-rich.css'
+import '../../../packages/twoslash/style-rich.css'
 import 'floating-vue/dist/style.css'
-import '../../../packages/vitepress-plugin-twoslash/src/style.css'
+import '../../../packages/vitepress-twoslash/src/style.css'
 import 'uno.css'
 import './style.css'
 import './transformers.css'

docs/.vitepress/theme/index.ts

@@ -10,8 +10,8 @@ declare module 'vue' {
     Badges: typeof import('./.vitepress/components/Badges.vue')['default']
     HomeDemo: typeof import('./.vitepress/components/HomeDemo.vue')['default']
     LanguagesList: typeof import('./.vitepress/components/LanguagesList.vue')['default']
-    ShikijiMiniPlayground: typeof import('./.vitepress/components/ShikijiMiniPlayground.vue')['default']
-    ShikijiPlayground: typeof import('./.vitepress/components/ShikijiPlayground.vue')['default']
+    ShikiMiniPlayground: typeof import('./.vitepress/components/ShikiMiniPlayground.vue')['default']
+    ShikiPlayground: typeof import('./.vitepress/components/ShikiPlayground.vue')['default']
     ThemesList: typeof import('./.vitepress/components/ThemesList.vue')['default']
   }
 }

docs/components.d.ts

@@ -4,31 +4,31 @@ outline: deep
 
 # Bundles
 
-The main `shikiji` entries bundles all supported themes and languages via lazy dynamic imports. The efficiency shouldn't be a concern to most of the scenarios as the grammar would only be imported/downloaded when it is used. However, when you bundle Shikiji into browsers runtime or web workers, even those files are not imported, they still add up to your dist size. We provide the [fine-grained bundle](/guide/install#fine-grained-bundle) to help you compose languages and themes one-by-one as you need.
+The main `shiki` entries bundles all supported themes and languages via lazy dynamic imports. The efficiency shouldn't be a concern to most of the scenarios as the grammar would only be imported/downloaded when it is used. However, when you bundle Shiki into browsers runtime or web workers, even those files are not imported, they still add up to your dist size. We provide the [fine-grained bundle](/guide/install#fine-grained-bundle) to help you compose languages and themes one-by-one as you need.
 
 To make it easier, we also provide some pre-composed bundles for you to use:
 
-## `shikiji/bundle/full`
+## `shiki/bundle/full`
 
 > [Bundle Size](/guide/#bundle-size): 6.4 MB (minified), 1.2 MB (gzip), async chunks included
 
-The full bundle includes all themes and languages, same as the main `shikiji` entry.
+The full bundle includes all themes and languages, same as the main `shiki` entry.
 
-## `shikiji/bundle/web`
+## `shiki/bundle/web`
 
 > [Bundle Size](/guide/#bundle-size): 3.8 MB (minified), 695 KB (gzip), async chunks included
 
 The bundle includes all themes and common web languages like (HTML, CSS, JS, TS, JSON, Markdown, etc.) and some web frameworks (Vue, JSX, Svelte, etc.).
 
-Use as normal, all functions from `shikiji` are also available in the bundle:
+Use as normal, all functions from `shiki` are also available in the bundle:
 
 ```ts twoslash
 import {
   BundledLanguage,
   BundledTheme,
   codeToHtml,
   getHighlighter
-} from 'shikiji/bundle/web' // [!code highlight]
+} from 'shiki/bundle/web' // [!code highlight]
 
 const highlighter = await getHighlighter({
   langs: ['html', 'css', 'js'],

docs/guide/bundles.md

@@ -6,38 +6,38 @@ outline: deep
 
 We took the chance of the rewrite to make some breaking changes that we think are beneficial for the future. We'd suggest you try to migrate those changes if possible, as most of them should be straightforward. If you have very deep integration, you can try our compatibility build which aligns better with `shiki`'s current API.
 
-## Install `shikiji-compat`
+## Install `shiki-compat`
 
-<Badges name="shikiji-compat" />
+<Badges name="shiki-compat" />
 
 Set the alias to `shiki` in your `package.json`:
 
 ```json
 {
   "dependencies": {
-    "shiki": "npm:shikiji-compat@0.9"
+    "shiki": "npm:shiki-compat@0.9"
   }
 }
 ```
 
 ## Breaking Changes from Shiki
 
-Compare to [`shiki@0.14.3`](https://github.com/shikijs/shiki/releases/tag/v0.14.3), the breaking changes between Shiki and Shikiji are:
+Compare to [`shiki@0.14.3`](https://github.com/shikijs/shiki/releases/tag/v0.14.3), the breaking changes between Shiki and Shiki are:
 
 ### Hard Breaking Changes
 
-Breaking changes applied to both `shikiji` and `shikiji-compat`:
+Breaking changes applied to both `shiki` and `shiki-compat`:
 
 - CJS and IIFE builds are dropped. See [CJS Usage](/guide/install#cjs-usage) and [CDN Usage](/guide/install#cdn-usage) for more details.
 - `codeToHtml` uses [`hast`](https://github.com/syntax-tree/hast) internally. The generated HTML will be a bit different but should behave the same.
 - `css-variables` theme is not supported. Use the [dual themes](/guide/dual-themes) approach instead, or learn more at the [Theme Colors Manipulation](/guide/theme-colors) page.
 
 ### Soft Breaking Changes
 
-Breaking changes applies to `shikiji`, but are shimmed by `shikiji-compat`:
+Breaking changes applies to `shiki`, but are shimmed by `shiki-compat`:
 
 - Top-level named exports `setCDN`, `loadLanguage`, `loadTheme`, `setWasm` are dropped as they are not needed anymore.
-- `BUNDLED_LANGUAGES`, `BUNDLED_THEMES` are moved to `shikiji/langs` and `shikiji/themes` and renamed to `bundledLanguages` and `bundledThemes` respectively.
+- `BUNDLED_LANGUAGES`, `BUNDLED_THEMES` are moved to `shiki/langs` and `shiki/themes` and renamed to `bundledLanguages` and `bundledThemes` respectively.
 - `theme` option for `getHighlighter` is dropped, use `themes` with an array instead.
 - Highlighter does not maintain an internal default theme context. `theme` option is required for `codeToHtml` and `codeToThemedTokens`.
 - `codeToThemedTokens` sets `includeExplanation` to `false` by default.