@monosmith/plugin-sdk 0.2.0 → 0.2.1
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": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
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",
|
|
@@ -990,6 +990,10 @@ export const protocolSchema = {
|
|
|
990
990
|
"type": "string"
|
|
991
991
|
},
|
|
992
992
|
"description": "Notes are printed to the user after generation."
|
|
993
|
+
},
|
|
994
|
+
"installPending": {
|
|
995
|
+
"type": "boolean",
|
|
996
|
+
"description": "InstallPending is true when the plugin changed what the workspace depends on and left installing it to the host. A project is made by several plugins in turn; the host asks each plugin that reported this to install once (dependencies/install with Quiet set) after the last of them has generated, instead of once per plugin."
|
|
993
997
|
}
|
|
994
998
|
},
|
|
995
999
|
"required": [
|
|
@@ -1140,6 +1144,10 @@ export const protocolSchema = {
|
|
|
1140
1144
|
"dev": {
|
|
1141
1145
|
"type": "boolean",
|
|
1142
1146
|
"description": "Dev adds them as development dependencies where the ecosystem has such a thing; a plugin without one says so in a note."
|
|
1147
|
+
},
|
|
1148
|
+
"quiet": {
|
|
1149
|
+
"type": "boolean",
|
|
1150
|
+
"description": "Quiet keeps the package manager's output unless it fails: the host sets it when it installs as one step of a larger job (smith add)."
|
|
1143
1151
|
}
|
|
1144
1152
|
}
|
|
1145
1153
|
},
|
|
@@ -389,6 +389,13 @@ export interface GenerateResult {
|
|
|
389
389
|
files: string[];
|
|
390
390
|
/** Notes are printed to the user after generation. */
|
|
391
391
|
notes?: string[];
|
|
392
|
+
/**
|
|
393
|
+
* InstallPending is true when the plugin changed what the workspace depends on and left
|
|
394
|
+
* installing it to the host. A project is made by several plugins in turn; the host asks each
|
|
395
|
+
* plugin that reported this to install once (dependencies/install with Quiet set) after the last
|
|
396
|
+
* of them has generated, instead of once per plugin.
|
|
397
|
+
*/
|
|
398
|
+
installPending?: boolean;
|
|
392
399
|
}
|
|
393
400
|
/** InitializeParams is sent once, first, by the host. */
|
|
394
401
|
export interface InitializeParams {
|
|
@@ -469,6 +476,11 @@ export interface InstallParams {
|
|
|
469
476
|
* without one says so in a note.
|
|
470
477
|
*/
|
|
471
478
|
dev?: boolean;
|
|
479
|
+
/**
|
|
480
|
+
* Quiet keeps the package manager's output unless it fails: the host sets it when it installs as
|
|
481
|
+
* one step of a larger job (smith add).
|
|
482
|
+
*/
|
|
483
|
+
quiet?: boolean;
|
|
472
484
|
}
|
|
473
485
|
/**
|
|
474
486
|
* LatestParams asks for the newest stable release of each dependency, and, with Tools, how the
|