@monosmith/plugin-sdk 2.0.0-beta.2 → 2.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@monosmith/plugin-sdk",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.4",
|
|
4
4
|
"description": "The TypeScript SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -616,6 +616,10 @@ export const protocolSchema = {
|
|
|
616
616
|
"channels": {
|
|
617
617
|
"type": "boolean",
|
|
618
618
|
"description": "Channels says a prerelease version the plugin publishes never takes the place of the stable one: the plugin publishes under PublishParams.Tag, a release channel's name, without moving the registry's stable pointer (npm's latest), or its registry orders a prerelease below the release (PyPI, NuGet) and needs no tag. A host does not publish a package of a release channel with a plugin that lacks it."
|
|
619
|
+
},
|
|
620
|
+
"declared": {
|
|
621
|
+
"type": "boolean",
|
|
622
|
+
"description": "Declared says the plugin describes the projects smith.toml declares for its language (DiscoverParams.declared): folders with no manifest of their own. A plugin without it finds a project by its manifest only, and the host refuses a declaration for its language with a message that says so."
|
|
619
623
|
}
|
|
620
624
|
}
|
|
621
625
|
},
|
|
@@ -1145,6 +1149,13 @@ export const protocolSchema = {
|
|
|
1145
1149
|
"$ref": "#/$defs/DeclaredProject"
|
|
1146
1150
|
},
|
|
1147
1151
|
"description": "Declared are the projects smith.toml declares for this plugin's language ([projects.<name>] with a root and a language): folders with no manifest of their own, such as a program that is a package of the Go module above it. The plugin describes each one in its result, or answers with an error saying why it cannot."
|
|
1152
|
+
},
|
|
1153
|
+
"settings": {
|
|
1154
|
+
"type": "object",
|
|
1155
|
+
"additionalProperties": {
|
|
1156
|
+
"type": "object"
|
|
1157
|
+
},
|
|
1158
|
+
"description": "Settings are this plugin's settings for projects, by project name, from smith.toml [projects.<project>.settings.<plugin>]. They reach the plugin here because the tasks it describes may depend on them (the Go plugin's build tags). A project with no settings is absent."
|
|
1148
1159
|
}
|
|
1149
1160
|
},
|
|
1150
1161
|
"required": [
|
|
@@ -204,6 +204,13 @@ export interface Capabilities {
|
|
|
204
204
|
* plugin that lacks it.
|
|
205
205
|
*/
|
|
206
206
|
channels?: boolean;
|
|
207
|
+
/**
|
|
208
|
+
* Declared says the plugin describes the projects smith.toml declares for its language
|
|
209
|
+
* (DiscoverParams.declared): folders with no manifest of their own. A plugin without it finds a
|
|
210
|
+
* project by its manifest only, and the host refuses a declaration for its language with a
|
|
211
|
+
* message that says so.
|
|
212
|
+
*/
|
|
213
|
+
declared?: boolean;
|
|
207
214
|
}
|
|
208
215
|
/**
|
|
209
216
|
* ChangeKindParams asks a plugin what changing a project's kind edits. The plugin writes nothing:
|
|
@@ -518,6 +525,13 @@ export interface DiscoverParams {
|
|
|
518
525
|
* an error saying why it cannot.
|
|
519
526
|
*/
|
|
520
527
|
declared?: DeclaredProject[];
|
|
528
|
+
/**
|
|
529
|
+
* Settings are this plugin's settings for projects, by project name, from smith.toml
|
|
530
|
+
* [projects.<project>.settings.<plugin>]. They reach the plugin here because the tasks it
|
|
531
|
+
* describes may depend on them (the Go plugin's build tags). A project with no settings is
|
|
532
|
+
* absent.
|
|
533
|
+
*/
|
|
534
|
+
settings?: Record<string, Record<string, unknown>>;
|
|
521
535
|
}
|
|
522
536
|
/**
|
|
523
537
|
* DiscoverResult describes every manifest that is a project of this plugin. A manifest the plugin
|