dsh-nerd-mode 0.5.0 → 0.5.2

package/skills/study-plus/scripts/build-book.mjs

@@ -1,155 +1,155 @@
-#!/usr/bin/env node
-// Build study/<course>/book.html from the graph and its existing lecture files.
-
-import { readFileSync, readdirSync, writeFileSync, existsSync, unlinkSync, realpathSync, statSync, lstatSync, copyFileSync, renameSync } from 'node:fs';
-import { join, resolve, dirname, relative, isAbsolute, sep } from 'node:path';
-import { spawnSync } from 'node:child_process';
-import { createHash } from 'node:crypto';
-import { fileURLToPath } from 'node:url';
-import { parseBookData } from './book-data.mjs';
-
-const here = dirname(fileURLToPath(import.meta.url));
-const AM = resolve(here, '..', '..', 'answer-me-with-html', 'scripts', 'am.mjs');
-const CLIENT = join(here, 'book-client.js');
-
-function die(message) {
-  console.error(message);
-  process.exit(1);
-}
-
-function findTopic(arg) {
-  const studyPath = resolve('study');
-  let studyStat;
-  try {
-    studyStat = lstatSync(studyPath);
-  } catch (error) {
-    if (error.code === 'ENOENT') die('No study/ folder here. Pass a Course folder under workspace study/.');
-    die(`Cannot inspect workspace study/ folder: ${error.message}`);
-  }
-  if (studyStat.isSymbolicLink()) die(`Refusing to use symlink as workspace study/ folder: ${studyPath}`);
-  let studyRoot;
-  try {
-    studyRoot = realpathSync(studyPath);
-  } catch (error) {
-    die(`Cannot resolve workspace study/ folder: ${error.message}`);
-  }
-  if (!statSync(studyRoot).isDirectory()) die(`Workspace study/ path is not a directory: ${studyRoot}`);
-
-  let topicPath = arg ? resolve(arg) : '';
-  if (!arg) {
-    const hits = readdirSync(studyRoot).filter((name) => existsSync(join(studyRoot, name, 'graph.md')));
-    if (hits.length !== 1) die(`Pass a Course folder under workspace study/. Found ${hits.length} Courses under study/: ${hits.join(', ') || 'none'}.`);
-    topicPath = join(studyRoot, hits[0]);
-  }
-
-  let topicDir;
-  try {
-    topicDir = realpathSync(topicPath);
-  } catch (error) {
-    die(`Cannot resolve Course folder ${topicPath}: ${error.message}`);
-  }
-  const topicRelative = relative(studyRoot, topicDir);
-  if (!statSync(topicDir).isDirectory() || !topicRelative || topicRelative === '..' || topicRelative.startsWith(`..${sep}`) || isAbsolute(topicRelative)) {
-    die(`Course folder must be a real directory at least one level below workspace study/: ${topicPath}`);
-  }
-  return topicDir;
-}
-
-function build() {
-  const dir = findTopic(process.argv[2]);
-  const graphPath = join(dir, 'graph.md');
-  const lectureDir = join(dir, 'lectures');
-  if (!existsSync(graphPath)) die(`graph.md not found at ${graphPath}`);
-  if (!existsSync(lectureDir)) die(`No lectures folder found at ${lectureDir}`);
-  if (!existsSync(AM)) die(`am CLI not found at ${AM}. Install answer-me-with-html next to study-plus.`);
-  if (!existsSync(CLIENT)) die(`book-client.js not found at ${CLIENT}. Install the study-plus runtime scripts first.`);
-
-  const files = readdirSync(lectureDir)
-    .filter((name) => name.endsWith('.md') && !name.startsWith('.'))
-    .sort()
-    .map((name) => ({ name, text: readFileSync(join(lectureDir, name), 'utf8') }));
-  let book;
-  try {
-    book = parseBookData(readFileSync(graphPath, 'utf8'), files, { topicFallback: dir.split(/[\\/]/).pop() });
-  } catch (error) {
-    die(error.message);
-  }
-
-  const draft = [
-    '---',
-    'template: doc',
-    `title: ${JSON.stringify(book.title)}`,
-    ...(book.goal ? [`subtitle: ${JSON.stringify(book.goal)}`] : []),
-    '---',
-    '',
-    book.units.map((unit) => `## ${unit.chapter}.${unit.section} ${unit.title}\n\n${unit.body}`).join('\n\n'),
-    '',
-  ].join('\n')
-    // am reads $ and $$ math only: a LaTeX display delimiter on its own line
-    // would reach the page as a literal bracket, so turn it into a $$ block.
-    .replace(/^ {0,3}\\\[\s*$/gm, () => '$$')
-    .replace(/^ {0,3}\\\]\s*$/gm, () => '$$');
-  const outPath = join(dir, 'book.html');
-  const backupPath = join(dir, 'book.html.bak');
-  const guardPath = (path, what) => {
-    try {
-      const stat = lstatSync(path);
-      if (stat.isSymbolicLink()) die(`Refusing to overwrite symlink book ${what}: ${path}`);
-      if (!stat.isFile()) die(`Refusing to overwrite non-regular book ${what}: ${path}`);
-    } catch (error) {
-      if (error.code !== 'ENOENT') die(`Cannot inspect book ${what} ${path}: ${error.message}`);
-    }
-  };
-  guardPath(outPath, 'output');
-  guardPath(backupPath, 'backup');
-  // Render beside book.html: a failed build must never damage the current book.
-  const tmpPath = join(dir, `.book.new-${process.pid}.html`);
-  const draftPath = join(dir, `.book.draft-${process.pid}.md`);
-  writeFileSync(draftPath, draft, { encoding: 'utf8', flag: 'wx' });
-
-  let run;
-  try {
-    // Book builds stay offline: without this the renderer may start a weekly update check.
-    run = spawnSync(process.execPath, [AM, 'render', draftPath, '-o', tmpPath, '--no-open', '--template', 'doc', '--theme', 'shadcn', '--mode', 'light', '--style', 'off'], { stdio: 'inherit', env: { ...process.env, AM_NO_UPDATE_CHECK: '1' } });
-  } finally {
-    if (existsSync(draftPath)) unlinkSync(draftPath);
-  }
-
-  try {
-    if (run.error) throw new Error(`Could not run am render: ${run.error.message}`);
-    if (run.status !== 0) throw new Error(`am render failed with exit ${run.status ?? 'unknown'}`);
-
-    const payload = {
-      title: book.title,
-      goal: book.goal,
-      lang: book.lang,
-      chapters: book.chapters.map(({ n, name, description, count }) => ({ n, name, description, count })),
-      units: book.units.map(({ concept, title, chapter, section, index, status }) => ({ concept, title, chapter, section, index, status })),
-    };
-    const json = JSON.stringify(payload).replace(/</g, '\\u003c');
-    // HTML parsing turns CRLF into LF before the browser checks the CSP hash,
-    // so a Windows checkout would otherwise be blocked as the wrong hash.
-    const client = readFileSync(CLIENT, 'utf8').replace(/\r\n?/g, '\n');
-    const html = readFileSync(tmpPath, 'utf8');
-    const scriptText = `\n${client}\n`;
-    const hash = createHash('sha256').update(scriptText, 'utf8').digest('base64');
-    const csp = /(<meta http-equiv="Content-Security-Policy" content="[^"]*?script-src )/;
-    if (!csp.test(html)) throw new Error('No Content-Security-Policy script-src entry found in the rendered page.');
-    const out = html
-      .replace(csp, `$1'sha256-${hash}' `)
-      .replace('</head>', `<script>${scriptText}</script>\n</head>`)
-      .replace('</body>', `<script type="application/json" id="bk-book">${json}</script>\n</body>`);
-    writeFileSync(tmpPath, out, 'utf8');
-
-    if (existsSync(outPath)) copyFileSync(outPath, backupPath);
-    renameSync(tmpPath, outPath);
-  } catch (error) {
-    if (existsSync(tmpPath)) unlinkSync(tmpPath);
-    die(error.message);
-  }
-
-  if (book.orphans.length) console.warn(`Orphan lecture files excluded (concept number is not in graph.md): ${book.orphans.join(', ')}`);
-  console.log(`book: ${outPath} (${book.units.length} sections, ${book.chapters.length} chapters)`);
-}
-
-build();
+#!/usr/bin/env node
+// Build study/<course>/book.html from the graph and its existing lecture files.
+
+import { readFileSync, readdirSync, writeFileSync, existsSync, unlinkSync, realpathSync, statSync, lstatSync, copyFileSync, renameSync } from 'node:fs';
+import { join, resolve, dirname, relative, isAbsolute, sep } from 'node:path';
+import { spawnSync } from 'node:child_process';
+import { createHash } from 'node:crypto';
+import { fileURLToPath } from 'node:url';
+import { parseBookData } from './book-data.mjs';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const AM = resolve(here, '..', '..', 'answer-me-with-html', 'scripts', 'am.mjs');
+const CLIENT = join(here, 'book-client.js');
+
+function die(message) {
+  console.error(message);
+  process.exit(1);
+}
+
+function findTopic(arg) {
+  const studyPath = resolve('study');
+  let studyStat;
+  try {
+    studyStat = lstatSync(studyPath);
+  } catch (error) {
+    if (error.code === 'ENOENT') die('No study/ folder here. Pass a Course folder under workspace study/.');
+    die(`Cannot inspect workspace study/ folder: ${error.message}`);
+  }
+  if (studyStat.isSymbolicLink()) die(`Refusing to use symlink as workspace study/ folder: ${studyPath}`);
+  let studyRoot;
+  try {
+    studyRoot = realpathSync(studyPath);
+  } catch (error) {
+    die(`Cannot resolve workspace study/ folder: ${error.message}`);
+  }
+  if (!statSync(studyRoot).isDirectory()) die(`Workspace study/ path is not a directory: ${studyRoot}`);
+
+  let topicPath = arg ? resolve(arg) : '';
+  if (!arg) {
+    const hits = readdirSync(studyRoot).filter((name) => existsSync(join(studyRoot, name, 'graph.md')));
+    if (hits.length !== 1) die(`Pass a Course folder under workspace study/. Found ${hits.length} Courses under study/: ${hits.join(', ') || 'none'}.`);
+    topicPath = join(studyRoot, hits[0]);
+  }
+
+  let topicDir;
+  try {
+    topicDir = realpathSync(topicPath);
+  } catch (error) {
+    die(`Cannot resolve Course folder ${topicPath}: ${error.message}`);
+  }
+  const topicRelative = relative(studyRoot, topicDir);
+  if (!statSync(topicDir).isDirectory() || !topicRelative || topicRelative === '..' || topicRelative.startsWith(`..${sep}`) || isAbsolute(topicRelative)) {
+    die(`Course folder must be a real directory at least one level below workspace study/: ${topicPath}`);
+  }
+  return topicDir;
+}
+
+function build() {
+  const dir = findTopic(process.argv[2]);
+  const graphPath = join(dir, 'graph.md');
+  const lectureDir = join(dir, 'lectures');
+  if (!existsSync(graphPath)) die(`graph.md not found at ${graphPath}`);
+  if (!existsSync(lectureDir)) die(`No lectures folder found at ${lectureDir}`);
+  if (!existsSync(AM)) die(`am CLI not found at ${AM}. Install answer-me-with-html next to study-plus.`);
+  if (!existsSync(CLIENT)) die(`book-client.js not found at ${CLIENT}. Install the study-plus runtime scripts first.`);
+
+  const files = readdirSync(lectureDir)
+    .filter((name) => name.endsWith('.md') && !name.startsWith('.'))
+    .sort()
+    .map((name) => ({ name, text: readFileSync(join(lectureDir, name), 'utf8') }));
+  let book;
+  try {
+    book = parseBookData(readFileSync(graphPath, 'utf8'), files, { topicFallback: dir.split(/[\\/]/).pop() });
+  } catch (error) {
+    die(error.message);
+  }
+
+  const draft = [
+    '---',
+    'template: doc',
+    `title: ${JSON.stringify(book.title)}`,
+    ...(book.goal ? [`subtitle: ${JSON.stringify(book.goal)}`] : []),
+    '---',
+    '',
+    book.units.map((unit) => `## ${unit.chapter}.${unit.section} ${unit.title}\n\n${unit.body}`).join('\n\n'),
+    '',
+  ].join('\n')
+    // am reads $ and $$ math only: a LaTeX display delimiter on its own line
+    // would reach the page as a literal bracket, so turn it into a $$ block.
+    .replace(/^ {0,3}\\\[\s*$/gm, () => '$$')
+    .replace(/^ {0,3}\\\]\s*$/gm, () => '$$');
+  const outPath = join(dir, 'book.html');
+  const backupPath = join(dir, 'book.html.bak');
+  const guardPath = (path, what) => {
+    try {
+      const stat = lstatSync(path);
+      if (stat.isSymbolicLink()) die(`Refusing to overwrite symlink book ${what}: ${path}`);
+      if (!stat.isFile()) die(`Refusing to overwrite non-regular book ${what}: ${path}`);
+    } catch (error) {
+      if (error.code !== 'ENOENT') die(`Cannot inspect book ${what} ${path}: ${error.message}`);
+    }
+  };
+  guardPath(outPath, 'output');
+  guardPath(backupPath, 'backup');
+  // Render beside book.html: a failed build must never damage the current book.
+  const tmpPath = join(dir, `.book.new-${process.pid}.html`);
+  const draftPath = join(dir, `.book.draft-${process.pid}.md`);
+  writeFileSync(draftPath, draft, { encoding: 'utf8', flag: 'wx' });
+
+  let run;
+  try {
+    // Book builds stay offline: without this the renderer may start a weekly update check.
+    run = spawnSync(process.execPath, [AM, 'render', draftPath, '-o', tmpPath, '--no-open', '--template', 'doc', '--theme', 'shadcn', '--mode', 'light', '--style', 'off'], { stdio: 'inherit', env: { ...process.env, AM_NO_UPDATE_CHECK: '1' } });
+  } finally {
+    if (existsSync(draftPath)) unlinkSync(draftPath);
+  }
+
+  try {
+    if (run.error) throw new Error(`Could not run am render: ${run.error.message}`);
+    if (run.status !== 0) throw new Error(`am render failed with exit ${run.status ?? 'unknown'}`);
+
+    const payload = {
+      title: book.title,
+      goal: book.goal,
+      lang: book.lang,
+      chapters: book.chapters.map(({ n, name, description, count }) => ({ n, name, description, count })),
+      units: book.units.map(({ concept, title, chapter, section, index, status }) => ({ concept, title, chapter, section, index, status })),
+    };
+    const json = JSON.stringify(payload).replace(/</g, '\\u003c');
+    // HTML parsing turns CRLF into LF before the browser checks the CSP hash,
+    // so a Windows checkout would otherwise be blocked as the wrong hash.
+    const client = readFileSync(CLIENT, 'utf8').replace(/\r\n?/g, '\n');
+    const html = readFileSync(tmpPath, 'utf8');
+    const scriptText = `\n${client}\n`;
+    const hash = createHash('sha256').update(scriptText, 'utf8').digest('base64');
+    const csp = /(<meta http-equiv="Content-Security-Policy" content="[^"]*?script-src )/;
+    if (!csp.test(html)) throw new Error('No Content-Security-Policy script-src entry found in the rendered page.');
+    const out = html
+      .replace(csp, `$1'sha256-${hash}' `)
+      .replace('</head>', `<script>${scriptText}</script>\n</head>`)
+      .replace('</body>', `<script type="application/json" id="bk-book">${json}</script>\n</body>`);
+    writeFileSync(tmpPath, out, 'utf8');
+
+    if (existsSync(outPath)) copyFileSync(outPath, backupPath);
+    renameSync(tmpPath, outPath);
+  } catch (error) {
+    if (existsSync(tmpPath)) unlinkSync(tmpPath);
+    die(error.message);
+  }
+
+  if (book.orphans.length) console.warn(`Orphan lecture files excluded (concept number is not in graph.md): ${book.orphans.join(', ')}`);
+  console.log(`book: ${outPath} (${book.units.length} sections, ${book.chapters.length} chapters)`);
+}
+
+build();

