Add plugin authoring best-practices section and ref docs#621
Open
Copilot wants to merge 2 commits into
Open
Conversation
Copilot created this pull request from a session on behalf of
philmillman
April 15, 2026 19:18
View session
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
varlock-website | 7640356 | Commit Preview URL Branch Preview URL |
Jun 16 2026, 07:16 AM |
commit: |
philmillman
changed the title
selfire1
reviewed
May 5, 2026
Contributor
There was a problem hiding this comment.
Thanks for adding the docs! It comes in handy as we're looking to build a custom internal plugin.
I started following the WIP docs. When using strict: true, I got a few errors that I needed to resolve with !.
This might not be the most elegant solution, but I just wanted to put on your radar that the examples require some coercion or checks.
Comment on lines
+189
to
+194
| async execute({ id, tokenResolver }) { | ||
| // Await dynamic values (these may reference other schema items) | ||
| const token = await tokenResolver?.resolve(); | ||
| instances[id].token = token ? String(token) : undefined; | ||
| }, | ||
| }); |
Contributor
There was a problem hiding this comment.
Suggested change
| async execute({ id, tokenResolver }) { | |
| // Await dynamic values (these may reference other schema items) | |
| const token = await tokenResolver?.resolve(); | |
| instances[id].token = token ? String(token) : undefined; | |
| }, | |
| }); | |
| async execute({ id, tokenResolver }) { | |
| // Await dynamic values (these may reference other schema items) | |
| const token = await tokenResolver?.resolve(); | |
| instances[id]!.token = token ? String(token) : undefined; | |
| } |
Comment on lines
+240
to
+253
| process() { | ||
| let instanceId = '_default'; | ||
| let refResolver: Resolver; | ||
|
|
||
| if (this.arrArgs!.length === 1) { | ||
| refResolver = this.arrArgs![0]; | ||
| } else { | ||
| // first arg is the instance id – must be a literal | ||
| if (!this.arrArgs![0].isStatic) { | ||
| throw new SchemaError('Instance id must be a static value'); | ||
| } | ||
| instanceId = String(this.arrArgs![0].staticValue); | ||
| refResolver = this.arrArgs![1]; | ||
| } |
Contributor
There was a problem hiding this comment.
Suggested change
| process() { | |
| let instanceId = '_default'; | |
| let refResolver: Resolver; | |
| if (this.arrArgs!.length === 1) { | |
| refResolver = this.arrArgs![0]; | |
| } else { | |
| // first arg is the instance id – must be a literal | |
| if (!this.arrArgs![0].isStatic) { | |
| throw new SchemaError('Instance id must be a static value'); | |
| } | |
| instanceId = String(this.arrArgs![0].staticValue); | |
| refResolver = this.arrArgs![1]; | |
| } | |
| process() { | |
| let instanceId = '_default'; | |
| let refResolver: Resolver; | |
| if (this.arrArgs!.length === 1) { | |
| refResolver = this.arrArgs![0]!; | |
| } else { | |
| // first arg is the instance id – must be a literal | |
| if (!this.arrArgs![0]!.isStatic) { | |
| throw new SchemaError('Instance id must be a static value'); | |
| } | |
| instanceId = String(this.arrArgs![0]!.staticValue); | |
| refResolver = this.arrArgs![1]!; | |
| } | |
| if (!instances[instanceId]) { | |
| throw new SchemaError( | |
| `No MyPlugin instance "${instanceId}" found`, | |
| { tip: 'Add @initMyPlugin() to your .env.schema file' }, | |
| ); | |
| } | |
| return { instanceId, refResolver }; | |
| } |
Member
|
Thanks @selfire1, we'll revisit and get something merged this week. |
Adds a plugin authoring best-practices section (design conventions, scaffolding, the four register* primitives, caching, error handling, packaging, testing) to the plugins guide, plus a Plugin API reference page documenting varlock/plugin-lib. Also notes the labeler.yaml step for new monorepo plugins in AGENTS.md.
theoephraim
force-pushed
the
copilot/add-plugin-authoring-section
branch
from
5f9dccb to
371eedb
Compare
The consumer plugins guide (guides/plugins) is now install/scope/init/use only. The authoring how-to lives at plugins/authoring (Plugins sidebar group, after Overview); the Plugin API reference stays under Reference. Cross-linked from the overview, consumer guide, and reference page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
reference/plugin-api/folder (5 individual pages removed)reference/plugin-api.mdx— single page in the style of root-decorators / functions reference pagesastro.config.tssidebar to add one "Plugin API" entry under Reference