@nightlab-agent/still-true 0.1.0 → 0.1.1

package/README.md

@@ -18,7 +18,7 @@ Give it one or more Markdown files. For a bare `#12` it uses `--repo owner/name`
 
 Set `GITHUB_TOKEN` for private repositories and a higher rate limit. Without one, GitHub allows 60 requests an hour. Needs Node 20 or newer. Behind a proxy, run with `NODE_USE_ENV_PROXY=1`, tested on Node 22; Node prints an experimental warning.
 
-In a Markdown file with headings, it reads a section only if its heading starts with Now, Handoff, State, Status or Current, and any heading above it does too, or is the file's level 1 title. Plans and history stay out. Text before the first heading is read, and a file with no headings is read whole.
+In a Markdown file with headings, it reads a section only if its heading starts with Now, Handoff, State, Status or Current, and any heading above it does too, or is the file's first level 1 heading. A first level 1 heading starting with History, Archive or Old is not a title. Plans and history stay out. Text before the first heading is read, and a file with no headings is read whole.
 
 ## What each line means
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nightlab-agent/still-true",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Check a handoff note against GitHub: finds what it says about PRs and issues and prints the claims that are no longer true. Exits 1 on a contradiction.",
   "type": "module",
   "bin": { "still-true": "bin/still-true.js" },

package/src/extract.mjs

@@ -9,10 +9,12 @@ const WAIT = new RegExp(`(?:^|\\s)(?:waits?|waiting)\\s+(?:on|for)\\s+(${TOKEN}|
 const LABEL_LIST = new RegExp(`(?:^|:\\s*)(open|merged|closed)(?:\\s+(?:PRs|issues|pull requests))?:\\s*(${TOKEN}(?:\\s*(?:,|and)\\s*${TOKEN})*)$`, 'i');
 
 const REF = /^(?:([a-z0-9-]+)\/)?([a-z0-9_.-]+)?#([1-9][0-9]*)$/i;
+const PLANNED = /\b(?:plans?|planned|planning|proposed|intended|expected|ideas?|goals?|draft|to-?dos?|next|later|someday|old|previous|history|example)\b/i;
 const CURRENT_HEADING = /^(?:handoff|state|status|now|current)\b(?!-)/i;
 const PREAMBLE = /^(?:if|unless|once|after|when|until|yesterday|old note|example|suppose|imagine)\b/i;
 const UNCERTAIN = /\b(?:probably|maybe|might|should|could|would|if|unless|when|until|need|get|think|believe|locally|re-?opened)\b|\bonce\s+(?!at\b)\S|n['’]t\b|\bby\s+(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday|tomorrow|next)\b/i;
 const NONSTATE = /\b(?:(?:not|never|no longer)\s+(?:(?:yet|still|currently|already)\s+)?(?:open|merged|closed)|(?:was|were|used to be)\s+(?:(?:still|currently|already)\s+)?(?:open|closed)|(?:open|merged|closed)\s+or\s+(?:open|merged|closed))\b/i;
+const NOT_WAITING = /\b(?:(?:not|never|no\s+longer|no\s+more|stop(?:s|ped)?|done|finished|quit|gave\s+up|nothing(?:\s+is)?|without|instead\s+of)\s+(?:(?:yet|still|currently|really)\s+)?(?:waits?|waiting)|(?:n['’]t)\s+(?:waits?|waiting))\b/i;
 const QUALIFIED_STATE = /^\s+(?:to|into|for|or|after)\b/i;
 // A later comma field must look like a state fact, not "open question".
 const COMMA_STATE_TAIL = /^(?:$|\s+(?:\d|today\b|yesterday\b|last\b|since\b|by\b|as\s+a\s+duplicate\b))/i;
@@ -140,7 +142,7 @@ function claimsFromClause(quote, line) {
       context.list = false;
     }
     const waiting = WAIT.exec(tail);
-    if (waiting) add(REF.test(waiting[1]) ? [waiting[1]] : context.subjects, 'waiting');
+    if (waiting && !NOT_WAITING.test(text)) add(REF.test(waiting[1]) ? [waiting[1]] : context.subjects, 'waiting');
     const before = BEFORE_REF.exec(text);
     if (before && (!subject || before.index < subject[1].length) &&
         (before[1].toLowerCase() !== 'open' || (before[2] &&
@@ -179,11 +181,17 @@ function claimsFromLine(raw, line) {
   return claims;
 }
 
+function closes(lines, from, open) {
+  let quote = open;
+  for (let i = from; i < lines.length && quote !== null; i++) quote = endQuote(lines[i], quote);
+  return quote === null;
+}
+
 // Aliases and the default repository are resolved by the reader. Preserve the
 // identity written in the note, including refs that the reader cannot place.
 export function extractClaims(text, _options = {}) {
   const claims = [];
-  let paragraph = [], fence = null, quote = null, comment = false, sections = [], frontMatter = false;
+  let paragraph = [], fence = null, quote = null, comment = false, sections = [], frontMatter = false, titled = false, planned = null;
   const flush = () => {
     // A wrapped condition, quotation or historical preamble can change the
     // following line. Separate list items may contain independent nonclaims.
@@ -191,8 +199,13 @@ export function extractClaims(text, _options = {}) {
     // A historical label ("Old note:") covers the whole list under it.
     const old = paragraph.findIndex((entry) => !entry.list && !entry.claims.length && entry.label);
     paragraph.forEach((entry, i) => {
-      if (old >= 0 && i > old && entry.list) return;
-      if (!blocks(paragraph[i - 1]) && !blocks(paragraph[i + 1])) claims.push(...entry.claims);
+      // A planning list item covers the items nested under it, blank lines included.
+      if (planned !== null && entry.indent <= planned) planned = null;
+      const nested = planned !== null;
+      if (!nested && entry.parent) planned = entry.indent;
+      if (nested || (old >= 0 && i > old && entry.list)) return;
+      const after = paragraph[i + 1]; // A planning item says nothing of the line before it.
+      if (!blocks(paragraph[i - 1]) && (!blocks(after) || after.parent)) claims.push(...entry.claims);
     });
     paragraph = [];
   };
@@ -200,7 +213,8 @@ export function extractClaims(text, _options = {}) {
     sections = sections.filter((section) => section.level < level);
     // Unknown headings may introduce plans, examples or history. Only a
     // current section (and current ancestors) permits extraction.
-    sections.push({ level, current: CURRENT_HEADING.test(title) });
+    sections.push({ level, current: CURRENT_HEADING.test(title), title: level === 1 && !titled && !/^(?:history|archive|old)\b/i.test(title) });
+    titled ||= level === 1;
   };
 
   const lines = text.replace(/^\uFEFF/, '').split(/\r\n|\n|\r/);
@@ -220,13 +234,20 @@ export function extractClaims(text, _options = {}) {
     }
     if (comment || raw.includes('<!--')) {
       comment = !raw.includes('-->') || raw.lastIndexOf('<!--') > raw.lastIndexOf('-->');
-      paragraph.push({ claims: [], list: false });
+      paragraph.push({ claims: [], list: false, indent: Infinity });
       continue;
     }
     const quoted = quote !== null;
     quote = endQuote(raw, quote);
+    // A mark inside text that nothing closes was a stray.
+    if (!quoted && quote !== null && raw.trim().length > 1 && !closes(lines, index + 1, quote)) quote = null;
     if (quoted || quote !== null) {
-      paragraph.push({ claims: [], list: false });
+      // A heading inside a quote still changes the section the quote ends in.
+      const inner = /^ {0,3}(#{1,6})\s+(.+?)(?:\s+#+)?\s*$/.exec(raw);
+      const rule = /^ {0,3}(=+|-+)\s*$/.exec(raw);
+      if (inner) enterSection(inner[1].length, inner[2]);
+      else if (rule && lines[index - 1]?.trim()) enterSection(rule[1][0] === '=' ? 1 : 2, lines[index - 1].trim());
+      paragraph.push({ claims: [], list: false, indent: Infinity });
       continue;
     }
     const opening = /^ {0,3}(`{3,}|~{3,})/.exec(raw);
