| 1 | # syue-cli
|
| 2 | 基于webpack多页面打包工具
|
| 3 |
|
| 4 | ## Install
|
| 5 |
|
| 6 | npm install -g syue-cli
|
| 7 |
|
| 8 | ## Usage
|
| 9 | syue [options] [value ...]
|
| 10 |
|
| 11 | ```
|
| 12 | syue init projectName [--cover]
|
| 13 | 初始化一个项目，如果项目已经存在，可以添加--cover参数将其覆盖
|
| 14 |
|
| 15 | 项目目录
|
| 16 | |-components 通用组件
|
| 17 | |-pages 项目模块
|
| 18 | |-home 其中一个模块，模块必须有一个src目录
|
| 19 | |-src
|
| 20 | |-test 测试
|
| 21 | |-unit 单元测试
|
| 22 | |-sy.config.js/webpack.config.js sy配置文件
|
| 23 |
|
| 24 |
|
| 25 | syue dev
|
| 26 | 在本地会持续编译并生成对应的文件，主要在联调时供后端人员访问
|
| 27 | syue start
|
| 28 | 在本地会持续编译并打开浏览器，实现热加载和代理
|
| 29 | syue build
|
| 30 | 上线发布
|
| 31 | ```
|
| 32 |
|
| 33 | ```javascript
|
| 34 | // syue.config.js配置文件详情
|
| 35 | module.exports = {
|
| 36 | // 编译文件入口
|
| 37 | "files": {
|
| 38 | "pages/home/src/index.js": 1
|
| 39 | },
|
| 40 | // 对于node_modules下的js是否排除
|
| 41 | "exclude": true,
|
| 42 |
|
| 43 | /** 生产配置 **/
|
| 44 | // 提取js模块
|
| 45 | "vendor": true,
|
| 46 | // 生成文件的hash值,默认不生成
|
| 47 | "chunkhash": 8,
|
| 48 | // 是否提取css,默认不提取
|
| 49 | "extractCSS": true,
|
| 50 | // 是否生成source-map, 默认不生成
|
| 51 | "devtool": "#source-map",
|
| 52 | // 线上访问地址，默认//static.sunyur.com/项目目录
|
| 53 | "publicPath": "/",
|
| 54 | // 分析块之间的依赖
|
| 55 | "bundleAnalyzerReport": true,
|
| 56 |
|
| 57 | /** 开发配置 **/
|
| 58 | // 上下文,默认当前目录
|
| 59 | "context": __dirname,
|
| 60 | // 入口文件
|
| 61 | "index": "pages/home/index.html",
|
| 62 | // 静态资源目录,默认index的上级目录
|
| 63 | "staticPath": "./",
|
| 64 | // 端口默认8080
|
| 65 | "port": 8080,
|
| 66 | // 自动打开浏览器
|
| 67 | "autoOpenBrowser": true,
|
| 68 | // api
|
| 69 | "proxyTable": {
|
| 70 | '/api': {
|
| 71 | target: 'http://127.0.0.1:3000',
|
| 72 | changeOrigin: true
|
| 73 | }
|
| 74 | },
|
| 75 | // 添加mock，key：请求路径，value:文件地址
|
| 76 | "mockTable": {
|
| 77 | '/api': 'mocks/home.js'
|
| 78 | },
|
| 79 |
|
| 80 | /** 测试配置 */
|
| 81 | // 是否展示测试覆盖率，默认false
|
| 82 | coverage: true
|
| 83 | }
|
| 84 | ```
|
| 85 |
|
| 86 |
|
| 87 | ## Commands
|
| 88 |
|
| 89 | init [projectName] 初始化项目
|
| 90 | dev 开发
|
| 91 | build 发布上线
|
| 92 | start 开发自动启动服务
|
| 93 | help [cmd] display help for [cmd]
|
| 94 |
|
| 95 | ## Options
|
| 96 |
|
| 97 | -h, --help output usage information
|
| 98 | -V, --version output the version number
|
| 99 | -c, --cover 如果工程名存在,就覆盖掉
|
| 100 | -r, --remove build之前将dist目录删掉
|
| 101 |
|
| 102 | ## 其他
|
| 103 | 在测试时使用PhantomJS，但安装经常失败，在package.json依赖中去掉了，
|
| 104 | 需要手动安装vue-template-compiler和vue
|
| 105 | 经常失败的包，手动安装
|
| 106 | sass-loader
|
| 107 | node-sass
|
| 108 | less
|
| 109 | less-loader |
| \ | No newline at end of file |