ARK-CLI
工具说明
ark-cli 是一个基于 Vue.js 进行快速开发的脚手架,为开发者提供初始化项目及复杂逻辑项目,
提供上传自己作品及下载其它组件的开发命令,使用者成为ArkShare 生态园的提供者,减少开发者重复无效工作、
避免无效沟通,提升工作效率
安装命令 -全局安装
npm install @syman/ark-cli -g
脚手架架构图
脚手架上传组件规则
1. 首字母是英文字母可包含 数字者是_,不包含中文、不可重名、名称全局唯一
2. 版本号规则是X.Y.Z 全部都是数字,每次更新只能累加版本,不能撤回
3. 只有创建者有更换版本的权限
4. 上传组件需要arkshare里面新建配置,才能上传成功
新开项目
ark project 项目名称 创建本地项目
cd 项目名称
项目文件目录
ark-cli 需要上传的资源包请放在sharePages文件夹下
项目的启动配置
项目启动命令
npm run dev
界面配置命令
1. 启动登录命令 ark login 输入用户名及密码
2. 启动 ark share 命令 (必须在项目下面启动,否则创建文件时会报启动位置报错)
3. 新建项目名称及项目描述及仓库地址,或者选择已存在的项目进入资源包界面
4. 资源包页面 可以 新增或者选择要上传的资源包的组件
5. 选择资源包后,更改版本号,点击新建本地资源包按钮(在本地创建线上的文件名的文件夹)
6. 选择资源包后,更改版本号,点击编译按钮会编译上传本地的文件,点击预览链接后,可以依次执行提交动作
arkcli 编译完成后
基于已经开发完成的项目
实施步骤
1. 全局安装 npm install @syman/ark-cli -g
2. 启动登录命令 ark login 输入用户名及密码
3. 在自己项目下启动 ark share 命令
3. 新建项目名称及项目描述及仓库地址,或者选择已存在的项目进入资源包界面
4. 资源包页面 可以 新增或者选择要上传的资源包的组件
5. 选择资源包后,更改版本号,点击生成上传配置按钮,在本地项目文件夹下面会生成 arkConfig.json 文件
6. 配置arkConfig.json 文件后,(查看是否配置mock、路径是否修改成绝对),启动ark buildconfig
7. 确认预览链接无误后,启动 ark submit 命令,提交组件
开发规则
- 编译后的文件必须是绝对路径,文件中不能含有绝对路径
- 编译的路由是有hash值
- 如果用的是R3框架,需要在index.html 中添加 window.ProjectConfig = { mock: true, };
arkConfig.json 如何配置
{
"routers":[{
"moduleName":"goodsPages",
// 自动生成 是从arkshare 上拉取
"version":"0.0.4",
// 自动生成 是从arkshare 上拉取
"ID":"139",
// 自动生成 是从arkshare 上拉取
"component": "HomeSeeBoard",
// 手输入,本地项目组件名称
"componentUrl": "../component/customizedPage/HomeSeeBoard.vue",
// 手输入,本地项目组件在router config里面的路径
"src":"src/component/customizedPage/HomeSeeBoard.vue"
// 需要上传到arkshare 的文件(可以是文件夹或者是单个文件)
}],
"routerUrl":"src/config/router.config.js",
// 路由配置的绝对路径
"commands":"npm run share",
// 本地项目的编译命令(如果本地项目的编译满足上述的3点开发规则,可以直接写入自己本地的编译命令,否则建议用户新建个share 命令)
"entry":"./index.js",
// 入口文件
"mock":[{
"context": "/p/c",
"target": "http://dev.burgeononline.com:9090/mock/357/"
}]
// mock 的数据的正则匹配
}
下载项目命令
ark install 组件名称@版本号