poc

Author: Shane Osbourne

packages/browser-sync/.gitignore

@@ -1,5 +1,5 @@
 /dist/*
 /dist_backup/*
-/dist2/*
+/dist2/*s
 meta1.json
 meta2.json

packages/browser-sync/lib/bin.ts

@@ -166,8 +166,14 @@ function handleNoCommand(argv, input, yargs) {
  */
 function handleCli(opts) {
     opts.cb = opts.cb || utils.defaultCallback;
-    const m = require(`./cli/command.${opts.cli.input[0]}`);
-    if (m.default) {
+    const mapping = {
+        init: () => require("./cli/command.init.js"),
+        recipe: () => require("./cli/command.recipe.js"),
+        reload: () => require("./cli/command.reload.js"),
+        start: () => require("./cli/command.start.js")
+    };
+    const m = mapping[opts.cli.input[0]]?.();
+    if (m?.default) {
         return m.default(opts);
     }
     return m(opts);

packages/browser-sync/lib/browser-sync.js

@@ -72,7 +72,7 @@ BrowserSync.prototype.callback = function(name) {
 /**
  * @param {import("immutable").Map<string, any>} options
  * @param {Function} cb
- * @returns {BrowserSync}
+ * @returns {BrowserSync|undefined}
  */
 BrowserSync.prototype.init = function(options, cb) {
     /**
@@ -268,14 +268,14 @@ function tasksComplete(bs) {
         /**
          * Finally, call the user-provided callback given as last arg
          */
-        bs.cb(null, bs);
+        bs.cb?.(null, bs);
     };
 }
 
 /**
  * @param module
  * @param opts
- * @param cb
+ * @param [cb]
  */
 BrowserSync.prototype.registerPlugin = function(module, opts, cb) {
     var bs = this;

packages/browser-sync/lib/cli/cli-options.ts

@@ -93,11 +93,10 @@ export function explodeFilesArg(string): string {
 
 /**
  * @param value
- * @returns {{globs: Array, objs: Array}}
  */
 export function makeFilesArg(value) {
-    let globs = [];
-    let objs = [];
+    let globs: string[] = [];
+    let objs: any[] = [];
 
     if (_.isString(value)) {
         globs = globs.concat(explodeFilesArg(value));

packages/browser-sync/lib/cli/command.recipe.js

@@ -10,7 +10,6 @@ var chalk = require("chalk");
  * or one given with the --output flag
  *
  * @param opts
- * @returns {Function}
  */
 module.exports = function(opts) {
     var path = require("path");

packages/browser-sync/lib/cli/transforms/addDefaultIgnorePatterns.ts

@@ -21,6 +21,7 @@ export function addDefaultIgnorePatterns(incoming: BsTempOptions): TransformResu
             .filter(Boolean)
             .toSet();
 
+        // @ts-expect-error
         const merged = userIgnored.merge(defaultIgnorePatterns);
 
         return watchOptions.merge({

packages/browser-sync/lib/cli/transforms/addToFilesOption.ts

@@ -6,7 +6,7 @@ export function addToFilesOption(incoming: BsTempOptions): TransformResult {
         return [incoming, []];
     }
 
-    let serverPaths = [];
+    let serverPaths: string[] = [];
 
     const fromServeStatic = incoming.get("serveStatic", List([])).toArray();
     const ssPaths = fromServeStatic.reduce((acc, ss) => {
@@ -22,6 +22,7 @@ export function addToFilesOption(incoming: BsTempOptions): TransformResult {
     ssPaths.forEach(p => serverPaths.push(p));
 
     const server = incoming.get("server");
+
     if (server) {
         if (server === true) {
             serverPaths.push(".");
@@ -37,6 +38,8 @@ export function addToFilesOption(incoming: BsTempOptions): TransformResult {
             const baseDirs = List([])
                 .concat(baseDirProp)
                 .filter(Boolean);
+
+            // @ts-expect-error
             baseDirs.forEach(s => serverPaths.push(s));
         }
     }

packages/browser-sync/lib/cli/transforms/handleFilesOption.ts

@@ -1,17 +1,17 @@
-import { fromJS } from "immutable";
+import { fromJS, List } from "immutable";
 import { BsTempOptions, makeFilesArg, TransformResult } from "../cli-options";
-import { FilesNamespaces } from "../../types";
+import { FilesNamespace, FilesNamespaces, runnerOption } from "../../types";
+import { z } from "zod";
 
 export function handleFilesOption(incoming: BsTempOptions): TransformResult {
-    const value = incoming.get("files");
     const namespaces: FilesNamespaces = {
         core: {
             globs: [],
             objs: []
         }
     };
 
-    const processed = makeFilesArg(value);
+    const processed = makeFilesArg(incoming.get("files"));
 
     if (processed.globs.length) {
         namespaces.core.globs = processed.globs;
@@ -21,5 +21,36 @@ export function handleFilesOption(incoming: BsTempOptions): TransformResult {
         namespaces.core.objs = processed.objs;
     }
 
-    return [incoming.set("files", fromJS(namespaces)), []];
+    const runners = convertRunnerOption(incoming);
+
+    return [incoming.set("files", fromJS({ ...namespaces, ...runners })), []];
+}
+
+export function convertRunnerOption(incoming: BsTempOptions): FilesNamespaces | null {
+    const runners = incoming.has("runners");
+    if (!runners) return null;
+
+    const parser = z.array(runnerOption);
+    const parsed = parser.safeParse(incoming.get("runners").toJS());
+    if (!parsed.success) {
+        // todo: what to do in this case?
+        return null;
+    }
+    const runnerData = parsed.data;
+    const output: FilesNamespaces = {};
+
+    runnerData.forEach((runner, index) => {
+        const next: FilesNamespace = {
+            index,
+            globs: [],
+            objs: []
+        };
+        runner.files.forEach(fileOption => {
+            if (typeof fileOption === "string") {
+                next.globs.push(fileOption);
+            }
+        });
+        output["__unstable_runner_" + index] = next;
+    });
+    return output;
 }

packages/browser-sync/lib/default-config.js

@@ -3,6 +3,9 @@
  * @module BrowserSync.options
  */
 module.exports = {
+    /**
+     */
+    runners: [],
     /**
      * Browsersync includes a user-interface that is accessed via a separate port.
      * The UI allows to controls all devices, push sync updates and much more.
@@ -474,7 +477,7 @@ module.exports = {
 
     /**
      * @property host
-     * @type String
+     * @type String|null
      * @default null
      */
     host: null,

packages/browser-sync/lib/file-event-handler.js

@@ -5,7 +5,6 @@ var utils = require("./utils");
  * Apply the operators that apply to the 'file:changed' event
  * @param {import("rxjs").Observable} subject
  * @param options
- * @return {import("rxjs").Observable<{type: string, files: Array<any>}>}
  */
 function fileChanges(subject, options) {
     const operators = [
@@ -26,28 +25,14 @@ function fileChanges(subject, options) {
      */
     const initial = getAggregatedDebouncedStream(subject, options, scheduler);
 
-    return applyOperators(operators, initial, options, scheduler).map(function(items) {
-        const paths = items.map(x => x.path);
-
-        if (utils.willCauseReload(paths, options.get("injectFileTypes").toJS())) {
-            return {
-                type: "reload",
-                files: items
-            };
-        }
-        return {
-            type: "inject",
-            files: items
-        };
-    });
+    return applyOperators(operators, initial, options, scheduler);
 }
 module.exports.fileChanges = fileChanges;
 
 /**
  * Apply the operators that apply to the 'browser:reload' event
  * @param {import("rxjs").Observable} subject
  * @param options
- * @returns {import("rxjs").Observable}
  */
 function applyReloadOperators(subject, options) {
     var operators = [