feat: support php buckets (#485)

Author: mathio

.changeset/curly-pandas-hear.md

@@ -0,0 +1,6 @@
+---
+"@lingo.dev/_spec": minor
+"lingo.dev": minor
+---
+
+add support for php buckets

packages/cli/package.json

@@ -44,10 +44,10 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@lingo.dev/_sdk": "workspace:*",
-    "@lingo.dev/_spec": "workspace:*",
     "@datocms/cma-client-node": "^3.4.0",
     "@inquirer/prompts": "^7.2.3",
+    "@lingo.dev/_sdk": "workspace:*",
+    "@lingo.dev/_spec": "workspace:*",
     "@paralleldrive/cuid2": "^2.2.2",
     "chalk": "^5.4.1",
     "cors": "^2.8.5",
@@ -81,6 +81,7 @@
     "open": "^10.1.0",
     "ora": "^8.1.1",
     "p-limit": "^6.2.0",
+    "php-array-reader": "^2.1.2",
     "plist": "^3.1.0",
     "prettier": "^3.4.2",
     "properties-parser": "^0.6.0",

packages/cli/src/cli/loaders/index.spec.ts

@@ -1560,6 +1560,63 @@ Mundo!`;
       });
     });
   });
+
+  describe("php bucket loader", () => {
+    it("should load php array", async () => {
+      setupFileMocks();
+
+      const input = `<?php return ['button.title' => 'Submit'];`;
+      const expectedOutput = { "button.title": "Submit" };
+
+      mockFileOperations(input);
+
+      const jsonLoader = createBucketLoader("php", "i18n/[locale].php");
+      jsonLoader.setDefaultLocale("en");
+      const data = await jsonLoader.pull("en");
+
+      expect(data).toEqual(expectedOutput);
+    });
+
+    it("should save php array", async () => {
+      setupFileMocks();
+
+      const input = `<?php 
+// this is locale
+
+return array(
+  'button.title' => 'Submit',
+  'button.description' => ['Hello', 'Goodbye'],
+  'button.index' => 1,
+  'button.class' => null,
+);`;
+      const expectedOutput = `<?php 
+// this is locale
+
+return array(
+  'button.title' => 'Enviar',
+  'button.description' => array(
+    'Hola',
+    'Adiós'
+  ),
+  'button.index' => 1,
+  'button.class' => null
+);`;
+
+      mockFileOperations(input);
+
+      const jsonLoader = createBucketLoader("php", "i18n/[locale].php");
+      jsonLoader.setDefaultLocale("en");
+      await jsonLoader.pull("en");
+
+      await jsonLoader.push("es", {
+        "button.title": "Enviar",
+        "button.description/0": "Hola",
+        "button.description/1": "Adiós",
+      });
+
+      expect(fs.writeFile).toHaveBeenCalledWith("i18n/es.php", expectedOutput, { encoding: "utf-8", flag: "w" });
+    });
+  });
 });
 
 // Helper functions

packages/cli/src/cli/loaders/index.ts

@@ -27,6 +27,7 @@ import createVttLoader from "./vtt";
 import createVariableLoader from "./variable";
 import createSyncLoader from "./sync";
 import createPlutilJsonTextLoader from "./plutil-json-loader";
+import createPhpLoader from "./php";
 
 type BucketLoaderOptions = {
   isCacheRestore?: boolean;
@@ -189,5 +190,13 @@ export default function createBucketLoader(
         createSyncLoader(),
         createUnlocalizableLoader(isCacheRestore),
       );
+    case "php":
+      return composeLoaders(
+        createTextFileLoader(bucketPathPattern),
+        createPhpLoader(),
+        createSyncLoader(),
+        createFlatLoader(),
+        createUnlocalizableLoader(),
+      );
   }
 }

packages/cli/src/cli/loaders/php.ts

@@ -0,0 +1,73 @@
+import { ILoader } from "./_types";
+import { createLoader } from "./_utils";
+import { fromString } from "php-array-reader";
+
+export default function createPhpLoader(): ILoader<string, Record<string, any>> {
+  return createLoader({
+    pull: async (locale, input) => {
+      try {
+        const output = fromString(input);
+        return output;
+      } catch (error) {
+        throw new Error(`Error parsing PHP file for locale ${locale}`);
+      }
+    },
+    push: async (locale, data, originalInput) => {
+      const output = toPhpString(data, originalInput);
+      return output;
+    },
+  });
+}
+
+function toPhpString(data: Record<string, any>, originalPhpString: string | null) {
+  const defaultFilePrefix = "<?php\n\n";
+  if (originalPhpString) {
+    const [filePrefix = defaultFilePrefix] = originalPhpString.split("return ");
+    const shortArraySyntax = !originalPhpString.includes("array(");
+    const output = `${filePrefix}return ${toPhpArray(data, shortArraySyntax)};`;
+    return output;
+  }
+  return `${defaultFilePrefix}return ${toPhpArray(data)};`;
+}
+
+function toPhpArray(data: any, shortSyntax = true, indentLevel = 1): string {
+  if (data === null || data === undefined) {
+    return "null";
+  }
+  if (typeof data === "string") {
+    return `'${escapePhpString(data)}'`;
+  }
+  if (typeof data === "number") {
+    return data.toString();
+  }
+  if (typeof data === "boolean") {
+    return data ? "true" : "false";
+  }
+
+  const arrayStart = shortSyntax ? "[" : "array(";
+  const arrayEnd = shortSyntax ? "]" : ")";
+
+  if (Array.isArray(data)) {
+    return `${arrayStart}\n${data
+      .map((value) => `${indent(indentLevel)}${toPhpArray(value, shortSyntax, indentLevel + 1)}`)
+      .join(",\n")}\n${indent(indentLevel - 1)}${arrayEnd}`;
+  }
+
+  const output = `${arrayStart}\n${Object.entries(data)
+    .map(([key, value]) => `${indent(indentLevel)}'${key}' => ${toPhpArray(value, shortSyntax, indentLevel + 1)}`)
+    .join(",\n")}\n${indent(indentLevel - 1)}${arrayEnd}`;
+  return output;
+}
+
+function indent(level: number) {
+  return "  ".repeat(level);
+}
+
+function escapePhpString(str: string) {
+  return str
+    .replaceAll("\\", "\\\\")
+    .replaceAll("'", "\\'")
+    .replaceAll("\r", "\\r")
+    .replaceAll("\n", "\\n")
+    .replaceAll("\t", "\\t");
+}

packages/cli/src/cli/utils/find-locale-paths.ts

@@ -16,6 +16,8 @@ export default function findLocaleFiles(bucket: string) {
       return findLocaleFilesWithExtension(".xml");
     case "markdown":
       return findLocaleFilesWithExtension(".md");
+    case "php":
+      return findLocaleFilesWithExtension(".php");
     case "xcode-xcstrings":
       return findLocaleFilesForFilename("Localizable.xcstrings");
     case "xcode-strings":

packages/spec/src/formats.ts

@@ -20,6 +20,7 @@ export const bucketTypes = [
   "dato",
   "compiler",
   "vtt",
+  "php",
 ] as const;
 
 export const bucketTypeSchema = Z.enum(bucketTypes);