diff --git a/CHANGELOG.md b/CHANGELOG.md index dc46205c..3ff2b6e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,31 @@ # CHANGE LOG +## 4.6.4-beta1.0 + +更新了核心依赖插件：`vite`, `vue`。 + +新增 `__ray-template` 包，用于模板启动时的一些检查或者其他钩子的启动。 + +## Feats + +- 更新了一些注释 +- 更新 `vue` 版本至 `3.4.19` +- 更新 `vite` 版本至 `5.1.3`；最新版本 `vite` 优化了 `HMR` 逻辑 +- 新增检查器功能（存于 `__ray-template` 包），用于在模板启动后，做一些检查工作 +- 使用 `checkRightClose`, `checkLeftClose` 方法替换原有检查关闭按钮禁用逻辑 +- `useDevice` 方法返回属性 `isTabletOrSmaller` 使用 `readonly` 方法包裹 +- `RChart` 组件相关 + - 移除 `animation` 配置项，该配置项在使用的时候可能会有潜在的性能问题 + - 新增 `nextTick` 配置项，是否将渲染图标内容放置到下一个队列中 + > 该配置项启用后，会先渲染一个空的图表，然后在下一个队列中渲染图表内容。这样做的好处是，可以避免一些图表渲染的性能问题，但是会导致图表渲染的时候会有一个空白的过程。 + - 修改 `registerTheme` 方法调用时机，并且该方法仅会执行一次 + - 预设 `Card` 风格的下载功能下拉框预留字段由 `downloadChart` 更名为 `__DOWN_LOAD_CHART__` + +## Fixes + +- 修复更新主题色时 `preset` 没有被正确更新问题。现在在更新主题色后，会正确的更新 `primaryColorPressed` +- 修复 `README.md` 描述文件中的一些错误描述 + ## 4.6.3 ## Feats diff --git a/README.commit.md b/README.commit.md new file mode 100644 index 00000000..8bc3e738 --- /dev/null +++ b/README.commit.md @@ -0,0 +1,22 @@ +# commit 规范 + +## commit message 格式 + +在提交代码时，`commit message` 遵循以下格式： + +- feat: 新功能`（feature）` +- fix: 修补 `bug` +- update: 更新代码 +- docs: 文档（documentation） +- style: 格式（不影响代码运行的变动） +- refactor: 重构（即不是新增功能，也不是修改bug的代码变动） +- test: 增加测试 +- chore: 构建过程或辅助工具的变动 +- revert: 撤销 +- merge: 合并分支 +- perf: 优化相关，比如提升性能、体验 +- build: 构建 +- plugin: 插件更新 +- publish: 发布 + +当你需要定制化自己的`commit message`格式时，可以在`commitlint.config.cjs`文件中进行配置。 diff --git a/README.md b/README.md index d6defcfd..352f6742 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ A `completely free`, `efficient`, `feature complete` and based on vite5. x & ts( - [Vue3](https://v3.vuejs.org/) - familiar with Vue basic syntax - [TypeScript](https://www.typescriptlang.org/) - familiar with TypeScript basic syntax - [ES6+](http://es6.ruanyifeng.com/) - familiar with es6 basic syntax -- [Vue-Hooks-Plus] - familiar with vue-hooks-plus useRequest method basic use +- [Vue-Hooks-Plus](https://inhiblabcore.github.io/docs/hooks/) - familiar with vue-hooks-plus useRequest method basic use - [Vue-Router-Next](https://next.router.vuejs.org/) - familiar with vue-router4.x basic use - [Naive-UI](https://www.naiveui.com) - naive ui basic use - [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax diff --git a/README.zh-CN.md b/README.zh-CN.md index 135e68ee..52509eeb 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -74,7 +74,7 @@ - [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法 - [TypeScript](https://www.typescriptlang.org/) - 熟悉 TypeScript 基本语法 - [ES6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法 -- [Vue-Hooks-Plus] - 熟悉 vue-hooks-plus useRequest 方法的基本使用 +- [Vue-Hooks-Plus](https://inhiblabcore.github.io/docs/hooks/) - 熟悉 vue-hooks-plus useRequest 方法的基本使用 - [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router4.x 基本使用 - [Naive-UI](https://www.naiveui.com) - naive ui 基本使用 - [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法 diff --git a/package.json b/package.json index 7bb35ca2..8a1c67ea 100755 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ray-template", "private": false, - "version": "4.6.3", + "version": "4.6.4-beta1.0", "type": "module", "engines": { "node": "^18.0.0 || >=20.0.0", @@ -48,7 +48,7 @@ "pinia": "^2.1.7", "pinia-plugin-persistedstate": "^3.2.0", "print-js": "^1.6.0", - "vue": "^3.4.15", + "vue": "^3.4.19", "vue-hooks-plus": "1.8.5", "vue-i18n": "^9.9.0", "vue-router": "^4.2.5", @@ -93,7 +93,7 @@ "typescript": "^5.2.2", "unplugin-auto-import": "^0.16.6", "unplugin-vue-components": "^0.25.2", - "vite": "^5.0.11", + "vite": "^5.1.3", "vite-plugin-cdn2": "0.15.2", "vite-plugin-compression": "^0.5.1", "vite-plugin-ejs": "^1.7.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c483437e..ee5dd7de 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -7,7 +7,7 @@ settings: dependencies: '@vueuse/core': specifier: ^10.7.1 - version: 10.7.1(vue@3.4.15) + version: 10.7.1(vue@3.4.19) awesome-qr: specifier: 2.1.5-rc.0 version: 2.1.5-rc.0 @@ -43,10 +43,10 @@ dependencies: version: 1.1.0 naive-ui: specifier: ^2.37.3 - version: 2.37.3(vue@3.4.15) + version: 2.37.3(vue@3.4.19) pinia: specifier: ^2.1.7 - version: 2.1.7(typescript@5.2.2)(vue@3.4.15) + version: 2.1.7(typescript@5.2.2)(vue@3.4.19) pinia-plugin-persistedstate: specifier: ^3.2.0 version: 3.2.0(pinia@2.1.7) @@ -54,17 +54,17 @@ dependencies: specifier: ^1.6.0 version: 1.6.0 vue: - specifier: ^3.4.15 - version: 3.4.15(typescript@5.2.2) + specifier: ^3.4.19 + version: 3.4.19(typescript@5.2.2) vue-hooks-plus: specifier: 1.8.5 - version: 1.8.5(vue@3.4.15) + version: 1.8.5(vue@3.4.19) vue-i18n: specifier: ^9.9.0 - version: 9.9.0(vue@3.4.15) + version: 9.9.0(vue@3.4.19) vue-router: specifier: ^4.2.5 - version: 4.2.5(vue@3.4.15) + version: 4.2.5(vue@3.4.19) xlsx: specifier: ^0.18.5 version: 0.18.5 @@ -108,10 +108,10 @@ devDependencies: version: 6.5.0(eslint@8.52.0)(typescript@5.2.2) '@vitejs/plugin-vue': specifier: ^5.0.3 - version: 5.0.3(vite@5.0.11)(vue@3.4.15) + version: 5.0.3(vite@5.1.3)(vue@3.4.19) '@vitejs/plugin-vue-jsx': specifier: ^3.1.0 - version: 3.1.0(vite@5.0.11)(vue@3.4.15) + version: 3.1.0(vite@5.1.3)(vue@3.4.19) '@vue-hooks-plus/resolvers': specifier: 1.2.4 version: 1.2.4(vue-hooks-plus@1.8.5) @@ -183,34 +183,34 @@ devDependencies: version: 0.16.6(@vueuse/core@10.7.1) unplugin-vue-components: specifier: ^0.25.2 - version: 0.25.2(vue@3.4.15) + version: 0.25.2(vue@3.4.19) vite: - specifier: ^5.0.11 - version: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + specifier: ^5.1.3 + version: 5.1.3(@types/node@20.4.7)(sass@1.69.5) vite-plugin-cdn2: specifier: 0.15.2 version: 0.15.2 vite-plugin-compression: specifier: ^0.5.1 - version: 0.5.1(vite@5.0.11) + version: 0.5.1(vite@5.1.3) vite-plugin-ejs: specifier: ^1.7.0 - version: 1.7.0(vite@5.0.11) + version: 1.7.0(vite@5.1.3) vite-plugin-eslint: specifier: 1.8.1 - version: 1.8.1(eslint@8.52.0)(vite@5.0.11) + version: 1.8.1(eslint@8.52.0)(vite@5.1.3) vite-plugin-imp: specifier: ^2.4.0 - version: 2.4.0(vite@5.0.11) + version: 2.4.0(vite@5.1.3) vite-plugin-inspect: specifier: ^0.7.38 - version: 0.7.38(vite@5.0.11) + version: 0.7.38(vite@5.1.3) vite-plugin-mock-dev-server: specifier: 1.3.4 - version: 1.3.4(vite@5.0.11) + version: 1.3.4(vite@5.1.3) vite-plugin-svg-icons: specifier: ^2.0.1 - version: 2.0.1(vite@5.0.11) + version: 2.0.1(vite@5.1.3) vite-svg-loader: specifier: ^4.0.0 version: 4.0.0 @@ -605,6 +605,14 @@ packages: hasBin: true dependencies: '@babel/types': 7.23.6 + dev: true + + /@babel/parser@7.23.9: + resolution: {integrity: sha512-9tcKgqKbs3xGJ+NtKF2ndOBBLVwPjl1SHxPQkd36r3Dlirw3xWUeGaTbqr7uGZcTaxkVNwc+03SVP7aCdWrTlA==} + engines: {node: '>=6.0.0'} + hasBin: true + dependencies: + '@babel/types': 7.23.6 /@babel/plugin-syntax-jsx@7.23.3(@babel/core@7.23.6): resolution: {integrity: sha512-EB2MELswq55OHUoRZLGg/zC7QWUKfNLpE57m/S2yr1uEneIgsTgrSzXP3NXEsMkVn76OlaVVnzN+ugObuYGwhg==} @@ -927,12 +935,12 @@ packages: css-render: 0.15.12 dev: false - /@css-render/vue3-ssr@0.15.12(vue@3.4.15): + /@css-render/vue3-ssr@0.15.12(vue@3.4.19): resolution: {integrity: sha512-AQLGhhaE0F+rwybRCkKUdzBdTEM/5PZBYy+fSYe1T9z9+yxMuV/k7ZRqa4M69X+EI1W8pa4kc9Iq2VjQkZx4rg==} peerDependencies: vue: ^3.0.11 dependencies: - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) dev: false /@emotion/hash@0.8.0: @@ -1430,7 +1438,7 @@ packages: magic-string: 0.30.5 mlly: 1.4.1 source-map-js: 1.0.2 - vue-i18n: 9.9.0(vue@3.4.15) + vue-i18n: 9.9.0(vue@3.4.19) yaml-eslint-parser: 1.2.2 dev: true @@ -1492,7 +1500,7 @@ packages: picocolors: 1.0.0 source-map-js: 1.0.2 unplugin: 1.4.0 - vue-i18n: 9.9.0(vue@3.4.15) + vue-i18n: 9.9.0(vue@3.4.19) transitivePeerDependencies: - rollup - supports-color @@ -2111,7 +2119,7 @@ packages: resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==} dev: true - /@vitejs/plugin-vue-jsx@3.1.0(vite@5.0.11)(vue@3.4.15): + /@vitejs/plugin-vue-jsx@3.1.0(vite@5.1.3)(vue@3.4.19): resolution: {integrity: sha512-w9M6F3LSEU5kszVb9An2/MmXNxocAnUb3WhRr8bHlimhDrXNt6n6D2nJQR3UXpGlZHh/EsgouOHCsM8V3Ln+WA==} engines: {node: ^14.18.0 || >=16.0.0} peerDependencies: @@ -2121,21 +2129,21 @@ packages: '@babel/core': 7.23.6 '@babel/plugin-transform-typescript': 7.23.6(@babel/core@7.23.6) '@vue/babel-plugin-jsx': 1.1.5(@babel/core@7.23.6) - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) - vue: 3.4.15(typescript@5.2.2) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) + vue: 3.4.19(typescript@5.2.2) transitivePeerDependencies: - supports-color dev: true - /@vitejs/plugin-vue@5.0.3(vite@5.0.11)(vue@3.4.15): + /@vitejs/plugin-vue@5.0.3(vite@5.1.3)(vue@3.4.19): resolution: {integrity: sha512-b8S5dVS40rgHdDrw+DQi/xOM9ed+kSRZzfm1T74bMmBDCd8XO87NKlFYInzCtwvtWwXZvo1QxE2OSspTATWrbA==} engines: {node: ^18.0.0 || >=20.0.0} peerDependencies: vite: ^5.0.0 vue: ^3.2.25 dependencies: - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) - vue: 3.4.15(typescript@5.2.2) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) + vue: 3.4.19(typescript@5.2.2) dev: true /@volar/language-core@1.10.1: @@ -2163,7 +2171,7 @@ packages: vue-hooks-plus: ^1.5.2 dependencies: local-pkg: 0.4.3 - vue-hooks-plus: 1.8.5(vue@3.4.15) + vue-hooks-plus: 1.8.5(vue@3.4.19) dev: true /@vue/babel-helper-vue-transform-on@1.1.5: @@ -2207,11 +2215,11 @@ packages: source-map-js: 1.0.2 dev: true - /@vue/compiler-core@3.4.15: - resolution: {integrity: sha512-XcJQVOaxTKCnth1vCxEChteGuwG6wqnUHxAm1DO3gCz0+uXKaJNx8/digSz4dLALCy8n2lKq24jSUs8segoqIw==} + /@vue/compiler-core@3.4.19: + resolution: {integrity: sha512-gj81785z0JNzRcU0Mq98E56e4ltO1yf8k5PQ+tV/7YHnbZkrM0fyFyuttnN8ngJZjbpofWE/m4qjKBiLl8Ju4w==} dependencies: - '@babel/parser': 7.23.6 - '@vue/shared': 3.4.15 + '@babel/parser': 7.23.9 + '@vue/shared': 3.4.19 entities: 4.5.0 estree-walker: 2.0.2 source-map-js: 1.0.2 @@ -2230,11 +2238,11 @@ packages: '@vue/shared': 3.3.8 dev: true - /@vue/compiler-dom@3.4.15: - resolution: {integrity: sha512-wox0aasVV74zoXyblarOM3AZQz/Z+OunYcIHe1OsGclCHt8RsRm04DObjefaI82u6XDzv+qGWZ24tIsRAIi5MQ==} + /@vue/compiler-dom@3.4.19: + resolution: {integrity: sha512-vm6+cogWrshjqEHTzIDCp72DKtea8Ry/QVpQRYoyTIg9k7QZDX6D8+HGURjtmatfgM8xgCFtJJaOlCaRYRK3QA==} dependencies: - '@vue/compiler-core': 3.4.15 - '@vue/shared': 3.4.15 + '@vue/compiler-core': 3.4.19 + '@vue/shared': 3.4.19 /@vue/compiler-sfc@3.3.8: resolution: {integrity: sha512-WMzbUrlTjfYF8joyT84HfwwXo+8WPALuPxhy+BZ6R4Aafls+jDBnSz8PDz60uFhuqFbl3HxRfxvDzrUf3THwpA==} @@ -2251,17 +2259,17 @@ packages: source-map-js: 1.0.2 dev: true - /@vue/compiler-sfc@3.4.15: - resolution: {integrity: sha512-LCn5M6QpkpFsh3GQvs2mJUOAlBQcCco8D60Bcqmf3O3w5a+KWS5GvYbrrJBkgvL1BDnTp+e8q0lXCLgHhKguBA==} + /@vue/compiler-sfc@3.4.19: + resolution: {integrity: sha512-LQ3U4SN0DlvV0xhr1lUsgLCYlwQfUfetyPxkKYu7dkfvx7g3ojrGAkw0AERLOKYXuAGnqFsEuytkdcComei3Yg==} dependencies: - '@babel/parser': 7.23.6 - '@vue/compiler-core': 3.4.15 - '@vue/compiler-dom': 3.4.15 - '@vue/compiler-ssr': 3.4.15 - '@vue/shared': 3.4.15 + '@babel/parser': 7.23.9 + '@vue/compiler-core': 3.4.19 + '@vue/compiler-dom': 3.4.19 + '@vue/compiler-ssr': 3.4.19 + '@vue/shared': 3.4.19 estree-walker: 2.0.2 - magic-string: 0.30.5 - postcss: 8.4.33 + magic-string: 0.30.7 + postcss: 8.4.35 source-map-js: 1.0.2 /@vue/compiler-ssr@3.3.8: @@ -2271,11 +2279,11 @@ packages: '@vue/shared': 3.3.8 dev: true - /@vue/compiler-ssr@3.4.15: - resolution: {integrity: sha512-1jdeQyiGznr8gjFDadVmOJqZiLNSsMa5ZgqavkPZ8O2wjHv0tVuAEsw5hTdUoUW4232vpBbL/wJhzVW/JwY1Uw==} + /@vue/compiler-ssr@3.4.19: + resolution: {integrity: sha512-P0PLKC4+u4OMJ8sinba/5Z/iDT84uMRRlrWzadgLA69opCpI1gG4N55qDSC+dedwq2fJtzmGald05LWR5TFfLw==} dependencies: - '@vue/compiler-dom': 3.4.15 - '@vue/shared': 3.4.15 + '@vue/compiler-dom': 3.4.19 + '@vue/shared': 3.4.19 /@vue/devtools-api@6.5.1: resolution: {integrity: sha512-+KpckaAQyfbvshdDW5xQylLni1asvNSGme1JFs8I1+/H5pHEhqUKMEQD/qn3Nx5+/nycBq11qAEi8lk+LXI2dA==} @@ -2350,32 +2358,32 @@ packages: '@vue/shared': 3.3.8 dev: true - /@vue/reactivity@3.4.15: - resolution: {integrity: sha512-55yJh2bsff20K5O84MxSvXKPHHt17I2EomHznvFiJCAZpJTNW8IuLj1xZWMLELRhBK3kkFV/1ErZGHJfah7i7w==} + /@vue/reactivity@3.4.19: + resolution: {integrity: sha512-+VcwrQvLZgEclGZRHx4O2XhyEEcKaBi50WbxdVItEezUf4fqRh838Ix6amWTdX0CNb/b6t3Gkz3eOebfcSt+UA==} dependencies: - '@vue/shared': 3.4.15 + '@vue/shared': 3.4.19 - /@vue/runtime-core@3.4.15: - resolution: {integrity: sha512-6E3by5m6v1AkW0McCeAyhHTw+3y17YCOKG0U0HDKDscV4Hs0kgNT5G+GCHak16jKgcCDHpI9xe5NKb8sdLCLdw==} + /@vue/runtime-core@3.4.19: + resolution: {integrity: sha512-/Z3tFwOrerJB/oyutmJGoYbuoadphDcJAd5jOuJE86THNZji9pYjZroQ2NFsZkTxOq0GJbb+s2kxTYToDiyZzw==} dependencies: - '@vue/reactivity': 3.4.15 - '@vue/shared': 3.4.15 + '@vue/reactivity': 3.4.19 + '@vue/shared': 3.4.19 - /@vue/runtime-dom@3.4.15: - resolution: {integrity: sha512-EVW8D6vfFVq3V/yDKNPBFkZKGMFSvZrUQmx196o/v2tHKdwWdiZjYUBS+0Ez3+ohRyF8Njwy/6FH5gYJ75liUw==} + /@vue/runtime-dom@3.4.19: + resolution: {integrity: sha512-IyZzIDqfNCF0OyZOauL+F4yzjMPN2rPd8nhqPP2N1lBn3kYqJpPHHru+83Rkvo2lHz5mW+rEeIMEF9qY3PB94g==} dependencies: - '@vue/runtime-core': 3.4.15 - '@vue/shared': 3.4.15 + '@vue/runtime-core': 3.4.19 + '@vue/shared': 3.4.19 csstype: 3.1.3 - /@vue/server-renderer@3.4.15(vue@3.4.15): - resolution: {integrity: sha512-3HYzaidu9cHjrT+qGUuDhFYvF/j643bHC6uUN9BgM11DVy+pM6ATsG6uPBLnkwOgs7BpJABReLmpL3ZPAsUaqw==} + /@vue/server-renderer@3.4.19(vue@3.4.19): + resolution: {integrity: sha512-eAj2p0c429RZyyhtMRnttjcSToch+kTWxFPHlzGMkR28ZbF1PDlTcmGmlDxccBuqNd9iOQ7xPRPAGgPVj+YpQw==} peerDependencies: - vue: 3.4.15 + vue: 3.4.19 dependencies: - '@vue/compiler-ssr': 3.4.15 - '@vue/shared': 3.4.15 - vue: 3.4.15(typescript@5.2.2) + '@vue/compiler-ssr': 3.4.19 + '@vue/shared': 3.4.19 + vue: 3.4.19(typescript@5.2.2) /@vue/shared@3.3.13: resolution: {integrity: sha512-/zYUwiHD8j7gKx2argXEMCUXVST6q/21DFU0sTfNX0URJroCe3b1UF6vLJ3lQDfLNIiiRl2ONp7Nh5UVWS6QnA==} @@ -2385,8 +2393,8 @@ packages: resolution: {integrity: sha512-8PGwybFwM4x8pcfgqEQFy70NaQxASvOC5DJwLQfpArw1UDfUXrJkdxD3BhVTMS+0Lef/TU7YO0Jvr0jJY8T+mw==} dev: true - /@vue/shared@3.4.15: - resolution: {integrity: sha512-KzfPTxVaWfB+eGcGdbSf4CWdaXcGDqckoeXUh7SB3fZdEtzPCK2Vq9B/lRRL3yutax/LWITz+SwvgyOxz5V75g==} + /@vue/shared@3.4.19: + resolution: {integrity: sha512-/KliRRHMF6LoiThEy+4c1Z4KB/gbPrGjWwJR+crg2otgrf/egKzRaCPvJ51S5oetgsgXLfc4Rm5ZgrKHZrtMSw==} /@vue/typescript@1.8.8(typescript@5.2.2): resolution: {integrity: sha512-jUnmMB6egu5wl342eaUH236v8tdcEPXXkPgj+eI/F6JwW/lb+yAU6U07ZbQ3MVabZRlupIlPESB7ajgAGixhow==} @@ -2397,13 +2405,13 @@ packages: - typescript dev: true - /@vueuse/core@10.7.1(vue@3.4.15): + /@vueuse/core@10.7.1(vue@3.4.19): resolution: {integrity: sha512-74mWHlaesJSWGp1ihg76vAnfVq9NTv1YT0SYhAQ6zwFNdBkkP+CKKJmVOEHcdSnLXCXYiL5e7MaewblfiYLP7g==} dependencies: '@types/web-bluetooth': 0.0.20 '@vueuse/metadata': 10.7.1 - '@vueuse/shared': 10.7.1(vue@3.4.15) - vue-demi: 0.14.6(vue@3.4.15) + '@vueuse/shared': 10.7.1(vue@3.4.19) + vue-demi: 0.14.6(vue@3.4.19) transitivePeerDependencies: - '@vue/composition-api' - vue @@ -2411,10 +2419,10 @@ packages: /@vueuse/metadata@10.7.1: resolution: {integrity: sha512-jX8MbX5UX067DYVsbtrmKn6eG6KMcXxLRLlurGkZku5ZYT3vxgBjui2zajvUZ18QLIjrgBkFRsu7CqTAg18QFw==} - /@vueuse/shared@10.7.1(vue@3.4.15): + /@vueuse/shared@10.7.1(vue@3.4.19): resolution: {integrity: sha512-v0jbRR31LSgRY/C5i5X279A/WQjD6/JsMzGa+eqt658oJ75IvQXAeONmwvEMrvJQKnRElq/frzBR7fhmWY5uLw==} dependencies: - vue-demi: 0.14.6(vue@3.4.15) + vue-demi: 0.14.6(vue@3.4.19) transitivePeerDependencies: - '@vue/composition-api' - vue @@ -5718,6 +5726,13 @@ packages: engines: {node: '>=12'} dependencies: '@jridgewell/sourcemap-codec': 1.4.15 + dev: true + + /magic-string@0.30.7: + resolution: {integrity: sha512-8vBuFF/I/+OSLRmdf2wwFCJCz+nSn0m6DPvGH1fS/KiQoSaR+sETbov0eIk9KhEKy8CYqIkIAnbohxT/4H0kuA==} + engines: {node: '>=12'} + dependencies: + '@jridgewell/sourcemap-codec': 1.4.15 /make-dir@3.1.0: resolution: {integrity: sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==} @@ -5978,13 +5993,13 @@ packages: minimatch: 3.1.2 dev: true - /naive-ui@2.37.3(vue@3.4.15): + /naive-ui@2.37.3(vue@3.4.19): resolution: {integrity: sha512-aUkHFXVIluSi8Me+npbcsdv1NYhVMj5t9YaruoCESlqmfqspj+R2QHEVXkTtUI1kQwVrABMCtAGq/wountqjZA==} peerDependencies: vue: ^3.0.0 dependencies: '@css-render/plugin-bem': 0.15.12(css-render@0.15.12) - '@css-render/vue3-ssr': 0.15.12(vue@3.4.15) + '@css-render/vue3-ssr': 0.15.12(vue@3.4.19) '@types/katex': 0.16.7 '@types/lodash': 4.14.202 '@types/lodash-es': 4.17.11 @@ -5999,10 +6014,10 @@ packages: lodash-es: 4.17.21 seemly: 0.3.8 treemate: 0.3.11 - vdirs: 0.1.8(vue@3.4.15) - vooks: 0.2.12(vue@3.4.15) - vue: 3.4.15(typescript@5.2.2) - vueuc: 0.4.58(vue@3.4.15) + vdirs: 0.1.8(vue@3.4.19) + vooks: 0.2.12(vue@3.4.19) + vue: 3.4.19(typescript@5.2.2) + vueuc: 0.4.58(vue@3.4.19) dev: false /nan@2.17.0: @@ -6389,10 +6404,10 @@ packages: peerDependencies: pinia: ^2.0.0 dependencies: - pinia: 2.1.7(typescript@5.2.2)(vue@3.4.15) + pinia: 2.1.7(typescript@5.2.2)(vue@3.4.19) dev: false - /pinia@2.1.7(typescript@5.2.2)(vue@3.4.15): + /pinia@2.1.7(typescript@5.2.2)(vue@3.4.19): resolution: {integrity: sha512-+C2AHFtcFqjPih0zpYuvof37SFxMQ7OEG2zV9jRI12i9BOy3YQVAHwdKtyyc8pDcDyIc33WCIsZaCFWU7WWxGQ==} peerDependencies: '@vue/composition-api': ^1.4.0 @@ -6406,8 +6421,8 @@ packages: dependencies: '@vue/devtools-api': 6.5.1 typescript: 5.2.2 - vue: 3.4.15(typescript@5.2.2) - vue-demi: 0.14.6(vue@3.4.15) + vue: 3.4.19(typescript@5.2.2) + vue-demi: 0.14.6(vue@3.4.19) dev: false /pkg-types@1.0.3: @@ -6474,8 +6489,8 @@ packages: source-map-js: 1.0.2 dev: true - /postcss@8.4.33: - resolution: {integrity: sha512-Kkpbhhdjw2qQs2O2DGX+8m5OVqEcbB9HRBvuYM9pgrjEFUg30A9LmXNlTAUj4S9kgtGyrMbTzVjH7E+s5Re2yg==} + /postcss@8.4.35: + resolution: {integrity: sha512-u5U8qYpBCpN13BsiEB0CbR1Hhh4Gc0zLFuedrHJKMctHCHAGrMdG0PRM/KErzAL3CU6/eckEtmHNB3x6e3c0vA==} engines: {node: ^10 || ^12 || >=14} dependencies: nanoid: 3.3.7 @@ -7680,7 +7695,7 @@ packages: dependencies: '@antfu/utils': 0.7.6 '@rollup/pluginutils': 5.0.4 - '@vueuse/core': 10.7.1(vue@3.4.15) + '@vueuse/core': 10.7.1(vue@3.4.19) fast-glob: 3.3.1 local-pkg: 0.4.3 magic-string: 0.30.5 @@ -7691,7 +7706,7 @@ packages: - rollup dev: true - /unplugin-vue-components@0.25.2(vue@3.4.15): + /unplugin-vue-components@0.25.2(vue@3.4.19): resolution: {integrity: sha512-OVmLFqILH6w+eM8fyt/d/eoJT9A6WO51NZLf1vC5c1FZ4rmq2bbGxTy8WP2Jm7xwFdukaIdv819+UI7RClPyCA==} engines: {node: '>=14'} peerDependencies: @@ -7714,7 +7729,7 @@ packages: minimatch: 9.0.3 resolve: 1.22.5 unplugin: 1.4.0 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) transitivePeerDependencies: - rollup - supports-color @@ -7805,13 +7820,13 @@ packages: engines: {node: '>= 0.8'} dev: true - /vdirs@0.1.8(vue@3.4.15): + /vdirs@0.1.8(vue@3.4.19): resolution: {integrity: sha512-H9V1zGRLQZg9b+GdMk8MXDN2Lva0zx72MPahDKc30v+DtwKjfyOSXWRIX4t2mhDubM1H09gPhWeth/BJWPHGUw==} peerDependencies: vue: ^3.0.11 dependencies: evtd: 0.2.4 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) dev: false /vite-plugin-cdn2@0.15.2: @@ -7827,7 +7842,7 @@ packages: - supports-color dev: true - /vite-plugin-compression@0.5.1(vite@5.0.11): + /vite-plugin-compression@0.5.1(vite@5.1.3): resolution: {integrity: sha512-5QJKBDc+gNYVqL/skgFAP81Yuzo9R+EAf19d+EtsMF/i8kFUpNi3J/H01QD3Oo8zBQn+NzoCIFkpPLynoOzaJg==} peerDependencies: vite: '>=2.0.0' @@ -7835,21 +7850,21 @@ packages: chalk: 4.1.2 debug: 4.3.4 fs-extra: 10.1.0 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) transitivePeerDependencies: - supports-color dev: true - /vite-plugin-ejs@1.7.0(vite@5.0.11): + /vite-plugin-ejs@1.7.0(vite@5.1.3): resolution: {integrity: sha512-JNP3zQDC4mSbfoJ3G73s5mmZITD8NGjUmLkq4swxyahy/W0xuokK9U9IJGXw7KCggq6UucT6hJ0p+tQrNtqTZw==} peerDependencies: vite: '>=5.0.0' dependencies: ejs: 3.1.9 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) dev: true - /vite-plugin-eslint@1.8.1(eslint@8.52.0)(vite@5.0.11): + /vite-plugin-eslint@1.8.1(eslint@8.52.0)(vite@5.1.3): resolution: {integrity: sha512-PqdMf3Y2fLO9FsNPmMX+//2BF5SF8nEWspZdgl4kSt7UvHDRHVVfHvxsD7ULYzZrJDGRxR81Nq7TOFgwMnUang==} peerDependencies: eslint: '>=7' @@ -7859,10 +7874,10 @@ packages: '@types/eslint': 8.44.2 eslint: 8.52.0 rollup: 2.79.1 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) dev: true - /vite-plugin-imp@2.4.0(vite@5.0.11): + /vite-plugin-imp@2.4.0(vite@5.1.3): resolution: {integrity: sha512-L/6/nvOw+MyNh4UxAlCZHsmKd5MitmHamqqAWB15sbUgVIEz/OQ8jpKr6kkQU0eA/AIe8fkCVbQBlP81ajrqWg==} peerDependencies: vite: '>= 2.0.0-beta.5' @@ -7874,12 +7889,12 @@ packages: chalk: 4.1.2 param-case: 3.0.4 pascal-case: 3.1.2 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) transitivePeerDependencies: - supports-color dev: true - /vite-plugin-inspect@0.7.38(vite@5.0.11): + /vite-plugin-inspect@0.7.38(vite@5.1.3): resolution: {integrity: sha512-+p6pJVtBOLGv+RBrcKAFUdx+euizg0bjL35HhPyM0MjtKlqoC5V9xkCmO9Ctc8JrTyXqODbHqiLWJKumu5zJ7g==} engines: {node: '>=14'} peerDependencies: @@ -7897,13 +7912,13 @@ packages: open: 9.1.0 picocolors: 1.0.0 sirv: 2.0.3 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) transitivePeerDependencies: - rollup - supports-color dev: true - /vite-plugin-mock-dev-server@1.3.4(vite@5.0.11): + /vite-plugin-mock-dev-server@1.3.4(vite@5.1.3): resolution: {integrity: sha512-50biXarRPdKYxR/q9an4vHMh2cbwFlEWHfLJdXg6gpS63CMMrCo9XQWYIkdytZNSEs/5AwykGB5Xo0ORMMttgQ==} engines: {node: ^14.18.0 || >=16} peerDependencies: @@ -7924,7 +7939,7 @@ packages: mime-types: 2.1.35 path-to-regexp: 6.2.1 picocolors: 1.0.0 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) ws: 8.13.0 transitivePeerDependencies: - bufferutil @@ -7932,7 +7947,7 @@ packages: - utf-8-validate dev: true - /vite-plugin-svg-icons@2.0.1(vite@5.0.11): + /vite-plugin-svg-icons@2.0.1(vite@5.1.3): resolution: {integrity: sha512-6ktD+DhV6Rz3VtedYvBKKVA2eXF+sAQVaKkKLDSqGUfnhqXl3bj5PPkVTl3VexfTuZy66PmINi8Q6eFnVfRUmA==} peerDependencies: vite: '>=2.0.0' @@ -7945,7 +7960,7 @@ packages: pathe: 0.2.0 svg-baker: 1.7.0 svgo: 2.8.0 - vite: 5.0.11(@types/node@20.4.7)(sass@1.69.5) + vite: 5.1.3(@types/node@20.4.7)(sass@1.69.5) transitivePeerDependencies: - supports-color dev: true @@ -7957,8 +7972,8 @@ packages: svgo: 3.0.2 dev: true - /vite@5.0.11(@types/node@20.4.7)(sass@1.69.5): - resolution: {integrity: sha512-XBMnDjZcNAw/G1gEiskiM1v6yzM4GE5aMGvhWTlHAYYhxb7S3/V1s3m2LDHa8Vh6yIWYYB0iJwsEaS523c4oYA==} + /vite@5.1.3(@types/node@20.4.7)(sass@1.69.5): + resolution: {integrity: sha512-UfmUD36DKkqhi/F75RrxvPpry+9+tTkrXfMNZD+SboZqBCMsxKtO52XeGzzuh7ioz+Eo/SYDBbdb0Z7vgcDJew==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: @@ -7987,23 +8002,23 @@ packages: dependencies: '@types/node': 20.4.7 esbuild: 0.19.10 - postcss: 8.4.33 + postcss: 8.4.35 rollup: 4.9.1 sass: 1.69.5 optionalDependencies: fsevents: 2.3.3 dev: true - /vooks@0.2.12(vue@3.4.15): + /vooks@0.2.12(vue@3.4.19): resolution: {integrity: sha512-iox0I3RZzxtKlcgYaStQYKEzWWGAduMmq+jS7OrNdQo1FgGfPMubGL3uGHOU9n97NIvfFDBGnpSvkWyb/NSn/Q==} peerDependencies: vue: ^3.0.0 dependencies: evtd: 0.2.4 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) dev: false - /vue-demi@0.14.6(vue@3.4.15): + /vue-demi@0.14.6(vue@3.4.19): resolution: {integrity: sha512-8QA7wrYSHKaYgUxDA5ZC24w+eHm3sYCbp0EzcDwKqN3p6HqtTCGR/GVsPyZW92unff4UlcSh++lmqDWN3ZIq4w==} engines: {node: '>=12'} hasBin: true @@ -8015,7 +8030,7 @@ packages: '@vue/composition-api': optional: true dependencies: - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) /vue-eslint-parser@9.3.1(eslint@8.52.0): resolution: {integrity: sha512-Clr85iD2XFZ3lJ52/ppmUDG/spxQu6+MAeHXjjyI4I1NUYZ9xmenQp4N0oaHJhrA8OOxltCVxMRfANGa70vU0g==} @@ -8035,7 +8050,7 @@ packages: - supports-color dev: true - /vue-hooks-plus@1.8.5(vue@3.4.15): + /vue-hooks-plus@1.8.5(vue@3.4.19): resolution: {integrity: sha512-cIatTWz6QQcoSCDn7jadQ3zMr799FmNiHyb59yUvR7Ws5KDJ/KdIMHHx/b0XDKzbGhQ61kcJ78zJKAKhOV0pWw==} peerDependencies: vue: ^3.2.25 @@ -8047,9 +8062,9 @@ packages: qs: 6.11.2 query-string: 7.1.3 screenfull: 5.2.0 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) - /vue-i18n@9.9.0(vue@3.4.15): + /vue-i18n@9.9.0(vue@3.4.19): resolution: {integrity: sha512-xQ5SxszUAqK5n84N+uUyHH/PiQl9xZ24FOxyAaNonmOQgXeN+rD9z/6DStOpOxNFQn4Cgcquot05gZc+CdOujA==} engines: {node: '>= 16'} peerDependencies: @@ -8058,15 +8073,15 @@ packages: '@intlify/core-base': 9.9.0 '@intlify/shared': 9.9.0 '@vue/devtools-api': 6.5.1 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) - /vue-router@4.2.5(vue@3.4.15): + /vue-router@4.2.5(vue@3.4.19): resolution: {integrity: sha512-DIUpKcyg4+PTQKfFPX88UWhlagBEBEfJ5A8XDXRJLUnZOvcpMF8o/dnL90vpVkGaPbjvXazV/rC1qBKrZlFugw==} peerDependencies: vue: ^3.2.0 dependencies: '@vue/devtools-api': 6.5.1 - vue: 3.4.15(typescript@5.2.2) + vue: 3.4.19(typescript@5.2.2) dev: false /vue-template-compiler@2.7.14: @@ -8088,34 +8103,34 @@ packages: typescript: 5.2.2 dev: true - /vue@3.4.15(typescript@5.2.2): - resolution: {integrity: sha512-jC0GH4KkWLWJOEQjOpkqU1bQsBwf4R1rsFtw5GQJbjHVKWDzO6P0nWWBTmjp1xSemAioDFj1jdaK1qa3DnMQoQ==} + /vue@3.4.19(typescript@5.2.2): + resolution: {integrity: sha512-W/7Fc9KUkajFU8dBeDluM4sRGc/aa4YJnOYck8dkjgZoXtVsn3OeTGni66FV1l3+nvPA7VBFYtPioaGKUmEADw==} peerDependencies: typescript: '*' peerDependenciesMeta: typescript: optional: true dependencies: - '@vue/compiler-dom': 3.4.15 - '@vue/compiler-sfc': 3.4.15 - '@vue/runtime-dom': 3.4.15 - '@vue/server-renderer': 3.4.15(vue@3.4.15) - '@vue/shared': 3.4.15 + '@vue/compiler-dom': 3.4.19 + '@vue/compiler-sfc': 3.4.19 + '@vue/runtime-dom': 3.4.19 + '@vue/server-renderer': 3.4.19(vue@3.4.19) + '@vue/shared': 3.4.19 typescript: 5.2.2 - /vueuc@0.4.58(vue@3.4.15): + /vueuc@0.4.58(vue@3.4.19): resolution: {integrity: sha512-Wnj/N8WbPRSxSt+9ji1jtDHPzda5h2OH/0sFBhvdxDRuyCZbjGg3/cKMaKqEoe+dErTexG2R+i6Q8S/Toq1MYg==} peerDependencies: vue: ^3.0.11 dependencies: - '@css-render/vue3-ssr': 0.15.12(vue@3.4.15) + '@css-render/vue3-ssr': 0.15.12(vue@3.4.19) '@juggle/resize-observer': 3.4.0 css-render: 0.15.12 evtd: 0.2.4 seemly: 0.3.8 - vdirs: 0.1.8(vue@3.4.15) - vooks: 0.2.12(vue@3.4.15) - vue: 3.4.15(typescript@5.2.2) + vdirs: 0.1.8(vue@3.4.19) + vooks: 0.2.12(vue@3.4.19) + vue: 3.4.19(typescript@5.2.2) dev: false /webidl-conversions@3.0.1: diff --git a/src/__ray-template/README.md b/src/__ray-template/README.md new file mode 100644 index 00000000..9f4c4c11 --- /dev/null +++ b/src/__ray-template/README.md @@ -0,0 +1,6 @@ +# \_\_ray-template + +该包用于管理一些模板的管理，例如： + +- validAppRootPath: 检查模板 `appRootPath` 是否配置正确 +- validLocal: 检查模板 `localConfig` 是否配置正确 diff --git a/src/__ray-template/index.ts b/src/__ray-template/index.ts new file mode 100644 index 00000000..52587298 --- /dev/null +++ b/src/__ray-template/index.ts @@ -0,0 +1,2 @@ +export * from './valid/validAppRootPath' +export * from './valid/validLocal' diff --git a/src/__ray-template/valid/validAppRootPath.ts b/src/__ray-template/valid/validAppRootPath.ts new file mode 100644 index 00000000..4596efa4 --- /dev/null +++ b/src/__ray-template/valid/validAppRootPath.ts @@ -0,0 +1,28 @@ +import { useSettingGetters } from '@/store' +import { useVueRouter } from '@/hooks' + +/** + * + * @description + * 检查 appRootRoute.path 是否存配置正确。如果配置错误，将抛出错误。 + * + * 如果配置错误可以检查: [src/store/modules/setting/index.ts] 中的 appRootRoute 配置。 + * + * 该方法会通过调用 getRoutes 方法获取所有路由，也就意味着检查的路由格式是铺开之后的格式。当你的路由是嵌套路由时，需要注意检查完整的路径。 + */ +export const validAppRootPath = async () => { + const { getAppRootRoute } = useSettingGetters() + const { + router: { getRoutes }, + } = useVueRouter() + + const find = getRoutes().find( + (curr) => curr.path === getAppRootRoute.value.path, + ) + + if (!find) { + throw new Error( + `[validAppRootPath]: 'store setting appRootRoute path: ' '${getAppRootRoute.value.path}' not found in router, please check the 'appRootRoute' setting in the store setting module.`, + ) + } +} diff --git a/src/__ray-template/valid/validLocal.ts b/src/__ray-template/valid/validLocal.ts new file mode 100644 index 00000000..7c3fab9a --- /dev/null +++ b/src/__ray-template/valid/validLocal.ts @@ -0,0 +1,99 @@ +import { + LOCAL_OPTIONS, + SYSTEM_DEFAULT_LOCAL, + SYSTEM_FALLBACK_LOCALE, + DAYJS_LOCAL_MAP, + DEFAULT_DAYJS_LOCAL, +} from '@/app-config' + +/** + * + * @description + * 获取所有的 LOCAL_OPTIONS 的 key。 + */ +const getLocalOptionKeys = () => { + return LOCAL_OPTIONS.map((curr) => curr.key) +} + +/** + * + * @description + * 验证 SYSTEM_DEFAULT_LOCAL 是否在 LOCAL_OPTIONS 中。 + */ +const validSystemDefaultLocal = () => { + const localOptionKeys = getLocalOptionKeys() + + if (!localOptionKeys.includes(SYSTEM_DEFAULT_LOCAL)) { + throw new Error( + `[validLocal validSystemDefaultLocal:] SYSTEM_DEFAULT_LOCAL: '${SYSTEM_DEFAULT_LOCAL}' is not in LOCAL_OPTIONS: [${localOptionKeys.join( + ', ', + )}]`, + ) + } +} + +/** + * + * @description + * 验证 SYSTEM_FALLBACK_LOCALE 是否在 LOCAL_OPTIONS 中。 + */ +const validSystemFallbackLocale = () => { + const localOptionKeys = getLocalOptionKeys() + + if (!localOptionKeys.includes(SYSTEM_FALLBACK_LOCALE)) { + throw new Error( + `[validLocal validSystemFallbackLocale:] SYSTEM_FALLBACK_LOCALE: '${SYSTEM_FALLBACK_LOCALE}' is not in LOCAL_OPTIONS: [${localOptionKeys.join( + ', ', + )}]`, + ) + } +} + +/** + * + * @description + * 验证 DAYJS_LOCAL_MAP 是否在 LOCAL_OPTIONS 中。 + */ +const validDayjsLocalMap = () => { + const localOptionKeys = getLocalOptionKeys() as string[] + const dayjsLocalKeys = Object.keys(DAYJS_LOCAL_MAP) + + dayjsLocalKeys.forEach((key) => { + if (!localOptionKeys.includes(key)) { + throw new Error( + `[validLocal validDayjsLocalMap:] DAYJS_LOCAL_MAP: '${key}' is not in LOCAL_OPTIONS: [${localOptionKeys.join( + ', ', + )}]`, + ) + } + }) +} + +/** + * + * @description + * 验证 DEFAULT_DAYJS_LOCAL 是否在 DAYJS_LOCAL_MAP 中。 + */ +const validDefaultDayjsLocal = () => { + const dayjsLocalKeys = Object.values(DAYJS_LOCAL_MAP) + + if (!dayjsLocalKeys.includes(DEFAULT_DAYJS_LOCAL)) { + throw new Error( + `[validLocal validDefaultDayjsLocal:] DEFAULT_DAYJS_LOCAL: '${DEFAULT_DAYJS_LOCAL}' is not in DAYJS_LOCAL_MAP: [${dayjsLocalKeys.join( + ', ', + )}]`, + ) + } +} + +/** + * + * @description + * 验证所有的 localConfig 相关的配置。 + */ +export const validLocal = async () => { + validSystemDefaultLocal() + validSystemFallbackLocale() + validDayjsLocalMap() + validDefaultDayjsLocal() +} diff --git a/src/axios/index.ts b/src/axios/index.ts index c1741f44..80ab8cbb 100644 --- a/src/axios/index.ts +++ b/src/axios/index.ts @@ -33,8 +33,8 @@ import type { AppRawRequestConfig } from '@/axios/type' * @param option useRequest 配置项 * * @description - * 该方法有一定的局限性，仅可在 effect 作用域中使用 - * 如果在非 vue effect scope 中使用，会抛出一些警告 + * 该方法有一定的局限性，仅可在 effect 作用域中使用， + * 如果在非 vue effect scope 中使用，会抛出一些警告。 * * @example * // 请求函数 diff --git a/src/components/RChart/src/helper.ts b/src/components/RChart/src/helper.ts index da5ce678..388b6def 100644 --- a/src/components/RChart/src/helper.ts +++ b/src/components/RChart/src/helper.ts @@ -17,6 +17,7 @@ import type { /** * + * @description * 自动注册所有主题 * * 默认以文件名当作主题名称 @@ -26,7 +27,7 @@ import type { * 1. 配置、选择主题 * 2. 点击下载主题 * 3. 选择 json 类型，然后复制 - * 4. 在 @/echart-themes 包中创建对应的 json 文件，文件名为主题名称 + * 4. 在 echart-themes 包中创建对应的 json 文件，文件名为主题名称 */ export const setupChartTheme = () => { // 获取所有主题 @@ -47,7 +48,7 @@ export const setupChartTheme = () => { return pre } else { - throw new Error('theme name is not found') + throw new Error(`[RChart Theme Error]: name ${curr} is invalid!`) } }, [] as ChartThemeRawArray[]) @@ -56,8 +57,7 @@ export const setupChartTheme = () => { /** * - * @returns LoadingOptions - * + * @description * 为了方便使用加载动画, 写了此方法, 虽然没啥用 */ export const loadingOptions = (options?: LoadingOptions) => diff --git a/src/components/RChart/src/index.tsx b/src/components/RChart/src/index.tsx index e8a910bc..4ed47e6d 100644 --- a/src/components/RChart/src/index.tsx +++ b/src/components/RChart/src/index.tsx @@ -1,19 +1,3 @@ -/** - * - * 基于 `echarts` 的组件. 意在便捷的使用 `chart` 图 - * - * 暂时不支持自动解析导入 `chart` 组件, 如果使用未注册的组件, 需要在顶部手动导入并且再使用 `use` 注册 - * - * 预引入: 柱状图, 折线图, 饼图, k线图, 散点图等 - * 预引入: 提示框, 标题, 直角坐标系, 数据集, 内置数据转换器等 - * - * 如果需要大批量数据渲染, 可以通过获取实例后阶段性调用 `setOption` 方法注入数据 - * - * 该组件会在卸载组件时, 自动释放资源 - * - * 注意: 尽量别一次性倒入全部 `chart` 会造成打包体积异常大 - */ - import './index.scss' import * as echarts from 'echarts/core' // `echarts` 核心模块 @@ -63,6 +47,31 @@ const defaultChartOptions = { } const echartThemes = setupChartTheme() +/** 注册主题 */ +echartThemes.forEach((curr) => { + echarts.registerTheme(curr.name, curr.theme) +}) + +/** + * + * @description + * 基于 echarts 的图表组件。 + * + * 让你仅需要关注 echarts options 的配置管理，而不需要关心 echarts 的初始化、销毁、主题切换等操作。 + * + * 如果需要拓展配置项，进需要在使用该组件的时候使用 use 方法注册对应 chart 组件即可。 + * + * @example + * + * + *