@platformos/platformos-common 0.0.2

package/src/path-utils.ts

@@ -0,0 +1,45 @@
+/**
+ * Utility functions for identifying platformOS file types based on their paths
+ */
+
+import { UriString } from './AbstractFileSystem';
+
+/**
+ * Checks if a URI points to a partial file.
+ * Partials can be located in:
+ * - app/lib
+ * - app/views/partials
+ * - app/modules/{moduleName}/public/lib
+ * - app/modules/{moduleName}/private/lib
+ * - app/modules/{moduleName}/public/views/partials
+ * - app/modules/{moduleName}/private/views/partials
+ * - modules/{moduleName}/public/lib
+ * - modules/{moduleName}/private/lib
+ * - modules/{moduleName}/public/views/partials
+ * - modules/{moduleName}/private/views/partials
+ */
+export function isPartial(uri: UriString): boolean {
+  return uri.includes('/lib/') || uri.includes('/views/partials');
+}
+
+/**
+ * Checks if a URI points to a page file.
+ * Pages are located in app/views/pages
+ */
+export function isPage(uri: UriString): boolean {
+  return uri.includes('/views/pages');
+}
+
+/**
+ * Checks if a URI points to a layout file.
+ * Layouts are located in app/views/layouts
+ */
+export function isLayout(uri: UriString): boolean {
+  return uri.includes('/views/layouts');
+}
+
+/**
+ * Legacy Shopify terminology - use isPartial instead
+ * @deprecated Use isPartial instead
+ */
+export const isSnippet = isPartial;

package/src/translation-provider/TranslationProvider.spec.ts

@@ -0,0 +1,151 @@
+import { describe, it, expect, vi } from 'vitest';
+import { URI } from 'vscode-uri';
+import { TranslationProvider } from './TranslationProvider';
+import { AbstractFileSystem, FileType, FileStat, FileTuple } from '../AbstractFileSystem';
+
+function createMockFileSystem(files: Record<string, string>): AbstractFileSystem {
+  const fileSet = new Set(Object.keys(files));
+
+  return {
+    stat: vi.fn(async (uri: string): Promise<FileStat> => {
+      if (fileSet.has(uri)) {
+        return { type: FileType.File, size: files[uri].length };
+      }
+      throw new Error(`File not found: ${uri}`);
+    }),
+    readFile: vi.fn(async (uri: string): Promise<string> => {
+      if (fileSet.has(uri)) {
+        return files[uri];
+      }
+      throw new Error(`File not found: ${uri}`);
+    }),
+    readDirectory: vi.fn(async (_uri: string): Promise<FileTuple[]> => []),
+  };
+}
+
+describe('TranslationProvider', () => {
+  const rootUri = URI.parse('file:///project');
+
+  describe('findTranslationFile', () => {
+    it('should find translation file in app/translations', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/translations/en/general.yml': 'en:\n  hello: Hello',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const [file, key] = await provider.findTranslationFile(rootUri, 'general.hello', 'en');
+
+      expect(file).toBe('file:///project/app/translations/en/general.yml');
+      expect(key).toBe('general.hello');
+    });
+
+    it('should find module translation file', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/modules/user/public/translations/en/messages.yml':
+          'en:\n  welcome: Welcome',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const [file, key] = await provider.findTranslationFile(
+        rootUri,
+        'modules/user/messages.welcome',
+        'en',
+      );
+
+      expect(file).toBe('file:///project/app/modules/user/public/translations/en/messages.yml');
+      expect(key).toBe('messages.welcome');
+    });
+
+    it('should return undefined for non-existent translation file', async () => {
+      const fs = createMockFileSystem({});
+      const provider = new TranslationProvider(fs);
+
+      const [file, key] = await provider.findTranslationFile(rootUri, 'missing.key', 'en');
+
+      expect(file).toBeUndefined();
+      expect(key).toBeUndefined();
+    });
+
+    it('should return undefined for empty translation key', async () => {
+      const fs = createMockFileSystem({});
+      const provider = new TranslationProvider(fs);
+
+      const [file, key] = await provider.findTranslationFile(rootUri, '', 'en');
+
+      expect(file).toBeUndefined();
+      expect(key).toBeUndefined();
+    });
+  });
+
+  describe('translate', () => {
+    it('should translate a simple key', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/translations/en/general.yml':
+          'en:\n  general:\n    hello: Hello World',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'general.hello', 'en');
+
+      expect(result).toBe('Hello World');
+    });
+
+    it('should translate nested keys', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/translations/en/forms.yml':
+          'en:\n  forms:\n    errors:\n      required: This field is required',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'forms.errors.required', 'en');
+
+      expect(result).toBe('This field is required');
+    });
+
+    it('should return undefined for missing nested key', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/translations/en/general.yml': 'en:\n  existing: value',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'general.missing.nested', 'en');
+
+      expect(result).toBeUndefined();
+    });
+
+    it('should translate module keys', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/modules/admin/public/translations/en/dashboard.yml':
+          'en:\n  dashboard:\n    title: Admin Dashboard',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'modules/admin/dashboard.title', 'en');
+
+      expect(result).toBe('Admin Dashboard');
+    });
+
+    it('should use default locale when not specified', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/translations/en/common.yml': 'en:\n  common:\n    yes: Yes',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'common.yes');
+
+      expect(result).toBe('Yes');
+    });
+
+    it('should check private module translations when public does not exist', async () => {
+      const fs = createMockFileSystem({
+        'file:///project/app/modules/internal/private/translations/en/secret.yml':
+          'en:\n  secret:\n    message: Secret Message',
+      });
+      const provider = new TranslationProvider(fs);
+
+      const result = await provider.translate(rootUri, 'modules/internal/secret.message', 'en');
+
+      expect(result).toBe('Secret Message');
+    });
+  });
+});

