@inlang/paraglide-js/dist/services/file-handling/write-output.test.js

[](https://inlang.com)

import memfs from "memfs";
import { test, expect, vi, beforeEach } from "vitest";
beforeEach(() => {
    vi.resetModules();
});
test("should write the output to a non-existing directory", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    await writeOutput({
        directory: "/output",
        output: { "test.txt": "test" },
        fs,
    });
    expect(await fs.readFile("/output/test.txt", { encoding: "utf-8" })).toBe("test");
});
test("should clear & overwrite output that's already there", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({
        "/output/test.txt": "old",
        "/output/other.txt": "other",
    });
    await writeOutput({
        directory: "/output",
        output: { "test.txt": "new" },
        cleanDirectory: true,
        fs,
    });
    expect(await fs.readFile("/output/test.txt", { encoding: "utf-8" })).toBe("new");
    await expect(async () => await fs.readFile("/output/other.txt", { encoding: "utf-8" })).rejects.toBeDefined();
});
test("should create any missing directories", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    await writeOutput({
        directory: "/output/messages",
        output: {
            "de/test.txt": "de",
            "en/test.txt": "en",
        },
        fs,
    });
    expect(await fs.readFile("/output/messages/de/test.txt", { encoding: "utf-8" })).toBe("de");
    expect(await fs.readFile("/output/messages/en/test.txt", { encoding: "utf-8" })).toBe("en");
});
test("should only write once if the output hasn't changed", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    // @ts-expect-error - spy
    fs.writeFile = vi.spyOn(fs, "writeFile");
    const hashes = await writeOutput({
        directory: "/output",
        output: { "test.txt": "test" },
        fs,
    });
    const hashes2 = await writeOutput({
        directory: "/output",
        output: { "test.txt": "test" },
        fs,
        previousOutputHashes: hashes,
    });
    expect(hashes).toEqual(hashes2);
    expect(await fs.readFile("/output/test.txt", { encoding: "utf-8" })).toBe("test");
    expect(fs.writeFile).toHaveBeenCalledTimes(1);
});
test("should write again if the output has changed", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    // @ts-expect-error - spy
    fs.writeFile = vi.spyOn(fs, "writeFile");
    const hashes = await writeOutput({
        directory: "/output",
        output: { "test.txt": "test" },
        fs,
    });
    await writeOutput({
        directory: "/output",
        output: { "test.txt": "test2" },
        fs,
        previousOutputHashes: hashes,
    });
    expect(await fs.readFile("/output/test.txt", { encoding: "utf-8" })).toBe("test2");
    expect(fs.writeFile).toHaveBeenCalledTimes(2);
});
test("should write files if output has partially changed", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    // @ts-expect-error - spy
    fs.writeFile = vi.spyOn(fs, "writeFile");
    const hashes = await writeOutput({
        directory: "/output",
        output: { "file1.txt": "test", "file2.txt": "test" },
        fs,
    });
    await writeOutput({
        directory: "/output",
        output: { "file1.txt": "test", "file2.txt": "test2" },
        fs,
        previousOutputHashes: hashes,
    });
    expect(fs.writeFile).toHaveBeenCalledWith("/output/file2.txt", "test2");
    expect(fs.writeFile).toHaveBeenCalledTimes(3);
});
test("should delete files that have been removed from the output", async () => {
    const { writeOutput } = await import("./write-output.js");
    const fs = mockFs({});
    // First write with three files
    const hashes = await writeOutput({
        directory: "/output",
        output: {
            "file1.txt": "content1",
            "file2.txt": "content2",
            "subdir/file3.txt": "content3",
        },
        fs,
    });
    // Verify all files were written
    expect(await fs.readFile("/output/file1.txt", { encoding: "utf-8" })).toBe("content1");
    expect(await fs.readFile("/output/file2.txt", { encoding: "utf-8" })).toBe("content2");
    expect(await fs.readFile("/output/subdir/file3.txt", { encoding: "utf-8" })).toBe("content3");
    // Second write with file2.txt removed
    await writeOutput({
        directory: "/output",
        output: {
            "file1.txt": "content1",
            "subdir/file3.txt": "content3updated",
        },
        fs,
        previousOutputHashes: hashes,
    });
    // Verify file1.txt still exists
    expect(await fs.readFile("/output/file1.txt", { encoding: "utf-8" })).toBe("content1");
    // Verify file2.txt has been deleted
    await expect(async () => await fs.readFile("/output/file2.txt", { encoding: "utf-8" })).rejects.toBeDefined();
    // Verify file3.txt was updated
    expect(await fs.readFile("/output/subdir/file3.txt", { encoding: "utf-8" })).toBe("content3updated");
    // Get the new hashes
    const newHashes = await writeOutput({
        directory: "/output",
        output: {
            "file1.txt": "content1",
            "subdir/file3.txt": "content3updated",
        },
        fs,
        previousOutputHashes: hashes,
    });
    // Third write with subdir/file3.txt removed
    await writeOutput({
        directory: "/output",
        output: {
            "file1.txt": "content1",
        },
        fs,
        previousOutputHashes: newHashes,
    });
    // Verify file1.txt still exists
    expect(await fs.readFile("/output/file1.txt", { encoding: "utf-8" })).toBe("content1");
    // Verify subdir/file3.txt has been deleted
    await expect(async () => await fs.readFile("/output/subdir/file3.txt", { encoding: "utf-8" })).rejects.toBeDefined();
    // Verify the subdir directory has also been removed
    await expect(async () => await fs.readdir("/output/subdir")).rejects.toBeDefined();
});
const mockFs = (files) => {
    const _memfs = memfs.createFsFromVolume(memfs.Volume.fromJSON(files));
    return _memfs.promises;
};