# vfs-cli

**Repository Path**: panxianwen/vfs-cli

## Basic Information

- **Project Name**: vfs-cli
- **Description**: vue-frontend-scaffold cli
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-05
- **Last Updated**: 2022-01-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简介

`vfs-cli`是基于`vue-cli`实现的快速搭建`vue`项目的脚手架，可以实现vue项目的初始化、页面（组件）新建、打包、发布等功能。

## 安装

> **Node 版本要求**
> Vue CLI 需要 Node.js 8.9 或更高版本。

全局安装
```javascript
npm i vfs-cli -g
```

安装之后，你就可以在命令行中访问`vfs`命令。你还可以用这个命令来检查其版本是否正确：
```javascript
vfs --version
//或者
vfs -V
```

## 基础

运行`vfs help`可以查看当前支持的指令。

|  指令   | 效果  |
|  ----  | ----  |
| init  | 初始化项目 |
| build  | 项目打包，输出zip文件。使用`-p`或`--prod`会产出`release`包 |
| serve  | 本地运行项目，效果同`vue-cli-service serve`,`--open`会在编译完成后自动打开浏览器 |
| lint | ESLint代码检测，会自动修复简单错误 |
| generate、g  | 生成模版文件，当前支持页面及组件文件 |
| deploy  | 将zip包发布到指定环境 |

## 指令

#### `init`

```javascript
vfs init
```

初始化一个项目。在本脚手架中，初始化项目分为三种类型。

* web，Web端项目模板
* mobile，移动端项目模板
* template，使用上传的模板项目来初始化新项目

输入项目名称，脚手架会自动新建项目目录，进入项目目录，执行`npm i`安装第三方依赖，项目的初始化就完成了。

#### `serve`

```javascript
vfs serve
//或
vfs serve --open
```

运行以上代码，在本地启动项目。`--open`配置，可以在代码编译结束后自动打开默认浏览器。`vfs serve`的执行效果与`vue-cli-service serve`一致。

#### `build`

```javascript
vfs build
//或
vfs build --prod //-p
```
运行以上代码，会自动执行打包，最终生成zip包。

#### `generate、g`

生成模版文件，当前支持页面及组件文件

#### `package`

配合docker打包部署，会搜索当前目录下除dist外的文件夹，在每个文件夹内打包，并把最终的打包文件拷贝到当前目录的dist下。

```js
vfs package // 遍历文件夹下除dist外的所有文件夹，并按个文件夹打测试包，并拷贝文件夹下dist目录到当前dist目录

vfs package -p // 遍历文件夹下除dist外的所有文件夹，并按个文件夹打生产包，并拷贝文件夹下dist目录到当前dist目录

vfs package -l mobile // 为当前文件下下名为mobile的文件夹打包，其余非dist文件夹，拷贝文件夹下dist到当前dist目录 

vfs package -l mobile,web -p // 为当前文件下下名为mobile、web的文件夹打生产包，其余非dist文件夹，拷贝文件夹下dist到当前dist目录 
```