https://github.com/osdoc-dev/avenger

SDK、组件库研发工作流
https://github.com/osdoc-dev/avenger

cjs cli esm react rollup umd

Last synced: 3 months ago
JSON representation

SDK、组件库研发工作流

• Host: GitHub
• URL: https://github.com/osdoc-dev/avenger
• Owner: osdoc-dev
• Created: 2021-03-30T10:31:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-03-01T16:38:36.000Z (11 months ago)
• Last Synced: 2025-04-12T04:59:56.926Z (9 months ago)
• Topics: cjs, cli, esm, react, rollup, umd
• Language: TypeScript
• Homepage: https://osdoc-dev.github.io/avenger/#/
• Size: 1.05 MB
• Stars: 10
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          


    

    

    

    
@osdoc-dev/avenger

    
一键 📦 打包工具


[![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)



## 如何使用

### 安装

```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  --force

```

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

## 配置项

更多配置内容可参考官网