@platformos/platformos-common 0.0.12 → 0.0.16

package/src/documents-locator/DocumentsLocator.spec.ts

@@ -55,6 +55,74 @@ function createMockFileSystem(files: Record<string, string>): AbstractFileSystem
 describe('DocumentsLocator', () => {
   const rootUri = URI.parse('file:///project');
 
+  describe('locateDefault', () => {
+    it('render → app/views/partials', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'render', 'my/partial')).toBe(
+        'file:///project/app/views/partials/my/partial.liquid',
+      );
+    });
+
+    it('include → app/views/partials', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'include', 'card')).toBe(
+        'file:///project/app/views/partials/card.liquid',
+      );
+    });
+
+    it('function → app/lib', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'function', 'commands/apply')).toBe(
+        'file:///project/app/lib/commands/apply.liquid',
+      );
+    });
+
+    it('graphql → app/graphql', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'graphql', 'users/search')).toBe(
+        'file:///project/app/graphql/users/search.graphql',
+      );
+    });
+
+    it('theme_render_rc → undefined', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'theme_render_rc', 'card')).toBeUndefined();
+    });
+
+    it('module render → modules/.../public/views/partials', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'render', 'modules/core/my/partial')).toBe(
+        'file:///project/modules/core/public/views/partials/my/partial.liquid',
+      );
+    });
+
+    it('module function → modules/.../public/lib', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'function', 'modules/core/commands/apply')).toBe(
+        'file:///project/modules/core/public/lib/commands/apply.liquid',
+      );
+    });
+
+    it('module graphql → modules/.../public/graphql', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'graphql', 'modules/core/users/search')).toBe(
+        'file:///project/modules/core/public/graphql/users/search.graphql',
+      );
+    });
+
+    it('deeply nested path — creates all missing intermediate dirs', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'render', 'a/b/c/d/partial')).toBe(
+        'file:///project/app/views/partials/a/b/c/d/partial.liquid',
+      );
+    });
+
+    it('asset → undefined (no canonical creation path)', () => {
+      const locator = new DocumentsLocator(createMockFileSystem({}));
+      expect(locator.locateDefault(rootUri, 'asset', 'logo.png')).toBeUndefined();
+    });
+  });
+
   describe('locate', () => {
     it('should locate a partial file in app/lib', async () => {
       const fs = createMockFileSystem({

package/src/documents-locator/DocumentsLocator.ts

@@ -1,6 +1,6 @@
 import yaml from 'js-yaml';
 import { AbstractFileSystem, FileType } from '../AbstractFileSystem';
-import { getAppPaths, getModulePaths, PlatformOSFileType } from '../path-utils';
+import { getAppPaths, getModulePaths, parseModulePrefix, PlatformOSFileType } from '../path-utils';
 import { URI, Utils } from 'vscode-uri';
 
 export type DocumentType =
@@ -34,9 +34,8 @@ export async function loadSearchPaths(
   }
 }
 
-type ModulePathInfo =
-  | { isModule: false; key: string }
-  | { isModule: true; moduleName: string; key: string };
+/** Maximum number of concrete paths generated by a single dynamic search-path expansion. */
+const MAX_DYNAMIC_PATH_EXPANSIONS = 100;
 
 export class DocumentsLocator {
   constructor(private readonly fs: AbstractFileSystem) {}
@@ -49,17 +48,6 @@ export class DocumentsLocator {
     }
   }
 
-  private parseModulePath(fileName: string): ModulePathInfo {
-    if (!fileName.startsWith('modules/')) {
-      return { isModule: false, key: fileName };
-    }
-
-    const [, moduleName, ...rest] = fileName.split('/');
-    const key = rest.join('/');
-
-    return moduleName ? { isModule: true, moduleName, key } : { isModule: false, key: fileName };
-  }
-
   private getSearchPaths(type: 'partial' | 'graphql' | 'asset', moduleName?: string): string[] {
     const fileType: PlatformOSFileType = {
       partial: PlatformOSFileType.Partial,
@@ -75,7 +63,7 @@ export class DocumentsLocator {
     fileName: string,
     type: 'partial' | 'graphql' | 'asset',
   ): Promise<string | undefined> {
-    const parsed = this.parseModulePath(fileName);
+    const parsed = parseModulePrefix(fileName);
     const searchPaths = this.getSearchPaths(type, parsed.isModule ? parsed.moduleName : undefined);
 
     let targetFile = parsed.key;
@@ -101,7 +89,7 @@ export class DocumentsLocator {
     filePrefix: string,
     type: 'partial' | 'graphql' | 'asset',
   ): Promise<string[]> {
-    const parsed = this.parseModulePath(filePrefix);
+    const parsed = parseModulePrefix(filePrefix);
     const searchPaths = this.getSearchPaths(type, parsed.isModule ? parsed.moduleName : undefined);
 
     const results = new Set<string>();
@@ -185,7 +173,8 @@ export class DocumentsLocator {
    * concrete directory prefixes by enumerating subdirectories at each dynamic
    * segment. Static segments pass through unchanged.
    *
-   * Results are cached per (rootUri, searchPath) and capped at 100 entries.
+   * Results are cached per (rootUri, searchPath) and capped at
+   * MAX_DYNAMIC_PATH_EXPANSIONS entries per dynamic segment.
    */
   private async expandDynamicPath(rootUri: URI, searchPath: string): Promise<string[]> {
     const segments = searchPath.split('/');
@@ -211,9 +200,9 @@ export class DocumentsLocator {
         }
         for (const sub of subdirs) {
           nextPrefixes.push(prefix ? `${prefix}/${sub}` : sub);
-          if (nextPrefixes.length >= 100) break;
+          if (nextPrefixes.length >= MAX_DYNAMIC_PATH_EXPANSIONS) break;
         }
-        if (nextPrefixes.length >= 100) break;
+        if (nextPrefixes.length >= MAX_DYNAMIC_PATH_EXPANSIONS) break;
       }
       prefixes = nextPrefixes;
     }
@@ -263,6 +252,59 @@ export class DocumentsLocator {
     return undefined;
   }
 
+  /**
+   * Returns the canonical URI where `fileName` would live — used as a
+   * go-to-definition fallback when the file doesn't exist yet.
+   * Returns undefined for theme_render_rc (ambiguous search path) and asset.
+   */
+  locateDefault(rootUri: URI, nodeName: DocumentType, fileName: string): string | undefined {
+    const parsed = parseModulePrefix(fileName);
+
+    let basePath: string;
+    let ext: string;
+
+    switch (nodeName) {
+      case 'render':
+      case 'include':
+        basePath = parsed.isModule
+          ? `modules/${parsed.moduleName}/public/views/partials`
+          : 'app/views/partials';
+        ext = '.liquid';
+        break;
+      case 'function':
+        basePath = parsed.isModule ? `modules/${parsed.moduleName}/public/lib` : 'app/lib';
+        ext = '.liquid';
+        break;
+      case 'graphql':
+        basePath = parsed.isModule ? `modules/${parsed.moduleName}/public/graphql` : 'app/graphql';
+        ext = '.graphql';
+        break;
+      case 'theme_render_rc': // ambiguous — multiple search paths, no single canonical location
+      case 'asset': // no canonical creation path
+        return undefined;
+      default:
+        return undefined;
+    }
+
+    return Utils.joinPath(rootUri, basePath, parsed.key + ext).toString();
+  }
+
+  /**
+   * Resolves `fileName` to a filesystem URI (if the file exists), or falls
+   * back to the canonical default URI from `locateDefault`.
+   */
+  async locateOrDefault(
+    rootUri: URI,
+    nodeName: DocumentType,
+    fileName: string,
+    themeSearchPaths?: string[] | null,
+  ): Promise<string | undefined> {
+    return (
+      (await this.locate(rootUri, nodeName, fileName, themeSearchPaths)) ??
+      this.locateDefault(rootUri, nodeName, fileName)
+    );
+  }
+
   async locate(
     rootUri: URI,
     nodeName: DocumentType,