@git-diff-view/shiki

中文文档
0.1.8发布于 2026/10/15MITTypeScriptES Module近 30 天下载 11.2万

@git-diff-view/shiki

原始使用文档
文档目录11 节
  1. Features
  2. Installation
  3. Usage
  4. Basic Usage
  5. With Custom Shiki Configuration
  6. API Reference
  7. getDiffViewHighlighter()
  8. Comparison
  9. When to Use
  10. Related Packages
  11. License

@git-diff-view/shiki

Advanced syntax highlighter for @git-diff-view using Shiki

npm version npm downloads

Alternative syntax highlighter using Shiki for more accurate highlighting with TextMate grammars and VSCode themes.

Features

  • ✅ VSCode-quality syntax highlighting
  • ✅ TextMate grammar support
  • ✅ VSCode-compatible themes
  • ✅ More accurate language support
  • ✅ Better color fidelity
  • ✅ Async initialization

Installation

npm install @git-diff-view/shiki
# or
pnpm add @git-diff-view/shiki
# or
yarn add @git-diff-view/shiki

Usage

Basic Usage

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();

With Custom Shiki Configuration

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 Reference

getDiffViewHighlighter()

Get a configured Shiki highlighter instance.

async function getDiffViewHighlighter(
  options?: ShikiOptions
): Promise<Highlighter>

Options

Accepts standard Shiki configuration options.

Comparison

Feature@git-diff-view/lowlight@git-diff-view/shiki@git-diff-view/lezer
Default✅ Built-in❌ Separate package❌ Separate package
SetupNo setup neededAsync initializationSync parse / async API
AccuracyGoodExcellent (VSCode-level)Strong (LR grammar)
Themeshighlight.js themesVSCode themesGitHub-like CSS variables
Bundle SizeSmallerLargerMedium (per-language)
WASMNoOptionalNo
Constrained runtimesLimitedLimitedStronger fit

When to Use

Use @git-diff-view/shiki when you need:

  • VSCode-quality syntax highlighting
  • Accurate language grammar
  • VSCode-compatible themes
  • Better color fidelity

Use @git-diff-view/lowlight (default) when:

  • You want zero configuration
  • Bundle size is critical
  • Synchronous initialization is preferred
  • Basic highlighting is sufficient

Use @git-diff-view/lezer when:

  • You need pure JS parsers (no WASM / Node)
  • Targeting constrained runtimes such as Lynx
  • CodeMirror-quality LR grammars are enough

License

MIT © MrWangJustToDo

版本与发布记录

@git-diff-view/shiki 共发布 41 个版本,首次发布于 2024/03/22;过去 12 个月发布了 14 个版本。

版本发布日期距今
0.1.8latest2026/10/151 个月前
0.1.72026/07/134 个月前
0.1.62026/06/214 个月前
0.1.52026/05/265 个月前
0.1.42026/05/185 个月前
0.1.32026/03/207 个月前

关于 @git-diff-view/shiki 的常见问题

@git-diff-view/shiki 是什么?

@git-diff-view/shiki

如何安装 @git-diff-view/shiki?

在项目目录运行 npm install @git-diff-view/shiki,或使用 pnpm add / yarn add / bun add。

@git-diff-view/shiki 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@git-diff-view/shiki 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@git-diff-view/shiki 可以商用吗?

@git-diff-view/shiki 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@git-diff-view/shiki 的下载量有多少?

根据 npm 官方下载统计,@git-diff-view/shiki 在 2026/10/17 – 2026/11/15 这 30 天内被下载 112,249 次,日均约 3,742 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@git-diff-view/shiki 还在维护吗?

最新版本 0.1.8 发布于 2026/10/15(1 个月前);至今共发布 41 个版本,其中过去 12 个月发布了 14 个;首次发布于 2024/03/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。