ci(config): 整理全局配置内容

.env

@@ -2,10 +2,12 @@
 VITE_BASE_URL=/
 # 项目名称
 VITE_APP_NAME=EnchAdmin
+
 VITE_APP_TITLE=Ench管理系统
+
 VITE_APP_DESC=EnchAdmin是一个中后台管理系统模版
 
 # 路由模式
-VITE_HASH_ROUTE = N
+VITE_ROUTE_MODE = web
 # 权限路由模式: static ｜ dynamic
 VITE_AUTH_ROUTE_MODE=dynamic

.env.development

@@ -1,3 +1,3 @@
-VITE_HTTP_PROXY=N
+VITE_HTTP_PROXY=false
 # 开启localStorage内容加密
-VITE_STORAGE_ENCRYPT=N
+VITE_STORAGE_ENCRYPT=false

.env.production

@@ -1,11 +1,11 @@
 # 是否开启压缩资源
-VITE_COMPRESS_OPEN=N
+VITE_COMPRESS_OPEN=false
 
 # 压缩算法 gzip | brotliCompress | deflate | deflateRaw
 VITE_COMPRESS_TYPE=gzip
 
 # 是否开启打包依赖分析
-VITE_VISUALIZER=N
+VITE_VISUALIZER=false
 
 # 开启localStorage内容加密
-VITE_STORAGE_ENCRYPT=Y
+VITE_STORAGE_ENCRYPT=false

.vscode/settings.json

@@ -1,15 +1,10 @@
 {
-	// 缩进
 	"editor.tabSize": 2,
-	// 保存eslint校验
+	"editor.formatOnSave": false,
+	"eslint.format.enable": false,
 	"editor.codeActionsOnSave": {
 		"source.fixAll.eslint": true
 	},
-	"eslint.format.enable": true,
-	// 校验那些文件
 	"eslint.validate": ["typescript", "javascript", "vue", "html"],
-	// 加载配置文件
 	"eslint.options": { "configFile": ".eslintrc.js" },
-	// 保存自动格式化
-	"editor.formatOnSave": false,
 }

build/plugins/index.ts

