@flowscripter/example-cli-plugin 0.0.1

package/README.md

@@ -0,0 +1,102 @@
+# example-cli-plugin
+
+[![version](https://img.shields.io/github/v/release/flowscripter/example-cli-plugin?sort=semver)](https://github.com/flowscripter/example-cli-plugin/releases)
+[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/example-cli-plugin/release-bun-library.yml)](https://github.com/flowscripter/example-cli-plugin/actions/workflows/release-bun-library.yml)
+[![coverage](https://codecov.io/gh/flowscripter/example-cli-plugin/branch/main/graph/badge.svg?token=EMFT2938ZF)](https://codecov.io/gh/flowscripter/example-cli-plugin)
+[![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/example-cli-plugin/index.html)
+[![license: MIT](https://img.shields.io/github/license/flowscripter/example-cli-plugin)](https://github.com/flowscripter/example-cli-plugin/blob/main/LICENSE)
+
+> Example CLI plugin for the
+> [dynamic-cli-framework](https://github.com/flowscripter/dynamic-cli-framework)
+
+## Development
+
+Build (produces `dist/` for Node.js and TypeScript consumers; Bun uses raw source directly):
+
+`bun run build`
+
+Test:
+
+`bun test`
+
+Format:
+
+`bunx oxfmt`
+
+Lint:
+
+`bunx oxlint index.ts src/ tests/`
+
+Generate HTML API Documentation:
+
+`bunx typedoc index.ts`
+
+## Documentation
+
+### Overview
+
+```mermaid
+classDiagram
+    class Plugin {
+        <<interface>>
+        +extensionDescriptors: ExtensionDescriptor[]
+    }
+
+    class DemoCommandFactory {
+        <<CommandFactory>>
+        +getCommands() SubCommand[]
+    }
+
+    class DemoServiceProviderFactory {
+        <<ServiceProviderFactory>>
+        +getServiceProviders() ServiceProvider[]
+    }
+
+    class DemoServiceProvider {
+        <<ServiceProvider>>
+        +serviceId: string
+        +servicePriority: number
+        +getServiceInfo(cliConfig) ServiceInfo
+        +initService(context) void
+    }
+
+    class DemoService {
+        <<interface>>
+        +greet(name: string) string
+    }
+
+    class DefaultDemoService {
+        +greet(name: string) string
+    }
+
+    class helloCommand {
+        <<SubCommand>>
+        +name: "hello"
+        +positionals: name
+        +execute(context, argumentValues) void
+    }
+
+    Plugin --> DemoCommandFactory : extensionDescriptor
+    Plugin --> DemoServiceProviderFactory : extensionDescriptor
+    DemoCommandFactory --> helloCommand : getCommands()
+    DemoServiceProviderFactory --> DemoServiceProvider : getServiceProviders()
+    DemoServiceProvider --> DefaultDemoService : creates
+    DefaultDemoService ..|> DemoService
+    helloCommand --> DemoService : uses via context
+```
+
+### Framework API
+
+Refer to the
+[dynamic-cli-framework](https://github.com/flowscripter/dynamic-cli-framework)
+for an overview of what this example is demonstrating.
+
+### API
+
+Link to auto-generated API docs:
+
+[API Documentation](https://flowscripter.github.io/example-cli-plugin/index.html)
+
+## License
+
+MIT © Flowscripter

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./src/plugin.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,79 @@
+// @bun
+// ../dynamic-cli-framework/src/api/plugin/CommandFactory.ts
+var DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY";
+// ../dynamic-cli-framework/src/api/plugin/ServiceProviderFactory.ts
+var DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY";
+// 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",
+  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 name = argumentValues["name"] ?? "World";
+    const greeting = demoService ? demoService.greet(name) : `Hello, ${name}!`;
+    console.log(greeting);
+  }
+};
+var HelloCommand_default = helloCommand;
+
+// src/factory/DemoCommandFactory.ts
+class DemoCommandFactory {
+  getCommands() {
+    return [HelloCommand_default];
+  }
+}
+
+// src/service/DefaultDemoService.ts
+class DefaultDemoService {
+  greet(name) {
+    return `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 = {
+  extensionDescriptors: [
+    {
+      extensionPoint: DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT,
+      factory: { create: async () => new DemoCommandFactory }
+    },
+    {
+      extensionPoint: DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT,
+      factory: { create: async () => new DemoServiceProviderFactory }
+    }
+  ]
+};
+var plugin_default = plugin;
+export {
+  plugin_default as default
+};

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"HelloCommand.d.ts","sourceRoot":"","sources":["../../../src/command/HelloCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAGX,MAAM,4CAA4C,CAAC;AAKpD,QAAA,MAAM,YAAY,EAAE,UAmBnB,CAAC;AAEF,eAAe,YAAY,CAAC"}

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

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

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

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

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

@@ -0,0 +1,6 @@
+import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework/plugin";
+import DemoServiceProvider from "../service/DemoServiceProvider.ts";
+export default class DemoServiceProviderFactory implements ServiceProviderFactory {
+    getServiceProviders(): DemoServiceProvider[];
+}
+//# sourceMappingURL=DemoServiceProviderFactory.d.ts.map

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

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

package/dist/src/plugin.d.ts

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

package/dist/src/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wCAAwC,CAAC;AAQrE,QAAA,MAAM,MAAM,EAAE,MAWb,CAAC;AAEF,eAAe,MAAM,CAAC"}

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

@@ -0,0 +1,5 @@
+import type DemoService from "./DemoService.ts";
+export default class DefaultDemoService implements DemoService {
+    greet(name: string): string;
+}
+//# sourceMappingURL=DefaultDemoService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultDemoService.d.ts","sourceRoot":"","sources":["../../../src/service/DefaultDemoService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAEhD,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,WAAW;IAC5D,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAG5B"}

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

@@ -0,0 +1,5 @@
+export declare const DEMO_SERVICE_ID = "DEMO_SERVICE";
+export default interface DemoService {
+    greet(name: string): string;
+}
+//# sourceMappingURL=DemoService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DemoService.d.ts","sourceRoot":"","sources":["../../../src/service/DemoService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,MAAM,CAAC,OAAO,WAAW,WAAW;IAClC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC7B"}

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

@@ -0,0 +1,8 @@
+import type { ServiceProvider, ServiceInfo, CLIConfig, Context } from "@flowscripter/dynamic-cli-framework/plugin";
+export default class DemoServiceProvider implements ServiceProvider {
+    readonly serviceId = "DEMO_SERVICE";
+    readonly servicePriority = 10;
+    getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo>;
+    initService(_context: Context): Promise<void>;
+}
+//# sourceMappingURL=DemoServiceProvider.d.ts.map

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

@@ -0,0 +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,4CAA4C,CAAC;AAIpD,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/index.ts

@@ -0,0 +1 @@
+export { default } from "./src/plugin.ts";

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@flowscripter/example-cli-plugin",
+  "version": "0.0.1",
+  "description": "Example CLI plugin for the https://github.com/flowscripter/dynamic-cli-framework",
+  "keywords": [
+    "bun",
+    "cli",
+    "dynamic",
+    "dynamic-cli-framework",
+    "example",
+    "plugin"
+  ],
+  "homepage": "https://github.com/flowscripter/example-cli-plugin#readme",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flowscripter/example-cli-plugin.git"
+  },
+  "files": [
+    "dist",
+    "src",
+    "index.ts",
+    "cli-plugin.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "bun": "./index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "bun build index.ts --outdir dist --target bun && tsc -p tsconfig.build.json"
+  },
+  "dependencies": {
+    "@flowscripter/dynamic-plugin-framework": "1.9.0"
+  },
+  "devDependencies": {
+    "@flowscripter/dynamic-cli-framework": "1.6.1",
+    "@types/bun": "^1.3.14",
+    "oxfmt": "0.56.0",
+    "oxlint": "1.71.0"
+  },
+  "peerDependencies": {
+    "@flowscripter/dynamic-cli-framework": "*",
+    "typescript": "^6.0.3"
+  },
+  "dynamic-cli-framework": {
+    "extensionPoints": [
+      "DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY",
+      "DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY"
+    ]
+  }
+}

package/src/command/HelloCommand.ts

@@ -0,0 +1,31 @@
+import type {
+  SubCommand,
+  Context,
+  ArgumentValues,
+} from "@flowscripter/dynamic-cli-framework/plugin";
+import { ArgumentValueTypeName } from "@flowscripter/dynamic-cli-framework/plugin";
+import { DEMO_SERVICE_ID } from "../service/DemoService.ts";
+import type DemoService from "../service/DemoService.ts";
+
+const helloCommand: SubCommand = {
+  name: "hello",
+  description: "Greet someone using the demo service",
+  enableConfiguration: false,
+  options: [],
+  positionals: [
+    {
+      name: "name",
+      description: "Name to greet",
+      type: ArgumentValueTypeName.STRING,
+      isVarargOptional: true,
+    },
+  ],
+  execute: async (context: Context, argumentValues: ArgumentValues) => {
+    const demoService = context.getServiceById(DEMO_SERVICE_ID) as DemoService | undefined;
+    const name = (argumentValues["name"] as string | undefined) ?? "World";
+    const greeting = demoService ? demoService.greet(name) : `Hello, ${name}!`;
+    console.log(greeting);
+  },
+};
+
+export default helloCommand;

package/src/factory/DemoCommandFactory.ts

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

package/src/factory/DemoServiceProviderFactory.ts

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

package/src/plugin.ts

@@ -0,0 +1,22 @@
+import type { Plugin } from "@flowscripter/dynamic-plugin-framework";
+import {
+  DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT,
+  DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT,
+} from "@flowscripter/dynamic-cli-framework/plugin";
+import DemoCommandFactory from "./factory/DemoCommandFactory.ts";
+import DemoServiceProviderFactory from "./factory/DemoServiceProviderFactory.ts";
+
+const plugin: Plugin = {
+  extensionDescriptors: [
+    {
+      extensionPoint: DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT,
+      factory: { create: async () => new DemoCommandFactory() },
+    },
+    {
+      extensionPoint: DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT,
+      factory: { create: async () => new DemoServiceProviderFactory() },
+    },
+  ],
+};
+
+export default plugin;

package/src/service/DefaultDemoService.ts

@@ -0,0 +1,7 @@
+import type DemoService from "./DemoService.ts";
+
+export default class DefaultDemoService implements DemoService {
+  greet(name: string): string {
+    return `Hello, ${name}!`;
+  }
+}

package/src/service/DemoService.ts

@@ -0,0 +1,5 @@
+export const DEMO_SERVICE_ID = "DEMO_SERVICE";
+
+export default interface DemoService {
+  greet(name: string): string;
+}

package/src/service/DemoServiceProvider.ts

@@ -0,0 +1,19 @@
+import type {
+  ServiceProvider,
+  ServiceInfo,
+  CLIConfig,
+  Context,
+} from "@flowscripter/dynamic-cli-framework/plugin";
+import { DEMO_SERVICE_ID } from "./DemoService.ts";
+import DefaultDemoService from "./DefaultDemoService.ts";
+
+export default class DemoServiceProvider implements ServiceProvider {
+  readonly serviceId = DEMO_SERVICE_ID;
+  readonly servicePriority = 10;
+
+  async getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {
+    return { service: new DefaultDemoService(), commands: [] };
+  }
+
+  async initService(_context: Context): Promise<void> {}
+}