# study-bunjs

**Repository Path**: yanxxit/study-bunjs

## Basic Information

- **Project Name**: study-bunjs
- **Description**: bunjs study
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# study-bunjs

Bun.js CLI 演示工具 - 使用 Bun/TypeScript 构建的命令行工具示例

遵循 [Bun 开发规范](.qwen/skills/bun-best-practices/SKILL.md)

## 📦 安装

```bash
# 克隆项目
git clone <repository-url>
cd study-bunjs

# 安装依赖（如需要）
bun install

# 全局链接（可选）
bun link
```

## 🚀 使用方法

### 开发模式（推荐）

```bash
# 监听模式 - 文件更改时自动重新加载
bun run dev

# 或直接运行 TypeScript 文件
bun run src/cli.ts help
```

### 使用 Bun 运行

```bash
# 显示帮助
bun run src/cli.ts help

# 显示问候语
bun run src/cli.ts hello
bun run src/cli.ts hello Bun

# 计算加法
bun run src/cli.ts add 5 3

# 显示系统信息
bun run src/cli.ts info

# 显示版本
bun run src/cli.ts version
```

### 使用 npm 脚本

```bash
bun run help
bun run hello -- Bun
bun run add -- 5 3
bun run info
bun run version
```

## 📋 可用命令

| 命令 | 描述 | 示例 |
|------|------|------|
| `hello [name]` | 显示问候语 | `bun-cli hello World` |
| `add <a> <b>` | 计算两个数字的和 | `bun-cli add 5 3` |
| `info` | 显示系统信息 | `bun-cli info` |
| `version` | 显示版本号 | `bun-cli version` |
| `help` | 显示帮助信息 | `bun-cli help` |

## 🛠️ 项目结构

```
study-bunjs/
├── src/                    # TypeScript 源代码
│   └── cli.ts             # CLI 主实现
├── bin/                    # CLI 入口（兼容层）
│   └── cli.js             # 转发到 src/cli.ts
├── test/                   # 测试文件
│   └── cli.test.ts        # CLI 测试
├── .env.example           # 环境变量示例
├── tsconfig.json          # TypeScript 配置
├── package.json           # 项目配置
└── README.md              # 项目文档
```

## ✨ 特性

- 🎯 简单的命令行解析
- 🟦 TypeScript 原生支持
- 🌍 兼容 Bun 和 Node.js 运行时
- 📊 内置系统信息查看
- 🎨 彩色 Emoji 输出
- 📝 完整的帮助文档
- 🧪 完整的测试覆盖
- ⚡ 遵循 Bun 最佳实践

## 🧪 测试

```bash
# 运行所有测试
bun test

# 监听模式
bun run test:watch
```

测试覆盖：
- ✅ `hello` 命令 - 问候语输出
- ✅ `add` 命令 - 数字计算
- ✅ `info` 命令 - 系统信息显示
- ✅ `version` 命令 - 版本查询
- ✅ `help` 命令 - 帮助文档
- ✅ 错误处理 - 异常情况和无效输入
- ✅ 输出格式 - 格式化和结构验证

## 📝 开发与规范

本项目遵循 [Bun 开发规范](.qwen/skills/bun-best-practices/SKILL.md)。

### 常用命令

```bash
# 开发模式（监听文件变化）
bun run dev

# 运行测试
bun test

# 监听模式运行测试
bun run test:watch
```

### 编码规范

- ✅ 使用 ES Modules（`import/export`）
- ✅ 优先使用 Bun API（`Bun.file()`, `Bun.write()`）
- ✅ 使用 TypeScript 编写代码
- ✅ 所有功能必须有测试覆盖
- ✅ 异步 I/O 操作

详细规范请查看 [.qwen/skills/bun-best-practices/](.qwen/skills/bun-best-practices/) 目录。

## 🔧 配置

### TypeScript

项目使用 TypeScript，配置在 `tsconfig.json` 中。

### 环境变量

复制 `.env.example` 为 `.env` 并修改配置：

```bash
cp .env.example .env
```

## 📄 许可证

MIT