Code Format Skill 是一个面向多语言代码格式化与语法校验的 AI 技能,用于按标准工具或内置格式化器整理代码,并验证语法是否有效。
用途 该技能适用于以下请求:
- “Format this Python code”(格式化这段 Python 代码)
- “Validate this JSON”(校验这段 JSON)
- “Pretty print this JavaScript”(美化这段 JavaScript)
- “Format this Markdown”(格式化这段 Markdown)
不适用场景
- Linting 代码 → 直接使用 linter
- 编译代码 → 使用编译器
- 压缩代码 → 使用压缩工具
支持语言与格式化器
- Python:black、autopep8,回退到 auto-format
- JavaScript:prettier(若已安装)
- TypeScript:prettier(若已安装)
- JSON:python(内置)
- YAML:pyyaml(若已安装)
- Markdown:prettier(若已安装)
- HTML:prettier(若已安装)
- CSS:prettier(若已安装)
- SQL:sqlparse(若已安装)
- Shell:shfmt(若已安装)
命令 格式化代码: {baseDir}/format-code.sh <file> {baseDir}/format-code.sh <file> --language python {baseDir}/format-code.sh --stdin --language js < code.js
校验语法: {baseDir}/validate-code.sh <file> {baseDir}/validate-code.sh <file> --language python {baseDir}/validate-code.sh --stdin --language json < data.json
列出支持语言: {baseDir}/format-code.sh --languages
选项
- --language <lang>:指定语言(默认从扩展名自动检测)
- --stdin:从标准输入读取
- --out <file>:写入文件(默认输出到 stdout)
- --check:检查是否需要格式化(不修改内容)
- --diff:显示差异而非格式化后的输出
- --indent <n>:缩进大小(默认因语言而异)
示例 格式化 Python 文件: {baseDir}/format-code.py script.py
从 stdin 格式化 JSON: cat data.json | {baseDir}/format-code.sh --stdin --language json
检查是否需要格式化: {baseDir}/format-code.sh script.py --check
若已格式化退出 0,若需要格式化退出 1
使用自定义缩进格式化: {baseDir}/format-code.sh config.json --indent 4
校验代码: {baseDir}/validate-code.sh script.py
输出:✓ Valid Python syntax
说明
- 在可用时使用标准格式化工具
- 可回退到内置格式化器
- 默认不修改文件
- 使用 --out 可保存到相同或不同文件