Adding init schedule example

Author: ericallam

packages/cli-v3/src/commands/init.ts

@@ -3,11 +3,12 @@ import { context, trace } from "@opentelemetry/api";
 import { GetProjectResponseBody, flattenAttributes } from "@trigger.dev/core/v3";
 import { recordSpanException } from "@trigger.dev/core/v3/workers";
 import chalk from "chalk";
-import { Command } from "commander";
+import { Command, Option as CommandOption } from "commander";
 import { applyEdits, findNodeAtLocation, getNodeValue, modify, parseTree } from "jsonc-parser";
 import { writeFile } from "node:fs/promises";
 import { join, relative, resolve } from "node:path";
 import { addDependency, detectPackageManager } from "nypm";
+import { resolveTSConfig } from "pkg-types";
 import { z } from "zod";
 import { CliApiClient } from "../apiClient.js";
 import {
@@ -22,25 +23,24 @@ import {
 } from "../cli/common.js";
 import { loadConfig } from "../config.js";
 import { CLOUD_API_URL } from "../consts.js";
-import { cliLink, prettyError } from "../utilities/cliOutput.js";
+import { cliLink } from "../utilities/cliOutput.js";
 import {
   createFileFromTemplate,
   generateTemplateUrl,
 } from "../utilities/createFileFromTemplate.js";
 import { createFile, pathExists, readFile } from "../utilities/fileSystem.js";
 import { printStandloneInitialBanner } from "../utilities/initialBanner.js";
 import { logger } from "../utilities/logger.js";
-import { cliRootPath } from "../utilities/resolveInternalFilePath.js";
 import { spinner } from "../utilities/windows.js";
 import { login } from "./login.js";
-import { resolveTSConfig } from "pkg-types";
 
 const InitCommandOptions = CommonCommandOptions.extend({
   projectRef: z.string().optional(),
   overrideConfig: z.boolean().default(false),
   tag: z.string().default("beta"),
   skipPackageInstall: z.boolean().default(false),
   pkgArgs: z.string().optional(),
+  gitRef: z.string().default("main"),
 });
 
 type InitCommandOptions = z.infer<typeof InitCommandOptions>;
@@ -66,12 +66,19 @@ export function configureInitCommand(program: Command) {
         "--pkg-args <args>",
         "Additional arguments to pass to the package manager, accepts CSV for multiple args"
       )
-  ).action(async (path, options) => {
-    await handleTelemetry(async () => {
-      await printStandloneInitialBanner(true);
-      await initCommand(path, options);
+  )
+    .addOption(
+      new CommandOption(
+        "--git-ref <git ref>",
+        "The git ref to use when fetching templates from GitHub"
+      ).hideHelp()
+    )
+    .action(async (path, options) => {
+      await handleTelemetry(async () => {
+        await printStandloneInitialBanner(true);
+        await initCommand(path, options);
+      });
     });
-  });
 }
 
 export async function initCommand(dir: string, options: unknown) {
@@ -227,6 +234,7 @@ async function createTriggerDir(dir: string, options: InitCommandOptions) {
         message: `Choose an example to create in the ${location} directory`,
         options: [
           { value: "simple", label: "Simple (Hello World)" },
+          { value: "schedule", label: "Scheduled Task" },
           {
             value: "none",
             label: "None",
@@ -255,7 +263,7 @@ async function createTriggerDir(dir: string, options: InitCommandOptions) {
         return { location, isCustomValue: location !== defaultValue };
       }
 
-      const templateUrl = generateTemplateUrl(`examples/${example}.ts`);
+      const templateUrl = generateTemplateUrl(`examples/${example}.ts`, options.gitRef);
       const outputPath = join(triggerDir, "example.ts");
 
       await createFileFromTemplate({
@@ -449,7 +457,7 @@ async function writeConfigFile(
 
       const projectDir = resolve(process.cwd(), dir);
       const outputPath = join(projectDir, "trigger.config.ts");
-      const templateUrl = generateTemplateUrl("trigger.config.ts");
+      const templateUrl = generateTemplateUrl("trigger.config.ts", options.gitRef);
 
       span.setAttributes({
         "cli.projectDir": projectDir,

packages/cli-v3/src/utilities/createFileFromTemplate.ts

@@ -65,6 +65,6 @@ export function replaceAll(input: string, replacements: Record<string, string>)
   return output;
 }
 
-export function generateTemplateUrl(templateName: string) {
-  return `https://raw.githubusercontent.com/triggerdotdev/trigger.dev/main/packages/cli-v3/templates/${templateName}.template`;
+export function generateTemplateUrl(templateName: string, ref: string = "main") {
+  return `https://raw.githubusercontent.com/triggerdotdev/trigger.dev/${ref}/packages/cli-v3/templates/${templateName}.template`;
 }

packages/cli-v3/templates/examples/schedule.ts.template

@@ -0,0 +1,25 @@
+import { logger, schedules, wait } from "@trigger.dev/sdk/v3";
+
+export const firstScheduledTask = schedules.task({
+  id: "first-scheduled-task",
+  //every hour
+  cron: "0 * * * *",
+  run: async (payload, { ctx }) => {
+    // The payload contains the last run timestamp that you can use to check if this is the first run
+    // And calculate the time since the last run
+    const distanceInMs =
+      payload.timestamp.getTime() - (payload.lastTimestamp ?? new Date()).getTime();
+
+    logger.log("First scheduled tasks", { payload, distanceInMs });
+
+    // Wait for 5 seconds
+    await wait.for({ seconds: 5 });
+
+    // Format the timestamp using the timezone from the payload
+    const formatted = payload.timestamp.toLocaleString("en-US", {
+      timeZone: payload.timezone,
+    });
+
+    logger.log(formatted);
+  },
+});