mcpField
S
shellcheck-configuration

shellcheck-configuration

github.com/wshobson测试与质量41.9k11.7k 次安装2 周前更新
代码仓库

关于 shellcheck-configuration

面向维护 Shell 脚本的开发者,提供 ShellCheck 配置与静态分析指导,涵盖 lint 设置、警告解读、规则配置和开发工作流集成。

主要功能

  1. 01按目标 Shell 配置 ShellCheck
  2. 02分析脚本中的常见问题
  3. 03理解警告和错误代码
  4. 04说明理由后抑制误报
  5. 05集成到 CI/CD 和编辑器

适用场景

  1. 01在 CI/CD 流水线中加入 Shell lint
  2. 02检查现有脚本的问题
  3. 03按项目需求配置规则
  4. 04合并前落实脚本质量检查

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration

安装后在 Claude Code 中输入/shellcheck-configuration确认已加载。

附带文件references/details.md

详细介绍

ShellCheck 配置与静态分析

关于配置和使用 ShellCheck 的全面指南,通过静态代码分析提升 Shell 脚本质量、发现常见陷阱并落实最佳实践。

何时使用本技能

  • 在 CI/CD 流水线中为 Shell 脚本设置 lint 检查
  • 分析现有 Shell 脚本中的问题
  • 理解 ShellCheck 错误代码与警告
  • 针对特定项目需求配置 ShellCheck
  • 将 ShellCheck 集成到开发工作流中
  • 抑制误报并配置规则集
  • 落实一致的代码质量标准
  • 迁移脚本以满足质量门禁

详细模式与完整示例

详细的模式文档位于 references/details.md。当上述导航层级不够用时,请阅读该文件。

最佳实践

  1. 在 CI/CD 中运行 ShellCheck - 在合并前发现问题
  2. 针对目标 Shell 进行配置 - 不要将 bash 当作 sh 分析
  3. 记录排除项 - 说明为何抑制某些违规
  4. 处理违规 - 不要只是禁用警告
  5. 启用严格模式 - 使用 --enable=all 并谨慎设置排除项
  6. 定期更新 - 保持 ShellCheck 为最新版本以获得新检查
  7. 使用 pre-commit 钩子 - 在推送前于本地发现问题
  8. 与编辑器集成 - 在开发过程中获得实时反馈

评论

支持 Markdown