package/src/translation-provider/TranslationProvider.ts

@@ -0,0 +1,99 @@
+import { AbstractFileSystem, FileType } from '../AbstractFileSystem';
+import { URI, Utils } from 'vscode-uri';
+import yaml from 'js-yaml';
+
+type ModuleKeyInfo =
+  | { isModule: false; key: string }
+  | { isModule: true; moduleName: string; key: string };
+
+export class TranslationProvider {
+  constructor(private readonly fs: AbstractFileSystem) {}
+
+  private async isFile(path: string): Promise<boolean> {
+    try {
+      return (await this.fs.stat(path)).type === FileType.File;
+    } catch {
+      return false;
+    }
+  }
+
+  private async readFileIfExists(path: string): Promise<string | undefined> {
+    return (await this.isFile(path)) ? this.fs.readFile(path) : undefined;
+  }
+
+  private parseModuleKey(translationKey: string): ModuleKeyInfo {
+    if (!translationKey.startsWith('modules/')) {
+      return { isModule: false, key: translationKey };
+    }
+
+    const [, moduleName, key] = translationKey.split('/', 3);
+
+    return key ? { isModule: true, moduleName, key } : { isModule: false, key: translationKey };
+  }
+
+  private getSearchPaths(moduleName?: string): string[] {
+    if (!moduleName) {
+      return ['app/translations'];
+    }
+
+    return [
+      `app/modules/${moduleName}/public/translations`,
+      `app/modules/${moduleName}/private/translations`,
+      `modules/${moduleName}/public/translations`,
+      `modules/${moduleName}/private/translations`,
+    ];
+  }
+
+  async findTranslationFile(
+    rootUri: URI,
+    translationKey: string,
+    defaultLocale: string,
+  ): Promise<[string | undefined, string | undefined]> {
+    const parsed = this.parseModuleKey(translationKey);
+    const fileName = parsed.key.split('.')[0];
+
+    if (!fileName) {
+      return [undefined, undefined];
+    }
+
+    const searchPaths = this.getSearchPaths(parsed.isModule ? parsed.moduleName : undefined);
+
+    for (const basePath of searchPaths) {
+      const uri = Utils.joinPath(rootUri, basePath, defaultLocale, `${fileName}.yml`).toString();
+
+      if (await this.isFile(uri)) {
+        return [uri, parsed.key];
+      }
+    }
+
+    return [undefined, undefined];
+  }
+
+  async translate(
+    rootUri: URI,
+    translationKey: string,
+    defaultLocale: string = 'en',
+  ): Promise<string | undefined> {
+    const [file, key] = await this.findTranslationFile(rootUri, translationKey, defaultLocale);
+
+    if (!file || !key) {
+      return undefined;
+    }
+
+    const contents = await this.readFileIfExists(file);
+    if (!contents) {
+      return undefined;
+    }
+
+    let data: any = yaml.load(contents);
+
+    for (const part of [defaultLocale, ...key.split('.')]) {
+      data = data?.[part];
+      if (data === undefined) {
+        return undefined;
+      }
+    }
+
+    return data;
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["**/*.spec.ts"],
+  "references": []
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.json"
+  ],
+  "exclude": [
+    "./dist"
+  ],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
+    "paths": {
+    }
+  },
+  "references": [
+  ]
+}