@monosmith/plugin-sdk 2.0.0-beta.11 → 2.0.0-beta.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monosmith/plugin-sdk",
-  "version": "2.0.0-beta.11",
+  "version": "2.0.0-beta.13",
   "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

@@ -643,6 +643,10 @@ export const protocolSchema = {
                     "type": "boolean",
                     "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."
                 },
+                "packs": {
+                    "type": "boolean",
+                    "description": "Packs says publish honours PublishParams.PackDir: it writes the package file and publishes nowhere (registry = \"github-release\"). A host never calls publish with the setting on a plugin that lacks it, since the plugin would publish to the public registry."
+                },
                 "declared": {
                     "type": "boolean",
                     "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."
@@ -1303,15 +1307,28 @@ export const protocolSchema = {
             ]
         },
         "Finding": {
-            "description": "Finding is one check. Every failed finding names its remedy.",
+            "description": "Finding is one check. Every failed finding names its problem and its remedy.",
             "type": "object",
             "properties": {
                 "check": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "Check is the rule, stated as it should hold (\"golangci-lint is 2.15.0, as in CI\"). A passing finding is listed by it."
                 },
                 "ok": {
                     "type": "boolean"
                 },
+                "problem": {
+                    "type": "string",
+                    "description": "Problem is what is wrong, in one line (\"golangci-lint is 2.14.0, CI uses 2.15.0\"). A failed finding is listed by it; one without it is listed by its Check."
+                },
+                "project": {
+                    "type": "string",
+                    "description": "Project is the project the finding is about, as the workspace names it (\"web\"); empty for a finding about the workspace itself. The host files a finding under its project, so the Check, Problem and Detail need not name it."
+                },
+                "area": {
+                    "type": "string",
+                    "description": "Area is the part of the workspace a workspace-wide finding is about, in one lowercase word: \"toolchain\", \"ci\", \"lint\", \"dependencies\", \"release\", \"git\" or \"config\". A finding with a Project has none."
+                },
                 "detail": {
                     "type": "string"
                 },
@@ -2056,6 +2073,10 @@ export const protocolSchema = {
                     "type": "string",
                     "description": "PropagationWait is the longest time a plugin waits, in a Finalize call, for the packages of the release to be fetchable from the registry: a duration such as \"15m\", \"0\" to not wait. Empty means the default. Only npm has such a wait. A publish never waits."
                 },
+                "packDir": {
+                    "type": "string",
+                    "description": "PackDir, when set, turns the call into a pack: the plugin writes the package file of the project's ecosystem (npm tarball, wheel and sdist, .nupkg, .gem, .crate) and returns the files in PublishResult.Assets, and publishes nothing anywhere. A workspace-relative folder. The host sends it only to a plugin with the packs capability. In a dry run the plugin lists the files it would write, writes none, and reads no registry."
+                },
                 "finalize": {
                     "type": "array",
                     "items": {
@@ -2204,6 +2225,10 @@ export const protocolSchema = {
                 "noPublish": {
                     "type": "boolean",
                     "description": "NoPublish means smith.toml says registry = \"none\": the release versions and tags the project and publishes it to no registry (a registry that builds from the tag, such as JitPack, does the rest)."
+                },
+                "packToRelease": {
+                    "type": "boolean",
+                    "description": "PackToRelease means smith.toml says registry = \"github-release\": the release packs the project into its ecosystem's package file and attaches it to the project's GitHub Release, publishing to no registry. The host sends PublishParams.PackDir to a plugin with the packs capability and never calls publish on one without it."
                 }
             }
         },

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

@@ -211,6 +211,12 @@ export interface Capabilities {
      * plugin that lacks it.
      */
     channels?: boolean;
+    /**
+     * Packs says publish honours PublishParams.PackDir: it writes the package file and publishes
+     * nowhere (registry = "github-release"). A host never calls publish with the setting on a plugin
+     * that lacks it, since the plugin would publish to the public registry.
+     */
+    packs?: boolean;
     /**
      * 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
@@ -596,10 +602,31 @@ export interface FileEdit {
     content?: string;
     delete?: boolean;
 }
-/** Finding is one check. Every failed finding names its remedy. */
+/** Finding is one check. Every failed finding names its problem and its remedy. */
 export interface Finding {
+    /**
+     * Check is the rule, stated as it should hold ("golangci-lint is 2.15.0, as in CI"). A passing
+     * finding is listed by it.
+     */
     check: string;
     ok: boolean;
+    /**
+     * Problem is what is wrong, in one line ("golangci-lint is 2.14.0, CI uses 2.15.0"). A failed
+     * finding is listed by it; one without it is listed by its Check.
+     */
+    problem?: string;
+    /**
+     * Project is the project the finding is about, as the workspace names it ("web"); empty for a
+     * finding about the workspace itself. The host files a finding under its project, so the Check,
+     * Problem and Detail need not name it.
+     */
+    project?: string;
+    /**
+     * Area is the part of the workspace a workspace-wide finding is about, in one lowercase word:
+     * "toolchain", "ci", "lint", "dependencies", "release", "git" or "config". A finding with a
+     * Project has none.
+     */
+    area?: string;
     detail?: string;
     remedy?: string;
     /** Warning true reports a problem without failing doctor. */
@@ -1102,6 +1129,14 @@ export interface PublishParams {
      * means the default. Only npm has such a wait. A publish never waits.
      */
     propagationWait?: string;
+    /**
+     * PackDir, when set, turns the call into a pack: the plugin writes the package file of the
+     * project's ecosystem (npm tarball, wheel and sdist, .nupkg, .gem, .crate) and returns the files
+     * in PublishResult.Assets, and publishes nothing anywhere. A workspace-relative folder. The host
+     * sends it only to a plugin with the packs capability. In a dry run the plugin lists the files it
+     * would write, writes none, and reads no registry.
+     */
+    packDir?: string;
     /**
      * Finalize turns the call into the last phase of a release: nothing is published; for each move
      * the plugin waits until its packages are fetchable, then moves the dist-tag. The host sends it
@@ -1195,6 +1230,13 @@ export interface Registries {
      * rest).
      */
     noPublish?: boolean;
+    /**
+     * PackToRelease means smith.toml says registry = "github-release": the release packs the project
+     * into its ecosystem's package file and attaches it to the project's GitHub Release, publishing
+     * to no registry. The host sends PublishParams.PackDir to a plugin with the packs capability and
+     * never calls publish on one without it.
+     */
+    packToRelease?: boolean;
 }
 /**
  * Registry is a package registry smith.toml names in [registries.<name>]: a private feed (Azure

package/scaffold/index.d.ts

@@ -1,3 +1,3 @@
 export { scaffoldProject } from './scaffold-project.use-case.ts';
 export type { ScaffoldOptions } from './scaffold-project.use-case.ts';
-export { scaffoldData } from './scaffold-data.mapper.ts';
+export { scaffoldData } from './template-fields.mapper.ts';

package/scaffold/index.js

@@ -1,2 +1,2 @@
 export { scaffoldProject } from './scaffold-project.use-case.js';
-export { scaffoldData } from './scaffold-data.mapper.js';
+export { scaffoldData } from './template-fields.mapper.js';

package/scaffold/scaffold-project.use-case.js

@@ -1,5 +1,5 @@
 import { writeTemplates } from '../templating/index.js';
-import { scaffoldData } from './scaffold-data.mapper.js';
+import { scaffoldData } from './template-fields.mapper.js';
 /**
  * The answer to `generate` for a scaffold: renders the templates into the new
  * project, never overwriting a file, and reports what it wrote. A language