Remix routes id as an array

routes_gen.mjs

// 1. copy and paste this in a remix project base directory.
// 2. run `node routes_gen.mjs <optional routes folder default to "./app/routes"> <optional output file default to "./app/routes.ts">`
// 3. you get a cool string[] of all the routes ids in a file inside your project


import fs from "fs";
import path from "path";

const routesFolder = process.argv[2] || "./app/routes/";
const outputFile = process.argv[3] || "./app/routes.ts";

const generateRoutes = (routesFolder, outputFile) => {
  fs.readdir(routesFolder, { withFileTypes: true }, (err, entries) => {
    if (err) {
      console.error("Error reading route files:", err);
      return;
    }

    const routeIds = [
      "root",
      ...entries.map((entry) => {
        const { name } = entry;
        if (entry.isDirectory()) {
          return `routes/${name}`;
        } else {
          const { name: fileName } = path.parse(name);
          return `routes/${fileName}`;
        }
      }),
    ];

    const exportStatement = `export const routes = ${JSON.stringify(
      routeIds
    )} as const;\n`;

    fs.writeFile(outputFile, exportStatement, (writeErr) => {
      if (writeErr) {
        console.error("Error writing to output file:", writeErr);
        return;
      }
      console.log("Output file created:", outputFile);
    });
  });
};

generateRoutes(routesFolder, outputFile);