fuc-new/doc/node_modules/@vuepress/highlighter-helper/lib/node/whitespace.d.ts
hellcat 6adbc04d4b 1
2025-10-03 17:17:08 +08:00

36 lines
1.3 KiB
TypeScript

/**
* Regular expression to match `:whitespace` directive in code block info
*
* 匹配代码块信息中 `:whitespace` 指令的正则表达式
*/
export declare const WHITESPACE_REGEXP: RegExp;
/**
* Regular expression to match `:no-whitespace` directive in code block info
*
* 匹配代码块信息中 `:no-whitespace` 指令的正则表达式
*/
export declare const NO_WHITESPACE_REGEXP: RegExp;
/**
* Whitespace position types
*
* 空白符位置类型
*/
export type WhitespacePosition = 'all' | 'boundary' | 'trailing';
/**
* Resolve whitespace position from code block info and global option
*
* 从代码块信息和全局选项中解析空白符位置
*
* @param info - Code block info string / 代码块信息字符串
* @param globalOption - Global whitespace option / 全局空白符选项
* @returns Resolved whitespace position or false if disabled / 解析的空白符位置,如果禁用则返回 false
*
* @example
* ```ts
* resolveWhitespacePosition('js :whitespace=all', 'boundary') // 'all'
* resolveWhitespacePosition('js :no-whitespace', 'boundary') // false
* resolveWhitespacePosition('js', 'boundary') // 'boundary'
* ```
*/
export declare const resolveWhitespacePosition: (info: string, globalOption: WhitespacePosition | true) => WhitespacePosition | false;