Support adding pages

packages/studio-plugin/src/ParsingOrchestrator.ts

@@ -1,13 +1,12 @@
 import path from "path";
-import { FileMetadata, PageState } from "./types";
+import { FileMetadata, PageState, UserPaths, StudioData } from "./types";
 import fs from "fs";
 import ComponentFile from "./sourcefiles/ComponentFile";
 import ModuleFile from "./sourcefiles/ModuleFile";
 import PageFile from "./sourcefiles/PageFile";
 import SiteSettingsFile, { SiteSettings } from "./sourcefiles/SiteSettingsFile";
 import { Project } from "ts-morph";
 import typescript from "typescript";
-import { StudioData } from "./types/StudioData";
 
 export function createTsMorphProject() {
   return new Project({
@@ -27,14 +26,7 @@ export default class ParsingOrchestrator {
   private project: Project;
 
   /** All paths are assumed to be absolute. */
-  constructor(
-    private paths: {
-      components: string;
-      pages: string;
-      modules: string;
-      siteSettings: string;
-    }
-  ) {
+  constructor(private paths: UserPaths) {
     this.project = createTsMorphProject();
     this.getFileMetadata = this.getFileMetadata.bind(this);
     this.filepathToFileMetadata = this.setFilepathToFileMetadata();
@@ -55,6 +47,7 @@ export default class ParsingOrchestrator {
       pageNameToPageState,
       UUIDToFileMetadata,
       siteSettings,
+      userPaths: this.paths,
     };
   }
 

packages/studio-plugin/src/parsers/ComponentTreeParser.ts

@@ -12,7 +12,7 @@ import {
   StandardOrModuleComponentState,
 } from "../types/State";
 import { v4 } from "uuid";
-import { FileMetadataKind, PropValues } from "../types";
+import { FileMetadataKind } from "../types";
 import StudioSourceFileParser from "./StudioSourceFileParser";
 import StaticParsingHelpers from "./helpers/StaticParsingHelpers";
 import TypeGuards from "./helpers/TypeGuards";

packages/studio-plugin/src/parsers/getStudioPaths.ts

@@ -1,12 +1,13 @@
 import path from "path";
+import { UserPaths } from "../types";
 
 /**
  * Given an absolute path to the user's src folder, determine the filepaths Studio will
  * use for parsing files.
  *
- * @param pathToSrc An absolute path to the src folder
+ * @param pathToSrc - An absolute path to the src folder
  */
-export default function getStudioPaths(pathToSrc: string) {
+export default function getStudioPaths(pathToSrc: string): UserPaths {
   return {
     pages: path.join(pathToSrc, "pages"),
     modules: path.join(pathToSrc, "modules"),

packages/studio-plugin/src/sourcefiles/PageFile.ts

@@ -63,9 +63,11 @@ export default class PageFile {
       absPathDefaultImports
     );
     const cssImports = this.studioSourceFileParser.parseCssImports();
+    const filepath = this.studioSourceFileParser.getFilepath();
     return {
       componentTree,
       cssImports,
+      filepath,
     };
   }
 

packages/studio-plugin/src/types/State.ts

@@ -3,6 +3,7 @@ import { PropValues } from "./PropValues";
 export type PageState = {
   componentTree: ComponentState[];
   cssImports: string[];
+  filepath: string;
 };
 
 export type ComponentState =

packages/studio-plugin/src/types/StudioData.ts

@@ -1,9 +1,11 @@
 import { SiteSettings } from "../sourcefiles/SiteSettingsFile";
 import { ComponentMetadata } from "./ComponentMetadata";
 import { PageState } from "./State";
+import { UserPaths } from "./UserPaths";
 
 export interface StudioData {
   pageNameToPageState: Record<string, PageState>;
   UUIDToFileMetadata: Record<string, ComponentMetadata>;
   siteSettings?: SiteSettings;
+  userPaths: UserPaths;
 }

packages/studio-plugin/src/types/UserPaths.ts

@@ -0,0 +1,14 @@
+/**
+ * Absolute paths for files and directories in the user's file system that are
+ * relevant for Studio.
+ */
+export interface UserPaths {
+  /** The absolute path to the directory with the user's components. */
+  components: string;
+  /** The absolute path to the directory with the user's pages. */
+  pages: string;
+  /** The absolute path to the directory with the user's modules. */
+  modules: string;
+  /** The absolute path to the file with the user's site settings. */
+  siteSettings: string;
+}

packages/studio-plugin/src/types/index.ts

@@ -5,3 +5,4 @@ export * from "./ModuleMetadata";
 export * from "./FileMetadata";
 export * from "./State";
 export * from "./StudioData";
+export * from "./UserPaths";

packages/studio-plugin/tests/ParsingOrchestrator.test.ts

@@ -67,6 +67,7 @@ describe("aggregates data as expected", () => {
           }),
         ],
         cssImports: [],
+        filepath: expect.anything(),
       },
       pageWithModules: {
         componentTree: [
@@ -80,6 +81,7 @@ describe("aggregates data as expected", () => {
           }),
         ],
         cssImports: [],
+        filepath: expect.anything(),
       },
     });
   });

packages/studio-plugin/tests/sourcefiles/PageFile.getPageState.test.ts

@@ -120,6 +120,13 @@ describe("getPageState", () => {
     ]);
   });
 
+  it("correctly gets filepath", () => {
+    const pageFile = createPageFile("shortFragmentSyntaxPage");
+    const result = pageFile.getPageState();
+
+    expect(result.filepath).toEqual(getPagePath("shortFragmentSyntaxPage"));
+  });
+
   describe("throws errors", () => {
     it("throws an error when no return statement is found in the default export", () => {
       const pageFile = createPageFile("noReturnStatementPage");