From e68e1b40ce91af199b74a6dfbb7330d3fb3c233d Mon Sep 17 00:00:00 2001
From: vben <ann.vben@gmail.com>
Date: Sun, 7 Jul 2024 22:14:40 +0800
Subject: [PATCH] perf: add eslint import rules, improve the coupling of some
 components

---
 apps/web-antd/src/app.vue                     |   5 +-
 .../eslint-config/src/custom-config.ts        | 113 ++++++++++++++++++
 packages/@core/locales/src/i18n.ts            |   1 -
 packages/@core/shared/toolkit/src/dom.ts      |   1 -
 packages/@core/shared/typings/vue-router.d.ts |   1 +
 .../src/global-provider/global-provider.vue   |  16 ++-
 .../src/global-search/search-panel.vue        |   2 +-
 scripts/vsh/src/aggregate-changelog/index.ts  |  71 -----------
 8 files changed, 130 insertions(+), 80 deletions(-)
 delete mode 100644 scripts/vsh/src/aggregate-changelog/index.ts

diff --git a/apps/web-antd/src/app.vue b/apps/web-antd/src/app.vue
index 694c77ed..78f2adef 100644
--- a/apps/web-antd/src/app.vue
+++ b/apps/web-antd/src/app.vue
@@ -30,7 +30,10 @@ const tokenTheme = computed(() => {
 </script>
 
 <template>
-  <GlobalProvider>
+  <GlobalProvider
+    :enable-ai-assistant="preferences.app.aiAssistant"
+    :is-mobile="preferences.app.isMobile"
+  >
     <ConfigProvider :locale="antdLocale" :theme="tokenTheme">
       <App>
         <RouterView />
diff --git a/internal/lint-configs/eslint-config/src/custom-config.ts b/internal/lint-configs/eslint-config/src/custom-config.ts
index ecf8effb..11683fd2 100644
--- a/internal/lint-configs/eslint-config/src/custom-config.ts
+++ b/internal/lint-configs/eslint-config/src/custom-config.ts
@@ -1,12 +1,125 @@
 import type { Linter } from 'eslint';
 
+const restrictedImportIgnores = [
+  '**/vite.config.mts',
+  '**/tailwind.config.mjs',
+  '**/postcss.config.mjs',
+];
+
 const customConfig: Linter.FlatConfig[] = [
+  // shadcn-ui 内部组件是自动生成的，这里忽略
   {
     files: ['packages/@core/ui-kit/shadcn-ui/**/**'],
     rules: {
       'vue/require-default-prop': 'off',
     },
   },
+  {
+    // apps内部的一些基础规则
+    files: ['apps/**/**'],
+    ignores: restrictedImportIgnores,
+    rules: {
+      'no-restricted-imports': [
+        'error',
+        {
+          patterns: [
+            {
+              group: ['#/api/*'],
+              message:
+                'The #/api package cannot be imported, please use the @core package itself',
+            },
+            {
+              group: ['#/layouts/*'],
+              message:
+                'The #/layouts package cannot be imported, please use the @core package itself',
+            },
+            {
+              group: ['#/locales/*'],
+              message:
+                'The #/locales package cannot be imported, please use the @core package itself',
+            },
+            {
+              group: ['#/stores/*'],
+              message:
+                'The #/stores package cannot be imported, please use the @core package itself',
+            },
+            {
+              group: ['#/forward/*'],
+              message:
+                'The #/forward package cannot be imported, please use the @core package itself',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    // @core内部组件，不能引入@vben/* 里面的包
+    files: ['packages/@core/**/**'],
+    ignores: restrictedImportIgnores,
+    rules: {
+      'no-restricted-imports': [
+        'error',
+        {
+          // 如果需要，可以指定禁止特定的子路径
+          patterns: [
+            {
+              group: ['@vben/*'],
+              message:
+                'The @core package cannot import the @vben package, please use the @core package itself',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    // @core/shared内部组件，不能引入@vben/* 或者 @vben-core/* 里面的包
+    files: ['packages/@core/shared/**/**'],
+    ignores: restrictedImportIgnores,
+    rules: {
+      'no-restricted-imports': [
+        'error',
+        {
+          // 如果需要，可以指定禁止特定的子路径
+          patterns: [
+            {
+              group: ['@vben/*', '@vben-core/*'],
+              message:
+                'The @vben-core/shared package cannot import the @vben package, please use the @core/shared package itself',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    // 不能引入@vben/*里面的包
+    files: [
+      'packages/types/**/**',
+      'packages/utils/**/**',
+      'packages/icons/**/**',
+      'packages/constants/**/**',
+      'packages/styles/**/**',
+    ],
+    ignores: restrictedImportIgnores,
+    rules: {
+      'no-restricted-imports': [
+        'error',
+        {
+          // 如果需要，可以指定禁止特定的子路径
+          patterns: [
+            {
+              group: ['@vben/*'],
+              message:
+                'The @vben package cannot be imported, please use the @core package itself',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  // 后端模拟代码，不需要太多规则
   {
     files: ['apps/backend-mock/**/**'],
     rules: {
diff --git a/packages/@core/locales/src/i18n.ts b/packages/@core/locales/src/i18n.ts
index caceea35..50dbd038 100644
--- a/packages/@core/locales/src/i18n.ts
+++ b/packages/@core/locales/src/i18n.ts
@@ -8,7 +8,6 @@ import { createI18n } from 'vue-i18n';
 
 const loadedLanguages = new Set<string>();
 
-// TODO：import.meta.env，会导致该包依赖外部项目必须是vite才可以
 const i18n = createI18n({
   globalInjection: true,
   legacy: false,
diff --git a/packages/@core/shared/toolkit/src/dom.ts b/packages/@core/shared/toolkit/src/dom.ts
index f7321d46..6a6e69c7 100644
--- a/packages/@core/shared/toolkit/src/dom.ts
+++ b/packages/@core/shared/toolkit/src/dom.ts
@@ -1,7 +1,6 @@
 /**
  * 获取元素可见高度
  * @param element
- * @returns
  */
 function getElementVisibleHeight(
   element?: HTMLElement | null | undefined,
diff --git a/packages/@core/shared/typings/vue-router.d.ts b/packages/@core/shared/typings/vue-router.d.ts
index 239f315e..f10bf93e 100644
--- a/packages/@core/shared/typings/vue-router.d.ts
+++ b/packages/@core/shared/typings/vue-router.d.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-restricted-imports */
 import type { RouteMeta as IRouteMeta } from '@vben-core/typings';
 
 import 'vue-router';
diff --git a/packages/business/widgets/src/global-provider/global-provider.vue b/packages/business/widgets/src/global-provider/global-provider.vue
index e8055bb2..21da3527 100644
--- a/packages/business/widgets/src/global-provider/global-provider.vue
+++ b/packages/business/widgets/src/global-provider/global-provider.vue
@@ -1,16 +1,22 @@
 <script setup lang="ts">
-import { preferences } from '@vben-core/preferences';
 import { Toaster } from '@vben-core/shadcn-ui';
 
 import { CozeAssistant } from '../coze-assistant';
 
+interface Props {
+  enableAiAssistant?: boolean;
+  isMobile?: boolean;
+}
+
 defineOptions({ name: 'GlobalProvider' });
+
+withDefaults(defineProps<Props>(), {
+  enableAiAssistant: false,
+  isMobile: false,
+});
 </script>
 <template>
   <Toaster />
-  <CozeAssistant
-    v-if="preferences.app.aiAssistant"
-    :is-mobile="preferences.app.isMobile"
-  />
+  <CozeAssistant v-if="enableAiAssistant" :is-mobile="isMobile" />
   <slot></slot>
 </template>
diff --git a/packages/business/widgets/src/global-search/search-panel.vue b/packages/business/widgets/src/global-search/search-panel.vue
index f9b39676..41264816 100644
--- a/packages/business/widgets/src/global-search/search-panel.vue
+++ b/packages/business/widgets/src/global-search/search-panel.vue
@@ -26,7 +26,7 @@ const emit = defineEmits<{ close: [] }>();
 
 const router = useRouter();
 const searchHistory = useLocalStorage<MenuRecordRaw[]>(
-  `__search-history-${import.meta.env.PROD ? 'prod' : 'dev'}__`,
+  `__search-history-${location.hostname}__`,
   [],
 );
 const activeIndex = ref(-1);
diff --git a/scripts/vsh/src/aggregate-changelog/index.ts b/scripts/vsh/src/aggregate-changelog/index.ts
deleted file mode 100644
index 139f6007..00000000
--- a/scripts/vsh/src/aggregate-changelog/index.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-import type { CAC } from 'cac';
-
-import { extname } from 'node:path';
-
-import { getStagedFiles } from '@vben/node-utils';
-
-import { circularDepsDetect, printCircles } from 'circular-dependency-scanner';
-
-const IGNORE_DIR = [
-  'dist',
-  '.turbo',
-  'output',
-  '.cache',
-  'scripts',
-  'internal',
-  // 'packages/@vben-core/shared/shadcn-ui/',
-  'packages/@vben-core/ui-kit/menu-ui/src/',
-].join(',');
-
-const IGNORE = [`**/{${IGNORE_DIR}}/**`];
-
-interface CommandOptions {
-  staged: boolean;
-  verbose: boolean;
-}
-
-async function checkCircular({ staged, verbose }: CommandOptions) {
-  const results = await circularDepsDetect({
-    absolute: staged,
-    cwd: process.cwd(),
-    ignore: IGNORE,
-  });
-
-  if (staged) {
-    let files = await getStagedFiles();
-
-    files = files.filter((file) =>
-      ['.cjs', '.js', '.jsx', '.mjs', '.ts', '.tsx', '.vue'].includes(
-        extname(file),
-      ),
-    );
-    const circularFiles: string[][] = [];
-
-    for (const file of files) {
-      for (const result of results) {
-        const resultFiles = result.flat();
-        if (resultFiles.includes(file)) {
-          circularFiles.push(result);
-        }
-      }
-    }
-    verbose && printCircles(circularFiles);
-  } else {
-    verbose && printCircles(results);
-  }
-}
-
-function defineCheckCircularCommand(cac: CAC) {
-  cac
-    .command('check-circular')
-    .option(
-      '--staged',
-      'Whether it is the staged commit mode, in which mode, if there is a circular dependency, an alarm will be given.',
-    )
-    .usage(`Analysis of project circular dependencies.`)
-    .action(async ({ staged }) => {
-      await checkCircular({ staged, verbose: true });
-    });
-}
-
-export { defineCheckCircularCommand };