Skip to content

目录说明

框架目录

重要

核心目录: src/MainAppsrc/global

全局资源: src/assetssrc/locales

环境配置: env

框架核心目录MainAppglobal目录,默认由iking-global-mainapp插件生成

iking-global-mainapp非特殊情况都需要开启

目录说明

  • MainApp:框架整体UI布局和内置页面
  • global:框架组件、API、方法、hooks、store、router、类型、指令等

后续可通过pnpm add iking-global-mainapp@x.x.x更新版本来完成框架BUG修复和正常的维护更新。

如果必须要关闭此功能,可以修改vite.config.ts文件,将以下copyDir的两行代码注释掉,或者pnpm remove iking-global-mainapp

javascript
  /**
   * @description:根据项目插件替换本地框架文件,达到
   * @return {注意:框架开发时 切勿开启, 业务项目建议开启}
   * @return {注意:业务项目请勿修改global和MainApp目录下的文件,插件升级时会替换这两个目录}
   */
  // global + MainApp目录
   copyDir('node_modules/iking-global-mainapp/pkg', 'src', true)

全局资源目录assetslocales目录,默认由iking-assets-locales插件生成

iking-assets-locales可根据情况决定是否开启(建议开启)

全局资源

  • src/assets:静态资源和样式文件
  • src/locales: 国际化配置文件

框架也支持assets和locales目录的动态更新,由iking-assets-locales提供能力,用法和iking-global-mainapp完全一致

javascript
  // assets + locales目录
   copyDir('node_modules/iking-assets-locales/pkg', 'src', true)

项目目录

项目目录

MicroApp:项目所有文件都应该写在MicroApp目录下

项目目录

MicroApp

重要目录说明:

  • apis:项目请求配置目录,使用框架内置的请求配置即可,具体查看(与服务端交互)

  • assets:项目静态资源样式目录;默认有一个global.scss文件,需要写全局样式或者覆盖掉某些样式时可以写在这个文件内。

  • types:没有类型申明的组件等声明文件可以放在types目录下的mirao.d.ts文件内

  • views:项目页面文件

  • router:项目路由文件(注意:现在菜单路由是在菜单管理页面新增时直接指定了路由对应的页面文件,所以大多数情况下是不需要单独创建路由文件的),目录下默认有一个routes.ts文件,可以把项目路由写在这个文件内,这样不需要在菜单管理中添加也可以访问。

  • iconfont:项目图标目录,将项目的图标文件放在该目录下(放入目录即可,不需要做其它操作,iconfont图标库应该包含iconfont.cssiconfont.jsoniconfont.ttficonfont.woff等文件),即可在项目中使用引入的图标

项目依赖

  • 查看项目中已安装的依赖和最新依赖对比: pnpm outdated
  • 更新所有依赖: pnpm update

框架依赖版本列表

依赖包脚手架版本 < 3.0.6最新依赖版本
@iconify/json (dev)2.2.242.2.77
@iconify/vue (dev)4.1.04.1.1
@imengyu/vue3-context-menu1.2.31.2.10
@monaco-editor/loader1.3.21.3.3
@types/sortablejs (dev)1.15.01.15.1
@vitejs/plugin-legacy (dev)4.0.14.0.4
@vitejs/plugin-vue-jsx (dev)3.0.03.0.1
@webcontainer/api (dev)1.1.01.1.5
autoprefixer (dev)10.4.1310.4.14
fs-extra (dev)11.1.011.1.1
hotkeys-js3.10.13.10.2
iking-global-mainapp (dev)1.0.21.0.15
iking-utils1.1.201.1.22
postcss (dev)8.4.218.4.24
rollup-plugin-visualizer (dev)5.9.05.9.2
vconsole3.15.03.15.1
vue3.3.23.3.4
vue-tsc (dev)1.6.41.6.5
@tinymce/tinymce-vue5.0.05.1.0
axios1.3.31.4.0
element-plus2.2.322.3.6
eslint (dev)8.34.08.42.0
inquirer (dev)9.1.49.2.7
lint-staged (dev)13.1.213.2.2
pinia2.0.302.1.3
sass (dev)1.58.31.63.4
stylelint (dev)15.1.015.7.0
tailwindcss (dev)3.2.73.3.2
terser (dev)5.16.45.18.0
tinymce6.3.16.5.0
vite-plugin-vue-inspector (dev)3.3.23.4.2
vue-router4.1.64.2.2
@vueuse/core9.13.010.1.2
@vueuse/integrations9.13.010.1.2
eruda2.11.23.0.0
stylelint-config-standard (dev)30.0.133.0.0
stylelint-config-standard-scss (dev)7.0.19.0.0
stylelint-scss (dev)4.4.05.0.1
typescript (dev)4.9.55.1.3
vite-plugin-mock (dev)2.9.63.0.0
@antfu/eslint-config (dev)0.35.20.39.5
@intlify/unplugin-vue-i18n (dev)0.8.20.11.0
iking-picker0.1.30.1.8
monaco-editor0.36.00.39.0
unocss (dev)0.49.70.53.1
unplugin-auto-import (dev)0.14.30.16.4
unplugin-vue-components (dev)0.24.00.25.1
vite-plugin-pages (dev)0.28.00.31.0