Function buildREADME

src/shared/build-tools.ts:373–445

(
  pkgMgr: string,
  mode: "nextjs" | "react-router" | "qwikcity"
)

}

export async function buildREADME(
  pkgMgr: string,
  mode: "nextjs" | "react-router" | "qwikcity"
) {
  const sortedPaths = Object.values(paths).sort((a, b) =>
    a.importPath.localeCompare(b.importPath)
  );

  let tasks: string[] = [];
  for (const { infoPath, verbs, importKey, pathTemplate } of sortedPaths) {
    if (verbs.length > 0) {
      for (const verb of verbs) {
        tasks.push(`\`${infoPath}\`: Add typing for \`${verb}\``);
        tasks.push(
          `Convert \`${verb}\` fetch calls to \`${pathTemplate}\` to \`${verb.toLowerCase()}${importKey}(...)\` calls`
        );
      }
    } else {
      tasks.push(
        `\`${infoPath}\`: Add search typing to if the page supports search paramaters`
      );
      tasks.push(
        `Convert \`Link\` components for \`${pathTemplate}\` to \`<${importKey}.Link>\``
      );
      if (infoPath.includes("[")) {
        tasks.push(
          `Convert \`params\` typing in \`${infoPath.replace(
            ".info",
            ""
          )}\` to \`z.infer<>\``
        );
      }
    }
  }

  const routes: {
    pathTemplate: string;
    verb: string;
    importKey: string;
    usage: string;
  }[] = [];
  for (const { pathTemplate, verbs, importKey } of sortedPaths) {
    if (verbs.length > 0) {
      for (const verb of verbs) {
        routes.push({
          pathTemplate,
          verb,
          importKey,
          usage: `${verb.toLowerCase()}${importKey}(...)`
        });
      }
    } else {
      routes.push({
        pathTemplate,
        verb: "-",
        importKey,
        usage: `<${importKey}.Link>`
      });