feat: add comments

web-infra-dev · Nov 13, 2024 · 4863275 · 4863275
1 parent ec1d1d8
commit 4863275
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 37 deletions.
diff --git a/packages/solutions/app-tools/src/new/compat/hooks.ts b/packages/solutions/app-tools/src/new/compat/hooks.ts
@@ -17,6 +17,9 @@ import {
   transformHookRunner,
 } from './utils';
 
+/**
+ * old plugin useHookRunners function result
+ */
 export function getHookRunners(
   context: InternalContext<
     AppToolsUserConfig<'shared'>,

diff --git a/packages/solutions/app-tools/src/new/compat/utils.ts b/packages/solutions/app-tools/src/new/compat/utils.ts
@@ -1,3 +1,6 @@
+/**
+ * Maps old plugin hook function names to new plugin API names
+ */
 export function transformHookRunner(hookRunnerName: string) {
   switch (hookRunnerName) {
     case 'beforeConfig':
@@ -40,24 +43,6 @@ export function transformHookRunner(hookRunnerName: string) {
       return 'onBeforeRestart';
     case 'htmlPartials':
       return 'modifyHtmlPartials';
-    // case 'config':
-    //   return 'config';
-    // case 'deploy':
-    //   return 'deploy';
-    // case 'checkEntryPoint':
-    //   return 'checkEntryPoint';
-    // case 'modifyEntrypoints':
-    //   return 'modifyEntrypoints';
-    // case 'modifyFileSystemRoutes':
-    //   return 'modifyFileSystemRoutes';
-    // case 'modifyServerRoutes':
-    //   return 'modifyServerRoutes';
-    // case 'generateEntryCode':
-    //   return 'generateEntryCode';
-    // case '_internalRuntimePlugins':
-    //   return '_internalRuntimePlugins';
-    // case '_internalServerPlugins':
-    //   return '_internalServerPlugins';
     default:
       return hookRunnerName;
   }

diff --git a/packages/solutions/app-tools/src/new/context.ts b/packages/solutions/app-tools/src/new/context.ts
@@ -35,7 +35,7 @@ export const initAppContext = ({
     apiDirectory: path.resolve(appDirectory, apiDir),
     lambdaDirectory: path.resolve(appDirectory, apiDir, 'lambda'),
     sharedDirectory: path.resolve(appDirectory, sharedDir),
-    distDirectory: distDir,
+    distDirectory: distDir, // Special case: use ' ' to ensure compatibility with older plugins
     serverPlugins: [],
     internalDirectory: path.resolve(
       appDirectory,

diff --git a/packages/solutions/app-tools/src/new/types/plugin.ts b/packages/solutions/app-tools/src/new/types/plugin.ts