Skip to content

Commit 50c8e4a

Browse files
committed
fix: improve deprecation warnings
1 parent 2335dda commit 50c8e4a

File tree

6 files changed

+33
-6
lines changed

6 files changed

+33
-6
lines changed

docs/guide/bundles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ When importing `shiki`, all the themes and languages are bundled as async chunks
4646
// @noErrors
4747
// `shiki/core` entry does not include any themes or languages or the wasm binary.
4848
import { createHighlighterCore } from 'shiki/core'
49+
import { createOnigurumaEngine } from 'shiki/engine/oniguruma'
4950

5051
// directly import the theme and language modules, only the ones you imported will be bundled.
5152
import nord from 'shiki/themes/nord.mjs'
Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
import type { JavaScriptRegexEngineOptions } from '@shikijs/engine-javascript'
22
import type { RegexEngine } from '@shikijs/types'
3-
import { createJavaScriptRegexEngine as _createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript'
3+
import {
4+
createJavaScriptRegexEngine as _createJavaScriptRegexEngine,
5+
defaultJavaScriptRegexConstructor as _defaultJavaScriptRegexConstructor,
6+
} from '@shikijs/engine-javascript'
47
import { warnDeprecated } from '../warn'
58

9+
/**
10+
* @deprecated Import `createJavaScriptRegexEngine` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead.
11+
*/
612
export function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine {
713
warnDeprecated('import `createJavaScriptRegexEngine` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead')
814
return _createJavaScriptRegexEngine(options)
915
}
1016

11-
export { defaultJavaScriptRegexConstructor }
17+
/**
18+
* @deprecated Import `defaultJavaScriptRegexConstructor` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead.
19+
*/
20+
export function defaultJavaScriptRegexConstructor(pattern: string): RegExp {
21+
warnDeprecated('import `defaultJavaScriptRegexConstructor` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead')
22+
return _defaultJavaScriptRegexConstructor(pattern)
23+
}

packages/core/src/engines/oniguruma.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,25 @@ import {
55
} from '@shikijs/engine-oniguruma'
66
import { warnDeprecated } from '../warn'
77

8+
/**
9+
* @deprecated Import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
10+
*/
811
export function createOnigurumaEngine(options?: LoadWasmOptions | null): Promise<RegexEngine> {
912
warnDeprecated('import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead')
1013
return _createOnigurumaEngine(options)
1114
}
1215

16+
/**
17+
* @deprecated Import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
18+
*/
1319
export function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine> {
1420
warnDeprecated('import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead')
15-
return createOnigurumaEngine(options)
21+
return _createOnigurumaEngine(options)
1622
}
1723

24+
/**
25+
* @deprecated Import `loadWasm` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
26+
*/
1827
export function loadWasm(options: LoadWasmOptions): Promise<void> {
1928
warnDeprecated('import `loadWasm` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead')
2029
return _loadWasm(options)

packages/shiki/src/core.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,3 @@ export type { CssVariablesThemeOptions } from './theme-css-variables'
22

33
export { createCssVariablesTheme } from './theme-css-variables'
44
export * from '@shikijs/core'
5-
6-
export { createJavaScriptRegexEngine } from '@shikijs/engine-javascript'
7-
export { createOnigurumaEngine, loadWasm } from '@shikijs/engine-oniguruma'

packages/shiki/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
export * from './bundle-full'
22
export type { BuiltinLanguage, BuiltinTheme } from './types'
3+
4+
export { createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript'
5+
export { createOnigurumaEngine, loadWasm } from '@shikijs/engine-oniguruma'

packages/shiki/src/wasm-dynamic.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
import type { WebAssemblyInstantiator } from './types'
2+
import { warnDeprecated } from '@shikijs/core'
23

4+
/**
5+
* @deprecated Use `import('shiki/wasm')` instead.
6+
*/
37
export const getWasmInlined: WebAssemblyInstantiator = async (info) => {
8+
warnDeprecated('`getWasmInlined` is deprecated. Use `import("shiki/wasm")` instead.')
49
return import('shiki/wasm').then(wasm => wasm.default(info))
510
}

0 commit comments

Comments
 (0)