fix(compact): improve types export

shikijs · Dec 11, 2023 · 5d73792 · 5d73792
1 parent 02d7b50
commit 5d73792
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/packages/shikiji-compat/src/types.ts b/packages/shikiji-compat/src/types.ts
@@ -5,11 +5,12 @@ import type {
   CodeOptionsMultipleThemes,
   CodeOptionsSingleTheme,
   CodeToHastOptionsCommon,
-  IRawGrammar,
   LanguageRegistration,
+  RawGrammar,
   StringLiteralUnion,
   ThemeRegistration,
   ThemeRegistrationRaw,
+  ThemedToken,
 } from 'shikiji'
 
 export interface LineOption {
@@ -35,6 +36,8 @@ export interface HighlighterOptions extends BundledHighlighterOptions<BuiltinLan
 export type IThemeRegistration = ThemeRegistrationRaw | ThemeRegistration | StringLiteralUnion<BuiltinTheme>
 
 export interface IShikiTheme extends ThemeRegistration {}
+export interface IThemedToken extends ThemedToken {}
+export interface IRawGrammar extends RawGrammar {}
 
 export interface ILanguageRegistration extends LanguageRegistration {
   grammar?: IRawGrammar

diff --git a/packages/shikiji/src/types.ts b/packages/shikiji/src/types.ts
@@ -1,12 +1,23 @@
-import type { IGrammar, IRawGrammar, IRawTheme } from 'vscode-textmate'
+import type {
+  IGrammar as Grammar,
+  IRawGrammar as RawGrammar,
+  IRawTheme as RawTheme,
+} from 'vscode-textmate'
 import type { IRawThemeSetting } from 'vscode-textmate/release/theme'
 import type { Element, Root } from 'hast'
 import type { bundledThemes } from './themes'
 import type { bundledLanguages } from './assets/langs'
 import type { FontStyle } from './core/stackElementMetadata'
 import type { OnigurumaLoadOptions } from './oniguruma'
 
-export { IRawGrammar, IGrammar, FontStyle }
+export {
+  Grammar,
+  RawGrammar,
+  FontStyle,
+  // TODO: move these in the next major version
+  Grammar as IGrammar,
+  RawGrammar as IRawGrammar,
+}
 
 export type BuiltinLanguage = keyof typeof bundledLanguages
 export type BuiltinTheme = keyof typeof bundledThemes
@@ -42,7 +53,7 @@ export interface ShikiContext {
   }
 
   getTheme(name: string | ThemeRegistration | ThemeRegistrationRaw): ThemeRegistration
-  getLangGrammar(name: string): IGrammar
+  getLangGrammar(name: string): Grammar
 
   getLoadedThemes(): string[]
   getLoadedLanguages(): string[]
@@ -155,7 +166,7 @@ export interface BundledHighlighterOptions<L extends string, T extends string> {
   langAlias?: Record<string, StringLiteralUnion<L>>
 }
 
-export interface LanguageRegistration extends IRawGrammar {
+export interface LanguageRegistration extends RawGrammar {
   name: string
   scopeName: string
   displayName?: string
@@ -290,9 +301,7 @@ export type CodeToHastOptions<Languages extends string = string, Themes extends
   & CodeOptionsThemes<Themes>
   & CodeOptionsMeta
 
-export interface ThemeRegistrationRaw extends IRawTheme {
-
-}
+export interface ThemeRegistrationRaw extends RawTheme {}
 
 export interface ThemeRegistration extends ThemeRegistrationRaw {
   /**