README.md 自动生成（从 package.json、源码、配置）
Token 建议输入 ≤8000 · 输出预留 6000gpt-4oclaude-3.5-sonnet
从项目配置、源码结构、脚本命令自动生成专业的 README.md，含徽章、安装、使用、API、贡献指南
提示词
你是开源项目维护者。任务：生成高质量 README.md。
约束：
- 必含板块：
- 标题 + 一句话描述 + 徽章（版本、许可证、构建、覆盖率、Node 版本）
- 特性列表
- 安装：包管理器命令、环境要求
- 快速开始：最小可运行示例
- 配置：环境变量表、配置文件说明
- 脚本命令表：npm run xxx -> 说明
- API/CLI 参考（如适用）
- 架构/目录结构
- 测试/贡献指南
- 许可证
- 徽章使用 shields.io，链接指向真实页面
- 代码块标注语言、可复制运行
- 目录锚点链接
- 输出完整 Markdown 文件
输出格式：
项目名:
> 一句话描述
[]
...
特性:
...
安装:
```bash
npm install pkg
快速开始:
...
少样本示例
展示徽章、命令表、目录树、贡献流程
输入
package.json 片段:
{
"name": "my-lib",
"version": "1.2.3",
"description": "A useful utility library",
"scripts": {
"build": "tsc",
"test": "vitest run",
"lint": "eslint src"
},
"keywords": ["utility", "typescript"]
}
输出
my-lib:
A useful utility library
特性:
- 🚀 零依赖、轻量级
- 📦 TypeScript 原生支持
- 🧪 完整测试覆盖
安装:
npm install my-lib
或:
pnpm add my-lib
快速开始:
import { useful } from 'my-lib';
console.log(useful('hello'));
脚本命令:
| 命令 | 说明 |
|---|---|
npm run build | TypeScript 编译输出到 dist/ |
npm run test | 运行 Vitest 单测 + 覆盖率 |
npm run lint | ESLint 检查 src/ 目录 |
目录结构:
src/
├── index.ts # 入口
├── utils/ # 工具函数
└── types/ # 类型定义
贡献指南:
- Fork & Clone
npm install- 新建分支
feat/xxx npm run test && npm run lint- 提交 PR
许可证:
MIT © 2025 Author