README
vue-framework
使用
在项目中引入 vue-framework 及相关模板、插件,例如:
npm install --save-dev @vue-framework/vue-framework @vue-framework/template-pc-inner-less @vue-framework/plugin-hmr
在项目根目录中新增 vue-framework.config.js
配置文件:
module.exports = {
template: '@vue-framework/template-pc-inner-less',
plugins: [
'@vue-framework/plugin-hmr'
]
}
在项目的 package.json
中配置指令,如:
{
"scripts": {
"dev": "vue-framework dev",
"build": "vue-framework build"
}
}
项目开发中,在项目根目录下执行:
npm run dev
则进入开发模式,监听代码变更并自动进行编译并推送变更到已打开的页面。
项目部署前,执行:
npm run build
则将代码进行打包。
可以参照 example/pc-inner-less
、example/plugin
两个 DEMO 项目。
开发说明
** 调试 **
本地调试模块:
- 待调试模块目录下,执行“npm link“,将模块发布为本机全局模块(链接形式)
- 使用待调试模块的应用目录下,执行“npm link @vue-framework/xxx”以创建到本机全局目录下该模块的链接
也可以简化在使用待调试的应用目录下执行“npm link ../../xxx”的方式,原理也是先创建全局模块再引用。
注意:待调试模块如果使用了额外的依赖模块,在应用目录下解析依赖的模块可能会有问题。这种情况暂且只能放弃调试,改为发布 alpha 版本用于测试:
# 待调试模块目录
npm publish --tag alpha --access public
# 应用目录
npm install @vue-framework/xxx@alpha
** 发布 **
发布带有 scope 的模块:
npm publish --access public
@vue-framework 对应的发布账号包括“koa-framework-admin”,需要先登录改账号(npm login --scope=@vue-framework)再发布。