@savvy-web/silk-effects 5.9.2 → 6.0.0

package/changesets/utils/issue-refs.js

@@ -1,65 +1,44 @@
+import { collectReferenceLists, keywordFamily } from "@effected/github-references";
+
 //#region src/changesets/utils/issue-refs.ts
 /**
-* Matches "closes #123" or "close: #456, #789" patterns (case-insensitive).
-*
-* Capture group `[1]` contains the comma-separated issue number list.
-*
-* @internal
-*/
-const CLOSES_ISSUE_PATTERN = /closes?:?\s*#?(\d+(?:, *#?\d+)*)/i;
-/**
-* Matches "fixes #123" or "fix: #456, #789" patterns (case-insensitive).
-*
-* Capture group `[1]` contains the comma-separated issue number list.
-*
-* @internal
-*/
-const FIXES_ISSUE_PATTERN = /fix(?:es)?:?\s*#?(\d+(?:, *#?\d+)*)/i;
-/**
-* Matches "refs #123" or "ref: #456, #789" patterns (case-insensitive).
-*
-* Capture group `[1]` contains the comma-separated issue number list.
-*
-* @internal
-*/
-const REFS_ISSUE_PATTERN = /refs?:?\s*#?(\d+(?:, *#?\d+)*)/i;
-/**
-* Pattern for splitting comma-separated issue numbers.
-*
-* @internal
-*/
-const ISSUE_NUMBER_SPLIT_PATTERN = /, */;
-/**
-* Extract issue numbers from a regex match against a commit message.
+* The output category each keyword family lands in.
 *
 * @remarks
-* Truncates the input to 10,000 characters before matching to prevent
-* ReDoS on adversarial input. Strips `#` prefixes from matched numbers.
-*
-* @param pattern - The regex pattern to match (must have a capture group for issue numbers)
-* @param message - The commit message body to search
-* @returns Array of issue number strings (without `#` prefix)
+* The `resolve` family reads as `closes` since closing is what those keywords
+* do; the record is total over `KeywordFamily`, so a family the kit adds
+* without a category here is a type error, never a silent drop.
 *
 * @internal
 */
