files.test.ts

import * as prettier from "prettier";
import { readFileSync } from "node:fs";
import { resolve } from "node:path";
import { AllOptions } from "../src/types";

import "jest-specific-snapshot";

function subjectFiles(relativePath: string, options: Partial<AllOptions> = {}) {
  const filepath = resolve(process.cwd(), "tests", relativePath);

  try {
    const code = readFileSync(filepath).toString();

    return prettier.format(code, {
      plugins: ["prettier-plugin-jsdoc"],
      jsdocSpaces: 1,
      trailingComma: "all",
      filepath,
      ...options,
    } as AllOptions);
  } catch (error) {
    console.error(error);
  }
}

const PrismOptions = {
  arrowParens: "avoid",
  printWidth: 120,
  quoteProps: "preserve",
  semi: true,
  singleQuote: true,
  tabWidth: 4,
  trailingComma: "none",
  useTabs: true,
  jsdocKeepUnParseAbleExampleIndent: true,
} as const;

/**
 * @type {TestFile[]}
 *
 * @typedef TestFile
 * @property {string} name
 * @property {import("prettier").Options} [options]
 */
const files: {
  name: string;
  options?: Partial<AllOptions>;
}[] = [
  { name: "typeScript.js" },
  { name: "typeScript.js" },
  { name: "typeScript.ts" },
  { name: "types.ts" },
  { name: "order.jsx" },
  { name: "create-ignorer.js" },
  {
    name: "prism-core.js",
    options: PrismOptions,
  },
  {
    name: "prism-dependencies.js",
    options: {
      jsdocSeparateTagGroups: true,
      ...PrismOptions,
    },
  },
  {
    name: "tsdoc.ts",
    options: {
      tsdoc: true,
    },
  },
  {
    name: "order-custom.jsx",
    options: {
      jsdocTagsOrder: '{"example":43, "typedef":0, "returns": 46}' as any,
      // {
      //   example: 70,
      // } as any,
    },
  },
];

for (let i = 0; i < files.length; i++) {
  const { name, options } = files[i];
  test(`File: ${name}`, async () => {
    const result = await subjectFiles("./files/" + name, options);
    (expect(result) as any).toMatchSpecificSnapshot(
      `./__snapshots__/files/${name}.shot`,
    );
  });
}