Is the local plugin authoring API (varlock/plugin-lib) stable?

[aek676]

I wrote a small local plugin to add a custom data type (@type=timeZone, validating IANA zone names), loaded with @plugin(./varlock/time-zone-plugin.cjs). It works fine on varlock 1.18.0, but I had to work out the API from the bitwarden plugin's bundle and the published .d.mts types, since the plugins guide only covers @plugin(./path) and the self-contained-file constraint:

• const { plugin } = require("varlock/plugin-lib")
• plugin.name = "..."
• plugin.registerDataType({ name, typeDescription, docs, validate })
• plugin.ERRORS.ValidationError

varlock/plugin-lib is a public export in package.json, but since none of it is documented I can't tell whether it's meant for end users or only for the official @varlock/* plugins.

1. Is writing your own local plugin a supported use case, and is this API covered by semver?
2. If yes, would you take a short "Authoring a plugin" section in the guide? I can draft it from a minimal working example (a custom data type in about 20 lines).

Related: I've opened feature requests for a built-in timeZone type (#1100) and for .ts plugins under auto-load in Bun (#1101).

[theoephraim]

Yep should be ok - at first I wanted things to stabilize a bit, but now I'd say they are. I will put together a guide!
The intent for the single file plugins is simple stuff, while a more complex plugin should be a package.

I'll take a look at your PR so this can likely be part of main - but regardless this should be better documented!