ts-npm-init/README.md

创建TypeScript NPM库的现代化模板

# ts-npm-init

一个用于快速创建TypeScript NPM库的命令行工具，集成了现代化构建和测试工具链。

## 特性

- 🚀 **快速创建**: 一行命令即可创建完整的TypeScript NPM库项目
- 💪 **TypeScript**: 内置TypeScript支持与类型声明生成
- 📦 **多格式输出**: 支持CommonJS、ES Module、UMD和IIFE格式
- 🎨 **CSS/SCSS支持**: 可以将样式文件打包到JS中或提取为单独文件
- 🧪 **测试环境**: 内置Node.js和浏览器测试环境
- 🔄 **灵活配置**: 模块化且易于自定义的构建配置

## 快速开始

无需安装，直接运行:

```bash
# 使用npx（推荐）
npx ts-npm-init my-lib

# 或使用npm
npm init ts-npm my-lib

# 或使用yarn
yarn create ts-npm my-lib
```

然后按照提示操作，输入包名称、描述和作者信息。

## 手动安装

如果你需要多次使用，也可以选择全局安装:

```bash
# 全局安装
npm install -g ts-npm-init

# 然后使用
ts-npm-init my-lib
```

## 生成的项目内容

生成的项目包含以下内容:

```
.
├── src/               # 源代码目录
│   ├── index.ts       # 主入口文件
│   └── styles/        # 样式文件
├── build/             # 构建配置
├── dist/              # 打包输出目录（构建后生成）
├── types/             # 类型声明文件（构建后生成）
├── test-project/      # 测试项目
├── tsconfig.json      # TypeScript配置
└── rollup.config.js   # Rollup配置
```

## 使用生成的项目

生成项目后，你可以:

```bash
# 安装依赖
cd my-lib
npm install

# 开发模式（构建并在Node.js中测试）
npm run dev

# 在浏览器中测试
npm run test:browser

# 构建生产版本
npm run build:pro

# 发布到NPM
npm run toPublish
```

## 许可证

MIT