# @carbon-labs/vscode-snippets 中文文档

规范地址：https://npmcn.com/package/%40carbon-labs/vscode-snippets/

版本：0\.5\.0
npm 元数据更新时间：2026-08-21T15:34:49.315Z
中文译文更新时间：2026-11-09T07:28:51.461Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40carbon-labs/vscode-snippets
原文对照：https://npmcn.com/package/%40carbon-labs/vscode-snippets/?lang=original
项目主页：https://github.com/carbon-design-system/carbon-labs#readme
源码仓库：https://github.com/carbon-design-system/carbon-labs

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

- 包体积（解压后）：61.2 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-01-14T17:03:05.115Z
- 最新版本发布：2026-05-14T00:42:49.543Z
- 近 30 天下载量：4189（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

碳实验室 -- -- 碳设计系统的VSCode片段

## 安装

```sh
npm install @carbon-labs/vscode-snippets
```

也可以使用：`pnpm add @carbon-labs/vscode-snippets`、`yarn add @carbon-labs/vscode-snippets`、`bun add @carbon-labs/vscode-snippets`

## README

# @ 碳- labs/ vscode- 片段

> VSCode 碳设计系统的片断 SCSS

这个包提供了碳设计系统SCSS开发的代码片段, 兼容 VSCode,IBM Bob,以及其他基于 VSCode 的 IDEs.

## 安装

```bash
npm install @carbon-labs/vscode-snippets
```

或者说

```bash
yarn add @carbon-labs/vscode-snippets
```

软件包将自动向您的工程安装片段文件 `.vscode` 文件夹通过安装后脚本.

### 查看安装输出

要查看安装输出, 请使用 `--foreground-scripts` 旗帜 :

```bash
npm install @carbon-labs/vscode-snippets --foreground-scripts
```

## 片段文件

软件包安装了以下有组织的片段文件:

-   **碳一般.代码片段** - 组合类BEM模式和@use进口
-   **碳-linter-disables.code-spippets 碳-linter-disables.code-spippets 碳-l-disables 碳-l-disables.code-spippets** - 斯泰林特禁用注释
-   **碳相间距. code- sippets** - 间距标志 (相距01至) 间隔-13美元
-   **碳-打字法.代码-片段** - 类型样式 (@ 包括类型样式)
-   **碳-运动.代码-片段** - 期限标志和运动搅拌器
-   **碳主题.代码片段** - 与主题有关的片段

## 使用量

安装后, 您的 SCSS 文件中立即提供片段 . 只要开始输入片段前缀, IDE 将建议完成 .

### 示例片断

-   类型 `block-class` 生成 BEM 块类结构
-   类型 `@use spacing` 用于导入碳间距公用设备
-   类型 `$spacing-05` 以插入间隔为 0 5 个符号
-   类型 `type` 进入打字风格混音器

## 如何运作

1.  安装后, 软件包会自动运行安装后脚本
2.  脚本复制所有从软件包到您的项目的片段文件 `.vscode/` 文件夹
3.  VSCode 和相容的 IDEs 自动加载全部 `.code-snippets` 来自 `.vscode/`
4.  在您的 SCSS 文件中可以立即获取片段

## 兼容性

这个软件包与 :

-   **视觉工作室代码** - 微软官方IDE
-   **IBM 鲍勃** - IBM的基于VSCode的 IDE
-   **V** - 开源的VSCode建造
-   **光标** - AI-动力VSCode的IDE
-   支持基于 VSCode 的任何其他 IDE `.code-snippets` 文件

## 页:1

-   在工作空间一级安装片段(`.vscode/` 文件夹)
-   重运行的软件包安装将覆盖本地修改 片断文件
-   这个 `.vscode/` 如果文件夹不存在, 将自动创建文件夹
-   已存在的碳片断文件( 来自以前的版本) 自动 安装前删除

## 发展

### 运行测试

该包包括对安装逻辑的全面测试:

```bash
cd packages/vscode-snippets
yarn test
```

测试覆盖 :

-   删除旧片段文件( 包括新旧软件包名称格式)
-   复制片段文件到 `.vscode` 目录
-   文件系统操作处理出错
-   整个安装流程的综合测试

所有测试都使用被模拟的文件系统操作,并使用节点实验VM运行 用于支持ES模块的模块.

### 测试范围

-   涵盖所有安装情况的12个测试
-   在 CI 中自动运行每个 PR 并合并的测试
-   ES模块支持的游戏

## 许可证

阿帕奇 - 2.0

## 捐款

此软件包是 [碳实验室](https://github.com/carbon-design-system/carbon-labs) 单相机.

## 常见问题

### @carbon-labs/vscode-snippets 是什么？

碳实验室 -- -- 碳设计系统的VSCode片段

### 如何安装 @carbon-labs/vscode-snippets？

在项目目录运行 npm install @carbon-labs/vscode-snippets，或使用 pnpm add / yarn add / bun add。

### @carbon-labs/vscode-snippets 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/carbon-labs\_\_vscode-snippets 是否存在。

### @carbon-labs/vscode-snippets 支持 ESM 还是 CommonJS？

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

### @carbon-labs/vscode-snippets 可以商用吗？

@carbon-labs/vscode-snippets 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @carbon-labs/vscode-snippets 的下载量有多少？

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

### @carbon-labs/vscode-snippets 还在维护吗？

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

