# @gitbutler/svelte-comment-injector 中文文档

规范地址：https://npmcn.com/package/%40gitbutler/svelte-comment-injector/

版本：1\.0\.1
npm 元数据更新时间：2026-03-12T23:10:21.978Z
中文译文更新时间：2026-11-16T10:33:06.437Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gitbutler/svelte-comment-injector
原文对照：https://npmcn.com/package/%40gitbutler/svelte-comment-injector/?lang=original
项目主页：https://github.com/gitbutlerapp/gitbutler/tree/master/packages/svelte-comment-injector
源码仓库：https://github.com/gitbutlerapp/gitbutler

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

- 包体积（解压后）：4.2 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-05-30T13:25:21.625Z
- 最新版本发布：2026-03-12T23:10:21.841Z
- 近 30 天下载量：12130（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 1 个）

## 中文简介

一个Svelte预处理器,用于在浏览器 DevTools 中为识别组件而注入 HTML 注释.

## 安装

```sh
npm install @gitbutler/svelte-comment-injector
```

也可以使用：`pnpm add @gitbutler/svelte-comment-injector`、`yarn add @gitbutler/svelte-comment-injector`、`bun add @gitbutler/svelte-comment-injector`

## README

# 丝绒-评论-注射器

一个斯维尔特预处理器,它在每个组件的顶端注入一个HTML注释,使得在浏览器DevTools中更容易识别组件.

## \* 特性

-   注入 DevTools 可见的 HTML 注释, 如 :
    
    ```html
    <!-- Begin MyComponent.svelte -->
    <div class="my-component">
      <!-- Component content -->
    </div>
    <!-- End MyComponent.svelte -->
    ```
    

## \* 安装

```bash
npm install @gitbutler/svelte-comment-injector --save-dev
```

## 使用量

在您的 Svelte 配置中添加预处理器 :

```js
// svelte.config.js
import svelteInjectComment from "@gitbutler/svelte-comment-injector";

export default {
    preprocess: [svelteInjectComment()],
    // ...rest of your config
};
```

## QQ 配置

您可以通过将选项传递到预处理器来自定义注释格式 :

```js
// svelte.config.js
import svelteInjectComment from "@gitbutler/svelte-comment-injector";

export default {
    preprocess: [
        svelteInjectComment({
            enabled: true, // Enable or disable the comment injection
            showEndComment: true, // Show the end comment
            showFullPath: false, // Show the full path in the comment
        }),
    ],
    // ...rest of your config
};
```

## 常见问题

### @gitbutler/svelte-comment-injector 是什么？

一个Svelte预处理器,用于在浏览器 DevTools 中为识别组件而注入 HTML 注释\.

### 如何安装 @gitbutler/svelte-comment-injector？

在项目目录运行 npm install @gitbutler/svelte-comment-injector，或使用 pnpm add / yarn add / bun add。

### @gitbutler/svelte-comment-injector 支持 TypeScript 吗？

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

### @gitbutler/svelte-comment-injector 支持 ESM 还是 CommonJS？

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

### @gitbutler/svelte-comment-injector 可以商用吗？

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

### @gitbutler/svelte-comment-injector 的下载量有多少？

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

### @gitbutler/svelte-comment-injector 还在维护吗？

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

