@dittowords/cli 4.4.0 → 4.5.0

package/lib/pull.test.ts

@@ -1,330 +1,117 @@
-import fs from "fs";
-import path from "path";
-
-jest.mock("./api", () => ({
-  createApiClient: jest.fn(), // this needs to be mocked in each test that requires it
-}));
-import { createApiClient } from "./api";
-
-const testProjects: Project[] = [
-  {
-    id: "1",
-    name: "Project 1",
-    fileName: "Project 1",
-  },
-  { id: "2", name: "Project 2", fileName: "Project 2" },
-];
-
-// TODO: all tests in this file currently failing because we're re-instantiating the api client
-// everywhere and are unable to mock the return type separately for each instance of usage.
-// We need to refactor to share one api client everywhere instead of always re-creating it.
-const mockApi = createApiClient() as any as jest.Mocked<
-  ReturnType<typeof createApiClient>
->;
-
-jest.mock("./consts", () => ({
-  TEXT_DIR: ".testing",
-  API_HOST: "https://api.dittowords.com",
-  CONFIG_FILE: ".testing/ditto",
-  PROJECT_CONFIG_FILE: ".testing/config.yml",
-  TEXT_FILE: ".testing/text.json",
-}));
-
+import { pull } from "./pull";
+import { vol } from "memfs";
 import consts from "./consts";
-import allPull, { getFormatDataIsValid } from "./pull";
-import { Project, SupportedExtension, SupportedFormat } from "./types";
+import { jest } from "@jest/globals";
+import axios from "axios";
+const axiosMock = jest.mocked(axios);
+import fs from "fs";
 
-const {
-  _testing: { cleanOutputFiles, downloadAndSaveVariant, downloadAndSaveBase },
-} = allPull;
-const variant = "english";
+jest.mock("fs");
+jest.mock("./api");
 
-const cleanOutputDir = () => {
-  if (fs.existsSync(consts.TEXT_DIR))
-    fs.rmSync(consts.TEXT_DIR, { recursive: true, force: true });
+jest.mock("./http/fetchComponentFolders");
+jest.mock("./http/fetchComponents");
+jest.mock("./http/fetchVariants");
 
-  fs.mkdirSync(consts.TEXT_DIR);
-};
+const defaultEnv = { ...process.env };
 