-function extractIssueNumbers(pattern, message) {
-	const safeMessage = message.slice(0, 1e4);
-	const match = pattern.exec(safeMessage);
-	if (!match?.[1]) return [];
-	return match[1].split(ISSUE_NUMBER_SPLIT_PATTERN).map((num) => num.replace("#", "").trim());
+const CATEGORY_BY_FAMILY = {
+	close: "closes",
+	fix: "fixes",
+	ref: "refs",
+	resolve: "closes"
+};
+/** @internal */
+function categoryOf(list) {
+	return CATEGORY_BY_FAMILY[keywordFamily(list.keyword)];
 }
 /**
 * Parse a commit message for GitHub issue references.
 *
-* Recognizes `Closes`, `Fixes`, and `Refs` keywords with various formats:
-* - `Closes #123`
-* - `Fixes: #456, #789`
-* - `Refs #101`
+* Recognizes GitHub's closing keywords plus `Ref`/`Refs`/`References` in
+* both list dialects:
+* - whole-line trailers — `Closes #123`, `Fixes: #456, #789`, `Refs #101`;
+* - inline in prose — `This closes #12 in passing`, or several lists on one
+*   line: `Closes #123, Fixes #456`.
 *
 * @remarks
-* Each keyword category is matched independently, so a single commit
-* message can contain references in all three categories. Keywords are
-* case-insensitive and accept both singular and plural forms.
+* References accumulate in message order: two `Closes` lists contribute to
+* the same category. Keywords are case-insensitive and the `#` is mandatory.
+* The colon spelling is line-dialect-only; `collectReferenceLists` owns the
+* per-line composition (whole-line trailer parse first, inline harvest
+* otherwise), guaranteeing a trailer line is never double-counted. Malformed
+* candidates are simply skipped. The kit preserves duplicates by contract;
+* each category dedupes them here (first occurrence wins), mirroring the
+* PR-body path, so a repeated reference renders one changelog link.
 *
 * @param commitMessage - The commit message body to parse
 * @returns Categorized issue references with numbers as strings (no `#` prefix)
@@ -68,20 +47,23 @@ function extractIssueNumbers(pattern, message) {
 * ```typescript
 * import { parseIssueReferences } from "../utils/issue-refs.js";
 *
-* const refs = parseIssueReferences("feat: add API\n\nCloses #42\nFixes: #17, #23");
+* const refs = parseIssueReferences("feat: add API\n\nCloses #42, Fixes #17");
 * // refs.closes === ["42"]
-* // refs.fixes === ["17", "23"]
+* // refs.fixes === ["17"]
 * // refs.refs === []
 * ```
 *
 * @internal
 */
 function parseIssueReferences(commitMessage) {
-	return {
-		closes: extractIssueNumbers(CLOSES_ISSUE_PATTERN, commitMessage),
-		fixes: extractIssueNumbers(FIXES_ISSUE_PATTERN, commitMessage),
-		refs: extractIssueNumbers(REFS_ISSUE_PATTERN, commitMessage)
+	const references = {
+		closes: [],
+		fixes: [],
+		refs: []
 	};
+	for (const list of collectReferenceLists(commitMessage)) references[categoryOf(list)].push(...list.issueNumbers.map(String));
+	for (const category of Object.keys(references)) references[category] = [...new Set(references[category])];
+	return references;
 }
 
 //#endregion

package/commitlint/hook/rules/closes-trailer.js

@@ -1,4 +1,5 @@
 import { Effect } from "effect";
+import { parseClosingLists } from "@effected/github-references";
 
 //#region src/commitlint/hook/rules/closes-trailer.ts
 /**
@@ -8,33 +9,22 @@ import { Effect } from "effect";
 * @internal
 */
 /**
-* A closing keyword followed by its full list of issue references.
+* Whether some line of the message is a closing trailer naming `ticketId`.
 *
 * @remarks
-* The house commit format puts every issue on ONE comma-separated trailer
-* (`Closes #247, #248, #251`), so a pattern anchored on `keyword\s+#N` sees
-* only the first id and reports a missing trailer that is plainly present.
-* Capturing the whole list and scanning it is what makes the later ids count.
-*
-* `and` is accepted alongside the comma because humans write it; the optional
-* colon matches the `Closes: #N` form the validator's trailer pattern allows.
-*
-* @internal
-*/
-const CLOSING_LIST_PATTERN = /\b(?:closes|fixes|resolves):?\s+(#\d+(?:\s*(?:,|and)\s*#\d+)*)/gi;
-/**
-* Reference ids within a captured closing list.
+* The message is read with `@effected/github-references`' `parseClosingLists`:
+* per line, the whole line, after trimming, must be a closing keyword (any of
+* GitHub's nine tenses, optional colon) followed by its full `#N` list —
+* comma, `and`, or Oxford `, and` separated — so every id in the house
+* one-trailer format (`Closes #247, #248, #251`) counts, not just the first.
+* A `#N` mentioned mid-prose never qualifies: a trailer is a line of its own,
+* which is why this rule deliberately stays on the whole-line dialect rather
+* than the inline harvest.
 *
 * @internal
 */
-const REFERENCE_PATTERN = /#(\d+)/g;
 function hasClosingTrailer(message, ticketId) {
-	for (const keywordMatch of message.matchAll(CLOSING_LIST_PATTERN)) {
-		const list = keywordMatch[1];
-		if (list === void 0) continue;
-		for (const reference of list.matchAll(REFERENCE_PATTERN)) if (Number(reference[1]) === ticketId) return true;
-	}
-	return false;
+	return parseClosingLists(message).some((list) => list.issueNumbers.includes(ticketId));
 }
 const closesTrailerRule = {
 	id: "closes-trailer",

package/index.d.ts

@@ -6497,6 +6497,21 @@ interface ClosesTrailerCtx {
   branchInfo: BranchInfo;
   openIssues: ReadonlyArray<OpenIssue>;
 }
+/**
+ * Whether some line of the message is a closing trailer naming `ticketId`.
+ *
+ * @remarks
+ * The message is read with `@effected/github-references`' `parseClosingLists`:
+ * per line, the whole line, after trimming, must be a closing keyword (any of
+ * GitHub's nine tenses, optional colon) followed by its full `#N` list —
+ * comma, `and`, or Oxford `, and` separated — so every id in the house
+ * one-trailer format (`Closes #247, #248, #251`) counts, not just the first.
+ * A `#N` mentioned mid-prose never qualifies: a trailer is a line of its own,
+ * which is why this rule deliberately stays on the whole-line dialect rather
+ * than the inline harvest.
+ *
+ * @internal
+ */
 declare function hasClosingTrailer(message: string, ticketId: number): boolean;
 declare const closesTrailerRule: Rule<ClosesTrailerInput, ClosesTrailerCtx>;
 //#endregion
@@ -8608,18 +8623,6 @@ declare const ClosingReferences_base: Schema.Class<ClosingReferences, Schema.Str
  * @public
  */
 declare class ClosingReferences extends ClosingReferences_base {
-  /**
-   * A closing keyword and its issue reference, anchored per line.
-   *
-   * @remarks
-   * Anchored so a number mentioned in passing is not mistaken for a closing
-   * reference — matching what GitHub itself links on. Every keyword GitHub
-   * accepts is matched, not just the present-tense plural this contract
-   * emits: `close`/`closed`, `fix`/`fixed`, `resolve`/`resolved` and an
-   * optional colon are all valid, and a reference the parser fails to
-   * recognise is one the next regeneration silently deletes.
-   */
-  static readonly BARE_LINE_PATTERN: RegExp;
   /**
    * The open issues' ids, in input order, duplicates preserved.
    *
@@ -8634,6 +8637,15 @@ declare class ClosingReferences extends ClosingReferences_base {
   /**
    * Issue ids carried by a region's bare closing lines.
    *
+   * @remarks
+   * The region is read with `@effected/github-references`' `parseBareLines`
+   * — per line, the whole line, after trimming, must be
+   * `<keyword>[:] #<number>`, so a number mentioned in passing is never
+   * mistaken for a closing reference. Every keyword GitHub accepts counts,
+   * not just the present-tense plural this contract emits, because a
+   * reference the parser fails to recognise is one the next regeneration
+   * silently deletes.
+   *
    * @public
    */
   static parseBare(region: string): ReadonlyArray<number>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/silk-effects",
-	"version": "5.9.2",
+	"version": "6.0.0",
 	"private": false,
 	"description": "Shared Effect library for Silk Suite conventions",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/silk-effects",
@@ -35,12 +35,13 @@
 		"@changesets/get-release-plan": "^5.0.0",
 		"@effected/commands": "^0.5.0",
 		"@effected/git": "^0.9.0",
+		"@effected/github-references": "^0.1.0",
 		"@effected/glob": "^0.4.0",
 		"@effected/jsonc": "^0.7.0",
-		"@effected/package-json": "^0.10.0",
-		"@effected/templates": "^0.3.0",
+		"@effected/package-json": "^0.10.1",
+		"@effected/templates": "^0.4.0",
 		"@effected/walker": "^0.5.0",
-		"@effected/workspaces": "^0.14.0",
+		"@effected/workspaces": "^0.14.1",
 		"@effected/yaml": "^0.10.0",
 		"@manypkg/get-packages": "^3.1.0",
 		"mdast-util-heading-range": "^4.0.0",

package/pr-body/references.js

@@ -1,6 +1,7 @@
 import { Markers } from "./markers.js";
 import { LinkedIssueRef } from "./linked-issue.js";
 import { Schema } from "effect";
+import { parseBareLines } from "@effected/github-references";
 
 //#region src/pr-body/references.ts
 /**
@@ -32,18 +33,6 @@ import { Schema } from "effect";
 * @public
 */
 var ClosingReferences = class ClosingReferences extends Schema.Class("ClosingReferences")({ ids: Schema.Array(Schema.Number.check(Schema.isInt())) }) {
-	/**
-	* A closing keyword and its issue reference, anchored per line.
-	*
-	* @remarks
-	* Anchored so a number mentioned in passing is not mistaken for a closing
-	* reference — matching what GitHub itself links on. Every keyword GitHub
-	* accepts is matched, not just the present-tense plural this contract
-	* emits: `close`/`closed`, `fix`/`fixed`, `resolve`/`resolved` and an
-	* optional colon are all valid, and a reference the parser fails to
-	* recognise is one the next regeneration silently deletes.
-	*/
-	static BARE_LINE_PATTERN = /^(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?):?\s+#(\d+)$/i;
 	/**
 	* The open issues' ids, in input order, duplicates preserved.
 	*
@@ -60,10 +49,19 @@ var ClosingReferences = class ClosingReferences extends Schema.Class("ClosingRef
 	/**
 	* Issue ids carried by a region's bare closing lines.
 	*
+	* @remarks
+	* The region is read with `@effected/github-references`' `parseBareLines`
+	* — per line, the whole line, after trimming, must be
+	* `<keyword>[:] #<number>`, so a number mentioned in passing is never
+	* mistaken for a closing reference. Every keyword GitHub accepts counts,
+	* not just the present-tense plural this contract emits, because a
+	* reference the parser fails to recognise is one the next regeneration
+	* silently deletes.
+	*
 	* @public
 	*/
 	static parseBare(region) {
-		return region.split("\n").map((line) => ClosingReferences.BARE_LINE_PATTERN.exec(line.trim())?.[1]).filter((id) => id !== void 0).map(Number);
+		return parseBareLines(region).map((ref) => ref.issueNumber);
 	}
 	/**
 	* A copy with duplicate ids removed, first occurrence winning.