@norskvideo/ctl-dev-kit 0.2.59 → 0.2.60

package/doc-guide/doc-guide.d.ts

@@ -28,11 +28,13 @@ export declare function docsRoot(): string;
  *  at about 2.5 words/s: 35 words is 14 s on one still, 50 is 20 s, and the
  *  renderer's own lint warns at 35. This is the hard stop. */
 export declare const DEFAULT_CAPTION_WORDS = 50;
+/** The part of a step's text that is narrated: everything but its fenced blocks. */
+export declare function spokenText(text: string): string;
 /** Why a step's text cannot be narrated as written, or null when it can. Pure,
  *  so the wording is pinned without a browser. Checks the budget first: an
  *  over-long caption gets rewritten anyway, and the rewrite is where the
- *  phrasing gets fixed. */
-export declare function captionFault(text: string, budget: number): string | null;
+ *  phrasing gets fixed. Only the spoken part is held to either. */
+export declare function captionFault(caption: string, budget: number): string | null;
 /** Device scale factor for a capture: 2 in a DOCS_GENERATE run, 1 otherwise.
  *  The video spike found the manual's component crops 383 to 778 px wide; in
  *  a 1080p frame they are soft, and no renderer recovers detail that was never

package/doc-guide/doc-guide.js

@@ -17,11 +17,19 @@ export const DEFAULT_CAPTION_WORDS = 50;
 const SPOKEN_WORD = /[\p{L}\p{N}]/u;
 const RAW_URL = /https?:\/\/\S+/;
 const SLASH_BETWEEN_WORDS = /\S+\/\S+/;
+/** A fenced block (``` or ~~~, closed or running to the end as markdown has
+ *  it) is a transcript or a file to copy: the page shows it, nobody speaks it. */
+const FENCED_BLOCK = /^(`{3,}|~{3,})[^\n]*$[\s\S]*?(?:^\1[ \t]*$|(?![\s\S]))/gm;
+/** The part of a step's text that is narrated: everything but its fenced blocks. */
+export function spokenText(text) {
+    return text.replace(FENCED_BLOCK, "");
+}
 /** Why a step's text cannot be narrated as written, or null when it can. Pure,
  *  so the wording is pinned without a browser. Checks the budget first: an
  *  over-long caption gets rewritten anyway, and the rewrite is where the
- *  phrasing gets fixed. */
-export function captionFault(text, budget) {
+ *  phrasing gets fixed. Only the spoken part is held to either. */
+export function captionFault(caption, budget) {
+    const text = spokenText(caption);
     const count = text.split(/\s+/).filter((token) => SPOKEN_WORD.test(token)).length;
     if (count > budget)
         return `${count} words; the spoken budget is ${budget}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-dev-kit",
-  "version": "0.2.59",
+  "version": "0.2.60",
   "type": "module",
   "exports": {
     "./create-product": "./create-product/create-product.ts",