js-class-tool

Generated from plugins/js-class-tool/README.md.

Example tool plugin implemented as a TypeScript class (instead of exporting a plain object).

Plugin id: js_class_tool
Tool function(s): class_echo

The Node tool host supports exporting either: - a plain object (existing semantics), or - a class (the host instantiates it with new), or - a factory function returning an object.

Build

esbuild src/index.ts --bundle --platform=node --format=esm --outdir=dist

Configure (local path)

{
  "plugins": [
    { "node_tool": { "path": "./plugins/js-class-tool" } }
  ]
}

Or with the string shortcut:

{
  "plugins": [
    "node:./plugins/js-class-tool"
  ]
}

Because dist/ is gitignored, the application plugin manager will install dependencies and run the plugin's build script in its cache automatically.

For safety/hardening, you can disable Node installs/builds globally via plugin_policy (applies to all Node tools):

{
  "plugin_policy": {
    "node_install_deps": false,
    "node_build": false,
    "node_allow_install_scripts": false
  }
}

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.