@dittowords/cli 4.5.2 → 5.0.0-beta.0

package/lib/pull-lib.test.ts

@@ -1,367 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { _test } from "./pull";
-import { jest } from "@jest/globals";
-import axios from "axios";
-const axiosMock = jest.mocked(axios);
-
-jest.mock("fs");
-jest.mock("./api");
-
-const testProjects: Project[] = [
-  {
-    id: "1",
-    name: "Project 1",
-    fileName: "Project 1",
-  },
-  { id: "2", name: "Project 2", fileName: "Project 2" },
-];
-
-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 consts from "./consts";
-import allPull, { getFormatDataIsValid } from "./pull";
-import { Project, SupportedExtension, SupportedFormat } from "./types";
-
-const {
-  _testing: { cleanOutputFiles, downloadAndSaveBase },
-} = allPull;
-
-const cleanOutputDir = () => {
-  if (fs.existsSync(consts.TEXT_DIR))
-    fs.rmSync(consts.TEXT_DIR, { recursive: true, force: true });
-
-  fs.mkdirSync(consts.TEXT_DIR);
-};
-
-afterAll(() => {
-  fs.rmSync(consts.TEXT_DIR, { force: true, recursive: true });
-});
-
-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();
-
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(1);
-  });
-});
-
-describe("downloadAndSaveBase", () => {
-  beforeAll(() => {
-    if (!fs.existsSync(consts.TEXT_DIR)) {
-      fs.mkdirSync(consts.TEXT_DIR);
-    }
-  });
-
-  beforeEach(() => {
-    cleanOutputDir();
-  });
-
-  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) => {
-    axiosMock.get.mockResolvedValue({ data });
-  };
-
-  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"
-    );
-
-    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;
-    }
-  };
-
-  formats.forEach(({ format, data, ext }) => {
-    it(`writes the ${format} format to disk`, async () => {
-      mockApiCall(data);
-      await verifySavedData(format, data, ext);
-    });
-  });
-});
-
-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);
-  });
-});
-
-const { getJsonFormat } = _test;
-describe("getJsonFormat", () => {
-  it("returns 'flat' if no format specified", () => {
-    expect(getJsonFormat([])).toBe("flat");
-  });
-  it("returns 'flat' if invalid format specified", () => {
-    expect(getJsonFormat(["invalid-format"])).toBe("flat");
-  });
-  it("returns valid specified formats", () => {
-    expect(getJsonFormat(["structured"])).toBe("structured");
-    expect(getJsonFormat(["nested"])).toBe("nested");
-    expect(getJsonFormat(["icu"])).toBe("icu");
-    expect(getJsonFormat(["flat"])).toBe("flat");
-  });
-  it("returns last of formats if multiple specified", () => {
-    expect(getJsonFormat(["flat", "structured", "icu"])).toBe("icu");
-    expect(getJsonFormat(["flat", "icu", "structured"])).toBe("structured");
-  });
-});
-
-const { getJsonFormatIsValid } = _test;
-describe("getJsonFormatIsValid", () => {
-  it("returns true for valid json", () => {
-    expect(getJsonFormatIsValid(`{ "key": "value" }`)).toBe(true);
-    expect(getJsonFormatIsValid(`{ "key": { "text": "value" }}`)).toBe(true);
-    expect(getJsonFormatIsValid(`{ "nested": { "key": "value" }}`)).toBe(true);
-  });
-  it("returns false for empty json", () => {
-    expect(getJsonFormatIsValid(`{}`)).toBe(false);
-  });
-  it("returns false for invalid json", () => {
-    expect(getJsonFormatIsValid(`abcdefg`)).toBe(false);
-  });
-});
-
-const { ensureEndsWithNewLine } = _test;
-describe("ensureEndsWithNewLine", () => {
-  it("adds a newline to the end of a string if it doesn't already have one", () => {
-    expect(ensureEndsWithNewLine("hello")).toBe("hello\n");
-  });
-  it("doesn't add a newline to the end of a string if it already has one", () => {
-    expect(ensureEndsWithNewLine("hello\n")).toBe("hello\n");
-  });
-});

package/lib/pull.test.ts

@@ -1,117 +0,0 @@
-import { pull } from "./pull";
-import { vol } from "memfs";
-import consts from "./consts";
-import { jest } from "@jest/globals";
-import axios from "axios";
-const axiosMock = jest.mocked(axios);
-import fs from "fs";
-
-jest.mock("fs");
-jest.mock("./api");
-
-jest.mock("./http/fetchComponentFolders");
-jest.mock("./http/fetchComponents");
-jest.mock("./http/fetchVariants");
-
-const defaultEnv = { ...process.env };
-
-beforeEach(() => {
-  vol.reset();
-  process.env = { ...defaultEnv };
-});
-
-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" })
-    );
-
-    vol.fromJSON({
-      [consts.CONFIG_FILE]: mockGlobalConfigFile,
-      [consts.PROJECT_CONFIG_FILE]: mockProjectConfigFile,
-    });
-
-    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);
-    });
-
-    expect(filesOnDiskExpected.size).toBe(0);
-  });
-
-  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";
-
-    // 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" })
-    );
-
-    vol.fromJSON({
-      [consts.CONFIG_FILE]: mockGlobalConfigFile,
-      [consts.PROJECT_CONFIG_FILE]:
-        mockProjectConfigFile + "\n" + "disableJsDriver: true",
-    });
-
-    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);
-    });
-
-    expect(filesOnDiskExpected.size).toBe(0);
-  });
-});