Class Express

packages/cli/src/frameworks/express/index.ts:9–51

import boxen from "boxen";

export class Express implements Framework {
  id = "express";
  name = "Express";

  async isMatch(path: string, packageManager: PackageManager): Promise<boolean> {
    //check for the express package
    const packageJsonContent = await readPackageJson(path);
    if (packageJsonContent?.dependencies?.express) {
      return true;
    }

    return false;
  }

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

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

  async install(path: string, { typescript, endpointSlug }: ProjectInstallOptions): Promise<void> {}

  async postInstall(path: string, options: ProjectInstallOptions): Promise<void> {}

  async printInstallationComplete(projectUrl: string): Promise<void> {
    logger.info(
      boxen(
        "Automatic installation isn't currently supported for Express. \nFollow the steps in our manual installation guide: https://trigger.dev/docs/documentation/guides/manual/express",
        { padding: 1, margin: 1, borderStyle: "double", borderColor: "magenta" }
      )
    );
  }

  defaultHostnames = ["localhost", "[::]"];
  defaultPorts = [3000, 8000, 80, 8080];
  watchFilePaths = standardWatchFilePaths;
  watchIgnoreRegex = /(node_modules)/;
}