# node-run

**Repository Path**: clinfc/node-run

## Basic Information

- **Project Name**: node-run
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-20
- **Last Updated**: 2026-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pkg-run

一个基于 Node.js 的轻量级命令行工具，用于读取并执行当前工作目录下 `package.json` 中定义的 `scripts` 脚本。

## 功能特性

- 🚀 **极速执行**：直接读取 `package.json` 并执行对应脚本。
- 🖱️ **交互式选择**：不带参数运行进入交互模式，支持方向键与数字键选择脚本。
- 📦 **零依赖运行**：打包后的单一文件，不依赖任何外部运行时转译。
- 🛠️ **参数透传**：支持通过 `--` 向底层脚本传递额外参数。
- 🎯 **Node.js 兼容性**：支持 Node.js ≥ 22。
- 🛡️ **健壮性**：完善的错误处理与单元测试覆盖。

## 安装

你可以通过 `npm` 全局安装：

```bash
npm install -g pkg-run
```

或者直接通过 `npx` 使用：

```bash
npx pkg-run [script-name] [-- extra-args]
```

## 使用方法

### 1. 交互式选择脚本
直接运行 `pkg-run` 且不带任何参数时，将进入交互式选择模式：
```bash
pkg-run
```
- 使用 **↑/↓ 方向键** 或 **数字键 (1-9)** 选择脚本。
- 按 **Enter** 确认并执行。
- 按 **Ctrl+C** 退出。

### 2. 执行指定脚本
```bash
pkg-run build
```

### 3. 透传额外参数
向 `test` 脚本传递 `--grep="auth"` 参数：
```bash
pkg-run test -- --grep="auth"
```

## 本地开发

1. **克隆仓库**：
   ```bash
   git clone <repository-url>
   cd pkg-run
   ```

2. **安装依赖**：
   ```bash
   npm install
   ```

3. **运行测试**：
   ```bash
   npm test
   ```

4. **查看测试覆盖率**：
   ```bash
   npm run coverage
   ```

## 构建与发布

1. **打包项目**：
   该项目使用 Rollup 将源码打包到 `dist/index.js`。
   ```bash
   npm run build
   ```

2. **发布到 npm**：
   确保你已经登录了 npm 账号。
   ```bash
   npm publish
   ```

## 项目结构

```text
.
├── dist/               # 打包产物目录
│   └── index.js        # 打包后的单一入口文件
├── src/                # 源码目录
│   └── index.js        # CLI 核心逻辑
├── tests/              # 测试目录
│   └── index.test.js   # 单元测试
├── rollup.config.mjs   # Rollup 配置文件
├── CHANGELOG.md        # 变更记录
├── package.json        # 项目配置
└── README.md           # 说明文档
```

## 许可证

ISC