@@ -14,11 +14,11 @@ import mock from './mock';
 export function setVitePlugins(env: ImportMetaEnv) {
   const plugins = [...vue, unocss(), ...unplugin, mock];
   // 是否压缩
-  if (env.VITE_COMPRESS_OPEN === 'Y') {
+  if (env.VITE_COMPRESS_OPEN) {
     plugins.push(compress(env));
   }
   // 是否依赖分析
-  if (env.VITE_VISUALIZER === 'Y') {
+  if (env.VITE_VISUALIZER) {
     plugins.push(visualizer as PluginOption);
   }
   return plugins;

package.json

@@ -28,7 +28,7 @@
 		}
 	},
 	"lint-staged": {
-		"./src/**/*.{vue,js,jsx,ts,tsx,json}": "eslint --fix"
+		"*.{vue,js,jsx,ts,tsx,json}": "eslint --fix"
 	},
 	"dependencies": {
 		"@vueuse/core": "^9.13.0",

src/config/env.ts

@@ -1,8 +1,5 @@
-/** 请求服务的环境配置 */
-type ServiceEnv = Record<ServiceEnvType, ServiceEnvConfig>;
-
 /** 不同请求服务的环境配置 */
-const serviceEnv: ServiceEnv = {
+export const proxyConfig: Record<ServiceEnvType, ServiceEnvConfig> = {
 	development: {
 		url: 'https://mock.mengxuegu.com/mock/61e4df7c17249f68847fc191/api',
 		urlPattern: '/url-pattern',
@@ -21,14 +18,4 @@ const serviceEnv: ServiceEnv = {
 		secondUrl: 'http://localhost:8081',
 		secondUrlPattern: '/second-url-pattern',
 	},
-};
-
-/**
- * 获取当前环境模式下的请求服务的配置
- * @param env 环境
- */
-export function getServiceEnvConfig(mode: ServiceEnvType = 'development') {
-	const config = serviceEnv[mode];
-
-	return config;
-}
+};

src/router/index.ts

@@ -3,10 +3,10 @@ import { createRouter, createWebHistory, createWebHashHistory, RouteRecordRaw }
 import { setupRouterGuard } from './guard';
 import { routes } from './routes';
 
-const { VITE_HASH_ROUTE = 'N', VITE_BASE_URL } = import.meta.env;
+const { VITE_ROUTE_MODE = 'hash', VITE_BASE_URL } = import.meta.env;
 export const router = createRouter({
-  history: VITE_HASH_ROUTE === 'Y' ? createWebHashHistory(VITE_BASE_URL) : createWebHistory(VITE_BASE_URL),
-  routes,
+	history: VITE_ROUTE_MODE === 'hash' ? createWebHashHistory(VITE_BASE_URL) : createWebHistory(VITE_BASE_URL),
+	routes,
 });
 // 安装vue路由
 export async function setupRouter(app: App) {

src/service/http/index.ts

@@ -1,9 +1,9 @@
-import { getServiceEnvConfig } from '@/config';
+import { proxyConfig } from '@/config';
 import { createRequest } from './request';
 
-const { url, urlPattern } = getServiceEnvConfig(import.meta.env.MODE);
+const { url, urlPattern } = proxyConfig[import.meta.env.MODE];
 
-const isHttpProxy = import.meta.env.VITE_HTTP_PROXY === 'Y';
+const isHttpProxy = import.meta.env.VITE_HTTP_PROXY || false;
 
 export const request = createRequest({ baseURL: isHttpProxy ? urlPattern : url });
 

src/typings/env.d.ts

@@ -25,22 +25,22 @@ interface ImportMetaEnv {
 	readonly VITE_APP_TITLE: string;
 	readonly VITE_APP_DESC: string;
 	/** 开启请求代理 */
-	readonly VITE_HTTP_PROXY?: 'Y' | 'N';
+	readonly VITE_HTTP_PROXY?: boolean;
 	/** 是否开启打包依赖分析 */
-	readonly VITE_VISUALIZER?: 'Y' | 'N';
+	readonly VITE_VISUALIZER?: boolean;
 	/** 是否开启打包压缩 */
-	readonly VITE_COMPRESS_OPEN?: 'Y' | 'N';
+	readonly VITE_COMPRESS_OPEN?: boolean;
 	/** 压缩算法类型 */
 	readonly VITE_COMPRESS_TYPE?: 'gzip' | 'brotliCompress' | 'deflate' | 'deflateRaw';
 	/** hash路由模式 */
-	readonly VITE_HASH_ROUTE?: 'Y' | 'N';
+	readonly VITE_ROUTE_MODE?: 'hash' | 'web';
 	/** 路由加载模式 */
 	readonly VITE_AUTH_ROUTE_MODE?: 'static' | 'dynamic';
 	/** 本地存储内容开启加密 */
-	readonly VITE_STORAGE_ENCRYPT?: 'Y' | 'N';
+	readonly VITE_STORAGE_ENCRYPT?: boolean;
 
 	/** 后端服务的环境类型 */
-	readonly MODE?: ServiceEnvType;
+	readonly MODE: ServiceEnvType;
 }
 
 interface ImportMeta {

src/typings/global.d.ts

@@ -7,3 +7,29 @@ interface Window {
 
 declare const AMap: any;
 declare const BMap: any;
+
+interface GolbalConfig {
+	app: {
+		proxyUrl: Record<ServiceEnvType, ServiceEnvConfig>;
+	};
+}
+declare namespace NaiveUI {
+	type ThemeColor = 'default' | 'error' | 'primary' | 'info' | 'success' | 'warning';
+}
+declare namespace UnionKey {
+	/* http请求头content-type类型 */
+	type ContentType = 'application/json' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
+}
+declare namespace Storage {
+	interface Session {
+		demoKey: string;
+	}
+
+	interface Local {
+		userInfo: Auth.UserInfo;
+		token: string;
+		refreshToken: string;
+		tabsRoutes: string;
+		login_account: any;
+	}
+}

src/typings/naive-ui.d.ts

@@ -1,3 +0,0 @@
-declare namespace NaiveUI {
-  type ThemeColor = 'default' | 'error' | 'primary' | 'info' | 'success' | 'warning';
-}

src/typings/service.d.ts

@@ -42,11 +42,4 @@ declare namespace Service {
 
 	/** 自定义的请求结果 */
 	type RequestResult<T = any> = SuccessResult<T> | FailedResult;
-}
-/** 菜单项配置 */
-type GlobalMenuOption = import('naive-ui').MenuOption & {
-	key: string;
-	label: string;
-	icon?: () => import('vue').VNodeChild;
-	children?: GlobalMenuOption[];
-};
+}

src/typings/storage.d.ts

@@ -1,14 +0,0 @@
-declare namespace Storage {
-
-  interface Session {
-    demoKey: string
-  }
-
-  interface Local {
-		userInfo: Auth.UserInfo;
-		token: string;
-		refreshToken: string;
-		tabsRoutes: string;
-		login_account:any;
-	}
-}

src/typings/union-key.d.ts

@@ -1,4 +0,0 @@
-declare namespace UnionKey { 
-  /* http请求头content-type类型 */
-  type ContentType = 'application/json' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
-}

src/utils/crypto.ts

@@ -15,7 +15,7 @@ export function encrypto(data: any) {
 		newData = JSON.stringify(data);
 	}
 
-	if (VITE_STORAGE_ENCRYPT === 'N') {
+	if (VITE_STORAGE_ENCRYPT) {
 		return newData;
 	}
 
@@ -27,7 +27,7 @@ export function encrypto(data: any) {
  * @param cipherText - 密文
  */
 export function decrypto(cipherText: string) {
-	if (VITE_STORAGE_ENCRYPT === 'N') {
+	if (!VITE_STORAGE_ENCRYPT) {
 		return JSON.parse(cipherText);
 	}
 

vite.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig, loadEnv, ConfigEnv } from 'vite';
 import { createViteProxy, setVitePlugins } from './build';
 import { resolve } from 'path';
-import { getServiceEnvConfig } from './src/config';
+import { proxyConfig } from '@/config';
 
 // 当前执行node命令时文件夹的地址（工作目录）
 const rootPath: string = resolve(process.cwd());
@@ -14,9 +14,7 @@ export default defineConfig(({ command, mode }: ConfigEnv) => {
 	// 根据当前工作目录中的 `mode` 加载 .env 文件
 	// 设置第三个参数为 '' 来加载所有环境变量，而不管是否有 `VITE_` 前缀。
 	const env = loadEnv(mode, process.cwd(), '') as unknown as ImportMetaEnv;
-	const isOpenProxy = env.VITE_HTTP_PROXY === 'Y';
-
-	const envConfig = getServiceEnvConfig(mode as ServiceEnvType);
+	const envConfig = proxyConfig[mode as ServiceEnvType];
 
 	return {
 		base: env.VITE_BASE_URL,
@@ -31,7 +29,7 @@ export default defineConfig(({ command, mode }: ConfigEnv) => {
 			host: '0.0.0.0',
 			port: 3000,
 			open: false,
-			proxy: isOpenProxy ? createViteProxy(envConfig) : undefined,
+			proxy: env.VITE_HTTP_PROXY ? createViteProxy(envConfig) : undefined,
 		},
 		preview: {
 			port: 5211,