@mccaskie-labs/workbench-config 0.1.38 → 0.1.40

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @mccaskie-labs/workbench-config
 
+## 0.1.40
+
+### Patch Changes
+
+- A skill whose client questions aren't written yet (pdf, email) also gets its "Restyling" section, which now says PDFs and emails take project.css too.
+
+## 0.1.39
+
+### Patch Changes
+
+- Skills: each tool's skill now sends Claude to the project's own note beside it, `.claude/skills/workbench-<component>/project.md` (never generated), for where that project wires the tool in, instead of to the project's `CLAUDE.md`. `workbench-start` tells Claude to make no claim about cost or setup when it introduces the tools (the first live test invented one). New export `projectNotes`.
+
 ## 0.1.38
 
 ### Patch Changes

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { defineConfig, type Config } from "./define-config.ts";
 export { sharedSecret, workerSecret, redact, redactAll, type SecretsStoreSecretLike } from "./secrets.ts";
 export { WorkbenchConfigError, type ConfigErrorCode, type ConfigProblem } from "./errors.ts";
 export { capabilitySchema, checkManifests, allowedSchemas, COMPONENTS, type Capability, type Component, type ManifestProblem, type Offer, OFFER_PATTERNS, OFFER_PENDING, } from "./capability-schema.ts";
-export { renderSkill, renderSkills, renderStart, skillName, SKILLS_DIR, START_SKILL, TOOLS_FILE } from "./skills.ts";
+export { projectNotes, renderSkill, renderSkills, renderStart, skillName, SKILLS_DIR, START_SKILL, TOOLS_FILE } from "./skills.ts";
 export { toolsState } from "./tools.ts";
 export type { ToolChoices, ToolsState } from "./tools.ts";
 export { capabilities, MANIFEST_VERSION, type Alias, type GatewayScope } from "./capabilities.gen.ts";

package/dist/index.js

@@ -3,7 +3,7 @@ export { defineConfig } from "./define-config.js";
 export { sharedSecret, workerSecret, redact, redactAll } from "./secrets.js";
 export { WorkbenchConfigError } from "./errors.js";
 export { capabilitySchema, checkManifests, allowedSchemas, COMPONENTS, OFFER_PATTERNS, OFFER_PENDING, } from "./capability-schema.js";
-export { renderSkill, renderSkills, renderStart, skillName, SKILLS_DIR, START_SKILL, TOOLS_FILE } from "./skills.js";
+export { projectNotes, renderSkill, renderSkills, renderStart, skillName, SKILLS_DIR, START_SKILL, TOOLS_FILE } from "./skills.js";
 export { toolsState } from "./tools.js";
 export { capabilities, MANIFEST_VERSION } from "./capabilities.gen.js";
 export { compareDevVars, parseDevVarNames } from "./dev-vars.js";

package/dist/skills.d.ts

@@ -4,6 +4,8 @@ export declare const skillName: (component: string) => string;
 /** The owner's choices: which optional tools this project uses (§9.6). */
 export declare const TOOLS_FILE = "workbench/tools.json";
 export declare const START_SKILL = "workbench-start";
+/** The project's own notes on a tool, beside its generated skill: where this project wires it in. Never generated. */
+export declare const projectNotes: (component: string) => string;
 /** The SKILL.md for one manifest, or undefined when it has no `delivery` (plumbing). `guide` is its `capabilities/<component>.md`, when there is one. */
 export declare function renderSkill(m: Capability, guide?: string): string | undefined;
 /** The `workbench-start` skill: every tool introduced to the owner, and how their choices are recorded (§9.6). */

package/dist/skills.js

@@ -9,6 +9,8 @@ export const skillName = (component) => `workbench-${component}`;
 /** The owner's choices: which optional tools this project uses (§9.6). */
 export const TOOLS_FILE = "workbench/tools.json";
 export const START_SKILL = "workbench-start";
+/** The project's own notes on a tool, beside its generated skill: where this project wires it in. Never generated. */
+export const projectNotes = (component) => `${SKILLS_DIR}/${skillName(component)}/project.md`;
 const GENERATED = (from) => `<!-- Generated by \`npx workbench-config skills\` from @mccaskie-labs/workbench-config, ${from}. Don't edit: \`npx workbench-config skills --check\` fails when this file differs. -->`;
 const show = (v) => (v === null ? "none" : `\`${JSON.stringify(v)}\``);
 const cell = (s) => s.replaceAll("|", "\\|").replaceAll("\n", " ");
