@review-vir/common 2.0.0 → 3.1.0

package/dist/index.d.ts

@@ -1 +1,2 @@
-export * from './parse-primary-reviewers.js';
+export * from './parse-description-users.js';
+export * from './parse-inserted-code-owners.js';

package/dist/index.js

@@ -1 +1,2 @@
-export * from './parse-primary-reviewers.js';
+export * from './parse-description-users.js';
+export * from './parse-inserted-code-owners.js';

package/dist/parse-description-users.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Accepts a pull request text body, expected to be in plain text format (not markdown) and parses
+ * out tagged primary reviewers from strings that look like:
+ *
+ * `primary reviewer: @username, @otherUsername`
+ *
+ * Which will return the following output:
+ *
+ * `['username', 'otherUsername']`
+ */
+export declare function parseDescriptionUsers({ triggerText, bodyText, }: {
+    /**
+     * The start of the line for which usernames need to be parsed out of. An `'s'` is automatically
+     * allowed at the end of this text. Case insensitive.
+     *
+     * @example
+     *
+     * - `'primary reviewer'`
+     * - `'code owner'`
+     */
+    triggerText: string;
+    bodyText: string;
+}): string[];

package/dist/parse-description-users.js

@@ -0,0 +1,23 @@
+import { removePrefix, safeMatch } from '@augment-vir/common';
+/**
+ * Accepts a pull request text body, expected to be in plain text format (not markdown) and parses
+ * out tagged primary reviewers from strings that look like:
+ *
+ * `primary reviewer: @username, @otherUsername`
+ *
+ * Which will return the following output:
+ *
+ * `['username', 'otherUsername']`
+ */
+export function parseDescriptionUsers({ triggerText, bodyText, }) {
+    const [, match,] = safeMatch(bodyText, new RegExp(`${triggerText}s?\\W+((?:@[^@]+)+)(?:\n\n|$|\n#)`, 'i'));
+    if (!match) {
+        return [];
+    }
+    const [, restrictedMatch,] = safeMatch(match, /((?:@[\w-]+[^\w@]*)+)/);
+    const userTags = Array.from(restrictedMatch?.matchAll(/@[\w-]+/g) || []);
+    return userTags.map((userTag) => removePrefix({
+        value: userTag[0],
+        prefix: '@',
+    }));
+}

