v3-cli

安装

局部安装,直接在项目目录下执行:

npm install v3-cli

之后将会自动下载v3-cli并启动项目初始化向导。
全局安装:

npm install v3-cli -g

使用

1.全局安装:
v3二次开发脚手架全局安装时提供三个命令:
v3 init 初始化一个v3二次开发项目,可以传递一个路径参数，如v3 init E:\myproject 传入了路径参数时将在指定的路径下初始化二次开发项目,没有传入参数时在当前命令执行路径下初始化。
v3 cli:update 脚手架工具更新检查,执行该命令后会自动检查v3二次开发脚手架及关键依赖的更新，如果发现更新会提示是否更新。用户也可以自行执行npm update -g v3-cli进行更新。
v3 version 查看当前脚手架工具的版本号
2.局部安装:
使用局部安装命令以及通过全局v3 init 初始化之后的项目，在进行实际开发时均在当前项目路径下执行脚手架提供的局部命令:
npm run cli:update 手动执行脚手架更新检查,本地脚手架默认启用更新自动检查，检查频率为每24小时一次,如果需要禁用更新自动检查可以执行 npm run cli:update false ,同理启用更新自动检查命令为npm run cli:update true。
npm run v3:init 局部项目初始化，主要用于各种配置文件丢失时的简单修复。
npm run v3:start 启用测试预览服务器，提供代码实时热更新，用于开发阶段的快速编码及预览。
npm run v3:package 使用webpack打包项目，但不生成v3构件。
npm run v3:pack 打包本地项目并生成v3构件，构件输出目录为当前项目的target目录。
npm run v3:publish 打包项目生成v3构件并发布到vstore构件仓库(初始化向导中指定的库)，第一次执行会要求输入vstore账号信息。
npm run v3:apply 打包项目生成v3构件并安装到指定的执行系统中，同时自动检测执行系统缺失的依赖构件并自动安装，第一次执行该命令会要求输入执行系统地址。
npm run v3:install v3构件安装命令,不带参数执行时会在当前路径下运行一次npm install安装补全npm插件，然后检测当前项目安装的全部v3插件并安装。带参数执行的情况有两种，一种是指定一个本地v3插件的jar文件的绝对路径地址(npm run v3:install 'e:\xxx.jar')，此时会将该v3构件及其依赖安装至本项目；一种是指定一个vstore中的v3构件编码，并选择指定库进行在线安装并自动下载安装关联依赖构件,如npm run v3:install test。
npm run v3:uninstall v3构件卸载命令，执行该命令后会列出当前项目安装的全部v3构件列表,用户选择需要卸载的构件按下回车即可卸载对应的构件。

说明

项目部分目录结构说明：

- project   ->项目根目录
  - .v3platform   ->v3平台脚本目录，svn/git受控时需要包含该目录
  - build   ->webpack配置文件存放目录
    |- v3   ->脚手架预设的webpack配置文件存放目录,不建议修改
    |- webpack.ext.config.js    ->扩展的webpack配置文件,如果对webpack配置有定制需求请在该文件中修改
  - dist    ->webpack打包结果输出目录
  - examples    ->示例代码目录,只有二次开发标签(widget)项目包含该目录,资源构件(resource)构件无该目录
  - node_modules    ->npm模块存放目录,svn/git受控时可以忽略该目录,拉取项目后可以执行npm install命令自动安装npm包和对应的v3构件依赖
  - src   ->项目源码存放目录
  - target    ->打包后的v3构件存放目录,包含构件jar文件以及一个对应的源码jar,该目录在每次生成构件前会自动清空,请勿在该目录存放其他文件
  - .v3devrc    ->脚手架基础配置文件,包含项目基本信息和构件安装信息
  - index.js    ->本项目的入口文件
  - package.json    ->npm配置文件

modify: 2019-1-3 by xujw