@diglot/code

中文文档
0.2.2发布于 2026/11/08MITTypeScriptES Module构建来源已验证近 30 天下载 3817

Code-block comment extraction for diglot

原始使用文档

@diglot/code

Code-block comment extraction for diglot. Finds the prose comments of a code block with a per-language tokenizer, turns each comment line into a code-comment segment, and replaces only the comment text when applying a translation.

pnpm add @diglot/code @diglot/core

Usage

import { applyCode, extractCode } from '@diglot/code'

const { segments } = extractCode(code, 'ts')
const { code: translated, report } = applyCode(code, 'ts', translations)

For adapters:

  • findComments(code, language) returns { line, start, end, text } for each prose comment line, where [start, end) are offsets of the text in the code
  • commentDraft(comment, language, context) converts a comment to a segment draft; inline code and URLs become placeholders
  • replaceComments(code, replacements) substitutes comment texts

Supported languages: JavaScript and TypeScript (js, ts, jsx, tsx, mjs, cjs), Vue and HTML (including <script> and <style> blocks), CSS, SCSS and Less, shell (bash, sh, zsh), dotenv and ini, YAML, TOML, JSON5 and JSONC.

Not extracted: twoslash directives (// ^?, // @errors, // ---cut---), Shiki notations (// [!code ++]), tool pragmas (eslint-disable, @ts-expect-error, #region), commented-out code, and comments with fewer than two words.

版本与发布记录

@diglot/code 共发布 10 个版本,首次发布于 2026/11/03;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.2latest2026/11/083 天前
0.2.12026/11/066 天前
0.2.02026/11/057 天前
0.1.42026/11/048 天前
0.1.32026/11/038 天前
0.1.22026/11/039 天前

关于 @diglot/code 的常见问题

@diglot/code 是什么?

Code-block comment extraction for diglot

如何安装 @diglot/code?

在项目目录运行 npm install @diglot/code,或使用 pnpm add / yarn add / bun add。

@diglot/code 支持 TypeScript 吗?

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

@diglot/code 支持 ESM 还是 CommonJS?

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

@diglot/code 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@diglot/code 可以商用吗?

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

@diglot/code 的下载量有多少?

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

@diglot/code 还在维护吗?

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