package/dist/parse-inserted-code-owners.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Parses the code owners that pull-request-vir inserts into a pull request's _raw markdown_ body.
+ *
+ * Pull-request-vir wraps its code owners in HTML comment delimiters and lists each owner on its own
+ * line followed by a collapsible list of their owned files:
+ *
+ *     <!-- code owners start -->
+ *     **Code owners**:
+ *     (at)username1
+ *     <details>
+ *     <summary>Owned files</summary>
+ *
+ *     - [some/file.ts](https://...)
+ *
+ *     </details>
+ *     (at)username2
+ *     ...
+ *     <!-- code owners end -->
+ *
+ * Returns the owner usernames (e.g. `['username1', 'username2']`), or `undefined` when the body
+ * contains no inserted code owners block (so callers can fall back to other detection).
+ *
+ * This must run against the raw markdown `body`, not the rendered `bodyText`: GitHub strips HTML
+ * comments (and the `<details>` structure) out of `bodyText`, removing the delimiters that bound
+ * the block and interleaving the owners with their owned-file text.
+ */
+export declare function parseInsertedCodeOwners(body: string): string[] | undefined;

package/dist/parse-inserted-code-owners.js

@@ -0,0 +1,46 @@
+import { removeDuplicates, removePrefix, safeMatch } from '@augment-vir/common';
+const insertedCodeOwnersRegExp = /<!-- code owners start -->([\S\s]*?)<!-- code owners end -->/i;
+const fileLinkLineRegExp = /^\s*-\s/;
+const userTagRegExp = /@[\w-]+/g;
+/**
+ * Parses the code owners that pull-request-vir inserts into a pull request's _raw markdown_ body.
+ *
+ * Pull-request-vir wraps its code owners in HTML comment delimiters and lists each owner on its own
+ * line followed by a collapsible list of their owned files:
+ *
+ *     <!-- code owners start -->
+ *     **Code owners**:
+ *     (at)username1
+ *     <details>
+ *     <summary>Owned files</summary>
+ *
+ *     - [some/file.ts](https://...)
+ *
+ *     </details>
+ *     (at)username2
+ *     ...
+ *     <!-- code owners end -->
+ *
+ * Returns the owner usernames (e.g. `['username1', 'username2']`), or `undefined` when the body
+ * contains no inserted code owners block (so callers can fall back to other detection).
+ *
+ * This must run against the raw markdown `body`, not the rendered `bodyText`: GitHub strips HTML
+ * comments (and the `<details>` structure) out of `bodyText`, removing the delimiters that bound
+ * the block and interleaving the owners with their owned-file text.
+ */
+export function parseInsertedCodeOwners(body) {
+    const [, block,] = safeMatch(body, insertedCodeOwnersRegExp);
+    if (block == undefined) {
+        return undefined;
+    }
+    /** Drop owned-file link lines so scoped paths (e.g. `@types/...`) aren't read as owners. */
+    const ownerLines = block
+        .split('\n')
+        .filter((line) => !fileLinkLineRegExp.test(line))
+        .join('\n');
+    const userTags = Array.from(ownerLines.matchAll(userTagRegExp));
+    return removeDuplicates(userTags.map((userTag) => removePrefix({
+        value: userTag[0],
+        prefix: '@',
+    })));
+}

package/package.json

@@ -1,7 +1,13 @@
 {
     "name": "@review-vir/common",
-    "version": "2.0.0",
-    "keywords": [],
+    "version": "3.1.0",
+    "description": "Common functionality that review-vir primary uses but other external packages need as well.",
+    "keywords": [
+        "review-vir",
+        "primary reviewers",
+        "vir",
+        "code owners"
+    ],
     "homepage": "https://github.com/review-vir/review-vir",
     "bugs": {
         "url": "https://github.com/review-vir/review-vir/issues"
@@ -10,7 +16,7 @@
         "type": "git",
         "url": "git+https://github.com/review-vir/review-vir.git"
     },
-    "license": "(MIT or CC0 1.0)",
+    "license": "(MIT OR CC0-1.0)",
     "author": {
         "name": "electrovir",
         "url": "https://github.com/electrovir"
@@ -29,20 +35,20 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.2.0",
-        "@augment-vir/common": "^30.2.0"
+        "@augment-vir/assert": "^32.2.1",
+        "@augment-vir/common": "^32.2.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.2.0",
-        "@web/dev-server-esbuild": "^1.0.2",
-        "@web/test-runner": "^0.19.0",
-        "@web/test-runner-commands": "^0.9.0",
-        "@web/test-runner-playwright": "^0.11.0",
-        "@web/test-runner-visual-regression": "^0.10.0",
+        "@augment-vir/test": "^32.2.1",
+        "@web/dev-server-esbuild": "^2.0.0",
+        "@web/test-runner": "^1.0.0",
+        "@web/test-runner-commands": "^1.0.1",
+        "@web/test-runner-playwright": "^1.0.0",
+        "@web/test-runner-visual-regression": "^1.0.1",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "markdown-code-example-inserter": "^3.0.0",
-        "typedoc": "^0.26.8",
-        "typescript": "^5.6.2"
+        "markdown-code-example-inserter": "^3.0.6",
+        "typedoc": "^0.28.20",
+        "typescript": "^6.0.3"
     },
     "engines": {
         "node": ">=22"

package/dist/parse-primary-reviewers.d.ts

@@ -1,13 +0,0 @@
-/**
- * Accepts a pull request text body, expected to be in plain text format (not markdown) and parses
- * out tagged primary reviewers from strings that look like:
- *
- * `primary reviewer: @username, @otherUsername`
- *
- * Which will return the following output:
- *
- * `['username', 'otherUsername']`
- */
-export declare function parsePrimaryReviewers({ bodyText }: {
-    bodyText: string;
-}): string[];

package/dist/parse-primary-reviewers.js

@@ -1,19 +0,0 @@
-import { removePrefix, safeMatch } from '@augment-vir/common';
-/**
- * Accepts a pull request text body, expected to be in plain text format (not markdown) and parses
- * out tagged primary reviewers from strings that look like:
- *
- * `primary reviewer: @username, @otherUsername`
- *
- * Which will return the following output:
- *
- * `['username', 'otherUsername']`
- */
-export function parsePrimaryReviewers({ bodyText }) {
-    const [, match,] = safeMatch(bodyText, /primary reviewers?\W+((?:@[^@\s]+(?:\s|$))+)/i);
-    if (!match) {
-        return [];
-    }
-    const userTags = Array.from(match.matchAll(/@[\w-]+/g));
-    return userTags.map((userTag) => removePrefix({ value: userTag[0], prefix: '@' }));
-}