package/skills/writing-beats/SKILL.md

@@ -1,66 +1,66 @@
----
-name: writing-beats
-description: Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
----
-
-<what-to-do>
-
-The user has passed (or will pass) a markdown file of raw material. This is **exploit**: the exploring is done, the pile is fixed. Commit to a path through it and mine the pile to fill each beat.
-
-If the user did not say where to save the article, ask once and remember the path.
-
-Then run a beat-by-beat journey, choose-your-own-adventure style:
-
-1. **Establish the prerequisites.** Before any beats, settle with the user what the audience already knows walking in: the concepts that are **grounded** from the start. Everything else must be grounded by a beat before a later beat can use it. See [Grounding](#grounding).
-2. Write 2–3 candidate **starting beats**, drawn from the raw material. Each is a different entry point into the article. Each may only lean on grounded concepts; note what new concepts each one grounds. Show the user the beats before writing to the article file. The user picks one. Preview what beats that pick unlocks, as if the user is seeing a little way down the path.
-3. Once the user picks a starting beat, write **only that beat** to the article file. A beat may be one sentence or several paragraphs, whatever that beat naturally is. Stop there.
-4. Re-read the article file from disk. Then offer 2–3 candidate **next beats**: different directions the journey could pivot to from where the article now stands. Each must be reachable from the current grounded set; note what each one grounds.
-5. Loop steps 3–5 until the article reaches a natural end.
-
-</what-to-do>
-
-<supporting-info>
-
-## Grounding
-
-Every **concept** has to be **grounded** before a beat can lean on it: the audience either walked in knowing it or met it in an earlier beat. A beat that reaches for an ungrounded concept loses the reader; that is the one move the journey can't make. The unit is the concept, not the word for it: a beat can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name (a **term**), grounding it means landing the idea and the term together.
-
-A concept gets grounded one of two ways:
-
-- **Prerequisite**: grounded before the first beat. The audience brings it. Fixed at the start.
-- **Introduced**: a beat establishes it, and from then on it's grounded for every later beat.
-
-So each beat does two jobs: it **requires** concepts that are already grounded, and it **grounds** new ones. Keep a running list of what's grounded so far, and update it each time a beat lands.
-
-This is what shapes the choose-your-own-adventure. A candidate beat is only reachable if everything it requires is already grounded; picking a beat that grounds concept X unlocks every beat that was waiting on X. When you offer next beats, they must all be reachable from the current grounded set, and say what each one grounds, so the user can see which paths it opens.
-
-The big lever is what you make a prerequisite versus what you ground inside the piece. Demand too much up front and you shut out readers who don't have it; ground too much inside and the early beats drown in definitions. Settle this with the user when you establish prerequisites, and revisit it whenever a tempting beat turns out to require a concept nothing has grounded yet: the fix is either a grounding beat before it, or promoting the concept to a prerequisite.
-
-## What is a beat
-
-A beat is one move in the journey. It does one thing: sets a scene, lands a point, asks a question, drops an aside, twists the angle. Then it stops, leaving the reader at a place where the next beat can pivot.
-
-A beat is sized by what it needs:
-
-- A single sentence if that's all the move is ("And then nothing happened for three weeks.").
-- A short paragraph if the move needs setup.
-- Multiple paragraphs if the beat is a self-contained vignette, argument, or example.
-
-If a "beat" needs five paragraphs and three subheadings, it's not a beat; it's two beats glued together. Split it.
-
-## Pulling from the pile
-
-Pull material from the raw pile to populate each beat. You can paraphrase, split, recombine, or quote. The pile is a quarry.
-
-## Ending the journey
-
-The article ends when the journey is complete, not when the pile is empty. Most piles will have leftover fragments that don't make it in. That is fine; that is the point of having more raw material than you need.
-
-## Writing rhythm
-
-- Append one beat at a time. Never write ahead.
-- Re-read the article file from disk before every write. Preserve user edits absolutely.
-- If the user edits a previous beat substantially, let it change what comes next.
-- If the user says "rewrite that beat" or "go back and try a different beat 3", do it: edit in place, leave the rest alone.
-
-</supporting-info>
+---
+name: writing-beats
+description: Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
+---
+
+<what-to-do>
+
+The user has passed (or will pass) a markdown file of raw material. This is **exploit**: the exploring is done, the pile is fixed. Commit to a path through it and mine the pile to fill each beat.
+
+If the user did not say where to save the article, ask once and remember the path.
+
+Then run a beat-by-beat journey, choose-your-own-adventure style:
+
+1. **Establish the prerequisites.** Before any beats, settle with the user what the audience already knows walking in: the concepts that are **grounded** from the start. Everything else must be grounded by a beat before a later beat can use it. See [Grounding](#grounding).
+2. Write 2–3 candidate **starting beats**, drawn from the raw material. Each is a different entry point into the article. Each may only lean on grounded concepts; note what new concepts each one grounds. Show the user the beats before writing to the article file. The user picks one. Preview what beats that pick unlocks, as if the user is seeing a little way down the path.
+3. Once the user picks a starting beat, write **only that beat** to the article file. A beat may be one sentence or several paragraphs, whatever that beat naturally is. Stop there.
+4. Re-read the article file from disk. Then offer 2–3 candidate **next beats**: different directions the journey could pivot to from where the article now stands. Each must be reachable from the current grounded set; note what each one grounds.
+5. Loop steps 3–5 until the article reaches a natural end.
+
+</what-to-do>
+
+<supporting-info>
+
+## Grounding
+
+Every **concept** has to be **grounded** before a beat can lean on it: the audience either walked in knowing it or met it in an earlier beat. A beat that reaches for an ungrounded concept loses the reader; that is the one move the journey can't make. The unit is the concept, not the word for it: a beat can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name (a **term**), grounding it means landing the idea and the term together.
+
+A concept gets grounded one of two ways:
+
+- **Prerequisite**: grounded before the first beat. The audience brings it. Fixed at the start.
+- **Introduced**: a beat establishes it, and from then on it's grounded for every later beat.
+
+So each beat does two jobs: it **requires** concepts that are already grounded, and it **grounds** new ones. Keep a running list of what's grounded so far, and update it each time a beat lands.
+
+This is what shapes the choose-your-own-adventure. A candidate beat is only reachable if everything it requires is already grounded; picking a beat that grounds concept X unlocks every beat that was waiting on X. When you offer next beats, they must all be reachable from the current grounded set, and say what each one grounds, so the user can see which paths it opens.
+
+The big lever is what you make a prerequisite versus what you ground inside the piece. Demand too much up front and you shut out readers who don't have it; ground too much inside and the early beats drown in definitions. Settle this with the user when you establish prerequisites, and revisit it whenever a tempting beat turns out to require a concept nothing has grounded yet: the fix is either a grounding beat before it, or promoting the concept to a prerequisite.
+
+## What is a beat
+
+A beat is one move in the journey. It does one thing: sets a scene, lands a point, asks a question, drops an aside, twists the angle. Then it stops, leaving the reader at a place where the next beat can pivot.
+
+A beat is sized by what it needs:
+
+- A single sentence if that's all the move is ("And then nothing happened for three weeks.").
+- A short paragraph if the move needs setup.
+- Multiple paragraphs if the beat is a self-contained vignette, argument, or example.
+
+If a "beat" needs five paragraphs and three subheadings, it's not a beat; it's two beats glued together. Split it.
+
+## Pulling from the pile
+
+Pull material from the raw pile to populate each beat. You can paraphrase, split, recombine, or quote. The pile is a quarry.
+
+## Ending the journey
+
+The article ends when the journey is complete, not when the pile is empty. Most piles will have leftover fragments that don't make it in. That is fine; that is the point of having more raw material than you need.
+
+## Writing rhythm
+
+- Append one beat at a time. Never write ahead.
+- Re-read the article file from disk before every write. Preserve user edits absolutely.
+- If the user edits a previous beat substantially, let it change what comes next.
+- If the user says "rewrite that beat" or "go back and try a different beat 3", do it: edit in place, leave the rest alone.
+
+</supporting-info>

package/skills/writing-beats/agents/openai.yaml

@@ -1,5 +1,5 @@
-interface:
-  display_name: "Writing Beats"
-  short_description: "Assemble raw material into beats"
-policy:
-  allow_implicit_invocation: true
+interface:
+  display_name: "Writing Beats"
+  short_description: "Assemble raw material into beats"
+policy:
+  allow_implicit_invocation: true