-afterAll(() => {
-  fs.rmSync(consts.TEXT_DIR, { force: true, recursive: true });
+beforeEach(() => {
+  vol.reset();
+  process.env = { ...defaultEnv };
 });
 
-describe("cleanOutputFiles", () => {
-  it("removes .js, .json, .xml, .strings, .stringsdict files", () => {
-    cleanOutputDir();
-
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.json"), "test");
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.js"), "test");
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.xml"), "test");
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.strings"), "test");
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.stringsdict"), "test");
-    // this file shouldn't be deleted
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.txt"), "test");
-
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(6);
-
-    cleanOutputFiles();
+const mockGlobalConfigFile = `
+api.dittowords.com:
+  - token: xxx-xxx-xxx
+`;
+const mockProjectConfigFile = `
+sources:
+  components: true
+  projects:
+    - id: project-id-1
+      name: Test Project
+variants: true
+`;
+
+describe("pull", () => {
+  it("correctly writes files to disk per source for basic config", async () => {
+    process.env.DITTO_TEXT_DIR = "/ditto";
+    process.env.DITTO_PROJECT_CONFIG_FILE = "/ditto/config.yml";
+
+    // we need to manually mock responses for the http calls that happen
+    // directly within the pull function; we don't need to mock the http
+    // calls that happen by way of http/* function calls since those have
+    // their own mocks already.
+    axiosMock.get.mockImplementation(
+      (): Promise<any> => Promise.resolve({ data: "data" })
+    );
 
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(1);
-  });
-});
+    vol.fromJSON({
+      [consts.CONFIG_FILE]: mockGlobalConfigFile,
+      [consts.PROJECT_CONFIG_FILE]: mockProjectConfigFile,
+    });
 
-describe("downloadAndSaveBase", () => {
-  beforeAll(() => {
-    if (!fs.existsSync(consts.TEXT_DIR)) {
-      fs.mkdirSync(consts.TEXT_DIR);
-    }
-  });
+    await pull();
+
+    const filesOnDiskExpected = new Set([
+      "components__example-folder__base.json",
+      "components__example-folder__example-variant-1.json",
+      "components__example-folder__example-variant-2.json",
+      "components__root__base.json",
+      "components__root__example-variant-1.json",
+      "components__root__example-variant-2.json",
+      "test-project__base.json",
+      "test-project__example-variant-1.json",
+      "test-project__example-variant-2.json",
+      "index.d.ts",
+      "index.js",
+    ]);
+
+    const filesOnDisk = fs.readdirSync("/ditto");
+    filesOnDisk.forEach((file) => {
+      filesOnDiskExpected.delete(file);
+    });
 
-  beforeEach(() => {
-    cleanOutputDir();
+    expect(filesOnDiskExpected.size).toBe(0);
   });
 
-  const mockDataFlat = { hello: "world" };
-  const mockDataNested = { hello: { text: "world" } };
-  const mockDataStructured = { hello: { text: "world" } };
-  const mockDataIcu = { hello: "world" };
-  const mockDataAndroid = `
-      <?xml version="1.0" encoding="utf-8"?>
-      <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
-          <string name="hello-world" ditto_api_id="hello-world">Hello World</string>
-      </resources>
-    `;
-  const mockDataIosStrings = `
-      "hello" = "world"; 
-    `;
-  const mockDataIosStringsDict = `
-      <?xml version="1.0" encoding="utf-8"?>
-      <plist version="1.0">
-          <dict>
-              <key>hello-world</key>
-              <dict>
-                  <key>NSStringLocalizedFormatKey</key>
-                  <string>%1$#@count@</string>
-                  <key>count</key>
-                  <dict>
-                      <key>NSStringFormatSpecTypeKey</key>
-                      <string>NSStringPluralRuleType</string>
-                      <key>NSStringFormatValueTypeKey</key>
-                      <string>d</string>
-                      <key>other</key>
-                      <string>espanol</string>
-                  </dict>
-              </dict>
-          </dict>
-      </plist>
-    `;
-
-  const formats: Array<{
-    format: SupportedFormat;
-    data: Object;
-    ext: SupportedExtension;
-  }> = [
-    { format: "flat", data: mockDataFlat, ext: ".json" },
-    { format: "nested", data: mockDataNested, ext: ".json" },
-    { format: "structured", data: mockDataStructured, ext: ".json" },
-    { format: "icu", data: mockDataIcu, ext: ".json" },
-    { format: "android", data: mockDataAndroid, ext: ".xml" },
-    { format: "ios-strings", data: mockDataIosStrings, ext: ".strings" },
-    {
-      format: "ios-stringsdict",
-      data: mockDataIosStringsDict,
-      ext: ".stringsdict",
-    },
-  ];
-
-  const mockApiCall = (data: unknown) => {
-    (createApiClient as any).mockImplementation(() => ({
-      get: () => ({ data }),
-    }));
-  };
+  it("correctly does not write index.js or index.d.ts when `disableJsDriver: true` is specified", async () => {
+    process.env.DITTO_TEXT_DIR = "/ditto";
+    process.env.DITTO_PROJECT_CONFIG_FILE = "/ditto/config.yml";
 
-  const verifySavedData = async (
-    format: SupportedFormat,
-    data: unknown,
-    ext: SupportedExtension
-  ) => {
-    const output = await downloadAndSaveBase({
-      projects: testProjects,
-      format: format,
-    } as any);
-    expect(/successfully saved/i.test(output)).toEqual(true);
-    const directoryContents = fs.readdirSync(consts.TEXT_DIR);
-    expect(directoryContents.length).toEqual(testProjects.length);
-    expect(directoryContents.every((f) => f.endsWith(ext))).toBe(true);
-    const fileDataString = fs.readFileSync(
-      path.resolve(consts.TEXT_DIR, directoryContents[0]),
-      "utf8"
+    // we need to manually mock responses for the http calls that happen
+    // directly within the pull function; we don't need to mock the http
+    // calls that happen by way of http/* function calls since those have
+    // their own mocks already.
+    axiosMock.get.mockImplementation(
+      (): Promise<any> => Promise.resolve({ data: "data" })
     );
 
-    switch (format) {
-      case "android":
-      case "ios-strings":
-      case "ios-stringsdict":
-        expect(typeof data).toBe("string");
-        expect(fileDataString.replace(/\s/g, "")).toEqual(
-          (data as string).replace(/\s/g, "")
-        );
-        break;
-
-      case "flat":
-      case "nested":
-      case "structured":
-      case "icu":
-      default:
-        expect(JSON.parse(fileDataString)).toEqual(data);
-        break;
-    }
-  };
+    vol.fromJSON({
+      [consts.CONFIG_FILE]: mockGlobalConfigFile,
+      [consts.PROJECT_CONFIG_FILE]:
+        mockProjectConfigFile + "\n" + "disableJsDriver: true",
+    });
 
-  formats.forEach(({ format, data, ext }) => {
-    it(`writes the ${format} format to disk`, async () => {
-      mockApiCall(data);
-      await verifySavedData(format, data, ext);
+    await pull();
+
+    const filesOnDiskExpected = new Set([
+      "components__example-folder__base.json",
+      "components__example-folder__example-variant-1.json",
+      "components__example-folder__example-variant-2.json",
+      "components__root__base.json",
+      "components__root__example-variant-1.json",
+      "components__root__example-variant-2.json",
+      "test-project__base.json",
+      "test-project__example-variant-1.json",
+      "test-project__example-variant-2.json",
+    ]);
+
+    const filesOnDisk = fs.readdirSync("/ditto");
+    filesOnDisk.forEach((file) => {
+      filesOnDiskExpected.delete(file);
     });
-  });
-});
 
-describe("getFormatDataIsValid", () => {
-  it("handles flat format appropriately", () => {
-    expect(getFormatDataIsValid.flat("{}")).toBe(false);
-    expect(getFormatDataIsValid.flat(`{ "hello": "world" }`)).toBe(true);
-    expect(
-      getFormatDataIsValid.flat(`{
-      "__variant-name": "English",
-      "__variant-description": ""
-    }`)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid.flat(`{
-      "__variant-name": "English",
-      "__variant-description": "",
-      "hello": "world"
-    }`)
-    ).toBe(true);
-  });
-  it("handles structured format appropriately", () => {
-    expect(getFormatDataIsValid.structured("{}")).toBe(false);
-    expect(
-      getFormatDataIsValid.structured(`{ "hello": { "text": "world" } }`)
-    ).toBe(true);
-    expect(
-      getFormatDataIsValid.structured(`{
-      "__variant-name": "English",
-      "__variant-description": ""
-    }`)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid.structured(`{
-      "__variant-name": "English",
-      "__variant-description": "",
-      "hello": { "text": "world" }
-    }`)
-    ).toBe(true);
-  });
-  it("handles icu format appropriately", () => {
-    expect(getFormatDataIsValid.icu("{}")).toBe(false);
-    expect(getFormatDataIsValid.icu(`{ "hello": "world" }`)).toBe(true);
-    expect(
-      getFormatDataIsValid.icu(`{
-      "__variant-name": "English",
-      "__variant-description": ""
-    }`)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid.icu(`{
-      "__variant-name": "English",
-      "__variant-description": "",
-      "hello": "world"
-    }`)
-    ).toBe(true);
-  });
-  it("handles android format appropriately", () => {
-    expect(
-      getFormatDataIsValid.android(`
-      <?xml version="1.0" encoding="utf-8"?>
-      <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2"/>
-    `)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid.android(`
-      <?xml version="1.0" encoding="utf-8"?>
-      <!--Variant Name: English-->
-      <!--Variant Description: -->
-      <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2"/>
-    `)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid.android(`
-      <?xml version="1.0" encoding="utf-8"?>
-      <!--Variant Name: English-->
-      <!--Variant Description: -->
-      <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
-          <string name="hello-world" ditto_api_id="hello-world">Hello World</string>
-      </resources>
-    `)
-    ).toBe(true);
-  });
-  it("handles ios-strings format appropriately", () => {
-    expect(getFormatDataIsValid["ios-strings"]("")).toBe(false);
-    expect(
-      getFormatDataIsValid["ios-strings"](`
-        /* Variant Name: English */
-        /* Variant Description: */
-      `)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid["ios-strings"](`
-        /* Variant Name: English */
-        /* Variant Description: */
-        "Hello" = "World";
-      `)
-    ).toBe(true);
-  });
-  it("handles ios-stringsdict format appropriately", () => {
-    expect(
-      getFormatDataIsValid["ios-stringsdict"](`
-        <?xml version="1.0" encoding="utf-8"?>
-        <plist version="1.0">
-            <dict/>
-        </plist>
-      `)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid["ios-stringsdict"](`
-        <?xml version="1.0" encoding="utf-8"?>
-        <!--Variant Name: English-->
-        <!--Variant Description: -->
-        <plist version="1.0">
-            <dict/>
-        </plist>
-      `)
-    ).toBe(false);
-    expect(
-      getFormatDataIsValid["ios-stringsdict"](`
-        <?xml version="1.0" encoding="utf-8"?>
-        <!--Variant Name: English-->
-        <!--Variant Description: -->
-        <plist version="1.0">
-            <dict>
-              <key>Hello World</key>
-              <dict>
-                  <key>NSStringLocalizedFormatKey</key>
-                  <string>%1$#@count@</string>
-                  <key>count</key>
-                  <dict>
-                      <key>NSStringFormatSpecTypeKey</key>
-                      <string>NSStringPluralRuleType</string>
-                      <key>NSStringFormatValueTypeKey</key>
-                      <string>d</string>
-                      <key>other</key>
-                      <string>espanol</string>
-                  </dict>
-              </dict>
-            </dict>
-        </plist>
-      `)
-    ).toBe(true);
+    expect(filesOnDiskExpected.size).toBe(0);
   });
 });

package/lib/pull.ts

@@ -286,7 +286,7 @@ function cleanOutputFiles() {
 
     if (
       item.isFile() &&
-      /\.js(on)?|\.xml|\.strings(dict)?$|\.swift$/.test(item.name)
+      /\.js(on)?|\.ts|\.xml|\.strings(dict)?$|\.swift$/.test(item.name)
     ) {
       return fs.unlinkSync(path.resolve(consts.TEXT_DIR, item.name));
     }
@@ -310,6 +310,7 @@ async function downloadAndSave(
     componentFolders: specifiedComponentFolders,
     componentRoot,
     localeByVariantApiId,
+    disableJsDriver,
   } = source;
 
   const formats = getFormat(formatFromSource);
@@ -525,7 +526,8 @@ async function downloadAndSave(
 
     const sources: Source[] = [...validProjects, ...componentSources];
 
-    if (hasJSONFormat) msg += generateJsDriver(sources, getJsonFormat(formats));
+    if (hasJSONFormat && !disableJsDriver)
+      msg += generateJsDriver(sources, getJsonFormat(formats));
 
     if (shouldGenerateIOSBundles) {
       msg += "iOS locale information detected, generating bundles..\n\n";
@@ -583,7 +585,7 @@ export interface PullOptions {
 
 export const pull = async (options?: PullOptions) => {
   const meta = options ? options.meta : {};
-  const includeSampleData = options?.includeSampleData || false
+  const includeSampleData = options?.includeSampleData || false;
   const token = config.getToken(consts.CONFIG_FILE, consts.API_HOST);
   const sourceInformation = config.parseSourceInformation();
 
@@ -620,3 +622,9 @@ export default {
     downloadAndSaveBase,
   },
 };
+
+export const _test = {
+  getJsonFormat,
+  getJsonFormatIsValid,
+  ensureEndsWithNewLine,
+};

package/lib/replace.test.ts

@@ -1,16 +1,30 @@
-import fs from "fs/promises";
+import fs from "fs";
 import { parseOptions, replaceJSXTextInFile } from "./replace"; // Assuming the function is exported in a separate file
 
+jest.mock("fs");
+
 // Helper function to create a temporary file
 async function createTempJSXFile(content: string): Promise<string> {
-  const tempFile = "tempFile.jsx";
-  await fs.writeFile(tempFile, content);
+  const tempFile = "/tempFile.jsx";
+  await new Promise((resolve, reject) => {
+    try {
+      fs.writeFile(tempFile, content, resolve);
+    } catch (e) {
+      reject(e);
+    }
+  });
   return tempFile;
 }
 
 // Helper function to delete the temporary file
 async function deleteTempFile(filePath: string): Promise<void> {
-  await fs.unlink(filePath);
+  await new Promise((resolve, reject) => {
+    try {
+      fs.unlink(filePath, resolve);
+    } catch (e) {
+      reject(e);
+    }
+  });
 }
 
 describe("parseOptions", () => {
@@ -57,10 +71,9 @@ describe("parseOptions", () => {
   });
 });
 
-// TODO: this is flaky
 describe("replaceJSXTextInFile", () => {
   afterEach(async () => {
-    await deleteTempFile("tempFile.jsx");
+    await deleteTempFile("/tempFile.jsx");
   });
 
   test("should replace JSX text with a DittoComponent", async () => {
@@ -70,7 +83,15 @@ describe("replaceJSXTextInFile", () => {
 
     await replaceJSXTextInFile(tempFile, { searchString, replaceWith }, {});
 
-    const transformedCode = await fs.readFile(tempFile, "utf-8");
+    const transformedCode = await new Promise((resolve, reject) => {
+      fs.readFile(tempFile, "utf-8", (error, data) => {
+        if (error) {
+          reject(error);
+        } else {
+          resolve(data);
+        }
+      });
+    });
     expect(transformedCode).toContain(
       `<div>Hello, <DittoComponent componentId="${replaceWith}" /></div>`
     );
@@ -89,7 +110,12 @@ describe("replaceJSXTextInFile", () => {
       { lineNumbers: [3] }
     );
 
-    const transformedCode = await fs.readFile(tempFile, "utf-8");
+    const transformedCode = await new Promise((resolve, reject) =>
+      fs.readFile(tempFile, "utf-8", (error, data) => {
+        if (error) reject(error);
+        else resolve(data);
+      })
+    );
     expect(transformedCode).toContain(
       `<>\n  <div>Hello, world</div>\n  <div>Hello, <DittoComponent componentId=\"some-id\" /></div>\n</>;`
     );
@@ -102,7 +128,12 @@ describe("replaceJSXTextInFile", () => {
 
     await replaceJSXTextInFile(tempFile, { searchString, replaceWith }, {});
 
-    const transformedCode = await fs.readFile(tempFile, "utf-8");
+    const transformedCode = await new Promise((resolve, reject) =>
+      fs.readFile(tempFile, "utf-8", (error, data) => {
+        if (error) reject(error);
+        else resolve(data);
+      })
+    );
     expect(transformedCode).toContain(
       `<div>HeLLo, <DittoComponent componentId="${replaceWith}" /></div>`
     );
@@ -115,7 +146,12 @@ describe("replaceJSXTextInFile", () => {
 
     await replaceJSXTextInFile(tempFile, { searchString, replaceWith }, {});
 
-    const transformedCode = await fs.readFile(tempFile, "utf-8");
+    const transformedCode = await new Promise((resolve, reject) =>
+      fs.readFile(tempFile, "utf-8", (error, data) => {
+        if (error) reject(error);
+        else resolve(data);
+      })
+    );
     expect(transformedCode).toContain("<div>Hello, world!</div>");
   });
 });

package/lib/replace.ts

@@ -1,4 +1,4 @@
-import fs from "fs-extra";
+import fs from "fs";
 import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 import * as t from "@babel/types";
@@ -11,7 +11,15 @@ async function replaceJSXTextInFile(
     lineNumbers?: number[];
   }
 ) {
-  const code = await fs.readFile(filePath, "utf-8");
+  const code = await new Promise<string>((resolve, reject) =>
+    fs.readFile(filePath, "utf-8", (err, data) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(data);
+      }
+    })
+  );
   const ast = parse(code, {
     sourceType: "module",
     plugins: ["jsx", "typescript"],
@@ -69,7 +77,16 @@ async function replaceJSXTextInFile(
     /* @ts-ignore */
     configFile: false,
   });
-  fs.writeFile(filePath, transformedCode);
+
+  await new Promise((resolve, reject) =>
+    fs.writeFile(filePath, transformedCode, (err) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(null);
+      }
+    })
+  );
 }
 
 function splitByCaseInsensitive(str: string, delimiter: string) {

package/lib/types.ts

@@ -52,6 +52,10 @@ export interface ConfigYAML {
   // TODO: might want to rename this at some point
   iosLocales?: Record<string, string>[];
 
+  // prevents the generation of index.js and index.d.ts files
+  // when working with JSON formats
+  disableJsDriver?: boolean;
+
   // these are legacy fields - if they exist, we should output
   // a deprecation error, and suggest that they nest them under
   // a top-level `sources` property
@@ -73,6 +77,7 @@ export interface SourceInformation {
   componentRoot: boolean | { status: string } | undefined;
   componentFolders: ComponentFolder[] | undefined;
   localeByVariantApiId: Record<string, string> | undefined;
+  disableJsDriver?: boolean;
 }
 
 export type Token = string | undefined;

package/lib/utils/determineModuleType.test.ts

@@ -0,0 +1,48 @@
+import { determineModuleType } from "./determineModuleType";
+import { vol } from "memfs";
+
+const defaultEnv = process.env;
+
+jest.mock("fs");
+
+beforeEach(() => {
+  vol.reset();
+  process.env = { ...defaultEnv };
+});
+
+test("'commonjs' if no package.json found", () => {
+  expect(determineModuleType()).toBe("commonjs");
+});
+
+test("'commonjs' if package.json found but no `type` property", () => {
+  vol.fromJSON({ "package.json": JSON.stringify({}) }, process.cwd());
+  expect(determineModuleType()).toBe("commonjs");
+});
+
+test("'commonjs' if package.json found and `type` property is 'commonjs'", () => {
+  vol.fromJSON({ "package.json": JSON.stringify({ type: "commonjs" }) });
+  expect(determineModuleType()).toBe("commonjs");
+});
+
+test("'commonjs' if package.json found and `type` property is invalid", () => {
+  vol.fromJSON({ "package.json": JSON.stringify({ type: "invalid-type" }) });
+  expect(determineModuleType()).toBe("commonjs");
+});
+
+test("'module' if package.json found and `type` property is 'module'", () => {
+  vol.fromJSON({ "package.json": JSON.stringify({ type: "module" }) });
+  expect(determineModuleType()).toBe("module");
+});
+
+test("finds package.json in parent directories", () => {
+  vol.fromJSON({
+    "/some/nested/dir/test.txt": "",
+    "/package.json": JSON.stringify({ type: "module" }),
+  });
+  expect(determineModuleType("/some/nested/dir")).toBe("module");
+});
+
+test("supports explicit specification of module type via environment variable", () => {
+  process.env.DITTO_MODULE_TYPE = "module";
+  expect(determineModuleType()).toBe("module");
+});