# code-snippet-assistant

**Repository Path**: github-9819409/code-snippet-assistant

## Basic Information

- **Project Name**: code-snippet-assistant
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-12
- **Last Updated**: 2025-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 代码段助手

一个面向 VS Code 的轻量代码片段管理与快速插入工具。在侧边栏集中管理代码段，支持搜索、复制/插入/编辑/删除、快捷字母、导入/导出、同步到 VS Code 代码片段、输出到终端与执行。

## 主要功能
- 侧边栏列表管理：搜索、复制、插入、编辑、删除
- 右键菜单：同步到 VS Code 代码片段、输出到终端、输出到终端并运行
- 代码段详情：名称、描述、快捷字母、代码编辑；底部“温馨小提示”提供片段语法速查
- 快速插入：按快捷字母或名称搜索并插入到光标位置
- 导入/导出：以 JSON 批量导入或导出代码段
- 同步到 VS Code 代码片段：生成 `.code-snippets` 文件用于原生建议

## 使用指南
- 打开视图：活动栏选择“代码段助手”
- 新建：视图标题“新建”或列表底部按钮，进入详情页填写并保存
- 编辑：在列表项点击“编辑”或右键进入详情页
- 搜索：底部搜索框输入关键词（名称/描述/快捷字母）
- 插入：列表项“插入”按钮将代码插入当前编辑器选择处
- 复制：列表项“复制”按钮复制到剪贴板
- 从选区添加：在编辑器中选中内容，右键选择“添加到代码段助手”
- 同步到 VS Code 代码片段：视图标题“同步到 VS Code 代码片段”，或在列表项右键菜单触发
- 终端输出：在列表项右键选择“输出到终端”或“输出到终端并运行”（使用名为“代码段助手”的终端）

## 片段语法速查
- 插入光标：`$0`
- 占位序号并 Tab 跳转：`$1`、`$2` …
- 占位默认值：`${1:默认值}`
- 下拉选择：`${1|A,B,C|}`
- 常用变量：`${TM_FILENAME}`、`${CLIPBOARD}`
- 转义：反斜杠，例如 `\$`、`\}`

示例：
```
function ${1:name}(${2:args}) {
	$0
}
const ${3|apple,banana,orange|} = '${3}';
```

## 数据存储位置
- 代码段文件：`${workspaceRoot}/.code-snippet-assistant/*.json`
- VS Code 片段同步文件：`${workspaceRoot}/.vscode/code-snippet-assistant.code-snippets`

## 内置命令
- `codeSnippetAssistant.addSelection`：将编辑器选区添加为代码段
- `codeSnippetAssistant.openDetails`：打开代码段详情页
- `codeSnippetAssistant.copy`：复制代码段到剪贴板
- `codeSnippetAssistant.insert`：将代码段插入到编辑器
- `codeSnippetAssistant.create`：新建代码段
- `codeSnippetAssistant.delete`：删除代码段
- `codeSnippetAssistant.edit`：编辑代码段
- `codeSnippetAssistant.quickInsert`：根据快捷字母或名称快速插入
- `codeSnippetAssistant.export`：导出为 JSON
- `codeSnippetAssistant.import`：从 JSON 导入
- `codeSnippetAssistant.exportVsCodeSnippets`：同步到 VS Code 代码片段

## 开发与构建
- 安装依赖：`npm install`
- 编译：`npm run compile`
- 监听编译：`npm run watch`
- 调试：在 VS Code 中按 `F5` 以“运行扩展”启动测试环境