CLI create-integration templates and shared configs (#511)

* Add tsup config package

* Add integration tsconfig to extend from

* Return correct version via cli -v

* Make create-integration use templates

* Add changeset

* Switch to liquidjs templates

---------

Co-authored-by: Matt Aitken <matt@mattaitken.com>

Author: nicktrn

.changeset/gorgeous-panthers-run.md

@@ -0,0 +1,5 @@
+---
+"@trigger.dev/cli": patch
+---
+
+Improve create-integration output. Use templates and shared configs.

config-packages/tsconfig/integration.json

@@ -3,6 +3,8 @@
   "compilerOptions": {
     "lib": ["DOM", "DOM.Iterable", "ES2019"],
     "paths": {
+      "@trigger.dev/tsup/*": ["../../config-packages/tsup/src/*"],
+      "@trigger.dev/tsup": ["../../config-packages/tsup/src/index"],
       "@trigger.dev/sdk/*": ["../../packages/trigger-sdk/src/*"],
       "@trigger.dev/sdk": ["../../packages/trigger-sdk/src/index"],
       "@trigger.dev/integration-kit/*": ["../../packages/integration-kit/src/*"],

config-packages/tsup/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@trigger.dev/tsup",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "7.1.x"
+  }
+}

config-packages/tsup/src/index.ts

@@ -0,0 +1,3 @@
+export { defineConfig } from "tsup";
+export { deepMergeOptions } from "./utils";
+export { options as integrationOptions } from "./integration";

config-packages/tsup/src/integration.ts

@@ -0,0 +1,22 @@
+import { Options, defineConfig } from "tsup";
+
+export const options: Options = {
+  name: "main",
+  entry: ["./src/index.ts"],
+  outDir: "./dist",
+  platform: "node",
+  format: ["cjs"],
+  legacyOutput: true,
+  sourcemap: true,
+  clean: true,
+  bundle: true,
+  splitting: false,
+  dts: true,
+  treeshake: {
+    preset: "smallest",
+  },
+  esbuildPlugins: [],
+  external: ["http", "https", "util", "events", "tty", "os", "timers"],
+};
+
+export default defineConfig(options);

config-packages/tsup/src/utils.ts

@@ -0,0 +1,32 @@
+import { Options } from "tsup";
+
+export const deepMergeOptions = deepMergeRecords<Options>;
+
+function deepMergeRecords<TRecord extends Record<any, any>>(...options: TRecord[]): TRecord {
+  const result = {} as TRecord;
+
+  for (const option of options) {
+    for (const key in option) {
+      if (option.hasOwnProperty(key)) {
+        const optionValue = option[key];
+        const existingValue = result[key];
+
+        if (
+          existingValue &&
+          typeof existingValue === "object" &&
+          typeof optionValue === "object" &&
+          !Array.isArray(existingValue) &&
+          !Array.isArray(optionValue) &&
+          existingValue !== null &&
+          optionValue !== null
+        ) {
+          result[key] = deepMergeRecords(existingValue, optionValue);
+        } else {
+          result[key] = optionValue;
+        }
+      }
+    }
+  }
+
+  return result;
+}

packages/cli/package.json

@@ -68,6 +68,7 @@
     "execa": "^7.0.0",
     "gradient-string": "^2.0.2",
     "inquirer": "^9.1.4",
+    "liquidjs": "^10.9.2",
     "localtunnel": "^2.0.2",
     "mock-fs": "^5.2.0",
     "nanoid": "^4.0.2",

packages/cli/src/cli/index.ts

@@ -14,7 +14,10 @@ import { checkApiKeyIsDevServer } from "../utils/getApiKeyType";
 
 export const program = new Command();
 
-program.name(COMMAND_NAME).description("The Trigger.dev CLI").version("0.0.1");
+program
+  .name(COMMAND_NAME)
+  .description("The Trigger.dev CLI")
+  .version(getVersion(), "-v, --version", "Display the version number");
 
 program
   .command("init")

packages/cli/src/commands/createIntegration.ts

@@ -9,7 +9,8 @@ import { generateIntegrationFiles } from "../utils/generateIntegrationFiles";
 import { getPackageName } from "../utils/getPackagName";
 import { installDependencies } from "../utils/installDependencies";
 import { logger } from "../utils/logger";
-import { resolvePath } from "../utils/parseNameAndPath";
+import { relativePath, resolvePath } from "../utils/parseNameAndPath";
+import { createIntegrationFileFromTemplate } from "../utils/createIntegrationFileFromTemplate";
 
 const CLIOptionsSchema = z.object({
   packageName: z.string().optional(),
@@ -91,108 +92,107 @@ export async function createIntegrationCommand(path: string, cliOptions: any) {
     process.exit(1);
   }
 
-  // Create the package.json
-  const packageJson = {
-    name: resolvedOptions.packageName,
-    version: "0.0.1",
-    description: `Trigger.dev integration for ${resolvedOptions.sdkPackage}`,
-    main: "./dist/index.js",
-    types: "./dist/index.d.ts",
-    publishConfig: {
-      access: "public",
-    },
-    files: ["dist/index.js", "dist/index.d.ts", "dist/index.js.map"],
-    devDependencies: {
-      "@types/node": "16.x",
-      rimraf: "^3.0.2",
-      tsup: "7.1.x",
-      typescript: "4.9.4",
-    },
-    scripts: {
-      clean: "rimraf dist",
-      build: "npm run clean && npm run build:tsup",
-      "build:tsup": "tsup",
-      typecheck: "tsc --noEmit",
-    },
-    dependencies: {
-      [latestVersion.name]: `^${latestVersion.version}`,
-      [sdkVersion.name]: sdkVersion.version,
-      [integrationKitVersion.name]: integrationKitVersion.version,
-    },
-    engines: {
-      node: ">=16.8.0",
-    },
-  };
+  const integrationVersion = await getInternalOrExternalPackageVersion({
+    path: "integrations/github",
+    packageName: "@trigger.dev/github",
+    tag: "latest",
+    monorepoPath: triggerMonorepoPath,
+    prependWorkspace: false,
+  });
+
+  if (!integrationVersion) {
+    logger.error(
+      `Could not find the latest version of @trigger.dev/github. Please try again later.`
+    );
 
-  await createFileInPath(resolvedPath, "package.json", JSON.stringify(packageJson, null, 2));
+    process.exit(1);
+  }
 
-  // Create the tsconfig.json
-  const tsconfigJson = {
-    compilerOptions: {
-      composite: false,
-      declaration: false,
-      declarationMap: false,
-      esModuleInterop: true,
-      forceConsistentCasingInFileNames: true,
-      inlineSources: false,
-      isolatedModules: true,
-      moduleResolution: "node16",
-      noUnusedLocals: false,
-      noUnusedParameters: false,
-      preserveWatchOutput: true,
-      skipLibCheck: true,
-      strict: true,
-      experimentalDecorators: true,
-      emitDecoratorMetadata: true,
-      sourceMap: true,
-      resolveJsonModule: true,
-      lib: ["es2019"],
-      module: "commonjs",
-      target: "es2021",
-    },
-    include: ["./src/**/*.ts", "tsup.config.ts"],
-    exclude: ["node_modules"],
+  const baseVariables = {
+    packageName: resolvedOptions.packageName,
+    sdkPackage: resolvedOptions.sdkPackage,
+    integrationVersion: integrationVersion,
+    latestVersion: latestVersion,
+    sdkVersion: sdkVersion,
+    integrationKitVersion: integrationKitVersion,
+    triggerMonorepoPath,
   };
 
-  await createFileInPath(resolvedPath, "tsconfig.json", JSON.stringify(tsconfigJson, null, 2));
-
-  const readme = `
-# ${resolvedOptions.packageName}
-  `;
-
-  await createFileInPath(resolvedPath, "README.md", readme);
-
-  // Create the tsup.config.ts
-  const tsupConfig = `
-import { defineConfig } from "tsup";
-
-export default defineConfig([
-  {
-    name: "main",
-    entry: ["./src/index.ts"],
-    outDir: "./dist",
-    platform: "node",
-    format: ["cjs"],
-    legacyOutput: true,
-    sourcemap: true,
-    clean: true,
-    bundle: true,
-    splitting: false,
-    dts: true,
-    treeshake: {
-      preset: "smallest",
-    },
-    esbuildPlugins: [],
-    external: ["http", "https", "util", "events", "tty", "os", "timers"],
-  },
-]);
+  const getOutputPath = (relativePath: string) => pathModule.join(resolvedPath, relativePath);
 
-`;
+  const miscIntegrationFiles = [
+    {
+      relativeTemplatePath: "package.json.j2",
+      outputPath: getOutputPath("package.json"),
+    },
+    {
+      // use `tsc --showConfig` to update external tsconfig
+      relativeTemplatePath: `tsconfig-${triggerMonorepoPath ? "internal" : "external"}.json.j2`,
+      outputPath: getOutputPath("tsconfig.json"),
+    },
+    {
+      relativeTemplatePath: `tsup.config-${triggerMonorepoPath ? "internal" : "external"}.js.j2`,
+      outputPath: getOutputPath("tsup.config.ts"),
+    },
+    {
+      relativeTemplatePath: "README.md.j2",
+      outputPath: getOutputPath("README.md"),
+    },
+  ];
 
-  await createFileInPath(resolvedPath, "tsup.config.ts", tsupConfig);
+  await createIntegrationFiles(miscIntegrationFiles, baseVariables);
 
+  // create src/*
   if (resolvedOptions.skipGeneratingCode) {
-    await createFileInPath(resolvedPath, "src/index.ts", "export {}");
+    const getSrcOutputPath = (relativePath: string) =>
+      getOutputPath(pathModule.join("src", relativePath));
+
+    const srcIntegrationFiles = [
+      {
+        relativeTemplatePath: pathModule.join("payload-examples", "index.js.j2"),
+        outputPath: getSrcOutputPath(pathModule.join("payload-examples", "index.ts")),
+      },
+      {
+        relativeTemplatePath: "events.js.j2",
+        outputPath: getSrcOutputPath("events.ts"),
+      },
+      {
+        relativeTemplatePath: "index.js.j2",
+        outputPath: getSrcOutputPath("index.ts"),
+      },
+      {
+        relativeTemplatePath: "models.js.j2",
+        outputPath: getSrcOutputPath("models.ts"),
+      },
+      {
+        relativeTemplatePath: "schemas.js.j2",
+        outputPath: getSrcOutputPath("schemas.ts"),
+      },
+      {
+        relativeTemplatePath: "types.js.j2",
+        outputPath: getSrcOutputPath("types.ts"),
+      },
+      {
+        relativeTemplatePath: "utils.js.j2",
+        outputPath: getSrcOutputPath("utils.ts"),
+      },
+      {
+        relativeTemplatePath: "webhooks.js.j2",
+        outputPath: getSrcOutputPath("webhooks.ts"),
+      },
+    ];
+
+    const validIdentifier = pathModule
+      .basename(path)
+      .replace(/[^a-zA-Z0-9]+/g, "")
+      .replace(/^[0-9]+/g, "");
+
+    await createIntegrationFiles(srcIntegrationFiles, {
+      ...baseVariables,
+      apiKeyPropertyName: "apiKey", // TODO: prompt for this
+      authMethod: resolvedOptions.authMethod,
+      identifier: validIdentifier.length ? validIdentifier : "packageName",
+    });
   } else {
     await attemptToGenerateIntegrationFiles(pathModule.join(resolvedPath, "src"), resolvedOptions);
   }
@@ -295,8 +295,9 @@ const resolveOptionsWithPrompts = async (
       resolvedOptions.skipGeneratingCode = true;
     }
 
+    resolvedOptions.authMethod = await promptAuthMethod();
+
     if (!resolvedOptions.skipGeneratingCode) {
-      resolvedOptions.authMethod = await promptAuthMethod();
       resolvedOptions.extraInfo = await promptExtraInfo();
     }
   } catch (err) {
@@ -448,11 +449,13 @@ async function getInternalOrExternalPackageVersion({
   tag,
   path,
   monorepoPath,
+  prependWorkspace = true,
 }: {
   packageName: string;
   tag: string;
   path: string;
   monorepoPath?: string;
+  prependWorkspace?: boolean;
 }): Promise<{ name: string; version: string } | undefined> {
   if (!monorepoPath) {
     return await getLatestPackageVersion(packageName, tag);
@@ -470,7 +473,7 @@ async function getInternalOrExternalPackageVersion({
 
   return {
     name: packageJson.name,
-    version: `workspace:^${packageJson.version}`,
+    version: `${prependWorkspace ? "workspace:^" : ""}${packageJson.version}`,
   };
 }
 
@@ -550,3 +553,26 @@ async function updateJobCatalogWithNewIntegration(
   };
   await writeJSONFile(tsConfigPath, newTsConfig);
 }
+
+const createIntegrationFiles = async (
+  files: {
+    relativeTemplatePath: string;
+    outputPath: string;
+  }[],
+  variables?: Record<string, any>
+) => {
+  for (const file of files) {
+    const result = await createIntegrationFileFromTemplate({ ...file, variables });
+    handleCreateResult(file.outputPath, result);
+  }
+};
+
+const handleCreateResult = (
+  outputPath: string,
+  result: Awaited<ReturnType<typeof createIntegrationFileFromTemplate>>
+) => {
+  if (!result.success) {
+    throw new Error(`Failed to create ${pathModule.basename(outputPath)}: ${result.error}`);
+  }
+  logger.success(`✔ Created ${pathModule.basename(outputPath)} at ${relativePath(outputPath)}`);
+};

packages/cli/src/templates/integration/README.md.j2

@@ -0,0 +1 @@
+# {{ packageName }}