@flowscripter/example-cli-plugin 1.1.3 → 2.0.0

package/README.md

@@ -9,6 +9,13 @@
 > Example CLI plugin for the
 > [dynamic-cli-framework](https://github.com/flowscripter/dynamic-cli-framework)
 
+This plugin is authored against
+[`@flowscripter/dynamic-cli-framework-api`](https://github.com/flowscripter/dynamic-cli-framework-api),
+the lightweight plugin-facing API package, rather than the full
+`dynamic-cli-framework` - keeping the framework's concrete service
+implementations and their dependencies out of the plugin's own
+dependency tree.
+
 ## Development
 
 Build (produces `dist/` for Node.js and TypeScript consumers; Bun uses raw source directly):
@@ -76,13 +83,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/src/command/HelloCommand.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"HelloCommand.d.ts","sourceRoot":"","sources":["../../../src/command/HelloCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAIX,MAAM,gDAAgD,CAAC;AAQxD,QAAA,MAAM,YAAY,EAAE,UAqBnB,CAAC;AAEF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"HelloCommand.d.ts","sourceRoot":"","sources":["../../../src/command/HelloCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAIX,MAAM,yCAAyC,CAAC;AAKjD,QAAA,MAAM,YAAY,EAAE,UAqBnB,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/src/command/HelloCommand.js

@@ -1,4 +1,4 @@
-import { ArgumentValueTypeName, PRINTER_SERVICE_ID, } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { ArgumentValueTypeName, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { DEMO_SERVICE_ID } from "../service/DemoService.js";
 const helloCommand = {
     name: "hello",

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

@@ -0,0 +1,4 @@
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+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,EAAE,UAAU,EAA2B,MAAM,yCAAyC,CAAC;AAInG,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-api";
+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";
+import type { CommandFactory } from "@flowscripter/dynamic-cli-framework-api";
 export default class DemoCommandFactory implements CommandFactory {
-    getCommands(): import("@flowscripter/dynamic-cli-framework/cli-plugin").SubCommand[];
+    getCommands(): import("@flowscripter/dynamic-cli-framework-api").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,yCAAyC,CAAC;AAI9E,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,cAAc;IAC/D,WAAW;CAGZ"}

package/dist/src/factory/DemoCommandFactory.js

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

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

@@ -1,4 +1,4 @@
-import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework-api";
 import DemoServiceProvider from "../service/DemoServiceProvider.ts";
 export default class DemoServiceProviderFactory implements ServiceProviderFactory {
     getServiceProviders(): DemoServiceProvider[];

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

@@ -1 +1 @@
-{"version":3,"file":"DemoServiceProviderFactory.d.ts","sourceRoot":"","sources":["../../../src/factory/DemoServiceProviderFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,mBAAmB,MAAM,mCAAmC,CAAC;AAEpE,MAAM,CAAC,OAAO,OAAO,0BAA2B,YAAW,sBAAsB;IAC/E,mBAAmB;CAGpB"}
+{"version":3,"file":"DemoServiceProviderFactory.d.ts","sourceRoot":"","sources":["../../../src/factory/DemoServiceProviderFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,mBAAmB,MAAM,mCAAmC,CAAC;AAEpE,MAAM,CAAC,OAAO,OAAO,0BAA2B,YAAW,sBAAsB;IAC/E,mBAAmB;CAGpB"}

package/dist/src/plugin.d.ts

@@ -1,3 +1,3 @@
-declare const _default: import("@flowscripter/dynamic-cli-framework/cli-plugin").CLIPlugin;
+declare const _default: import("@flowscripter/dynamic-cli-framework-api").CLIPlugin;
 export default _default;
 //# sourceMappingURL=plugin.d.ts.map

package/dist/src/plugin.js

@@ -1,4 +1,4 @@
-import { createCLIPlugin } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { createCLIPlugin } from "@flowscripter/dynamic-cli-framework-api";
 import DemoCommandFactory from "./factory/DemoCommandFactory.js";
 import DemoServiceProviderFactory from "./factory/DemoServiceProviderFactory.js";
 export default createCLIPlugin({

package/dist/src/service/DemoServiceProvider.d.ts

@@ -1,4 +1,4 @@
-import type { ServiceProvider, ServiceInfo, CLIConfig, Context } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import type { ServiceProvider, ServiceInfo, CLIConfig, Context } from "@flowscripter/dynamic-cli-framework-api";
 export default class DemoServiceProvider implements ServiceProvider {
     readonly serviceId = "DEMO_SERVICE";
     readonly servicePriority = 10;

package/dist/src/service/DemoServiceProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DemoServiceProvider.d.ts","sourceRoot":"","sources":["../../../src/service/DemoServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACX,SAAS,EACT,OAAO,EACR,MAAM,gDAAgD,CAAC;AAIxD,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,eAAe;IACjE,QAAQ,CAAC,SAAS,kBAAmB;IACrC,QAAQ,CAAC,eAAe,MAAM;IAExB,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3D,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CACpD"}
+{"version":3,"file":"DemoServiceProvider.d.ts","sourceRoot":"","sources":["../../../src/service/DemoServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACX,SAAS,EACT,OAAO,EACR,MAAM,yCAAyC,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,eAAe;IACjE,QAAQ,CAAC,SAAS,kBAAmB;IACrC,QAAQ,CAAC,eAAe,MAAM;IAExB,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3D,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CACpD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/example-cli-plugin",
-  "version": "1.1.3",
+  "version": "2.0.0",
   "description": "Example CLI plugin for the https://github.com/flowscripter/dynamic-cli-framework",
   "keywords": [
     "bun",
@@ -42,16 +42,18 @@
     "build": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
+    "@flowscripter/template-bun-rust-library": "^1.2.5",
     "cowsay": "^1.6.0"
   },
   "devDependencies": {
-    "@flowscripter/dynamic-cli-framework": "1.7.3",
+    "@flowscripter/dynamic-cli-framework": "^2.0.0",
+    "@flowscripter/dynamic-cli-framework-api": "^1.0.1",
     "@types/bun": "^1.3.14",
     "oxfmt": "0.56.0",
     "oxlint": "1.71.0"
   },
   "peerDependencies": {
-    "@flowscripter/dynamic-cli-framework": "*",
+    "@flowscripter/dynamic-cli-framework-api": "*",
     "typescript": "^6.0.3"
   },
   "dynamic-cli-framework": {

package/src/command/HelloCommand.ts

@@ -3,11 +3,8 @@ import type {
   Context,
   ArgumentValues,
   PrinterService,
-} from "@flowscripter/dynamic-cli-framework/cli-plugin";
-import {
-  ArgumentValueTypeName,
-  PRINTER_SERVICE_ID,
-} from "@flowscripter/dynamic-cli-framework/cli-plugin";
+} from "@flowscripter/dynamic-cli-framework-api";
+import { ArgumentValueTypeName, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { DEMO_SERVICE_ID } from "../service/DemoService.ts";
 import type DemoService from "../service/DemoService.ts";
 

package/src/command/HelloRustCommand.ts

@@ -0,0 +1,19 @@
+import type { SubCommand, Context, PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+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 type { CommandFactory } from "@flowscripter/dynamic-cli-framework-api";
 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/src/factory/DemoServiceProviderFactory.ts

@@ -1,4 +1,4 @@
-import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework-api";
 import DemoServiceProvider from "../service/DemoServiceProvider.ts";
 
 export default class DemoServiceProviderFactory implements ServiceProviderFactory {

package/src/plugin.ts

@@ -1,4 +1,4 @@
-import { createCLIPlugin } from "@flowscripter/dynamic-cli-framework/cli-plugin";
+import { createCLIPlugin } from "@flowscripter/dynamic-cli-framework-api";
 import DemoCommandFactory from "./factory/DemoCommandFactory.ts";
 import DemoServiceProviderFactory from "./factory/DemoServiceProviderFactory.ts";
 

package/src/service/DemoServiceProvider.ts

@@ -3,7 +3,7 @@ import type {
   ServiceInfo,
   CLIConfig,
   Context,
-} from "@flowscripter/dynamic-cli-framework/cli-plugin";
+} from "@flowscripter/dynamic-cli-framework-api";
 import { DEMO_SERVICE_ID } from "./DemoService.ts";
 import DefaultDemoService from "./DefaultDemoService.ts";