关于 configure-editor
configure-editor 用于检查和配置团队共享的编辑器设置。它会检测项目语言和工具、生成合规报告,并可创建或更新编辑器及 VS Code 配置文件。
主要功能
- 01检测项目语言和工具
- 02检查 EditorConfig 与 VS Code 设置
- 03生成配置合规报告
- 04配置保存时格式化和扩展
- 05创建调试与任务配置
- 06编写团队编辑器设置文档
适用场景
- 01统一团队的编辑器设置
- 02只检查工作区配置而不修改
- 03配置格式化工具和推荐扩展
- 04添加项目调试与任务文件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ laurigates/ claude-plugins --skill configure-editor安装后在 Claude Code 中输入/configure-editor确认已加载。
附带文件REFERENCE.md
详细介绍
/configure:editor
检查并配置编辑器设置,确保团队内保持一致。
何时使用此技能
| 在以下情况下使用此技能…… | 在以下情况下使用其他方法…… |
|---|---|
| 为团队设置统一的编辑器配置 | 仅设置个人编辑器偏好(在用户设置中配置) |
| 检查 EditorConfig 或 VS Code 工作区是否合规 | 只查看现有 .editorconfig(使用 Read 工具) |
| 为检测到的语言配置保存时格式化 | 项目不使用 VS Code(手动为其他编辑器配置) |
| 为项目工具添加推荐的 VS Code 扩展 | 扩展已正确配置 |
| 设置调试配置和任务 | 无需调试的简单项目 |
上下文
- EditorConfig:!
find . -maxdepth 1 -name \'.editorconfig\' - VS Code 设置:!
find . -maxdepth 1 -name \'.vscode/settings.json\' - VS Code 扩展:!
find . -maxdepth 1 -name \'.vscode/extensions.json\' - VS Code 启动配置:!
find . -maxdepth 1 -name \'.vscode/launch.json\' - VS Code 任务:!
find . -maxdepth 1 -name \'.vscode/tasks.json\' - 项目语言:!
find . -maxdepth 1 \( -name 'package.json' -o -name 'tsconfig.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' -o -name 'biome.json' \) - 项目规范:!
find . -maxdepth 1 -name \'.project-standards.yaml\'
参数
从 $ARGUMENTS 解析:
--check-only:报告合规状态,不做任何修改--fix:无需提示,自动应用所有修复
执行
执行此编辑器配置工作流:
步骤 1:检测项目语言和工具
检查语言标识:
| 标识 | 语言/工具 | 所需配置 |
|---|---|---|
package.json | JavaScript/TypeScript | Biome |
tsconfig.json | TypeScript | TypeScript 扩展 |
pyproject.toml | Python | Ruff、Python 扩展 |
Cargo.toml | Rust | rust-analyzer |
biome.json | Biome 格式化工具/代码检查工具 | Biome 扩展 |
步骤 2:分析当前编辑器配置
根据以下要求检查现有配置:
EditorConfig:
- 验证
.editorconfig是否存在 - 检查 root 指令、字符集、行尾格式、文件末尾换行和空白修剪
- 检查特定语言的配置段是否与检测到的语言相符
VS Code 设置:
- 验证
.vscode/settings.json是否存在 - 检查保存时格式化、各语言的默认格式化工具和特定语言的设置
VS Code 扩展:
- 验证
.vscode/extensions.json是否存在 - 检查推荐扩展是否与项目工具相符
步骤 3:生成合规报告
打印格式化的合规报告,显示每项检查的状态:
Editor Configuration Compliance Report
=======================================
Project: [name]
Languages: [detected]
Detected Tools: [detected]
EditorConfig: [status per check]
VS Code Settings: [status per check]
VS Code Extensions: [status per check]
Overall: [X issues found]
Recommendations: [list specific fixes]
如果指定了 --check-only,则在此处停止。
步骤 4:配置编辑器文件(如果指定了 --fix 或用户确认)
根据检测到的语言应用修复。使用 REFERENCE.md 中的配置。
- 创建或更新
.editorconfig,添加特定语言的配置段 - 创建或更新
.vscode/settings.json,配置保存时格式化和各语言的格式化工具 - 创建或更新
.vscode/extensions.json,添加检测到的工具所需的推荐扩展 - 添加特定语言的设置(TypeScript 导入偏好、Python 解释器、Rust clippy)
步骤 5:创建启动和任务配置
- 创建
.vscode/launch.json,添加检测到的语言对应的调试配置 - 创建
.vscode/tasks.json,添加构建/测试/代码检查任务
步骤 6:更新规范跟踪
更新 .project-standards.yaml:
components:
editor: "2025.1"
editor_config: true
vscode_settings: true
vscode_extensions: true
步骤 7:创建文档
创建 docs/EDITOR_SETUP.md,为团队编写快速入门说明,涵盖 VS Code 设置、推荐扩展和故障排除。
第 8 步:打印完成报告
打印所有更改的摘要,包括创建/更新的文件、建议的扩展,以及团队的后续步骤。
如需查看详细的配置模板和特定语言的设置,请参阅 REFERENCE.md。
Agentic 优化
| 上下文 | 命令 |
|---|---|
| 检查是否存在 EditorConfig | test -f .editorconfig && echo "exists" || echo "missing" |
| 验证 EditorConfig 语法 | editorconfig-checker .editorconfig 2>&1(如果已安装) |
| 检查是否存在 VS Code 设置 | test -f .vscode/settings.json && jq empty .vscode/settings.json 2>&1 |
| 列出检测到的语言 | find . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' \) -exec basename {} \; |
| 快速合规性检查 | /configure:editor --check-only |
| 自动修复所有问题 | /configure:editor --fix |
标志
| 标志 | 说明 |
|---|---|
--check-only | 报告状态,不提供修复建议 |
--fix | 无需提示,自动应用所有修复 |
示例
# Check compliance and offer fixes
/configure:editor
# Check only, no modifications
/configure:editor --check-only
# Auto-fix all issues
/configure:editor --fix
错误处理
- 未检测到语言:创建最小化的 EditorConfig
- 格式化工具冲突:警告存在重复的格式化工具配置
- 无效 JSON:报告解析错误,并提供替换为模板的选项
另请参阅
/configure:formatting- 配置代码格式化/configure:linting- 配置 linting 工具/configure:all- 运行所有合规性检查- EditorConfig 文档:https://editorconfig.org
- VS Code 设置参考:https://code.visualstudio.com/docs/getstarted/settings
评论
支持 Markdown