@flowscripter/example-plugin

example-plugin

Example plugin for the dynamic-plugin-framework

Bundled Bun Module Usage

Use the module:

import { ExampleExtension } from "https://unpkg.com/@flowscripter/example-plugin/dist/bundle.js";

const extension = new ExampleExtension();

extension.sayHello();

Development

Install dependencies:

bun install

Test:

bun test

Bundle for usage as a dynamic-plugin-framework plugin:

bun build index.ts --outdir ./dist --entry-naming bundle.js --minify

NOTE: The following tasks use Deno as it excels at these and Bun does not currently provide such functionality:

Format:

deno fmt

Lint:

deno lint index.ts src/ tests/

Generate HTML API Documentation:

deno doc --html --name=example-plugin index.ts

Documentation

Overview

Refer to the dynamic-plugin-framework for an overview of what this example is demonstrating.

API

Link to auto-generated API docs for the library:

API Documentation

License

MIT © Flowscripter