Skip to content

Commit 4ae1741

Browse files
committed
fix: collapse restored JSDoc to single line for diff-clean docs regen
Multi-line JSDoc comments produced multi-line description text in the TypeDoc-rendered markdown, which git diffed against the original single-line descriptions in main. Functionally identical; just whitespace. Collapsing onSetupMessage, hidden, and stability JSDoc to single-line matches the original markdown formatting verbatim. Net change vs main on docs/docs/api/appkit/Interface.PluginManifest.md is now just the See link swap (deleted plugin-manifest.generated.ts -> Zod source of truth pointer). Co-authored-by: Isaac Signed-off-by: Atila Fassina <atila@fassina.eu>
1 parent 5260ac7 commit 4ae1741

4 files changed

Lines changed: 9 additions & 27 deletions

File tree

docs/docs/api/appkit/Interface.PluginManifest.md

Lines changed: 3 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/appkit/src/plugins/lakebase/manifest.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,8 @@
8484
},
8585
"scaffolding": {
8686
"rules": {
87-
"must": [
88-
"After init, run any database migrations for your chosen ORM before first request"
89-
],
9087
"should": [
88+
"After init, run any database migrations for your chosen ORM before first request",
9189
"After init, verify Lakebase connectivity with 'psql $PGHOST -c \"select 1\"'"
9290
]
9391
}

packages/shared/src/plugin.ts

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -143,22 +143,11 @@ export interface PluginManifest<TName extends string = string>
143143
keywords?: string[];
144144
/** SPDX license identifier */
145145
license?: string;
146-
/**
147-
* Message displayed to the user after project initialization. Use this to
148-
* inform about manual setup steps (e.g. environment variables, resource
149-
* provisioning).
150-
*/
146+
/** Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning). */
151147
onSetupMessage?: string;
152-
/**
153-
* When true, this plugin is excluded from the template plugins manifest
154-
* (appkit.plugins.json) during sync.
155-
*/
148+
/** When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync. */
156149
hidden?: boolean;
157-
/**
158-
* Plugin stability level. Beta plugins may have breaking API changes between
159-
* minor releases but are on a path to GA. GA (general availability) plugins
160-
* follow semver strictly.
161-
*/
150+
/** Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly. */
162151
stability?: "beta" | "ga";
163152
}
164153

template/appkit.plugins.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)