@effected/github 0.6.1 → 0.7.0

package/README.md

@@ -122,7 +122,7 @@ const program = Effect.gen(function* () {
 
 The existence check pages the issue's comments to the end and matches the marker in `upsert`'s exact spelling, so a comment either member writes stays findable by the other. It is a look-before-write: two runs racing on the same issue can both see no marker and both post, so treat the marker as the record rather than the check as a lock.
 
-Whether a run should comment at all usually turns on which issues a pull request closes, and that is a grammar rather than an API call. `IssueReferences` is that grammar as plain functions — no service, no layer, nothing but strings in — in the two dialects consumers actually write:
+Whether a run should comment at all usually turns on which issues a pull request closes, and that is a grammar rather than an API call. That grammar now lives in [`@effected/github-references`](https://www.npmjs.com/package/@effected/github-references), a pure package with no octokit behind it; this package re-exports the two dialects it used to own so existing code keeps compiling:
 
 ```ts
 import { harvestIssueReferences, parseBareLineReference } from "@effected/github";
@@ -140,6 +140,8 @@ console.log(parseBareLineReference("closes #12 for real"));
 
 `harvestIssueReferences` reads the **inline-in-prose** dialect: one of the nine closing keywords (`CLOSING_KEYWORDS`) followed by whitespace and `#<number>`, anywhere in the text, no colon — the spelling GitHub itself scans a pull request body for. Duplicates come back as written, because whether `fixes #1, fixes #1` means one intent or two is the caller's question. `parseBareLineReference` reads the **bare-line** dialect, where the whole trimmed line is the reference and the colon is optional — the shape a generated references block writes, one per line. Cross-repo (`owner/repo#12`) and full-URL references are out of scope.
 
+The re-export covers exactly six names — `CLOSING_KEYWORDS`, `ClosingKeyword`, `IssueReference`, `harvestIssueReferences`, `BareLineReference`, `parseBareLineReference` — and may be dropped at a later release. Import from `@effected/github-references` directly for new code; it also carries a third dialect this package does not re-export, the closing list (`Closes #247, #248 and #251`).
+
 ## Repository configuration
 
 Six services cover the half of a repository that is policy rather than content: `RepositorySecret`, `RepositoryVariable`, `Ruleset`, `DeploymentEnvironment`, `RepositorySecurity` and `CodeScanning`. They are shaped for a program applying the same configuration across a fleet, so every list read paginates to the end and a truncated page never becomes a wrong decision.
@@ -273,7 +275,7 @@ const TestClient = GitHubClient.layerFixture(fixtures);
 - `CheckRun` — `withCheckRun` concludes on every exit path; `CheckRunOutput.truncated()` cuts rendered output to GitHub's byte limits.
 - `PullRequest` / `PullRequestComment` — upserts for both, `listFiles` answering with the same full `CommitFile` records a commit read returns, `headSha`/`baseSha` on `PullRequestInfo`, plus `CommentMarker` for finding a sticky comment again.
 - `GitHubIssue` — issues and their comments, including `commentOnce` for a marked comment that is posted exactly once and never edited, and `linkedIssues` for what a pull request closes.
-- `IssueReferences` — GitHub's nine closing keywords as pure functions: `harvestIssueReferences` for references inline in prose, `parseBareLineReference` for one-per-line generated ones.
+- `harvestIssueReferences` / `parseBareLineReference` — a compatibility re-export of the two closing-reference dialects that moved to `@effected/github-references`, with `CLOSING_KEYWORDS` and their result types.
 - `GitHubRelease` — releases and asset uploads, including the one route (`uploadAsset`, with the endpoint's optional display label) outside GitHub's generated endpoint map.
 - `RepositorySecret` / `RepositoryVariable` — repository and environment secrets and variables, with the sealed-box encryption GitHub's secrets API demands kept in one module nothing else imports.
 - `Ruleset` / `DeploymentEnvironment` / `RepositorySecurity` / `CodeScanning` — the rest of the configuration tier: rulesets matched by name and scope, idempotent environment writes, the three security toggles GitHub keeps off the repository endpoint, and CodeQL default setup with the language detection that gates it.

package/index.d.ts

@@ -1,3 +1,4 @@
+import { BareLineReference, CLOSING_KEYWORDS, ClosingKeyword, IssueReference, harvestIssueReferences, parseBareLineReference } from "@effected/github-references";
 import { Config, Context, Duration, Effect, Layer, Option, Redacted, Result, Schedule, Schema, Scope, Stream } from "effect";
 import { PaginatingEndpoints } from "@octokit/plugin-paginate-rest";
 import { Endpoints, RequestHeaders } from "@octokit/types";
@@ -2549,108 +2550,6 @@ declare class GitTag extends GitTag_base {
   static readonly layerTest: (overrides?: Partial<GitTagShape>) => Layer.Layer<GitTag>;
 }
 //#endregion
-//#region src/IssueReferences.d.ts
-/**
- * GitHub's closing-keyword issue-reference grammar, as pure functions.
- *
- * @remarks
- * GitHub links an issue to a pull request when the PR's description carries
- * `<keyword> #<number>` for one of nine documented keywords. Consumers speak
- * that grammar in two distinct dialects, and this module models exactly those
- * two — no service, no layer, nothing but strings in and values out:
- *
- * - **Inline-in-prose** ({@link harvestIssueReferences}): a reference may appear anywhere in
- *   running text — `"fixes #12 and closes #13"` — with mandatory whitespace
- *   and **no colon**, because that is the spelling GitHub itself scans PR
- *   bodies for. This is the dialect a release pipeline harvests from commit
- *   subjects and PR descriptions.
- * - **Bare-line** ({@link parseBareLineReference}): the whole line, after trimming, *is*
- *   the reference — `"Closes: #12"` — with an **optional colon**, because a
- *   generated references region writes one reference per line and a colon
- *   reads better there. GitHub does not require the colon; the region format
- *   allows it, so the parser must too. The dialects differ because their
- *   producers do: prose is written by humans for GitHub's scanner, the region
- *   is written by tooling for humans.
- *
- * Deliberately out of scope this round: cross-repo references
- * (`owner/repo#N`) and full-URL references
- * (`https://github.com/owner/repo/issues/N`). Both are real GitHub spellings;
- * neither dialect's consumers emit them yet, and guessing at their shape here
- * would freeze an API nobody has driven.
- */
-/**
- * The nine closing keywords GitHub documents, lowercased.
- *
- * @public
- */
-declare const CLOSING_KEYWORDS: readonly ["close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"];
-/**
- * One of the nine documented closing keywords, in canonical lowercase form.
- *
- * @public
- */
-type ClosingKeyword = (typeof CLOSING_KEYWORDS)[number];
-/**
- * One closing reference found in prose by {@link harvestIssueReferences}.
- *
- * @public
- */
-interface IssueReference {
-  /** The referenced issue number. */
-  readonly issueNumber: number;
-  /** The matched keyword, lowercased to its canonical form. */
-  readonly keyword: ClosingKeyword;
-  /** Offset of the first character of the whole match (`keyword` through digits). */
-  readonly start: number;
-  /** Offset one past the last character of the whole match. */
-  readonly end: number;
-}
-/**
- * The closing reference a bare line carries, per {@link parseBareLineReference}.
- *
- * @remarks
- * No offsets: in the bare-line dialect the whole line is the reference, so
- * positions within it locate nothing a caller acts on.
- *
- * @public
- */
-interface BareLineReference {
-  /** The referenced issue number. */
-  readonly issueNumber: number;
-  /** The matched keyword, lowercased to its canonical form. */
-  readonly keyword: ClosingKeyword;
-}
-/**
- * Every inline closing reference in `text`, in document order.
- *
- * @remarks
- * The **inline-in-prose** dialect: case-insensitive `<keyword> #<number>`
- * anywhere in the text, whitespace mandatory, colon not accepted — a colon
- * spelling belongs to the bare-line dialect and {@link parseBareLineReference}.
- * Duplicates are preserved: whether `fixes #1, fixes #1` means one reference
- * or two is the caller's business, not a parser's.
- *
- * A match whose digits exceed `Number.MAX_SAFE_INTEGER` is skipped, not
- * misparsed — see the module remarks for the scope boundary.
- *
- * @public
- */
-declare const harvestIssueReferences: (text: string) => ReadonlyArray<IssueReference>;
-/**
- * The reference a whole line carries, or `Option.none()`.
- *
- * @remarks
- * The **bare-line** dialect: after trimming, the entire line must be
- * `<keyword>[:] #<number>` — keyword case-insensitive, colon optional,
- * whitespace before the `#` mandatory. Trailing prose, a missing keyword, or
- * anything else at all is a rejection, never a partial parse; a line carries
- * one reference or none. Digits past `Number.MAX_SAFE_INTEGER` reject too,
- * for the same reason {@link harvestIssueReferences} skips them.
- *
- * @public
- */
-declare const parseBareLineReference: (line: string) => Option.Option<BareLineReference>;
-//#endregion
 //#region src/PullRequest.d.ts
 /** How a pull request is merged. @public */
 declare const MergeMethod: Schema.Literals<readonly ["merge", "squash", "rebase"]>;

package/index.js

@@ -18,7 +18,6 @@ import { CommentOnceResult, GitHubIssue, IssueInfo, LinkedIssue } from "./GitHub
 import { GitHubRelease, ReleaseAsset, ReleaseInfo } from "./GitHubRelease.js";
 import { GRAPHQL_ONLY_SETTINGS, GitHubRepository, SECURITY_ANALYSIS_STATUS_FIELDS, transformSecurityAndAnalysis } from "./GitHubRepository.js";
 import { GitTag, SemverTag, TagRef, versionFromTag } from "./GitTag.js";
-import { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference } from "./IssueReferences.js";
 import { PageOptions } from "./Rest.js";
 import { MergeMethod, PullRequest, PullRequestInfo } from "./PullRequest.js";
 import { RepositorySecret } from "./RepositorySecret.js";
@@ -27,5 +26,6 @@ import { RepositoryVariable } from "./RepositoryVariable.js";
 import { Ruleset } from "./Ruleset.js";
 import { ExtraPermission, PermissionGap, PermissionLevel, PermissionResult, TokenPermissionError, TokenPermissions } from "./TokenPermissions.js";
 import { WorkflowDispatch, WorkflowRunStatus } from "./WorkflowDispatch.js";
+import { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference } from "@effected/github-references";
 
 export { Annotation, AnnotationLevel, AppIdentity, ArtifactMetadata, Attestation, AttestationListEntry, AttestationRecord, BotIdentity, CLOSING_KEYWORDS, CheckConclusion, CheckRun, CheckRunOutput, CheckRunRef, CodeScanning, CommentMarker, CommentOnceResult, CommentRecord, CommitComparison, CommitFile, CommitRef, CommitSummary, DeploymentEnvironment, ExtraPermission, FileChange, FileContent, FileDeletion, FileMode, FileStatus, GRAPHQL_ONLY_SETTINGS, GitBranch, GitCommit, GitHubApp, GitHubAppError, GitHubClient, GitHubCommit, GitHubContent, GitHubError, GitHubErrorKind, GitHubGraphQLError, GitHubIssue, GitHubRelease, GitHubRepository, GitTag, GraphQLDocument, GraphQLErrorEntry, Installation, InstallationToken, InvalidRepoRefError, IssueInfo, LinkedIssue, MergeMethod, PageOptions, PermissionGap, PermissionLevel, PermissionResult, PullRequest, PullRequestComment, PullRequestInfo, RateLimitSnapshot, ReleaseAsset, ReleaseInfo, Repo, RepoRef, RepositorySecret, RepositorySecurity, RepositoryVariable, RetryPolicy, Ruleset, SECURITY_ANALYSIS_STATUS_FIELDS, SemverTag, StorageRecordInput, TagRef, TokenPermissionError, TokenPermissions, WorkflowDispatch, WorkflowRunStatus, harvestIssueReferences, parseBareLineReference, transformSecurityAndAnalysis, versionFromTag };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/github",
-	"version": "0.6.1",
+	"version": "0.7.0",
 	"private": false,
 	"description": "Typed GitHub REST and GraphQL services over the octokit core request surface, with app auth and resource helpers.",
 	"keywords": [
@@ -38,6 +38,7 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
+		"@effected/github-references": "^0.1.0",
 		"@effected/semver": "^0.5.0",
 		"@octokit/core": "^7.0.6",
 		"@octokit/plugin-paginate-rest": "^15.0.0",

package/IssueReferences.js

@@ -1,126 +0,0 @@
-import { Option } from "effect";
-
-//#region src/IssueReferences.ts
-/**
-* GitHub's closing-keyword issue-reference grammar, as pure functions.
-*
-* @remarks
-* GitHub links an issue to a pull request when the PR's description carries
-* `<keyword> #<number>` for one of nine documented keywords. Consumers speak
-* that grammar in two distinct dialects, and this module models exactly those
-* two — no service, no layer, nothing but strings in and values out:
-*
-* - **Inline-in-prose** ({@link harvestIssueReferences}): a reference may appear anywhere in
-*   running text — `"fixes #12 and closes #13"` — with mandatory whitespace
-*   and **no colon**, because that is the spelling GitHub itself scans PR
-*   bodies for. This is the dialect a release pipeline harvests from commit
-*   subjects and PR descriptions.
-* - **Bare-line** ({@link parseBareLineReference}): the whole line, after trimming, *is*
-*   the reference — `"Closes: #12"` — with an **optional colon**, because a
-*   generated references region writes one reference per line and a colon
-*   reads better there. GitHub does not require the colon; the region format
-*   allows it, so the parser must too. The dialects differ because their
-*   producers do: prose is written by humans for GitHub's scanner, the region
-*   is written by tooling for humans.
-*
-* Deliberately out of scope this round: cross-repo references
-* (`owner/repo#N`) and full-URL references
-* (`https://github.com/owner/repo/issues/N`). Both are real GitHub spellings;
-* neither dialect's consumers emit them yet, and guessing at their shape here
-* would freeze an API nobody has driven.
-*/
-/**
-* The nine closing keywords GitHub documents, lowercased.
-*
-* @public
-*/
-const CLOSING_KEYWORDS = [
-	"close",
-	"closes",
-	"closed",
-	"fix",
-	"fixes",
-	"fixed",
-	"resolve",
-	"resolves",
-	"resolved"
-];
-/**
-* Both patterns derive from {@link CLOSING_KEYWORDS} so the constant and the
-* grammar cannot drift. Alternation order is safe: the regex engine backtracks
-* through alternatives, so `close` matching inside `closes` fails at the
-* mandatory `#`-introducer and retries the longer keyword.
-*/
-const KEYWORDS = CLOSING_KEYWORDS.join("|");
-/** Inline-in-prose: mandatory whitespace, no colon. */
-const INLINE_PATTERN = new RegExp(`\\b(${KEYWORDS})\\s+#(\\d+)`, "gi");
-/**
-* Bare-line: optional colon, then mandatory same-line whitespace. `[ \t]`
-* rather than `\s`, so an embedded newline cannot smuggle two lines past a
-* parser whose contract is one.
-*/
-const BARE_LINE_PATTERN = new RegExp(`^(${KEYWORDS}):?[ \\t]+#(\\d+)$`, "i");
-/**
-* `#<digits>` parsed to a number — or `undefined` when the digits exceed
-* `Number.MAX_SAFE_INTEGER`, because a silently rounded issue number is worse
-* than a skipped match. Callers skip such matches; they do not fail.
-*/
-const safeIssueNumber = (digits) => {
-	const value = Number(digits);
-	return Number.isSafeInteger(value) ? value : void 0;
-};
-/**
-* Every inline closing reference in `text`, in document order.
-*
-* @remarks
-* The **inline-in-prose** dialect: case-insensitive `<keyword> #<number>`
-* anywhere in the text, whitespace mandatory, colon not accepted — a colon
-* spelling belongs to the bare-line dialect and {@link parseBareLineReference}.
-* Duplicates are preserved: whether `fixes #1, fixes #1` means one reference
-* or two is the caller's business, not a parser's.
-*
-* A match whose digits exceed `Number.MAX_SAFE_INTEGER` is skipped, not
-* misparsed — see the module remarks for the scope boundary.
-*
-* @public
-*/
-const harvestIssueReferences = (text) => {
-	const references = [];
-	for (const match of text.matchAll(INLINE_PATTERN)) {
-		const issueNumber = safeIssueNumber(match[2] ?? "");
-		if (issueNumber === void 0) continue;
-		references.push({
-			issueNumber,
-			keyword: (match[1] ?? "").toLowerCase(),
-			start: match.index,
-			end: match.index + match[0].length
-		});
-	}
-	return references;
-};
-/**
-* The reference a whole line carries, or `Option.none()`.
-*
-* @remarks
-* The **bare-line** dialect: after trimming, the entire line must be
-* `<keyword>[:] #<number>` — keyword case-insensitive, colon optional,
-* whitespace before the `#` mandatory. Trailing prose, a missing keyword, or
-* anything else at all is a rejection, never a partial parse; a line carries
-* one reference or none. Digits past `Number.MAX_SAFE_INTEGER` reject too,
-* for the same reason {@link harvestIssueReferences} skips them.
-*
-* @public
-*/
-const parseBareLineReference = (line) => {
-	const match = BARE_LINE_PATTERN.exec(line.trim());
-	if (match === null) return Option.none();
-	const issueNumber = safeIssueNumber(match[2] ?? "");
-	if (issueNumber === void 0) return Option.none();
-	return Option.some({
-		issueNumber,
-		keyword: (match[1] ?? "").toLowerCase()
-	});
-};
-
-//#endregion
-export { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference };