style(projects): format code

src/store/modules/route/index.ts

@@ -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);