@git-diff-view/shiki (英语)
使用 Shiki 查看 @ git- diff- 视图的高级语法亮点
使用替代语法提示器 志纪 用于以 TextMate 语法和 VSCode 主题更精确地突出.
特征
- VSCode 质量语法突出显示
- QQ TextMate 语法支持
- VSCode 相容主题
- QQ 更准确的语言支持
- 彩色忠诚
- QQ 启动
安装
npm install @git-diff-view/shiki
# or
pnpm add @git-diff-view/shiki
# or
yarn add @git-diff-view/shiki
使用量
基本用途
import { DiffFile } from "@git-diff-view/core";
import { getDiffViewHighlighter } from "@git-diff-view/shiki";
const diffFile = new DiffFile(
oldFileName,
oldContent,
newFileName,
newContent,
hunks,
"typescript",
"typescript"
);
// Initialize raw diff data first
diffFile.initRaw();
// Get Shiki highlighter (async)
const highlighter = await getDiffViewHighlighter();
// Apply syntax highlighting with Shiki
diffFile.initSyntax({ registerHighlighter: highlighter });
// Build views
diffFile.buildSplitDiffLines();
diffFile.buildUnifiedDiffLines();
// Get bundle
const bundle = diffFile.getBundle();
带有自定义 Shiki 配置
import { getDiffViewHighlighter } from "@git-diff-view/shiki";
const highlighter = await getDiffViewHighlighter({
themes: ['github-dark', 'github-light'],
langs: ['typescript', 'javascript', 'python']
});
diffFile.initSyntax({ registerHighlighter: highlighter });
API 参考
获取 DiffView 高亮度 ()
获取配置的 Shiki 亮点实例 .
async function getDiffViewHighlighter(
options?: ShikiOptions
): Promise<Highlighter>
选项
接受标准 Shiki 配置选项。 。 。 .
比较
| 特性 | @git-diff-view/lowlight (英语) | @git-diff-view/shiki (英语) | @git-diff-view/lezer (英语) |
|---|---|---|---|
| 默认 | * 内建 | 分离软件包 | 分离软件包 |
| 设置 | 不需要设置 | 同步初始化 | 同步剖析 / aync API |
| 准确性 | 不错 | 优秀( VSCode- 级别) | 强 (LR 语法) |
| 主题 | 突出显示.js 主题 | VSCode 主题 | GitHub 类似 CSS 变量 |
| 套装大小 | 小一点 | 大一点 | 中 (每语) |
| 刚才 | 没有 | 可选 | 没有 |
| 限制运行时间 | 有限 | 有限 | 更强的合身 |
何时使用
使用 @git-diff-view/shiki (英语) 需要时:
- VSCode 质量语法突出显示
- 准确的语言语法
- VSCode 兼容主题
- 更好的颜色忠贞
使用 @git-diff-view/lowlight (英语) (默认)当:
- 您想要零配置
- 套装大小很关键
- 选择同步初始化
- 基本强调就够了
使用 @git-diff-view/lezer (英语) 当:
- 您需要纯 JS 解析器( 无 WASM / 节点)
- 锁定 Lynx 等有限的运行时间
- CodeMiror 质量 LR 语法足够了
相关软件包
- @ git- diff- 视图/ 核心 - 核心diff发动机
- @git-diff-view/lowlight (英语) - 默认亮点
- @git-diff-view/lezer (英语) - 勒泽突出显示器
- 志纪 - 地下图书馆
许可证
麻省理工学院 万正东先生