feat: add routes and hasSrcDir to api.appData

umijs · Oct 20, 2021 · 10fadde · 10fadde
1 parent 8445771
commit 10fadde
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 14 deletions.
diff --git a/packages/core/src/route/routesConvention.ts b/packages/core/src/route/routesConvention.ts
@@ -1,5 +1,6 @@
 import { winPath } from '@umijs/utils';
-import { lstatSync, readdirSync } from 'fs';
+import assert from 'assert';
+import { existsSync, lstatSync, readdirSync, statSync } from 'fs';
 import { join, relative, resolve } from 'path';
 import { defineRoutes } from './defineRoutes';
 import {
@@ -12,6 +13,10 @@ import {
 // opts.base: path of pages
 export function getConventionRoutes(opts: { base: string }) {
   const files: { [routeId: string]: string } = {};
+  assert(
+    existsSync(opts.base) && statSync(opts.base).isDirectory(),
+    `Convention routes base not found.`,
+  );
   visitFiles({
     dir: opts.base,
     visitor: (file) => {

diff --git a/packages/preset-built-in/src/commands/dev/dev.ts b/packages/preset-built-in/src/commands/dev/dev.ts
@@ -37,15 +37,18 @@ PORT=8888 umi dev
       clearTmp(api.paths.absTmpPath);
 
       // generate files
-      async function generate(files?: any) {
+      async function generate(opts: { isFirstTime?: boolean; files?: any }) {
         api.applyPlugins({
           key: 'onGenerateFiles',
           args: {
-            files: files || null,
+            files: opts.files || null,
+            isFirstTime: opts.isFirstTime,
           },
         });
       }
-      await generate();
+      await generate({
+        isFirstTime: true,
+      });
       const { absPagesPath, absSrcPath } = api.paths;
       const watcherPaths: string[] = await api.applyPlugins({
         key: 'addTmpGenerateWatcherPaths',
@@ -62,7 +65,7 @@ PORT=8888 umi dev
           onChange: createDebouncedHandler({
             timeout: 2000,
             async onChange(opts) {
-              await generate(opts.files);
+              await generate({ files: opts.files, isFirstTime: false });
             },
           }),
         });

diff --git a/packages/preset-built-in/src/features/appData/appData.ts b/packages/preset-built-in/src/features/appData/appData.ts
@@ -0,0 +1,16 @@
+import { IApi } from '../../types';
+import { getRoutes } from '../tmpFiles/routes';
+
+export default (api: IApi) => {
+  api.modifyAppData(async (memo) => {
+    // routes
+    memo.routes = await getRoutes({
+      config: api.config,
+      absSrcPage: api.paths.absSrcPath,
+      absPagesPath: api.paths.absPagesPath,
+    });
+    // hasSrcDir
+    memo.hasSrcDir = api.paths.absSrcPath.endsWith('/src');
+    return memo;
+  });
+};
diff --git a/packages/preset-built-in/src/features/check/check.ts b/packages/preset-built-in/src/features/check/check.ts
@@ -0,0 +1,12 @@
+import assert from 'assert';
+import { IApi } from '../../types';
+
+export default (api: IApi) => {
+  api.onCheck(() => {
+    // routes
+    assert(
+      api.appData.routes,
+      `routes not found, you may be run umi on the wrong directory.`,
+    );
+  });
+};
diff --git a/packages/preset-built-in/src/features/tmpFiles/tmpFiles.ts b/packages/preset-built-in/src/features/tmpFiles/tmpFiles.ts
@@ -13,7 +13,7 @@ export default (api: IApi) => {
     },
   });
 
-  api.onGenerateFiles(async () => {
+  api.onGenerateFiles(async (opts) => {
     // umi.ts
     api.writeTmpFile({
       path: 'umi.ts',
@@ -24,12 +24,17 @@ export default (api: IApi) => {
     });
 
     // routes.ts
-    const routes = await getRoutes({
-      config: api.config,
-      absSrcPage: api.paths.absSrcPath,
-      absPagesPath: api.paths.absPagesPath,
-    });
-    const hasSrc = api.paths.absSrcPath.endsWith('/src');
+    let routes;
+    if (opts.isFirstTime) {
+      routes = api.appData.routes;
+    } else {
+      routes = await getRoutes({
+        config: api.config,
+        absSrcPage: api.paths.absSrcPath,
+        absPagesPath: api.paths.absPagesPath,
+      });
+    }
+    const hasSrc = api.appData.hasSrcDir;
     // @/pages/
     const prefix = hasSrc ? '../../src/pages/' : '../../pages/';
     api.writeTmpFile({

diff --git a/packages/preset-built-in/src/index.ts b/packages/preset-built-in/src/index.ts
@@ -5,8 +5,10 @@ export default () => {
       require.resolve('./registerMethods'),
 
       // features
-      require.resolve('./features/tmpFiles/tmpFiles'),
+      require.resolve('./features/appData/appData'),
+      require.resolve('./features/check/check'),
       require.resolve('./features/configPlugins/configPlugins'),
+      require.resolve('./features/tmpFiles/tmpFiles'),
 
       // commands
       require.resolve('./commands/build'),

diff --git a/packages/preset-built-in/src/types.ts b/packages/preset-built-in/src/types.ts
@@ -12,7 +12,8 @@ export type IApi = PluginAPI &
     }) => void;
     addTmpGenerateWatcherPaths: IAdd<null, string[]>;
     onGenerateFiles: IEvent<{
-      files: { event: string; path: string } | null;
+      isFirstTime?: boolean;
+      files?: { event: string; path: string } | null;
     }>;
     onPkgJSONChanged: IEvent<{
       origin: Record<string, any>;