@@ -112,7 +114,7 @@ function useBlock(m, guide) {
     const out = ["## How to use it", ""];
     if (guide)
         out.push(guideSection(guide), "");
-    out.push(`Its limits, rules and error codes are in ${manifest}. Where the project already wires it in is in the project's \`CLAUDE.md\`, and each package's API is in its \`README.md\` under \`node_modules/@mccaskie-labs/\`.`);
+    out.push(`Read \`${projectNotes(m.component)}\` next, if it is there: it is this project's own note on where the tool is already wired in and how to call it here. It is the project's to edit; add to it when the wiring changes. Its limits, rules and error codes are in ${manifest}, and each package's API is in its \`README.md\` under \`node_modules/@mccaskie-labs/\`.`);
     return out;
 }
 /** The SKILL.md for one manifest, or undefined when it has no `delivery` (plumbing). `guide` is its `capabilities/<component>.md`, when there is one. */
@@ -142,7 +144,7 @@ export function renderSkill(m, guide) {
         ...beforeBlock(m),
     ];
     if (!o) {
-        out.push("", "## Questions", "", "This tool's questions for the client aren't written yet. Use it with its defaults, tell the client that is what you did, and invent no setting. A choice only the client can make goes to them as a plain question.", "", ...useBlock(m, guide));
+        out.push("", "## Questions", "", "This tool's questions for the client aren't written yet. Use it with its defaults, tell the client that is what you did, and invent no setting. A choice only the client can make goes to them as a plain question.", ...(m.styles ? ["", "## Restyling", "", restyleLine(m.styles.prefix)] : []), "", ...useBlock(m, guide));
         return `${out.join("\n")}\n`;
     }
     out.push("", "## What to say", "", d.choice === "optional"
@@ -160,7 +162,7 @@ export function renderSkill(m, guide) {
 }
 /** How a project restyles what a component draws (docs/capabilities-manifest.md §10). */
 function restyleLine(prefix) {
-    return `Everything this tool draws (on a page, in a PDF or in an email) has a \`${prefix}\` class with a default Workbench style, and its colours and sizes are \`--${prefix}*\` variables. All of them are listed, each with what it is, in \`public/styles/workbench.css\`, which \`npx workbench-ui styles\` generates: never edit it. To match the project's own look, write rules for those classes, or set the variables to the project's own colours, in \`public/styles/project.css\`. It loads after workbench.css and always wins. When the client asks for a different look, change project.css, never the tool's markup.`;
+    return `Everything this tool draws (on a page, in a PDF or in an email) has a \`${prefix}\` class with a default Workbench style, and its colours and sizes are \`--${prefix}*\` variables. All of them are listed, each with what it is, in \`public/styles/workbench.css\`, which \`npx workbench-ui styles\` generates: never edit it. To match the project's own look, write rules for those classes, or set the variables to the project's own colours, in \`public/styles/project.css\`. It loads after workbench.css and always wins, and PDFs and emails take it too (\`src/lib/project-css.ts\`). When the client asks for a different look, change project.css, never the tool's markup.`;
 }
 /** The `workbench-start` skill: every tool introduced to the owner, and how their choices are recorded (§9.6). */
 export function renderStart(manifests) {
@@ -186,7 +188,7 @@ export function renderStart(manifests) {
         `1. Read \`${TOOLS_FILE}\`. A tool listed there is decided: don't ask about it again.`,
         "2. If the file is missing, this is the first session. Introduce everything: say in two or three sentences that the project comes with Workbench tools, then show the two lists below in the owner's words (the first column), without package names.",
         "3. If the file is there and only some optional tools are missing from it, they arrived in an update. Introduce only those.",
-        "4. Say the built-in tools are simply there. Don't ask about them.",
+        "4. Say the built-in tools are simply there. Don't ask about them. Say only what the lists say: make no claim about what a tool costs, or that nothing needs setting up.",
         "5. Ask about each undecided optional tool with the AskUserQuestion tool, one question per tool, up to four questions per call: \"Use it (Recommended)\" or \"Not now\". Put what the tool does in the question, in plain words.",
         "6. Write every answer to the file at once (the format is below), and tell the owner they can change any choice later by asking.",
         "7. Then carry on with what the owner came to do. A tool with unanswered settings asks them when it is first used, through its own skill.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mccaskie-labs/workbench-config",
-  "version": "0.1.38",
+  "version": "0.1.40",
   "description": "Workbench app configuration: WORKBENCH_ENV, typed variables that fail by name, secrets that are never printed, and the capabilities manifest.",
   "license": "UNLICENSED",
   "type": "module",