@@ -238,19 +259,27 @@ export function extractClaims(text, _options = {}) {
     } else if (heading) {
       flush();
       enterSection(heading[1].length, heading[2]);
-    } else if (underline && paragraph.length) {
+    } else if (underline && paragraph.length && !(underline[1][0] === '-' && paragraph.some((entry) => entry.item))) {
       const title = paragraph.length === 1 ? lines[index - 1].trim() : '';
       paragraph = [];
       enterSection(underline[1][0] === '=' ? 1 : 2, title);
+    } else if (underline && paragraph.length) {
+      flush(); // A rule after a list item, not a heading underline.
     } else if (!raw.trim()) {
       flush();
     } else {
-      // A level 1 title above a current section does not switch it off.
-      const readable = sections.every((section, i) => section.current || (section.level === 1 && i < sections.length - 1));
+      // The file's level 1 title above a current section does not switch it off.
+      const readable = sections.every((section, i) => section.current || (section.title && i < sections.length - 1));
       const claims = readable ? claimsFromLine(raw, index + 1) : [];
-      const list = /^ {0,3}(?:[-+*]|[0-9]+[.)])\s+/.test(raw) && !/:\s*$/.test(raw);
-      const label = /:\s*$/.test(raw) && PREAMBLE.test(raw.trim().replace(/^(?:[-+*]|[0-9]+[.)])\s+/, ''));
-      paragraph.push({ claims, list, label });
+      const body = raw.trim().replace(/^(?:[-+*]|[0-9]+[.)])\s+/, '');
+      const label = /:\s*$/.test(raw) && PREAMBLE.test(body);
+      const bare = body.replace(/[*_`]/g, '');
+      const item = /^\s*(?:[-+*]|[0-9]+[.)])\s+/.test(raw);
+      const colon = /:\s*$/.test(bare);
+      const parent = item && colon && PLANNED.test(bare);
+      // A list item that opens a current list does not silence its first child.
+      const list = item && (!colon || CURRENT_HEADING.test(bare));
+      paragraph.push({ claims, list, item, label, parent, indent: /^\s*/.exec(raw)[0].length });
     }
   }
   flush();