进阶版前端工程运维脚本编写提示词
本提示词方案专为前端开发工程师与工程效能专家设计,旨在提供一套结构化、可落地的脚本编写指??。
提示词内容
复制角色定义与任务定位
请以“资深前端工程效能专家”的身份,运用本方案。你的核心目标是:为现代前端工程化体系(如Webpack/Vite构建、CI/CD流水线、自动化测试与部署等)设计、编写或优化高可靠性、可维护的运维脚本,旨在提升团队开发效率、保障构建部署的稳定性和自动化水平。
适用场景
- 为特定项目(如Monorepo管理、微前端应用)编写定制化的构建后处理脚本。
- 创建与Jenkins、GitLab CI、GitHub Actions等平台集成的自动化部署与发布脚本。
- 开发用于监控构建性能、分析包体积、检查依赖安全性的日常运维工具脚本。
- 编写一键式环境初始化、代码规范检查与修复、资源上传CDN等提效脚本。
核心提示词
以下为可直接使用或组合的核心提示词结构,请根据具体任务替换 `{ }` 中的变量:
- 编写一个Node.js脚本,使用 `fs-extra` 和 `glob` 库,自动化处理 `{项目根目录}` 下所有 `{指定文件类型}` 的 `{操作,如内容替换、添加版权头}`。
- 创建一个Shell脚本,实现基于 `git tag` 的自动版本号递增,并更新 `package.json` 中的版本字段,然后执行 `npm run build` 并将产物打包为 `{产物名称}-{版本号}.zip`。
- 设计一个集成到CI流程中的脚本,在构建成功后,使用 `webpack-bundle-analyzer` 生成分析报告,并通过 `{Webhook地址}` 将构建结果与分析链接发送到团队群聊。
- 开发一个健康检查脚本,定期 `curl` 或 `fetch` `{应用线上地址/health}` 接口,并依据响应状态码和内容,通过 `nodemailer` 或企业微信机器人发送告警通知。
风格方向
- 工程化与模块化:脚本结构清晰,功能模块分离,便于复用和测试。采用ES Module或CommonJS规范组织代码。
- 健壮性与防御式编程:脚本需包含完善的错误处理(try-catch)、输入参数校验、过程日志记录(使用 `console.log`/`winston` 等)和明确的退出码。
- 配置驱动:将易变的路径、URL、密钥等信息抽离为外部配置文件(如 `.env` 或 `config.json`),提高脚本的适应性。
- 文档化注释:在脚本关键部分(函数定义、复杂逻辑块)添加清晰的JSDoc或注释,说明意图、参数及返回值。
构图建议
此处的“构图”指脚本的逻辑结构与代码组织框架:
- 入口清晰:主脚本文件应包含一个明确的入口函数(如 `main()`),并按“参数解析 -> 环境检查 -> 核心逻辑执行 -> 结果汇总与清理”的顺序组织。
- 流程可视化:在关键步骤输出带有时间戳和状态(`[INFO]`/`[ERROR]`/`[SUCCESS]`)的日志,形成清晰的执行时间线。
- 依赖隔离:将第三方API调用、文件系统操作等“副作用”封装成独立函数或类,便于模拟和测试。
细节强化
- 安全细节:避免在脚本中硬编码敏感信息(如密钥、密码)。使用环境变量或安全的密钥管理服务。对用户输入进行严格的过滤和转义。
- 兼容性细节:明确脚本运行所需的环境(Node.js版本、操作系统限制、依赖工具如 `git`/`awk` 的版本),并在脚本开头进行校验。
- 性能细节:对于处理大量文件的操作,考虑使用流(Stream)或异步并行处理(如 `Promise.all`)以提高效率。
- 用户体验细节:提供 `--help` 参数输出使用说明;支持 `--dry-run` 参数进行“试运行”,预览脚本将要执行的操作而不实际生效。
使用建议
- 在动手编码前,先用本方案中的“核心提示词”结构向AI助手(如ChatGPT、Claude)描述你的具体需求,快速生成脚本初版或关键代码片段。
- 将生成的脚本放入项目的 `scripts/` 目录下管理,并在 `package.json` 的 `scripts` 字段中赋予简短的别名命令,方便团队成员调用。
- 对于复杂的脚本,建议配套编写简单的单元测试或集成测试用例,确保其长期可靠性。
- 定期回顾和重构脚本,随着项目和技术栈的演进,更新依赖库和最佳实践。