# @osdoc-dev/avenger-cli

> @osdoc-dev/avenger 一键 📦 打包工具

Latest version **0.2.4** (published 2021-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @osdoc-dev/avenger-cli
pnpm add @osdoc-dev/avenger-cli
yarn add @osdoc-dev/avenger-cli
bun add @osdoc-dev/avenger-cli
```

Provides the command `avenger`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2021-12-20 |
| First published | 2021-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^12.0.0 \|\| >= 14.0.0 |
| Dependencies | 7 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | ahwgs |
| Maintainers | ahwgs |

## Links

- npm: https://www.npmjs.com/package/@osdoc-dev/avenger-cli
- Repository: https://github.com/osdoc-dev/avenger
- Homepage: https://github.com/osdoc-dev/avenger#readme
- Issues: https://github.com/osdoc-dev/avenger/issues
- npm.io page: https://npm.io/package/@osdoc-dev/avenger-cli

## Dependencies (7)

- [envinfo](https://npm.io/package/envinfo.md) ^7.7.4
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [commander](https://npm.io/package/commander.md) ^7.2.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0
- [@osdoc-dev/avenger-core](https://npm.io/package/@osdoc-dev/avenger-core.md) ^0.2.4
- [@osdoc-dev/avenger-utils](https://npm.io/package/@osdoc-dev/avenger-utils.md) ^0.2.0
- [@osdoc-dev/avenger-shared](https://npm.io/package/@osdoc-dev/avenger-shared.md) ^0.2.2

## Recent versions

- 0.2.4 (latest) — 2021-12-20
- 0.2.3 — 2021-08-22
- 0.2.2 — 2021-08-22
- 0.2.1 — 2021-07-30
- 0.2.0 — 2021-05-28
- 0.1.3 — 2021-05-25
- 0.1.2 — 2021-05-25
- 0.1.1 — 2021-05-16
- 0.1.0 — 2021-05-14
- 0.0.6 — 2021-05-13
- 0.0.5 — 2021-05-13
- 0.0.4 — 2021-05-07
- 0.0.3 — 2021-04-29
- 0.0.2 — 2021-04-28

## README

<div align="center">
    <a href="#" target="_blank">
    <img src="https://static.ahwgs.cn/avenger_logo.jpeg" alt="Logo" width="80" height="80">
    </a>
    <h2>@osdoc-dev/avenger</h2>
    <p align="center">一键 📦 打包工具</p>

[![NPM version](https://img.shields.io/npm/v/@osdoc-dev/avenger-cli.svg?style=flat)](https://npmjs.org/package/@osdoc-dev/avenger-cli)
[![NPM downloads](https://img.shields.io/npm/dm/@osdoc-dev/avenger-cli.svg?style=flat)](https://www.npmjs.com/package/@osdoc-dev/avenger-cli)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![GitHub last commit](https://img.shields.io/github/last-commit/osdoc-dev/avenger.svg?style=flat-square)](https://github.com/osdoc-dev/avenger/commits/master)
</div>

## 如何使用

### 安装

```TypeScript
yarn add @osdoc-dev/avenger-cli 
```

### 增加配置文件

在根目录下新建 `.avengerrc.js, .avengerrc.ts, .avenger.config.js, .avenger.config.ts`

```typescript
export default {
  esm: {
    type: "rollup",
    sourcemap: true,
  },
  outFile: "demo",
}
```


同时，`avenger` 支持导出 `defineConfig` 函数辅助我们进行配置，如；

```typescript
import { defineConfig } from '@osdoc-dev/avenger-cli'

export default defineConfig({
  esm: 'rollup',
  cjs: 'rollup',
  outFile: 'sdk',
  umd: {
    name: 'SDK',
    sourcemap: true,
  },
})

```

### 增加脚本

在 `package.json` 中新增

```json
{
  "script":{
    "build":"avenger build"
  }
}
```

### 打包
```bash
yarn build
```
### 创建新项目

新版本支持新建二方包模版

```bash
avenger create <project name> --force
```

- `force` 强制覆盖本地已存在文件夹


## 配置项

更多配置内容可参考官网

---
_Source: https://npm.io/package/@osdoc-dev/avenger-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._