jiangyc/ruoyi-plus-soybean
1
0
Fork 0
mirror of https://github.com/m-xlsea/ruoyi-plus-soybean.git synced 2025-09-24 07:49:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

style(projects): format code

Browse Source
This commit is contained in:
Soybean
2023-12-14 21:45:29 +08:00
parent a176dc443e
commit a748166399
127 changed files with 2472 additions and 3006 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
src/store/modules/route/index.ts
View File

@ -1,25 +1,25 @@
import { ref, computed } from 'vue';
import { computed, ref } from 'vue';
import type { RouteRecordRaw } from 'vue-router';
import { defineStore } from 'pinia';
import { useBoolean } from '@sa/hooks';
import type { ElegantConstRoute, CustomRoute, RouteKey, LastLevelRouteKey, RouteMap } from '@elegant-router/types';
import type { CustomRoute, ElegantConstRoute, LastLevelRouteKey, RouteKey, RouteMap } from '@elegant-router/types';
import { SetupStoreId } from '@/enum';
import { router } from '@/router';
import { createRoutes, getAuthVueRoutes, ROOT_ROUTE } from '@/router/routes';
import { getRoutePath, getRouteName } from '@/router/elegant/transform';
import { ROOT_ROUTE, createRoutes, getAuthVueRoutes } from '@/router/routes';
import { getRouteName, getRoutePath } from '@/router/elegant/transform';
import { fetchGetUserRoutes, fetchIsRouteExist } from '@/service/api';
import {
filterAuthRoutesByRoles,
getGlobalMenusByAuthRoutes,
updateLocaleOfGlobalMenus,
getCacheRouteNames,
isRouteExistByRouteName,
getSelectedMenuKeyPathByKey,
getBreadcrumbsByRoute
} from './shared';
import { useAppStore } from '../app';
import { useAuthStore } from '../auth';
import { useTabStore } from '../tab';
import {
filterAuthRoutesByRoles,
getBreadcrumbsByRoute,
getCacheRouteNames,
getGlobalMenusByAuthRoutes,
getSelectedMenuKeyPathByKey,
isRouteExistByRouteName,
updateLocaleOfGlobalMenus
} from './shared';
export const useRouteStore = defineStore(SetupStoreId.Route, () => {
const appStore = useAppStore();
@ -29,52 +29,46 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
const removeRouteFns: (() => void)[] = [];
/**
* auth route mode
* @description it recommends to use static mode in the development environment, and use dynamic mode in the production environment,
* if use static mode in development environment, the auth routes will be auto generated by plugin "@elegant-router/vue"
* Auth route mode
*
* It recommends to use static mode in the development environment, and use dynamic mode in the production
* environment, if use static mode in development environment, the auth routes will be auto generated by plugin
* "@elegant-router/vue"
*/
const authRouteMode = ref(import.meta.env.VITE_AUTH_ROUTE_MODE);
/**
* home route key
*/
/** Home route key */
const routeHome = ref(import.meta.env.VITE_ROUTE_HOME);
/**
* set route home
* @param routeKey route key
* Set route home
*
* @param routeKey Route key
*/
function setRouteHome(routeKey: LastLevelRouteKey) {
routeHome.value = routeKey;
}
/**
* global menus
*/
/** Global menus */
const menus = ref<App.Global.Menu[]>([]);
/**
* get global menus
*/
/** Get global menus */
function getGlobalMenus(routes: ElegantConstRoute[]) {
menus.value = getGlobalMenusByAuthRoutes(routes);
}
/**
* update global menus by locale
*/
/** Update global menus by locale */
function updateGlobalMenusByLocale() {
menus.value = updateLocaleOfGlobalMenus(menus.value);
}
/**
* cache routes
*/
/** Cache routes */
const cacheRoutes = ref<RouteKey[]>([]);
/**
* get cache routes
* @param routes vue routes
* Get cache routes
*
* @param routes Vue routes
*/
function getCacheRoutes(routes: RouteRecordRaw[]) {
const { constantVueRoutes } = createRoutes();
@ -83,7 +77,8 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* add cache routes
* Add cache routes
*
* @param routeKey
*/
function addCacheRoutes(routeKey: RouteKey) {
@ -93,7 +88,8 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* remove cache routes
* Remove cache routes
*
* @param routeKey
*/
function removeCacheRoutes(routeKey: RouteKey) {
@ -105,7 +101,8 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* re-cache routes by route key
* Re-cache routes by route key
*
* @param routeKey
*/
async function reCacheRoutesByKey(routeKey: RouteKey) {
@ -117,7 +114,8 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* re-cache routes by route keys
* Re-cache routes by route keys
*
* @param routeKeys
*/
async function reCacheRoutesByKeys(routeKeys: RouteKey[]) {
@ -126,14 +124,10 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
}
/**
* global breadcrumbs
*/
/** Global breadcrumbs */
const breadcrumbs = computed(() => getBreadcrumbsByRoute(router.currentRoute.value, menus.value));
/**
* reset store
*/
/** Reset store */
async function resetStore() {
const routeStore = useRouteStore();
@ -142,17 +136,13 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
resetVueRoutes();
}
/**
* reset vue routes
*/
/** Reset vue routes */
function resetVueRoutes() {
removeRouteFns.forEach(fn => fn());
removeRouteFns.length = 0;
}
/**
* init auth route
*/
/** Init auth route */
async function initAuthRoute() {
if (authRouteMode.value === 'static') {
await initStaticAuthRoute();
@ -163,9 +153,7 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
tabStore.initHomeTab(router);
}
/**
* init static auth route
*/
/** Init static auth route */
async function initStaticAuthRoute() {
const { authRoutes } = createRoutes();
@ -176,9 +164,7 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
setIsInitAuthRoute(true);
}
/**
* init dynamic auth route
*/
/** Init dynamic auth route */
async function initDynamicAuthRoute() {
const {
data: { routes, home }
@ -194,8 +180,9 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* handle routes
* @param routes auth routes
* Handle routes
*
* @param routes Auth routes
*/
function handleAuthRoutes(routes: ElegantConstRoute[]) {
const vueRoutes = getAuthVueRoutes(routes);
@ -208,8 +195,9 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* add routes to vue router
* @param routes vue routes
* Add routes to vue router
*
* @param routes Vue routes
*/
function addRoutesToVueRouter(routes: RouteRecordRaw[]) {
routes.forEach(route => {
@ -219,7 +207,8 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* add remove route fn
* Add remove route fn
*
* @param fn
*/
function addRemoveRouteFn(fn: () => void) {
@ -227,8 +216,9 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* update root route redirect when auth route mode is dynamic
* @param redirectKey redirect route key
* Update root route redirect when auth route mode is dynamic
*
* @param redirectKey Redirect route key
*/
function handleUpdateRootRouteRedirect(redirectKey: LastLevelRouteKey) {
const redirect = getRoutePath(redirectKey);
@ -245,8 +235,9 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* get is auth route exist
* @param routePath route path
* Get is auth route exist
*
* @param routePath Route path
*/
async function getIsAuthRouteExist(routePath: RouteMap[RouteKey]) {
const routeName = getRouteName(routePath);
@ -267,8 +258,9 @@ export const useRouteStore = defineStore(SetupStoreId.Route, () => {
}
/**
* get selected menu key path
* @param selectedKey selected menu key
* Get selected menu key path
*
* @param selectedKey Selected menu key
*/
function getSelectedMenuKeyPath(selectedKey: string) {
return getSelectedMenuKeyPathByKey(selectedKey, menus.value);

56
src/store/modules/route/shared.ts
View File

@ -1,13 +1,14 @@
import type { RouteRecordRaw, _RouteRecordBase, RouteLocationNormalizedLoaded } from 'vue-router';
import type { ElegantConstRoute, RouteKey, RouteMap, LastLevelRouteKey } from '@elegant-router/types';
import type { RouteLocationNormalizedLoaded, RouteRecordRaw, _RouteRecordBase } from 'vue-router';
import type { ElegantConstRoute, LastLevelRouteKey, RouteKey, RouteMap } from '@elegant-router/types';
import { useSvgIconRender } from '@sa/hooks';
import { $t } from '@/locales';
import SvgIcon from '@/components/custom/svg-icon.vue';
/**
* filter auth routes by roles
* @param routes auth routes
* @param roles roles
* Filter auth routes by roles
*
* @param routes Auth routes
* @param roles Roles
*/
export function filterAuthRoutesByRoles(routes: ElegantConstRoute[], roles: string[]) {
const SUPER_ROLE = 'R_SUPER';
@ -20,9 +21,10 @@ export function filterAuthRoutesByRoles(routes: ElegantConstRoute[], roles: stri
}
/**
* filter auth route by roles
* @param route auth route
* @param roles roles
* Filter auth route by roles
*
* @param route Auth route
* @param roles Roles
*/
function filterAuthRouteByRoles(route: ElegantConstRoute, roles: string[]) {
const routeRoles = (route.meta && route.meta.roles) || [];
@ -43,8 +45,9 @@ function filterAuthRouteByRoles(route: ElegantConstRoute, roles: string[]) {
}
/**
* get global menus by auth routes
* @param routes auth routes
* Get global menus by auth routes
*
* @param routes Auth routes
*/
export function getGlobalMenusByAuthRoutes(routes: ElegantConstRoute[]) {
const menus: App.Global.Menu[] = [];
@ -65,7 +68,8 @@ export function getGlobalMenusByAuthRoutes(routes: ElegantConstRoute[]) {
}
/**
* update locale of global menus
* Update locale of global menus
*
* @param menus
*/
export function updateLocaleOfGlobalMenus(menus: App.Global.Menu[]) {
@ -92,7 +96,8 @@ export function updateLocaleOfGlobalMenus(menus: App.Global.Menu[]) {
}
/**
* get global menu by route
* Get global menu by route
*
* @param route
*/
function getGlobalMenuByBaseRoute(route: RouteLocationNormalizedLoaded | ElegantConstRoute) {
@ -116,8 +121,9 @@ function getGlobalMenuByBaseRoute(route: RouteLocationNormalizedLoaded | Elegant
}
/**
* get cache route names
* @param routes vue routes (two levels)
* Get cache route names
*
* @param routes Vue routes (two levels)
*/
export function getCacheRouteNames(routes: RouteRecordRaw[]) {
const cacheNames: LastLevelRouteKey[] = [];
@ -135,7 +141,8 @@ export function getCacheRouteNames(routes: RouteRecordRaw[]) {
}
/**
* is route exist by route name
* Is route exist by route name
*
* @param routeName
* @param routes
*/
@ -144,7 +151,8 @@ export function isRouteExistByRouteName(routeName: RouteKey, routes: ElegantCons
}
/**
* recursive get is route exist by route name
* Recursive get is route exist by route name
*
* @param route
* @param routeName
*/
@ -163,7 +171,8 @@ function recursiveGetIsRouteExistByRouteName(route: ElegantConstRoute, routeName
}
/**
* get selected menu key path
* Get selected menu key path
*
* @param selectedKey
* @param menus
*/
@ -186,9 +195,10 @@ export function getSelectedMenuKeyPathByKey(selectedKey: string, menus: App.Glob
}
/**
* find menu path
* @param targetKey target menu key
* @param menu menu
* Find menu path
*
* @param targetKey Target menu key
* @param menu Menu
*/
function findMenuPath(targetKey: string, menu: App.Global.Menu): string[] | null {
const path: string[] = [];
@ -221,7 +231,8 @@ function findMenuPath(targetKey: string, menu: App.Global.Menu): string[] | null
}
/**
* transform menu to breadcrumb
* Transform menu to breadcrumb
*
* @param menu
*/
function transformMenuToBreadcrumb(menu: App.Global.Menu) {
@ -239,7 +250,8 @@ function transformMenuToBreadcrumb(menu: App.Global.Menu) {
}
/**
* get breadcrumbs by route
* Get breadcrumbs by route
*
* @param route
* @param menus
*/