Agent skill

bash-style

Bash 编写规范。当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件, 或在 Markdown 中编写 bash/shell 代码块时触发。 包含注释规范、文件写入方式、Heredoc 引号规则、权限路径、脚本规范等。

Stars 424
Forks 44

Install this agent skill to your Project

npx add-skill https://github.com/doccker/cc-use-exp/tree/main/.cursor/skills/bash-style

SKILL.md

Bash 编写规范


1. 注释规范

禁止行尾注释

  • 禁止行尾注释(如 command # 注释
  • ✅ 注释应独占一行,放在代码上方
bash
# ❌ 错误:行尾注释
curl -X POST https://api.example.com/data # 发送请求

# ✅ 正确:注释独占一行
# 发送请求
curl -X POST https://api.example.com/data

2. 文件写入方式

推荐方式:tee 命令

bash
# ✅ 推荐:简洁、无嵌套引号
sudo tee /etc/myapp/config.yml > /dev/null << 'EOF'
server:
  port: 8080
EOF

方式对比

方式 优点 缺点 推荐场景
sudo tee 简洁、无嵌套 > /dev/null 抑制输出 首选
sudo bash -c 'cat >' 无需 tee 嵌套引号复杂 不推荐

3. Heredoc 引号规则

场景 用法 原因
配置文件 << 'EOF' 避免意外展开
模板生成 << EOF 需要插入变量
不确定时 << 'EOF' 更安全

4. 权限与路径

bash
# ✅ 正确:tee 配合 sudo
echo 'content' | sudo tee /etc/xxx

# ❌ 错误:重定向在 sudo 之外,权限不足
sudo echo 'content' > /etc/xxx

5. 脚本规范

文件头

bash
#!/usr/bin/env bash
set -euo pipefail

set 选项说明

选项 作用
-e 命令失败时退出
-u 使用未定义变量时报错
-o pipefail 管道中任一命令失败则整体失败

变量使用

bash
# ✅ 推荐:使用 ${} 包裹
echo "Hello, ${name}"
db_host="${DB_HOST:-localhost}"

# ❌ 避免:裸变量
echo "Hello, $name_suffix"

6. 常用模式

bash
# 检查命令是否存在
if ! command -v docker &> /dev/null; then
    echo "docker 未安装"
    exit 1
fi

# 安全删除
rm -rf "${dir:?}"/*

Expand your agent's capabilities with these related and highly-rated skills.

doccker/cc-use-exp

ops-safety

运维安全规范。当用户执行系统级命令(sysctl、iptables、systemctl、Docker 配置、数据库 DDL) 或进行服务器运维操作时触发。 包含命令风险说明模板、回滚方案要求、问题排查原则、Docker/Cloudflare/数据库场景规则等。

424 44
Explore
doccker/cc-use-exp

ruanzhu

当用户执行 /ruanzhu 命令或请求生成软著源代码文档时触发。提供软著源代码 DOCX 生成规范。 覆盖项目信息检测、语言扫描规则、页数控制、DOCX 格式规范等。

424 44
Explore
doccker/cc-use-exp

ui-ux-pro-max

专业级 UI/UX 设计规范,需要高质量界面设计时手动触发或描述"设计感/专业UI"时自动触发。 覆盖视觉层次、配色体系、排版节奏、交互微动效、响应式适配等。 日常前端开发由 frontend-dev skill 覆盖。

424 44
Explore
doccker/cc-use-exp

redis-safety

Redis 安全与性能规范。当用户操作 Redis 相关代码(go-redis、Jedis、redis-py、ioredis)时触发。 包含禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等。

424 44
Explore
doccker/cc-use-exp

python-dev

Python 开发规范。当用户操作 .py、pyproject.toml、requirements.txt、setup.py 文件, 或涉及 FastAPI、Django、Flask、pytest、asyncio 开发时触发。 包含 PEP 8 风格、类型注解、异常处理、测试规范、异步编程、性能优化等。

424 44
Explore
doccker/cc-use-exp

size-check

代码简化与文件行数检查。当用户描述"简化代码"、"检查文件大小"、"代码瘦身"时触发。 审查变更代码的复用性、质量和效率;扫描项目文件行数是否超限并给出拆分建议。

424 44
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results