@haklex/rich-ext-code-snippet

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module构建来源已验证近 30 天下载 1.3万

Multi-file code snippet extension

原始使用文档
文档目录16 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Register nodes in your editor config
  5. Use renderers
  6. Markdown transformer
  7. Tree-shake the default renderer
  8. Import styles
  9. Exports
  10. Nodes
  11. Renderers
  12. Slot Key
  13. Transformers
  14. Sub-path Exports
  15. Part of Haklex
  16. License

@haklex/rich-ext-code-snippet

Multi-file tabbed code snippet extension with drag-and-drop reordering.

Installation

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

Peer Dependencies

PackageVersion
lexical^0.45.0
react>= 19

Key runtime dependencies include @codemirror/* (editor engine), @dnd-kit/* (drag-and-drop), and shiki (syntax highlighting).

Usage

Register nodes in your editor config

Edit (read + write):

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

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

Static / read-only:

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

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

Use renderers

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

Markdown transformer

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

const transformers = [CODE_SNIPPET_BLOCK_TRANSFORMER];

Tree-shake the default renderer

The default CodeSnippetRenderer is not statically imported by CodeSnippetNode. Register a custom renderer through RendererConfig to drop the heavy default chunk:

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's codeSnippetModule lazy-loads the default renderer via lazyRenderers; the override pattern above bypasses it entirely.

Import styles

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

Exports

Nodes

  • CodeSnippetNode -- static (read-only) node
  • CodeSnippetEditNode -- edit node with interactive UI
  • $createCodeSnippetNode() / $isCodeSnippetNode() -- Lexical helpers
  • codeSnippetNodes -- array of static nodes for config registration
  • codeSnippetEditNodes -- array of edit nodes for config registration

Renderers

  • CodeSnippetRenderer -- static renderer (no heavy UI deps)
  • CodeSnippetEditRenderer -- edit renderer with CodeMirror, drag-and-drop tabs

Slot Key

  • CODE_SNIPPET_NODE_KEY -- 'CodeSnippet' constant for RendererConfig slot lookup

Transformers

  • CODE_SNIPPET_BLOCK_TRANSFORMER -- Markdown block transformer

Sub-path Exports

PathDescription
@haklex/rich-ext-code-snippetFull exports (node + renderer + edit)
@haklex/rich-ext-code-snippet/nodeLightweight node + slot key + types — no default renderer
@haklex/rich-ext-code-snippet/rendererDefault CodeSnippetRenderer (heavy)
@haklex/rich-ext-code-snippet/editEdit-mode node + CodeSnippetEditRenderer
@haklex/rich-ext-code-snippet/staticConvenience: node + renderer (SSR bundle)
@haklex/rich-ext-code-snippet/style.cssStylesheet

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-ext-code-snippet 共发布 236 个版本,首次发布于 2026/02/20;过去 12 个月发布了 236 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-ext-code-snippet 的常见问题

@haklex/rich-ext-code-snippet 是什么?

Multi-file code snippet extension

如何安装 @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 和提交记录判断。