@seanmars/tospec 0.24.0 → 0.26.0-beta

package/dist/core/parsers/requirement-blocks.d.ts

@@ -25,12 +25,34 @@ export declare function normalizeRequirementName(name: string): string;
  */
 export declare function foldRequirementName(name: string): string;
 /**
- * The one spelling of a requirement header, shared with the main-spec structure
- * guard and the merge. `\s*` on purpose: `###Requirement:` is accepted here (see
- * the no-space regressions in requirement-blocks.test.ts), so a guard using a
- * stricter `\s+` let a duplicate slip past and the merge's Map collapsed it.
+ * The first of `names` that folds onto `name`, else undefined. One helper so
+ * every duplicate and collision check applies the same rule: in-section checks
+ * that compared exactly let `Foo` + `foo` through while the cross-section ones
+ * refused them.
  */
-export declare const REQUIREMENT_HEADER_REGEX: RegExp;
+export declare function findFoldedMatch(names: Iterable<string>, name: string): string | undefined;
+/**
+ * The name a `### Requirement:` header carries, as authored, or null when the
+ * line is not one. The one spelling of a requirement header, shared with the
+ * main-spec structure guard and the merge. `\s*` on purpose: `###Requirement:`
+ * is accepted here (see the no-space regressions in requirement-blocks.test.ts),
+ * so a guard using a stricter `\s+` let a duplicate slip past and the merge's
+ * Map collapsed it.
+ *
+ * The rest of the line is captured whole and cut at a line terminator in code.
+ * As `(.+)\s*$`, `\s` took U+2028/U+2029 where `.` stops, so a header holding
+ * one re-split its blank run every way: 80k blanks inside the name took 5 s,
+ * and blanks before it grew cubically. The cut keeps what `(.+)` captured, and
+ * anything but blanks after the terminator is still no match.
+ */
+export declare function matchRequirementHeader(line: string): string | null;
+/**
+ * Whether a line ends the main spec's `## Requirements` section: a `#` or `##`
+ * heading, by `headingLevel`, the rule MarkdownParser ends that section by.
+ * Shared with the main-spec structure guard, so the requirements it checks are
+ * the ones the merge reads. Not fence-aware; the caller skips fenced lines.
+ */
+export declare function endsRequirementsSection(line: string): boolean;
 export declare function extractRequirementsSection(content: string): RequirementsSectionParts;
 export interface RemovedEntry {
     name: string;
@@ -43,12 +65,31 @@ export interface RemovedEntry {
 export interface RemovedScenarioEntry {
     /** Requirement the scenario is being removed from, normalized. */
     requirement: string;
-    /** Scenario name, as authored — it is matched against spec headers verbatim. */
+    /** Scenario name, as authored but for a closing `#` run — it is matched against spec headers verbatim. */
     scenario: string;
     /** 1-based line number of the entry's first line in the source document. */
     startLine: number;
     hasReason: boolean;
 }
+/**
+ * Guidance for a REMOVED Scenarios entry that names a requirement this change
+ * renames away. The merge applies RENAMED first and keys declarations by the
+ * MODIFIED block's header, so only the post-rename name matches. Telling the
+ * author to "check both names against the spec" sent them to the one file that
+ * shows the old name, which is the name that fails. Undefined when the entry
+ * does not name a RENAMED source, so callers keep their generic guidance.
+ * Shared so validate and archive word the same mistake the same way.
+ */
+export declare function postRenameRemovalHint(entry: RemovedScenarioEntry, renamed: ReadonlyArray<{
+    from: string;
+    to: string;
+}>): string | undefined;
+export interface RenamedEntry {
+    from: string;
+    to: string;
+    /** 1-based line number of the FROM: line, the one that names the requirement the main spec holds. */
+    fromLine: number;
+}
 export interface RenamedIssue {
     kind: 'from-without-to' | 'to-without-from';
     name: string;
@@ -62,6 +103,33 @@ export interface DuplicateSection {
     /** 1-based line numbers of every occurrence, in document order. */
     lines: number[];
 }
+/** A `### Requirement:` header no delta section owns, so nothing reads it. */
+export interface OrphanRequirement {
+    name: string;
+    /** 1-based line number of the header. */
+    line: number;
+    /** Title of the `##` section it sits under; null before the first `##`. */
+    section: string | null;
+}
+/**
+ * Text archive will not merge: a non-delta `##` section with content, or a `#`
+ * heading with text under it inside an ADDED or MODIFIED section.
+ */
+export interface UnmergedSection {
+    /** The header as authored, e.g. '## Notes' or '# Note'. */
+    title: string;
+    /** 1-based line number of the header. */
+    line: number;
+}
+/** A non-delta `##` section whose title is a near miss of a delta section title. */
+export interface MisspelledSection {
+    /** The header as authored, e.g. '## REMOVED Requirement'. */
+    title: string;
+    /** 1-based line number of the header. */
+    line: number;
+    /** The delta section header it is closest to, e.g. '## REMOVED Requirements'. */
+    suggestion: string;
+}
 export interface DeltaPlan {
     added: RequirementBlock[];
     modified: RequirementBlock[];
@@ -85,6 +153,11 @@ export interface DeltaPlan {
         from: string;
         to: string;
     }>;
+    /**
+     * The pairs of `renamed` with the FROM: line, kept apart as `removedEntries`
+     * is from `removed`: a finding about a FROM name has to point at that line.
+     */
+    renamedEntries: RenamedEntry[];
     /** Scenario removals the author declared rather than performed silently. */
     removedScenarios: RemovedScenarioEntry[];
     /** Orphaned FROM:/TO: lines that would otherwise be silently dropped. */
@@ -94,6 +167,25 @@ export interface DeltaPlan {
      * the validator rejects them rather than guess which the author meant.
      */
     duplicateSections: DuplicateSection[];
+    /**
+     * Requirements written before the first `##`, or under a section that is not
+     * a delta section (a typo such as `## Add Requirements`). Every reader goes
+     * by section, so these were neither validated nor merged, and nothing said so.
+     */
+    orphanRequirements: OrphanRequirement[];
+    /**
+     * Non-delta sections other than `## Purpose` that hold text, and `#` headings
+     * with text under them inside ADDED or MODIFIED. Purpose has its own
+     * carry-or-notice path in the merge.
+     */
+    unmergedSections: UnmergedSection[];
+    /**
+     * Unmerged sections whose title is a near miss of a delta section title,
+     * such as `## REMOVED Requirement`. A REMOVED bullet or a RENAMED FROM:/TO:
+     * pair is not a `### Requirement:` header, so the orphan scan never sees it,
+     * and the removal or rename silently does not happen.
+     */
+    misspelledSections: MisspelledSection[];
     sectionPresence: {
         added: boolean;
         modified: boolean;
@@ -103,6 +195,35 @@ export interface DeltaPlan {
     };
 }
 export declare function parseDeltaSpec(content: string): DeltaPlan;
+/** Whether a document has any (unfenced) delta section header. */
+export declare function hasDeltaSection(content: string): boolean;
+/**
+ * The title of a `## ` section header as authored, or null when the line is
+ * not one. `sectionHeaderKey` builds on it, so `extractDeltaPurpose` and migrate
+ * find the sections this parser finds.
+ *
+ * The rest of the line is captured whole and refused in code when it holds a
+ * line terminator. As `\s+(.+)$`, `\s` took U+2028/U+2029 where `.` stops, so a
+ * header holding one re-split its blank run every way: 80k blanks took 2.7 s.
+ * A title of blanks alone still matches on its last blank, as `(.+)` did, so
+ * `##  ` stays a section.
+ */
+export declare function matchSectionHeader(line: string): string | null;
+/**
+ * The key this parser files a `## ` header under (the same header match,
+ * closing `#` peel and case fold `splitTopLevelSections` applies), or null when
+ * the line is not one. Exported so a caller scanning lines on its own shares
+ * that reading rather than keeping a regex copy, which drifts: migrate's took
+ * only `## Purpose`, so a spec headed `## purpose` lost its Purpose to a stub.
+ * Not fence-aware; the caller skips fenced lines.
+ */
+export declare function sectionHeaderKey(line: string): string | null;
+/**
+ * Whether a line is a header this parser reads as a delta section, keyed as
+ * `sectionHeaderKey` keys it. Migrate's own regex took only the upper-case,
+ * single-space spelling. Not fence-aware either.
+ */
+export declare function isDeltaSectionHeader(line: string): boolean;
 /**
  * Every `### Requirement:` block in a document, whichever section it sits in (or
  * none). For a caller rebuilding a whole file rather than applying a delta: a

package/dist/core/parsers/requirement-blocks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requirement-blocks.d.ts","sourceRoot":"","sources":["../../../src/core/parsers/requirement-blocks.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,QAAoC,CAAC;AAE1E,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB,CA4EpF;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,6EAA6E;AAC7E,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,yBAAyB;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gEAAgE;IAChE,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B;;;;OAIG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC;;;;OAIG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7C,4EAA4E;IAC5E,gBAAgB,EAAE,oBAAoB,EAAE,CAAC;IACzC,yEAAyE;IACzE,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,eAAe,EAAE;QACf,KAAK,EAAE,OAAO,CAAC;QACf,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAsCzD;AAwGD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAS1E"}
+{"version":3,"file":"requirement-blocks.d.ts","sourceRoot":"","sources":["../../../src/core/parsers/requirement-blocks.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMzF;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOlE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG7D;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB,CAkFpF;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,6EAA6E;AAC7E,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,0GAA0G;IAC1G,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,aAAa,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,GACnD,MAAM,GAAG,SAAS,CAKpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,qGAAqG;IACrG,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oFAAoF;AACpF,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,iFAAiF;IACjF,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,yBAAyB;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gEAAgE;IAChE,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B;;;;OAIG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC;;;;OAIG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7C;;;OAGG;IACH,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,4EAA4E;IAC5E,gBAAgB,EAAE,oBAAoB,EAAE,CAAC;IACzC,yEAAyE;IACzE,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC;;;;OAIG;IACH,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC;;;;OAIG;IACH,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC;;;;;OAKG;IACH,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC,eAAe,EAAE;QACf,KAAK,EAAE,OAAO,CAAC;QACf,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CA0CzD;AAED,kEAAkE;AAClE,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAExD;AA6BD;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG9D;AAgED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG1D;AAgJD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAS1E"}