1.0.16 • Published 2 years ago
coder-bing-cli v1.0.16
说明文档
coder-bing-cli
: 一个帮助你快速搭建和开发前端项目的CLI
如何安装?
npm install coder-bing-cli -g
创建项目
目前支持Vue2,vue3
vue项目模块已经帮你配置:
- 常用的目录结构(你可以在此基础上修改)
- vue.config.js(其中配置了别名,你可以自行修改和配置更多)
- axios(网络请求axios的安装以及二次封装)
- vue-router(router的安装和配置,另外有路由的动态加载,后面详细说明)
- vuex(vuex的安装和配置,另外有动态加载子模块,后面详细说明)
- vue-ls(vue3暂不支持) (https://www.baidu.com/link?url=dlQgtnfzlHFxV8ycRLF-ZFunejCy47CIRelb_a0dxK79CVHPQQL4_iftz4hhOUrE&wd=&eqid=bb1f034100108dbd000000046163df0c)
创建项目
bingCli create your_project_name
自动拉取项目模板、安装项目依赖、打开浏览器 http://localhost:8080/
、自动启动项目
项目开发
项目开发目前提供三个功能:
- 创建Vue组件
- 创建Vue页面,并配置路由
- 创建Vuex子模块
创建Vue组件:
bingCli addcpn YourComponentName # 例如bingCli add NavBar,默认会存放到src/components文件夹中
bingCli addcpn YourComponentName -d src/pages/home # 也可以指定存放的具体文件夹
创建Vue页面,并配置路由
bingCli addpage YourPageName # 例如bingCli addpage Home,默认会放到src/pages/home/Home.vue中,并且会创建src/page/home/router.js
bingCli addpage YourPageName -d src/views # 也可以指定文件夹,但需要手动集成路由
为什么会创建router.js文件:
router.js
文件是路由的其中一个配置;- 创建该文件中
src/router/index.js
中会自动加载到路由的routes
配置中,不需要手动配置了(如果是自己配置的文件夹需要手动配置)
src/router/index.js
中已经完成如下操作:
// 动态加载pages中所有的路由文件
const files = require.context('@/pages', true, /router\.js$/);
const routes = files.keys().map(key => {
const page = require('@/pages' + key.replace('.', ''));
return page.default;
})
创建Vuex子模块
bingCli addstore YourVuexChildModuleName # 例如bingCli addstore home,默认会放到src/store/modules/home/index.js和types.js
bingCli addstore YourVuexChildModuleName -d src/vuex/modules # 也可以指定文件夹
创建完成后,不需要手动配置,已经动态将所有子模块集成进去:
// 动态加载modules
const modules = {}
const files = require.context('./', true, /index\.js$/);
files.keys().filter(key => {
if (key === './index.js') return false;
return true
}).map(key => {
// 获取名字
const modulePath = key.replace('./modules/', '');
const moduleName = modulePath.replace('/index.js', '');
const module = require(`${key}`);
modules[`${moduleName}`] = module.default;
})
检查更新
bingCli upgrade