UNPKG

2.56 kBMarkdownView Raw
1<h1 align="center">
2 <img src="https://img.alicdn.com/tfs/TB1OjR6HQL0gK0jSZFAXXcA9pXa-1360-1360.png" alt="Dawn" width="200">
3 <br>Dawn<br>
4</h1>
5
6<h4 align="center">Lightweight task management and build tool.</h4>
7
8<p align="center">
9 <a href="https://github.com/alibaba/dawn/blob/master/LICENSE">
10 <img src="https://img.shields.io/npm/l/dawn.svg" alt="LICENSE">
11 </a>
12 <a href="https://www.npmjs.com/package/dawn">
13 <img src="https://img.shields.io/npm/v/dawn.svg" alt="npm version">
14 </a>
15 <a href="https://www.travis-ci.org/alibaba/dawn">
16 <img src="https://coveralls.io/repos/github/alibaba/dawn/badge.svg?branch=dev" alt="Coverage Status">
17 </a>
18 <a href="https://www.npmjs.com/package/dawn">
19 <img src="https://img.shields.io/npm/dt/dawn.svg" alt="npm downloads">
20 </a>
21</p>
22
23<pre align="center">npm i <a href="https://www.npmjs.com/package/dawn">dawn</a> -g</pre>
24
25[README in English](README-intl.md)
26
27Dawn 取「黎明、破晓」之意,原为「阿里云·业务运营团队」内部的前端构建和工程化工具,现已完全开源。它通过 `pipeline``middleware` 将开发过程抽象为相对固定的阶段和有限的操作,简化并统一了开发人员的日常构建与开发相关的工作。
28
29## 特点
30
31- 采用中间件技术,封装常用功能,易于扩展,方便重用
32- 支持 pipeline 让多个 task 协同完成构建任务
33- 简单、一致的命令行接口,易于开发人员使用
34- 支持基于「中心服务」管理中间件和工程模板
35- 支持搭建私有中心服务,并统一下发构建规则,易于团队统一管理
36
37## 安装
38
39```sh
40$ npm install dawn -g
41```
42
43## 使用
44```sh
45# 1. 创建 & 初始化
46$ dn init -t front
47
48# 2. 开发 & 实时编译
49$ dn dev
50
51# 3. 语法检查 & 测试
52$ dn test
53
54# 4. 构建 & 打包
55$ dn build
56```
57
58## 示例(.dawn.yml 或 .dawn 目录)
59
60```yml
61# 启动开发服务
62dev:
63 - name: webpack
64 entry: ./src/*.js
65 template: ./assets/*.html
66 watch: true
67 - name: server
68 port: 8001
69
70# 直接构建
71buid:
72 - name: webpack
73 entry: ./src/*.js
74 template: ./assets/*.html
75```
76
77## 文档
78
79- 使用入门:[getting-started.md](docs/markdowns/getting-started.md)
80- 配置 Pipeline:[pipeline.md](docs/markdowns/pipeline.md)
81- 中间件:[middleware.md](docs/markdowns/middleware.md)
82- 更多文档:[https://alibaba.github.io/dawn/docs/](https://alibaba.github.io/dawn/docs/)
83
84## 其它
85
86- [贡献](CONTRIBUTING-zh.md)
87- [更新日志](CHANGELOG.md)
88- [MIT 协议](https://tldrlegal.com/license/mit-license)