64 lines
2.7 KiB
TypeScript
64 lines
2.7 KiB
TypeScript
import { PatternScanner, RegexEngineString, RegexEngine } from '@shikijs/types';
|
|
import { ToRegExpOptions } from 'oniguruma-to-es';
|
|
import { IOnigMatch } from '@shikijs/vscode-textmate';
|
|
|
|
interface JavaScriptRegexScannerOptions {
|
|
/**
|
|
* Whether to allow invalid regex patterns.
|
|
*
|
|
* @default false
|
|
*/
|
|
forgiving?: boolean;
|
|
/**
|
|
* Cache for regex patterns.
|
|
*/
|
|
cache?: Map<string, RegExp | Error> | null;
|
|
/**
|
|
* Custom pattern to RegExp constructor.
|
|
*
|
|
* By default `oniguruma-to-es` is used.
|
|
*/
|
|
regexConstructor?: (pattern: string) => RegExp;
|
|
}
|
|
declare class JavaScriptScanner implements PatternScanner {
|
|
patterns: (string | RegExp)[];
|
|
options: JavaScriptRegexScannerOptions;
|
|
regexps: (RegExp | null)[];
|
|
constructor(patterns: (string | RegExp)[], options?: JavaScriptRegexScannerOptions);
|
|
findNextMatchSync(string: string | RegexEngineString, startPosition: number, _options: number): IOnigMatch | null;
|
|
}
|
|
|
|
interface JavaScriptRegexEngineOptions extends JavaScriptRegexScannerOptions {
|
|
/**
|
|
* The target ECMAScript version.
|
|
*
|
|
* Oniguruma-To-ES uses RegExp features from later versions of ECMAScript to add support for a
|
|
* few more grammars. If using target `ES2024` or later, the RegExp `v` flag is used which
|
|
* requires Node.js 20+ or Chrome 112+.
|
|
* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets
|
|
*
|
|
* For maximum compatibility, you can set it to `ES2018` which uses the RegExp `u` flag.
|
|
*
|
|
* Set to `auto` to automatically detect the latest version supported by the environment.
|
|
*
|
|
* @default 'auto'
|
|
*/
|
|
target?: 'auto' | 'ES2025' | 'ES2024' | 'ES2018';
|
|
}
|
|
/**
|
|
* The default regex constructor for the JavaScript RegExp engine.
|
|
*/
|
|
declare function defaultJavaScriptRegexConstructor(pattern: string, options?: ToRegExpOptions): RegExp;
|
|
/**
|
|
* Use the modern JavaScript RegExp engine to implement the OnigScanner.
|
|
*
|
|
* As Oniguruma supports some features that can't be emulated using native JavaScript regexes, some
|
|
* patterns are not supported. Errors will be thrown when parsing TextMate grammars with
|
|
* unsupported patterns, and when the grammar includes patterns that use invalid Oniguruma syntax.
|
|
* Set `forgiving` to `true` to ignore these errors and skip any unsupported or invalid patterns.
|
|
*/
|
|
declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
|
|
|
|
export { JavaScriptScanner as b, createJavaScriptRegexEngine as c, defaultJavaScriptRegexConstructor as d };
|
|
export type { JavaScriptRegexEngineOptions as J, JavaScriptRegexScannerOptions as a };
|