@gitbutler/svelte-comment-injector

中文文档
1.0.1发布于 2026/03/13MITTypeScriptES Module零依赖近 30 天下载 1.2万

A Svelte preprocessor that injects HTML comments for identifying components in browser DevTools.

原始使用文档
文档目录4 节
  1. ✨ Features
  2. 📦 Installation
  3. ⚙️ Usage
  4. 🛠️ Configuration

svelte-comment-injector

A Svelte preprocessor that injects an HTML comment at the top of every component, making it easier to identify components in browser DevTools.

✨ Features

  • Injects a DevTools-visible HTML comment like:
    <!-- Begin MyComponent.svelte -->
    <div class="my-component">
      <!-- Component content -->
    </div>
    <!-- End MyComponent.svelte -->
    

📦 Installation

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

⚙️ Usage

Add the preprocessor to your Svelte configuration:

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

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

🛠️ Configuration

You can customize the comment format by passing options to the preprocessor:

// 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 共发布 2 个版本,首次发布于 2025/05/30;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.1latest2026/03/138 个月前
1.0.02025/05/301.5 年前

关于 @gitbutler/svelte-comment-injector 的常见问题

@gitbutler/svelte-comment-injector 是什么?

A Svelte preprocessor that injects HTML comments for identifying components in browser DevTools.

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