fix(shiki): rename createdBundledHighlighter to createBundledHighlighter (#1135)

Co-authored-by: Tushar <tushar@Tushar-ka-MacBook-Pro.local>
Co-authored-by: Anthony Fu <github@antfu.me>

Author: 3 people

docs/guide/shorthands.md

@@ -20,7 +20,7 @@ console.log(html) // highlighted html string
 You can create your own shorthands with fine-grained bundles. Here is an example of creating shorthands with fine-grained bundles:
 
 ```ts
-import { createdBundledHighlighter, createSingletonShorthands } from 'shiki/core'
+import { createBundledHighlighter, createSingletonShorthands } from 'shiki/core'
 import { createJavaScriptRegexEngine } from 'shiki/engine/javascript'
 
 const BundledLanguage = {
@@ -35,7 +35,7 @@ const BundledTheme = {
 }
 
 // This creates your custom 'createHighlighter' function with fine-grained bundles
-export const createHighlighter = /* @__PURE__ */ createdBundledHighlighter<
+export const createHighlighter = /* @__PURE__ */ createBundledHighlighter<
   BundledLanguage,
   BundledTheme
 >({

packages/codegen/src/index.ts

@@ -98,7 +98,7 @@ export async function codegen(options: ShikiCodegenOptions): Promise<ShikiCodege
     '@shikijs/types': ['HighlighterGeneric', 'DynamicImportThemeRegistration', 'DynamicImportLanguageRegistration'],
   }
   const imports: Record<string, string[]> = {
-    '@shikijs/core': ['createdBundledHighlighter'],
+    '@shikijs/core': ['createBundledHighlighter'],
   }
   const lines: string[] = [
     '',
@@ -143,7 +143,7 @@ export async function codegen(options: ShikiCodegenOptions): Promise<ShikiCodege
 
   lines.push(
     '',
-    `const createHighlighter = /* @__PURE__ */ createdBundledHighlighter${ts('<BundledLanguage, BundledTheme>')}({`,
+    `const createHighlighter = /* @__PURE__ */ createBundledHighlighter${ts('<BundledLanguage, BundledTheme>')}({`,
     `  langs: bundledLanguages,`,
     `  themes: bundledThemes,`,
     `  engine: () => ${engine}`,

packages/codegen/test/__snapshots__/basic-oniguruma-js.js

@@ -1,7 +1,7 @@
 /* Generate by @shikijs/codegen */
 import {
+  createBundledHighlighter,
   createSingletonShorthands,
-  createdBundledHighlighter,
 } from '@shikijs/core'
 import { createOnigurumaEngine } from '@shikijs/engine-oniguruma'
 
@@ -22,7 +22,7 @@ const bundledThemes = {
   'vitesse-dark': () => import('@shikijs/themes/vitesse-dark'),
 }
 
-const createHighlighter = /* @__PURE__ */ createdBundledHighlighter({
+const createHighlighter = /* @__PURE__ */ createBundledHighlighter({
   langs: bundledLanguages,
   themes: bundledThemes,
   engine: () => createOnigurumaEngine(import('shiki/wasm')),

packages/codegen/test/__snapshots__/basic-oniguruma.ts

@@ -5,8 +5,8 @@ import type {
   HighlighterGeneric,
 } from '@shikijs/types'
 import {
+  createBundledHighlighter,
   createSingletonShorthands,
-  createdBundledHighlighter,
 } from '@shikijs/core'
 import { createOnigurumaEngine } from '@shikijs/engine-oniguruma'
 
@@ -40,7 +40,7 @@ const bundledThemes = {
   'vitesse-dark': () => import('@shikijs/themes/vitesse-dark'),
 } as Record<BundledTheme, DynamicImportThemeRegistration>
 
-const createHighlighter = /* @__PURE__ */ createdBundledHighlighter<
+const createHighlighter = /* @__PURE__ */ createBundledHighlighter<
   BundledLanguage,
   BundledTheme
 >({

packages/codegen/test/__snapshots__/basic-precompiled.ts

@@ -4,7 +4,7 @@ import type {
   DynamicImportThemeRegistration,
   HighlighterGeneric,
 } from '@shikijs/types'
-import { createdBundledHighlighter } from '@shikijs/core'
+import { createBundledHighlighter } from '@shikijs/core'
 import { createJavaScriptRawEngine } from '@shikijs/engine-javascript/raw'
 
 type BundledLanguage =
@@ -37,7 +37,7 @@ const bundledThemes = {
   'vitesse-dark': () => import('@shikijs/themes/vitesse-dark'),
 } as Record<BundledTheme, DynamicImportThemeRegistration>
 
-const createHighlighter = /* @__PURE__ */ createdBundledHighlighter<
+const createHighlighter = /* @__PURE__ */ createBundledHighlighter<
   BundledLanguage,
   BundledTheme
 >({

packages/core/src/constructors/bundle-factory.ts

@@ -5,7 +5,7 @@ import type {
   CodeToTokensBaseOptions,
   CodeToTokensOptions,
   CodeToTokensWithThemesOptions,
-  CreatedBundledHighlighterOptions,
+  CreateBundledHighlighterOptions,
   CreateHighlighterFactory,
   GrammarState,
   HighlighterGeneric,
@@ -30,7 +30,7 @@ import { createHighlighterCore } from './highlighter'
  *
  * @example
  * ```ts
- * const createHighlighter = createdBundledHighlighter({
+ * const createHighlighter = createBundledHighlighter({
  *   langs: {
  *     typescript: () => import('@shikijs/langs/typescript'),
  *     // ...
@@ -45,13 +45,13 @@ import { createHighlighterCore } from './highlighter'
  *
  * @param options
  */
-export function createdBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(
-  options: CreatedBundledHighlighterOptions<BundledLangs, BundledThemes>,
+export function createBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(
+  options: CreateBundledHighlighterOptions<BundledLangs, BundledThemes>,
 ): CreateHighlighterFactory<BundledLangs, BundledThemes>
 
 // Implementation
-export function createdBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(
-  options: CreatedBundledHighlighterOptions<BundledLangs, BundledThemes>,
+export function createBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(
+  options: CreateBundledHighlighterOptions<BundledLangs, BundledThemes>,
 ): CreateHighlighterFactory<BundledLangs, BundledThemes> {
   const bundledLanguages = options.langs
   const bundledThemes = options.themes
@@ -270,3 +270,8 @@ export function createSingletonShorthands<L extends string, T extends string>(
     },
   }
 }
+
+/**
+ * @deprecated Use `createBundledHighlighter` instead.
+ */
+export const createdBundledHighlighter = createBundledHighlighter

packages/shiki/src/bundle-full.ts

@@ -2,7 +2,7 @@ import type { HighlighterGeneric } from '@shikijs/types'
 import type {} from 'hast'
 import type { BundledLanguage } from './langs-bundle-full'
 import type { BundledTheme } from './themes'
-import { createdBundledHighlighter, createSingletonShorthands, guessEmbeddedLanguages } from '@shikijs/core'
+import { createBundledHighlighter, createSingletonShorthands, guessEmbeddedLanguages } from '@shikijs/core'
 import { createOnigurumaEngine } from './engine-oniguruma'
 import { bundledLanguages } from './langs-bundle-full'
 import { bundledThemes } from './themes'
@@ -23,7 +23,7 @@ export type Highlighter = HighlighterGeneric<BundledLanguage, BundledTheme>
  * For granular control over the bundle, check:
  * @see https://shiki.style/guide/bundles#fine-grained-bundle
  */
-export const createHighlighter = /* @__PURE__ */ createdBundledHighlighter<
+export const createHighlighter = /* @__PURE__ */ createBundledHighlighter<
   BundledLanguage,
   BundledTheme
 >({

packages/shiki/src/bundle-web.ts

@@ -2,7 +2,7 @@ import type { HighlighterGeneric } from '@shikijs/types'
 import type {} from 'hast'
 import type { BundledLanguage } from './langs-bundle-web'
 import type { BundledTheme } from './themes'
-import { createdBundledHighlighter, createSingletonShorthands, guessEmbeddedLanguages } from '@shikijs/core'
+import { createBundledHighlighter, createSingletonShorthands, guessEmbeddedLanguages } from '@shikijs/core'
 import { createOnigurumaEngine } from './engine-oniguruma'
 import { bundledLanguages } from './langs-bundle-web'
 import { bundledThemes } from './themes'
@@ -23,7 +23,7 @@ export type Highlighter = HighlighterGeneric<BundledLanguage, BundledTheme>
  * For granular control over the bundle, check:
  * @see https://shiki.style/guide/bundles#fine-grained-bundle
  */
-export const createHighlighter = /* @__PURE__ */ createdBundledHighlighter<
+export const createHighlighter = /* @__PURE__ */ createBundledHighlighter<
   BundledLanguage,
   BundledTheme
 >({

packages/shiki/test/bundle.test.ts

@@ -7,7 +7,7 @@ it('bundle-full', async () => {
   }))
 
   expect(highlighter.getLoadedLanguages().length)
-    .toMatchInlineSnapshot(`331`)
+    .toMatchInlineSnapshot(`334`)
 })
 
 it('bundle-web', async () => {

packages/types/src/highlighter.ts

@@ -161,8 +161,15 @@ export type HighlighterCore = HighlighterGeneric<never, never>
 /**
  * Options for creating a bundled highlighter.
  */
-export interface CreatedBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string> {
+export interface CreateBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string> {
   langs: Record<BundledLangs, LanguageInput>
   themes: Record<BundledThemes, ThemeInput>
   engine: () => Awaitable<RegexEngine>
 }
+
+/**
+ * @deprecated Use `CreateBundledHighlighterOptions` instead.
+ */
+export interface CreatedBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string>
+  extends CreateBundledHighlighterOptions<BundledLangs, BundledThemes> {
+}