# @haklex/rich-ext-code-snippet 中文文档

规范地址：https://npmcn.com/package/%40haklex/rich-ext-code-snippet/

版本：0\.66\.0
npm 元数据更新时间：2026-11-15T13:30:36.546Z
中文译文更新时间：2026-11-17T06:32:02.150Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40haklex/rich-ext-code-snippet
原文对照：https://npmcn.com/package/%40haklex/rich-ext-code-snippet/?lang=original
项目主页：https://github.com/Innei/haklex#readme
源码仓库：https://github.com/Innei/haklex

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：116 kB，47 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：react \>=19，lexical ^0\.53\.0，lucide-react ^1\.0\.0，@lexical/react ^0\.53\.0，@haklex/rich-editor ^0\.66\.0，@haklex/rich-editor-ui ^0\.66\.0，@haklex/rich-style-token ^0\.66\.0
- 首次发布：2026-02-20T10:08:20.364Z
- 最新版本发布：2026-11-15T13:30:36.198Z
- 近 30 天下载量：13423（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：236（近 12 个月 236 个）

## 中文简介

多文件代码片段扩展名

## 安装

```sh
npm install @haklex/rich-ext-code-snippet
```

也可以使用：`pnpm add @haklex/rich-ext-code-snippet`、`yarn add @haklex/rich-ext-code-snippet`、`bun add @haklex/rich-ext-code-snippet`

## README

# @haklex/rich-ext-code- spipet

多文件制表符代码以拖放重排为扩展名.

## 安装

```bash
pnpm add @haklex/rich-ext-code-snippet
```

## 同伴依赖关系

| 软件包 | 版本 |
| --- | --- |
| `lexical` | `^0.45.0` |
| `react` | `>= 19` |

关键运行时间依赖关系包括: `@codemirror/*` (编辑引擎), `@dnd-kit/*` (一滴一滴),和 `shiki` (语法突出).

## 使用量

### 在编辑器配置中注册节点

编辑( 读 + 写) :

```ts
import { codeSnippetEditNodes } from '@haklex/rich-ext-code-snippet/edit';

const editorConfig = { nodes: [...codeSnippetEditNodes] };
```

静态/ 只读 :

```ts
import { codeSnippetNodes } from '@haklex/rich-ext-code-snippet/node';

const staticConfig = { nodes: [...codeSnippetNodes] };
```

### 使用渲染器

```tsx
import { CodeSnippetEditRenderer } from '@haklex/rich-ext-code-snippet/edit';
import { CodeSnippetRenderer } from '@haklex/rich-ext-code-snippet/renderer';
```

### 标记倒置变压器

```ts
import { CODE_SNIPPET_BLOCK_TRANSFORMER } from '@haklex/rich-ext-code-snippet/node';

const transformers = [CODE_SNIPPET_BLOCK_TRANSFORMER];
```

### 显示默认渲染器

默认 `CodeSnippetRenderer` 实值 **没有** 静态导入 `CodeSnippetNode`通过 `RendererConfig` 以删除重的默认块 :

```ts
import { CODE_SNIPPET_NODE_KEY, codeSnippetNodes } from '@haklex/rich-ext-code-snippet/node';
import type { RichRendererModule } from '@haklex/rich-compose';

const lightModule: RichRendererModule = {
  name: 'code-snippet',
  nodes: codeSnippetNodes,
  renderers: { [CODE_SNIPPET_NODE_KEY]: MyLightCodeSnippet },
};
```

`@haklex/rich-compose`是因为 `codeSnippetModule` 懒惰地通过默认渲染器装入 `lazyRenderers`;上面的覆盖模式完全绕过它.

### 导入样式

```ts
import '@haklex/rich-ext-code-snippet/style.css';
```

## 出口

### 节点

-   `CodeSnippetNode` -- 静态( 只读) 节点
-   `CodeSnippetEditNode` -- 使用交互式 UI 编辑节点
-   `$createCodeSnippetNode()` 编号 : `$isCodeSnippetNode()` - 语言辅助人员
-   `codeSnippetNodes` -- 用于配置注册的静态节点阵列
-   `codeSnippetEditNodes` -- 用于配置注册的编辑节点数组

### 渲染器

-   `CodeSnippetRenderer` -- 静态渲染器(无重UI道口)
-   `CodeSnippetEditRenderer` -- 用 CodeMiror 编辑渲染器, 拖放标签

### 槽密钥

-   `CODE_SNIPPET_NODE_KEY` - 说吧 `'CodeSnippet'` 常数 `RendererConfig` 搜索档

### 变形器

-   `CODE_SNIPPET_BLOCK_TRANSFORMER` - Markdown块变压器

## 子路径导出

| 路径 | 说明 |
| --- | --- |
| `@haklex/rich-ext-code-snippet` | 完全导出( 节点 + 渲染器 + 编辑) |
| `@haklex/rich-ext-code-snippet/node` | 轻量级节点+槽键+类型 — 无默认渲染器 |
| `@haklex/rich-ext-code-snippet/renderer` | 默认 `CodeSnippetRenderer` (重声) |
| `@haklex/rich-ext-code-snippet/edit` | 编辑-模式节点+ `CodeSnippetEditRenderer` |
| `@haklex/rich-ext-code-snippet/static` | 方便:节点+渲染器(SSR捆绑) |
| `@haklex/rich-ext-code-snippet/style.css` | 样式表 |

## 哈克历克的一部分

此软件包是 [哈克历](https://npmcn.com/package/README.md) 丰富的编辑生态系统.

## 许可证

麻省理工学院

## 常见问题

### @haklex/rich-ext-code-snippet 是什么？

多文件代码片段扩展名

### 如何安装 @haklex/rich-ext-code-snippet？

在项目目录运行 npm install @haklex/rich-ext-code-snippet，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19）、lexical（^0\.53\.0）、lucide-react（^1\.0\.0）、@lexical/react（^0\.53\.0）、@haklex/rich-editor（^0\.66\.0）、@haklex/rich-editor-ui（^0\.66\.0）、@haklex/rich-style-token（^0\.66\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haklex/rich-ext-code-snippet 支持 TypeScript 吗？

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

### @haklex/rich-ext-code-snippet 支持 ESM 还是 CommonJS？

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

### @haklex/rich-ext-code-snippet 可以商用吗？

@haklex/rich-ext-code-snippet 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @haklex/rich-ext-code-snippet 的下载量有多少？

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

### @haklex/rich-ext-code-snippet 还在维护吗？

最新版本 0\.66\.0 发布于 2026/11/15（1 天前）；至今共发布 236 个版本，其中过去 12 个月发布了 236 个；首次发布于 2026/02/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

