Class Remix

packages/cli/src/frameworks/remix/index.ts:13–110

import { standardWatchFilePaths } from "../watchConfig";

export class Remix implements Framework {
  id = "remix";
  name = "Remix";

  async isMatch(path: string, packageManager: PackageManager): Promise<boolean> {
    //check for remix.config.js
    const hasConfigFile = await pathExists(pathModule.join(path, "remix.config.js"));
    if (hasConfigFile) {
      return true;
    }

    //check for any packages starting with @remix-run
    const packageJsonContent = await readPackageJson(path);
    if (!packageJsonContent) {
      return false;
    }

    const keys = Object.keys(packageJsonContent.dependencies || {});
    const dependencyWithRemix = keys.find((key) => key.startsWith("@remix-run"));
    if (dependencyWithRemix) {
      return true;
    }

    return false;
  }

  async dependencies(): Promise<InstallPackage[]> {
    return [
      { name: "@trigger.dev/sdk", tag: "latest" },
      { name: "@trigger.dev/remix", tag: "latest" },
      { name: "@trigger.dev/react", tag: "latest" },
    ];
  }

  possibleEnvFilenames(): string[] {
    return [".env"];
  }

  async install(path: string, { typescript, endpointSlug }: ProjectInstallOptions): Promise<void> {
    const pathAlias = await getPathAlias({
      projectPath: path,
      isTypescriptProject: typescript,
      extraDirectories: ["app"],
    });
    const templatesDir = pathModule.join(templatesPath(), "remix");
    const appFolder = pathModule.join(path, "app");
    const fileExtension = typescript ? ".ts" : ".js";

    //create app/api.trigger.js
    const apiRoutePath = pathModule.join(appFolder, "routes", `api.trigger${fileExtension}`);
    const apiRouteResult = await createFileFromTemplate({
      templatePath: pathModule.join(templatesDir, "apiRoute.js"),
      replacements: {
        routePathPrefix: pathAlias ? pathAlias + "/" : "../../",
      },
      outputPath: apiRoutePath,
    });
    if (!apiRouteResult.success) {