SuperAPI AI 工具集

bash-style

编程与开发

查看项目

更新于 10-15 21:11

技能介绍

用途:在编辑 Shell 脚本(.sh)、Markdown 中的 bash 代码块,以及 Dockerfile、Makefile、.yml/.yaml 中的 shell 命令时触发,统一 Bash 编写风格。

主要能力与规范:

  1. 注释:禁止行尾注释,注释独占一行放在代码上方,避免复制粘贴带上注释、超长行及 Heredoc 内 # 被误解。
  2. 文件写入:推荐 sudo tee ... > /dev/null << 'EOF',追加用 tee -a 或单行 echo ... | tee -a;避免嵌套引号复杂的 sudo bash -c 'cat >' 与需转义的 sudo sh -c。
  3. Heredoc 引号:配置文件用 << 'EOF' 防止变量展开,模板生成用 << EOF 以插入变量,不确定时用 'EOF' 更安全。
  4. 权限与路径:需 root 时用 tee 配合 sudo,而非 sudo echo >(重定向在 sudo 外);路径带空格用双引号包裹。
  5. 脚本规范:文件头使用 #!/usr/bin/env bash 与 set -euo pipefail;变量用 ${} 包裹,支持 ${DB_HOST:-localhost} 默认值,避免裸变量。
  6. 常用模式:command -v 检查命令、[[ -f/-d ]] 检查文件目录、安全删除用 rm -rf "${dir:?}"/*。
  7. Markdown 文档中的 bash 代码块遵循同样规范。

限制:资料未提供该技能的安装命令、收费、平台支持与执行效果等信息;参考资料为 Google Shell Style Guide、Bash Pitfalls、ShellCheck。