separate runtime/startup runners

Shane Osbourne · Shane Osbourne · commit fbe3e9d88c4a · 2023-04-30T12:26:27.000+01:00
diff --git a/examples/tailwind/index.html b/examples/tailwind/index.html
@@ -8,8 +8,8 @@
   <title>Document</title>
   <link rel="stylesheet" href="./dist/output.css">
 </head>
-<body class="p-2">
-  <p class=text-4xl>hello world 8.0</p>
+<body class="p-4">
+  <p class=text-4xl>hello world 5.0</p>
 </body>
 </html>
 
diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json
@@ -6,6 +6,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tailwindcss -i base.css -o ./dist/output.css",
+    "clean": "rm -rf dist/**",
     "bs": "node run.js"
   },
   "keywords": [],
diff --git a/examples/tailwind/run.js b/examples/tailwind/run.js
@@ -4,9 +4,15 @@ bs.init(
     {
         server: ".",
         open: false,
+        notify: false,
         runners: [
             {
-                files: ["index.html", "base.css"],
+                at: "startup",
+                run: [{ npm: ["clean", "build"] }]
+            },
+            {
+                at: "runtime",
+                files: ["index.html"],
                 run: [{ npm: ["build"] }, { bs: "reload" }]
             }
         ]
diff --git a/packages/browser-sync/lib/cli/transforms/handleFilesOption.ts b/packages/browser-sync/lib/cli/transforms/handleFilesOption.ts
@@ -1,6 +1,6 @@
 import { fromJS, List } from "immutable";
 import { BsTempOptions, makeFilesArg, TransformResult } from "../cli-options";
-import { FilesNamespace, FilesNamespaces, runnerOption } from "../../types";
+import { FilesNamespace, FilesNamespaces, runnerOption, runtimeRunnerOption } from "../../types";
 import { z } from "zod";
 
 export function handleFilesOption(incoming: BsTempOptions): TransformResult {
@@ -31,16 +31,20 @@ export function convertRunnerOption(incoming: BsTempOptions): FilesNamespaces |
     if (!runners) return null;
 
     const parser = z.array(runnerOption);
-    const parsed = parser.safeParse(incoming.get("runners").toJS());
+    const incomingOpt = incoming.get("runners").toJS();
+    const parsed = parser.safeParse(incomingOpt);
+
     if (!parsed.success) {
         // todo: what to do in this case?
         console.log("failed to parse input", parsed.error);
         return null;
     }
+
     const runnerData = parsed.data;
     const output: FilesNamespaces = {};
 
     runnerData.forEach((runner, index) => {
+        if (runner.at !== "runtime") return;
         const next: FilesNamespace = {
             index,
             globs: [],
diff --git a/packages/browser-sync/lib/internal-events.js b/packages/browser-sync/lib/internal-events.js
@@ -8,7 +8,6 @@ var z = require("zod");
 var fromEvent = Rx.Observable.fromEvent;
 var fileHandler = require("./file-event-handler");
 const {
-    runnerOption,
     toRunnerOption,
     toRunnerNotification,
     toSideEffect,
diff --git a/packages/browser-sync/lib/types.ts b/packages/browser-sync/lib/types.ts
@@ -36,10 +36,10 @@ export type FilesObject = { match: string[]; fn?: Function; options?: any };
 export type FilesNamespace = { globs: string[]; objs: FilesObject[]; index?: number };
 export type FilesNamespaces = { [name: string]: FilesNamespace };
 
-export type RunnerOption = {
-    files: string[];
-    run: Runner[];
-};
+// prettier-ignore
+export type RunnerOption =
+  | { at: "startup";  run: Runner[]; }
+  | { at: "runtime"; files: string[]; run: Runner[]; }
 
 // prettier-ignore
 export type Runner =
@@ -66,13 +66,22 @@ const runnerParser = z.union([
     })
 ]);
 
-export const runnerOption = z.object({
+export const startupRunnerOption = z.object({
+    at: z.literal("startup"),
+    run: z.array(runnerParser)
+});
+
+export const runtimeRunnerOption = z.object({
+    at: z.literal("runtime"),
     files: z.array(z.string()),
     run: z.array(runnerParser)
 });
 
+export const runnerOption = z.discriminatedUnion("at", [startupRunnerOption, runtimeRunnerOption]);
+
 export function toRunnerOption(input: unknown): RunnerOption | null {
     const parsed = runnerOption.safeParse(input);
+    // todo: give good errors on format mistakes here
     return parsed.success ? parsed.data : null;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,15 @@ bs.init(`
`4`	`4`	`{`
`5`	`5`	`server: ".",`
`6`	`6`	`open: false,`
	`7`	`+ notify: false,`
`7`	`8`	`runners: [`
`8`	`9`	`{`
`9`		`- files: ["index.html", "base.css"],`
	`10`	`+ at: "startup",`
	`11`	`+ run: [{ npm: ["clean", "build"] }]`
	`12`	`+ },`
	`13`	`+ {`
	`14`	`+ at: "runtime",`
	`15`	`+ files: ["index.html"],`
`10`	`16`	`run: [{ npm: ["build"] }, { bs: "reload" }]`
`11`	`17`	`}`
`12`	`18`	`]`