@flowscripter/example-cli-plugin 1.1.2 → 1.2.0

package/README.md

@@ -76,13 +76,26 @@ classDiagram
         +execute(context, argumentValues) void
     }
 
+    class helloRustCommand {
+        <<SubCommand>>
+        +name: "hello_rust"
+        +execute(context) void
+    }
+
+    class world {
+        <<@flowscripter/template-bun-rust-library>>
+        +world() void
+    }
+
     Plugin --> DemoCommandFactory : extensionDescriptor
     Plugin --> DemoServiceProviderFactory : extensionDescriptor
     DemoCommandFactory --> helloCommand : getCommands()
+    DemoCommandFactory --> helloRustCommand : getCommands()
     DemoServiceProviderFactory --> DemoServiceProvider : getServiceProviders()
     DemoServiceProvider --> DefaultDemoService : creates
     DefaultDemoService ..|> DemoService
     helloCommand --> DemoService : uses via context
+    helloRustCommand --> world : calls
 ```
 
 ### Framework API

package/dist/index.js

@@ -1,386 +1 @@
-// @bun
-// node_modules/@flowscripter/dynamic-cli-framework/src/api/plugin/CommandFactory.ts
-var DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY";
-// node_modules/@flowscripter/dynamic-cli-framework/src/api/plugin/ServiceProviderFactory.ts
-var DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY";
-// node_modules/@flowscripter/dynamic-cli-framework/src/api/plugin/createCLIPlugin.ts
-function createCLIPlugin(options) {
-  const extensionDescriptors = [];
-  if (options.commandFactory) {
-    const commandFactory = options.commandFactory;
-    extensionDescriptors.push({
-      extensionPoint: DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT,
-      factory: {
-        create: async () => typeof commandFactory === "function" ? commandFactory() : commandFactory
-      }
-    });
-  }
-  if (options.serviceProviderFactory) {
-    const serviceProviderFactory = options.serviceProviderFactory;
-    extensionDescriptors.push({
-      extensionPoint: DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT,
-      factory: {
-        create: async () => typeof serviceProviderFactory === "function" ? serviceProviderFactory() : serviceProviderFactory
-      }
-    });
-  }
-  return { extensionDescriptors, pluginData: options.pluginData };
-}
-// node_modules/@flowscripter/dynamic-cli-framework/src/api/service/core/PrinterService.ts
-var PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/printer-service";
-// node_modules/@flowscripter/dynamic-cli-framework/src/api/service/core/Table.ts
-class Table {
-  rowCount;
-  columnCount;
-  options;
-  #columnOptions = new Map;
-  #rowOptions = new Map;
-  #cells = new Map;
-  constructor(rowCount, columnCount, options) {
-    this.rowCount = rowCount;
-    this.columnCount = columnCount;
-    this.options = options ?? {};
-  }
-  row(rowIndex, rowOptions) {
-    if (rowIndex < 0 || rowIndex >= this.rowCount) {
-      throw new Error(`Row index ${rowIndex} out of bounds [0, ${this.rowCount})`);
-    }
-    this.#rowOptions.set(rowIndex, rowOptions);
-    return this;
-  }
-  column(columnIndex, columnOptions) {
-    if (columnIndex < 0 || columnIndex >= this.columnCount) {
-      throw new Error(`Column index ${columnIndex} out of bounds [0, ${this.columnCount})`);
-    }
-    this.#columnOptions.set(columnIndex, columnOptions);
-    return this;
-  }
-  cell(rowIndex, columnIndex, contents, cellOptions) {
-    if (rowIndex < 0 || rowIndex >= this.rowCount) {
-      throw new Error(`Row index ${rowIndex} out of bounds [0, ${this.rowCount})`);
-    }
-    if (columnIndex < 0 || columnIndex >= this.columnCount) {
-      throw new Error(`Column index ${columnIndex} out of bounds [0, ${this.columnCount})`);
-    }
-    this.#cells.set(`${rowIndex},${columnIndex}`, {
-      contents,
-      options: cellOptions
-    });
-    return this;
-  }
-  getColumnOptions(columnIndex) {
-    return this.#columnOptions.get(columnIndex);
-  }
-  getRowOptions(rowIndex) {
-    return this.#rowOptions.get(rowIndex);
-  }
-  getCell(rowIndex, columnIndex) {
-    return this.#cells.get(`${rowIndex},${columnIndex}`);
-  }
-}
-// src/service/DemoService.ts
-var DEMO_SERVICE_ID = "DEMO_SERVICE";
-
-// src/command/HelloCommand.ts
-var helloCommand = {
-  name: "hello",
-  description: "Greet someone using the demo service",
-  helpTopic: "Hello",
-  enableConfiguration: false,
-  options: [],
-  positionals: [
-    {
-      name: "name",
-      description: "Name to greet",
-      type: 0 /* STRING */,
-      isVarargOptional: true
-    }
-  ],
-  execute: async (context, argumentValues) => {
-    const demoService = context.getServiceById(DEMO_SERVICE_ID);
-    const printerService = context.getServiceById(PRINTER_SERVICE_ID);
-    const name = argumentValues["name"] ?? "World";
-    const greeting = demoService.cowsay(name);
-    await printerService?.print(`${greeting}
-`);
-  }
-};
-var HelloCommand_default = helloCommand;
-
-// src/factory/DemoCommandFactory.ts
-class DemoCommandFactory {
-  getCommands() {
-    return [HelloCommand_default];
-  }
-}
-
-// node_modules/cowsay/build/cowsay.es.js
-var ansiRegex = () => {
-  const pattern = [
-    "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[a-zA-Z\\d]*)*)?\\u0007)",
-    "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))"
-  ].join("|");
-  return new RegExp(pattern, "g");
-};
-var stripAnsi = (input) => typeof input === "string" ? input.replace(ansiRegex(), "") : input;
-var isFullwidthCodePoint = (x) => {
-  if (Number.isNaN(x)) {
-    return false;
-  }
-  if (x >= 4352 && (x <= 4447 || x === 9001 || x === 9002 || 11904 <= x && x <= 12871 && x !== 12351 || 12880 <= x && x <= 19903 || 19968 <= x && x <= 42182 || 43360 <= x && x <= 43388 || 44032 <= x && x <= 55203 || 63744 <= x && x <= 64255 || 65040 <= x && x <= 65049 || 65072 <= x && x <= 65131 || 65281 <= x && x <= 65376 || 65504 <= x && x <= 65510 || 110592 <= x && x <= 110593 || 127488 <= x && x <= 127569 || 131072 <= x && x <= 262141)) {
-    return true;
-  }
-  return false;
-};
-var stringWidth = (str) => {
-  if (typeof str !== "string" || str.length === 0) {
-    return 0;
-  }
-  str = stripAnsi(str);
-  let width = 0;
-  for (let i = 0;i < str.length; i++) {
-    const code = str.codePointAt(i);
-    if (code <= 31 || code >= 127 && code <= 159) {
-      continue;
-    }
-    if (code >= 768 && code <= 879) {
-      continue;
-    }
-    if (code > 65535) {
-      i++;
-    }
-    width += isFullwidthCodePoint(code) ? 2 : 1;
-  }
-  return width;
-};
-var say = function(text, wrap) {
-  var delimiters = {
-    first: ["/", "\\"],
-    middle: ["|", "|"],
-    last: ["\\", "/"],
-    only: ["<", ">"]
-  };
-  return format(text, wrap, delimiters);
-};
-var think = function(text, wrap) {
-  var delimiters = {
-    first: ["(", ")"],
-    middle: ["(", ")"],
-    last: ["(", ")"],
-    only: ["(", ")"]
-  };
-  return format(text, wrap, delimiters);
-};
-function format(text, wrap, delimiters) {
-  var lines = split(text, wrap);
-  var maxLength = max(lines);
-  var balloon;
-  if (lines.length === 1) {
-    balloon = [
-      " " + top(maxLength),
-      delimiters.only[0] + " " + lines[0] + " " + delimiters.only[1],
-      " " + bottom(maxLength)
-    ];
-  } else {
-    balloon = [" " + top(maxLength)];
-    for (var i = 0, len = lines.length;i < len; i += 1) {
-      var delimiter;
-      if (i === 0) {
-        delimiter = delimiters.first;
-      } else if (i === len - 1) {
-        delimiter = delimiters.last;
-      } else {
-        delimiter = delimiters.middle;
-      }
-      balloon.push(delimiter[0] + " " + pad(lines[i], maxLength) + " " + delimiter[1]);
-    }
-    balloon.push(" " + bottom(maxLength));
-  }
-  return balloon.join(`
-`);
-}
-function split(text, wrap) {
-  text = text.replace(/\r\n?|[\n\u2028\u2029]/g, `
-`).replace(/^\uFEFF/, "").replace(/\t/g, "        ");
-  var lines = [];
-  if (!wrap) {
-    lines = text.split(`
-`);
-  } else {
-    var start = 0;
-    while (start < text.length) {
-      var nextNewLine = text.indexOf(`
-`, start);
-      var wrapAt = Math.min(start + wrap, nextNewLine === -1 ? text.length : nextNewLine);
-      lines.push(text.substring(start, wrapAt));
-      start = wrapAt;
-      if (text.charAt(start) === `
-`) {
-        start += 1;
-      }
-    }
-  }
-  return lines;
-}
-function max(lines) {
-  var max2 = 0;
-  for (var i = 0, len = lines.length;i < len; i += 1) {
-    if (stringWidth(lines[i]) > max2) {
-      max2 = stringWidth(lines[i]);
-    }
-  }
-  return max2;
-}
-function pad(text, length) {
-  return text + new Array(length - stringWidth(text) + 1).join(" ");
-}
-function top(length) {
-  return new Array(length + 3).join("_");
-}
-function bottom(length) {
-  return new Array(length + 3).join("-");
-}
-var balloon = {
-  say,
-  think
-};
-var replacer = function(cow, variables) {
-  var eyes = escapeRe(variables.eyes);
-  var eyeL = eyes.charAt(0);
-  var eyeR = eyes.charAt(1);
-  var tongue = escapeRe(variables.tongue);
-  if (cow.indexOf("$the_cow") !== -1) {
-    cow = extractTheCow(cow);
-  }
-  return cow.replace(/\$thoughts/g, variables.thoughts).replace(/\$eyes/g, eyes).replace(/\$tongue/g, tongue).replace(/\$\{eyes\}/g, eyes).replace(/\$eye/, eyeL).replace(/\$eye/, eyeR).replace(/\$\{tongue\}/g, tongue);
-};
-function escapeRe(s) {
-  if (s && s.replace) {
-    return s.replace(/\$/g, "$$$$");
-  }
-  return s;
-}
-function extractTheCow(cow) {
-  cow = cow.replace(/\r\n?|[\n\u2028\u2029]/g, `
-`).replace(/^\uFEFF/, "");
-  var match = /\$the_cow\s*=\s*<<"*EOC"*;*\n([\s\S]+)\nEOC\n/.exec(cow);
-  if (!match) {
-    console.error(`Cannot parse cow file
-`, cow);
-    return cow;
-  } else {
-    return match[1].replace(/\\{2}/g, "\\").replace(/\\@/g, "@").replace(/\\\$/g, "$");
-  }
-}
-var modes = {
-  b: {
-    eyes: "==",
-    tongue: "  "
-  },
-  d: {
-    eyes: "xx",
-    tongue: "U "
-  },
-  g: {
-    eyes: "$$",
-    tongue: "  "
-  },
-  p: {
-    eyes: "@@",
-    tongue: "  "
-  },
-  s: {
-    eyes: "**",
-    tongue: "U "
-  },
-  t: {
-    eyes: "--",
-    tongue: "  "
-  },
-  w: {
-    eyes: "OO",
-    tongue: "  "
-  },
-  y: {
-    eyes: "..",
-    tongue: "  "
-  }
-};
-var faces = function(options) {
-  for (var mode in modes) {
-    if (options[mode] === true) {
-      return modes[mode];
-    }
-  }
-  return {
-    eyes: options.e || "oo",
-    tongue: options.T || "  "
-  };
-};
-var DEFAULT_COW = `$the_cow = <<"EOC";
-        $thoughts   ^__^
-         $thoughts  ($eyes)\\\\_______
-            (__)\\\\       )\\\\/\\\\
-             $tongue ||----w |
-                ||     ||
-EOC
-`;
-function convertToCliOptions(browserOptions) {
-  const cliOptions = {
-    e: browserOptions.eyes || "oo",
-    T: browserOptions.tongue || "  ",
-    n: browserOptions.wrap,
-    W: browserOptions.wrapLength || 40,
-    text: browserOptions.text || "",
-    _: browserOptions.text || [],
-    f: browserOptions.cow
-  };
-  if (browserOptions.mode) {
-    cliOptions[browserOptions.mode] = true;
-  }
-  return cliOptions;
-}
-function doIt(options, sayAloud) {
-  const cow = options.f || DEFAULT_COW;
-  const face = faces(options);
-  face.thoughts = sayAloud ? "\\" : "o";
-  const action = sayAloud ? "say" : "think";
-  return balloon[action](options.text || options._.join(" "), options.n ? null : options.W) + `
-` + replacer(cow, face);
-}
-function say$1(browserOptions) {
-  return doIt(convertToCliOptions(browserOptions), true);
-}
-
-// src/service/DefaultDemoService.ts
-class DefaultDemoService {
-  cowsay(name) {
-    return say$1({ text: `Hello, ${name}!` });
-  }
-}
-
-// src/service/DemoServiceProvider.ts
-class DemoServiceProvider {
-  serviceId = DEMO_SERVICE_ID;
-  servicePriority = 10;
-  async getServiceInfo(_cliConfig) {
-    return { service: new DefaultDemoService, commands: [] };
-  }
-  async initService(_context) {}
-}
-
-// src/factory/DemoServiceProviderFactory.ts
-class DemoServiceProviderFactory {
-  getServiceProviders() {
-    return [new DemoServiceProvider];
-  }
-}
-
-// src/plugin.ts
-var plugin_default = createCLIPlugin({
-  commandFactory: new DemoCommandFactory,
-  serviceProviderFactory: new DemoServiceProviderFactory
-});
-export {
-  plugin_default as default
-};
+export { default } from "./src/plugin.js";

package/dist/src/command/HelloCommand.js

@@ -0,0 +1,25 @@
+import { ArgumentValueTypeName, PRINTER_SERVICE_ID, } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { DEMO_SERVICE_ID } from "../service/DemoService.js";
+const helloCommand = {
+    name: "hello",
+    description: "Greet someone using the demo service",
+    helpTopic: "Hello",
+    enableConfiguration: false,
+    options: [],
+    positionals: [
+        {
+            name: "name",
+            description: "Name to greet",
+            type: ArgumentValueTypeName.STRING,
+            isVarargOptional: true,
+        },
+    ],
+    execute: async (context, argumentValues) => {
+        const demoService = context.getServiceById(DEMO_SERVICE_ID);
+        const printerService = context.getServiceById(PRINTER_SERVICE_ID);
+        const name = argumentValues["name"] ?? "World";
+        const greeting = demoService.cowsay(name);
+        await printerService?.print(`${greeting}\n`);
+    },
+};
+export default helloCommand;

package/dist/src/command/HelloRustCommand.d.ts

@@ -0,0 +1,4 @@
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+declare const helloRustCommand: SubCommand;
+export default helloRustCommand;
+//# sourceMappingURL=HelloRustCommand.d.ts.map

package/dist/src/command/HelloRustCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HelloRustCommand.d.ts","sourceRoot":"","sources":["../../../src/command/HelloRustCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAGX,MAAM,gDAAgD,CAAC;AAIxD,QAAA,MAAM,gBAAgB,EAAE,UAYvB,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/src/command/HelloRustCommand.js

@@ -0,0 +1,16 @@
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { world } from "@flowscripter/template-bun-rust-library";
+const helloRustCommand = {
+    name: "hello_rust",
+    description: "Greet using a native Rust library via FFI",
+    helpTopic: "Hello",
+    enableConfiguration: false,
+    options: [],
+    positionals: [],
+    execute: async (context) => {
+        const printerService = context.getServiceById(PRINTER_SERVICE_ID);
+        await printerService?.print("Hello ");
+        world();
+    },
+};
+export default helloRustCommand;

package/dist/src/factory/DemoCommandFactory.d.ts

@@ -1,5 +1,5 @@
 import type { CommandFactory } from "@flowscripter/dynamic-cli-framework/cli-plugin";
 export default class DemoCommandFactory implements CommandFactory {
-    getCommands(): import("@flowscripter/dynamic-cli-framework").SubCommand[];
+    getCommands(): import("@flowscripter/dynamic-cli-framework/cli-plugin").SubCommand[];
 }
 //# sourceMappingURL=DemoCommandFactory.d.ts.map

package/dist/src/factory/DemoCommandFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DemoCommandFactory.d.ts","sourceRoot":"","sources":["../../../src/factory/DemoCommandFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAGrF,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,cAAc;IAC/D,WAAW;CAGZ"}
+{"version":3,"file":"DemoCommandFactory.d.ts","sourceRoot":"","sources":["../../../src/factory/DemoCommandFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAIrF,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,cAAc;IAC/D,WAAW;CAGZ"}

package/dist/src/factory/DemoCommandFactory.js

@@ -0,0 +1,7 @@
+import helloCommand from "../command/HelloCommand.js";
+import helloRustCommand from "../command/HelloRustCommand.js";
+export default class DemoCommandFactory {
+    getCommands() {
+        return [helloCommand, helloRustCommand];
+    }
+}

package/dist/src/factory/DemoServiceProviderFactory.js

@@ -0,0 +1,6 @@
+import DemoServiceProvider from "../service/DemoServiceProvider.js";
+export default class DemoServiceProviderFactory {
+    getServiceProviders() {
+        return [new DemoServiceProvider()];
+    }
+}

package/dist/src/plugin.js

@@ -0,0 +1,7 @@
+import { createCLIPlugin } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import DemoCommandFactory from "./factory/DemoCommandFactory.js";
+import DemoServiceProviderFactory from "./factory/DemoServiceProviderFactory.js";
+export default createCLIPlugin({
+    commandFactory: new DemoCommandFactory(),
+    serviceProviderFactory: new DemoServiceProviderFactory(),
+});

package/dist/src/service/DefaultDemoService.js

@@ -0,0 +1,6 @@
+import * as cowsay from "cowsay";
+export default class DefaultDemoService {
+    cowsay(name) {
+        return cowsay.say({ text: `Hello, ${name}!` });
+    }
+}

package/dist/src/service/DemoService.js

@@ -0,0 +1 @@
+export const DEMO_SERVICE_ID = "DEMO_SERVICE";

package/dist/src/service/DemoServiceProvider.js

@@ -0,0 +1,10 @@
+import { DEMO_SERVICE_ID } from "./DemoService.js";
+import DefaultDemoService from "./DefaultDemoService.js";
+export default class DemoServiceProvider {
+    serviceId = DEMO_SERVICE_ID;
+    servicePriority = 10;
+    async getServiceInfo(_cliConfig) {
+        return { service: new DefaultDemoService(), commands: [] };
+    }
+    async initService(_context) { }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/example-cli-plugin",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Example CLI plugin for the https://github.com/flowscripter/dynamic-cli-framework",
   "keywords": [
     "bun",
@@ -39,9 +39,10 @@
     "access": "public"
   },
   "scripts": {
-    "build": "bun build index.ts --outdir dist --target bun && tsc -p tsconfig.build.json"
+    "build": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
+    "@flowscripter/template-bun-rust-library": "^1.2.5",
     "cowsay": "^1.6.0"
   },
   "devDependencies": {

package/src/command/HelloRustCommand.ts

@@ -0,0 +1,23 @@
+import type {
+  SubCommand,
+  Context,
+  PrinterService,
+} from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { world } from "@flowscripter/template-bun-rust-library";
+
+const helloRustCommand: SubCommand = {
+  name: "hello_rust",
+  description: "Greet using a native Rust library via FFI",
+  helpTopic: "Hello",
+  enableConfiguration: false,
+  options: [],
+  positionals: [],
+  execute: async (context: Context) => {
+    const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
+    await printerService?.print("Hello ");
+    world();
+  },
+};
+
+export default helloRustCommand;

package/src/factory/DemoCommandFactory.ts

@@ -1,8 +1,9 @@
 import type { CommandFactory } from "@flowscripter/dynamic-cli-framework/cli-plugin";
 import helloCommand from "../command/HelloCommand.ts";
+import helloRustCommand from "../command/HelloRustCommand.ts";
 
 export default class DemoCommandFactory implements CommandFactory {
   getCommands() {
-    return [helloCommand];
+    return [helloCommand, helloRustCommand];
   }
 }

package/dist/tests/plugin.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=plugin.test.d.ts.map

package/dist/tests/plugin.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.test.d.ts","sourceRoot":"","sources":["../../tests/plugin.test.ts"],"names":[],"mappings":""}