@monosmith/plugin-sdk 0.4.0 → 0.5.0

package/conformance/check-generation.use-case.js

@@ -21,7 +21,10 @@ function article(kind) {
 export async function checkGeneration(client, workspace, report) {
     const language = effectiveRoles(client.info).includes('language');
     const made = [];
+    const declared = client.info.kinds ?? [];
     for (const kind of ['app', 'lib', 'package']) {
+        if (declared.length > 0 && !declared.includes(kind))
+            continue;
         const name = `c${kind}`;
         const params = {
             kind,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monosmith/plugin-sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "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.",
   "license": "MIT",
   "type": "module",

package/protocol/protocol-schema.contract.js

@@ -642,6 +642,10 @@ export const protocolSchema = {
                         }
                     },
                     "description": "DependsOn adds dependencies to tasks the project already has, by task name ({\"lint\": [\"slice-check\"]})."
+                },
+                "release": {
+                    "$ref": "#/$defs/ReleaseDefaults",
+                    "description": "Release is how the project's release files are made, for a project that releases through GitHub releases and leaves them out of its smith.toml [projects.<name>.release] table; what the table sets wins."
                 }
             }
         },
@@ -1163,6 +1167,13 @@ export const protocolSchema = {
                         "$ref": "#/$defs/Stack"
                     },
                     "description": "Stacks are ready-made stacks the plugin publishes."
+                },
+                "kinds": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ProjectKind"
+                    },
+                    "description": "Kinds are the project kinds the plugin can scaffold with generate. Absent or empty means all three (app, lib and package): what every plugin that says nothing does. A plugin that scaffolds only some, such as an app, lists them, so the host offers and the conformance suite asks for just those."
                 }
             },
             "required": [
@@ -1627,6 +1638,43 @@ export const protocolSchema = {
                 "auth"
             ]
         },
+        "ReleaseDefaults": {
+            "description": "ReleaseDefaults are release settings a plugin supplies for a project: the same fields as the release-from-a-command settings of smith.toml, used for the ones the project's table leaves out.",
+            "type": "object",
+            "properties": {
+                "build": {
+                    "type": "string",
+                    "description": "Build is the shell command that makes the files, run at the workspace root on a runner of each platform."
+                },
+                "assets": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Assets are workspace-relative globs of the files Build leaves."
+                },
+                "platforms": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Platforms are the runner platforms (windows-x64, macos-arm64, macos-x64, linux-x64, linux-arm64)."
+                },
+                "assetName": {
+                    "type": "string",
+                    "description": "AssetName renames each file on upload; see the asset_name setting."
+                },
+                "checksums": {
+                    "type": "boolean",
+                    "description": "Checksums attaches a checksums file for the files a runner uploads."
+                }
+            },
+            "required": [
+                "build",
+                "assets",
+                "platforms"
+            ]
+        },
         "RemoveParams": {
             "description": "RemoveParams tells a plugin a project is being removed. The host deletes the project's directory first; the plugin cleans what it owns outside it (a go.work entry, a lockfile, an installed package).",
             "type": "object",

package/protocol/protocol-types.contract.d.ts

@@ -229,6 +229,12 @@ export interface Contribution {
      * ["slice-check"]}).
      */
     dependsOn?: Record<string, string[]>;
+    /**
+     * Release is how the project's release files are made, for a project that releases through GitHub
+     * releases and leaves them out of its smith.toml [projects.<name>.release] table; what the table
+     * sets wins.
+     */
+    release?: ReleaseDefaults;
 }
 /** Credential is a secret the release phase needs. */
 export interface Credential {
@@ -491,6 +497,13 @@ export interface InitializeResult {
     conflicts?: PluginRef[];
     /** Stacks are ready-made stacks the plugin publishes. */
     stacks?: Stack[];
+    /**
+     * Kinds are the project kinds the plugin can scaffold with generate. Absent or empty means all
+     * three (app, lib and package): what every plugin that says nothing does. A plugin that scaffolds
+     * only some, such as an app, lists them, so the host offers and the conformance suite asks for
+     * just those.
+     */
+    kinds?: ProjectKind[];
 }
 /**
  * Input is one input of an ActionStep. Values are written as quoted YAML strings, except true and
@@ -796,6 +809,28 @@ export interface Registry {
      */
     maven?: string;
 }
+/**
+ * ReleaseDefaults are release settings a plugin supplies for a project: the same fields as the
+ * release-from-a-command settings of smith.toml, used for the ones the project's table leaves out.
+ */
+export interface ReleaseDefaults {
+    /**
+     * Build is the shell command that makes the files, run at the workspace root on a runner of each
+     * platform.
+     */
+    build: string;
+    /** Assets are workspace-relative globs of the files Build leaves. */
+    assets: string[];
+    /**
+     * Platforms are the runner platforms (windows-x64, macos-arm64, macos-x64, linux-x64,
+     * linux-arm64).
+     */
+    platforms: string[];
+    /** AssetName renames each file on upload; see the asset_name setting. */
+    assetName?: string;
+    /** Checksums attaches a checksums file for the files a runner uploads. */
+    checksums?: boolean;
+}
 /**
  * RemoveParams tells a plugin a project is being removed. The host deletes the project's directory
  * first; the plugin cleans what it owns outside it (a go.work entry, a lockfile, an installed