chore: add comment for caution

forcedotcom · Aug 13, 2024 · 6b6117a · 6b6117a
1 parent 92652ef
commit 6b6117a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/generators/baseGenerator.ts b/src/generators/baseGenerator.ts
@@ -193,6 +193,12 @@ export abstract class BaseGenerator<
    * @param partialPath the relative path from the templates folder to templates root folder.
    */
   public sourceRootWithPartialPath(partialPath: string): void {
+    /**
+     * CAUTION:
+     * PLEASE make sure the relative path from this function to /templates does NOT change!
+     * The core VSCode extension bundles /templates separately, so the change of the relative path will make bundling fail!
+     * Reach out to [email protected] if unsure.
+     */
     this.builtInTemplatesRootPath = path.join(
       __dirname,
       '..',