genauigkeit/src/init.js

Visual Regression Testing for Storybook

import { writeFile } from "node:fs/promises";
import path from "node:path";
import { consola } from "consola";
import { ensureDirSync } from "fs-extra";
import { config_defaults } from "./config.js";
import { GIT_IGNORE } from "./constants.js";

export async function init_config() {
    const port = Number.parseInt(
        await consola.prompt("Storybook Port", {
            type: "text",
            default: "6006",
            placeholder: "6006",
        }),
    );
    const directory = await consola.prompt("Screenshots directory", {
        type: "text",
        default: "./.genauigkeit",
        placeholder: "./.genauigkeit",
    });

    console.log();
    consola.info("Initializing genauigkeit");

    const config_path = path.join("./genauigkeit.config.js");
    let config = "/** @type {import('genauigkeit').Config} */";
    config += "\nexport default ";
    config += JSON.stringify(
        { ...config_defaults, port, directory },
        undefined,
        4,
    );

    await writeFile(config_path, config, {
        encoding: "utf-8",
    });
    consola.success(`${config_path} created.`);

    const gi_path = path.join(directory, ".gitignore");

    ensureDirSync(directory);
    ensureDirSync(path.join(directory, "current"));
    ensureDirSync(path.join(directory, "diffs"));
    ensureDirSync(path.join(directory, "references"));
    await writeFile(gi_path, GIT_IGNORE);
    consola.success(`${gi_path} created.`);

    let final = "genauigkeit is now ready!\n\n";
    final += "You can run `npx genauigkeit generate` to create references.\n";
    final += "After that, you can run `npx genauigkeit test` to run the tests.";
    final += "\nYou can also add scripts to your `package.json`:";
    final += '\n\n"scripts": {';
    final += '\n  "genauigkeit:generate": "genauigkeit generate",';
    final += '\n  "genauigkeit:test": "genauigkeit test"';
    final += "\n}";
    final += "\n\nHappy testing! 🎉";

    consola.box(final);
}