get-fixtures.js

import fs from "node:fs";
import path from "node:path";
import { FORMAT_SCRIPT_FILENAME } from "./constants.js";
import visualizeEndOfLine from "./visualize-end-of-line.js";

/**
@import {Context} from "./run-format-test.js"
@typedef {Exclude<ReturnType<ReturnType<getFixtures>["next"]>["value"], void>} Fixture
*/

/**
@param {Context} context
*/
function* getFixtures(context) {
  yield* getFiles(context);
  yield* getSnippets(context);
}

/**
@param {Context} context
*/
function* getFiles(context) {
  const { dirname } = context;
  for (const file of fs.readdirSync(dirname, { withFileTypes: true })) {
    const filename = file.name;
    const filepath = path.join(dirname, filename);
    if (
      !file.isFile() ||
      filename[0] === "." ||
      filename === FORMAT_SCRIPT_FILENAME ||
      // VSCode creates this file sometime https://github.com/microsoft/vscode/issues/105191
      filename === "debug.log" ||
      path.extname(filename) === ".snap"
    ) {
      continue;
    }

    const text = fs.readFileSync(filepath, "utf8");

    yield {
      context,
      name: filename,
      filename,
      filepath,
      code: text,
    };
  }
}

/**
@param {Context} context
*/
function* getSnippets(context) {
  for (const [index, snippet] of context.snippets.entries()) {
    const testCase =
      typeof snippet === "string"
        ? { code: snippet, context }
        : { ...snippet, context };

    if (typeof testCase.code !== "string") {
      throw Object.assign(new Error("Invalid test"), { snippet });
    }

    if (typeof testCase.output === "string") {
      testCase.output = visualizeEndOfLine(testCase.output);
    }

    testCase.name = `snippet: ${testCase.name || `#${index}`}`;

    if (typeof testCase.filename === "string") {
      testCase.filepath = path.join(context.dirname, testCase.filename);
    }

    yield testCase;
  }
}

export { getFixtures };