@review-vir/common 2.0.0 → 3.0.0

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './parse-primary-reviewers.js';
+export * from './parse-description-users.js';

package/dist/index.js

@@ -1 +1 @@
-export * from './parse-primary-reviewers.js';
+export * from './parse-description-users.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-primary-reviewers.js → parse-description-users.js}

@@ -9,11 +9,12 @@ import { removePrefix, safeMatch } from '@augment-vir/common';
  *
  * `['username', 'otherUsername']`
  */
-export function parsePrimaryReviewers({ bodyText }) {
-    const [, match,] = safeMatch(bodyText, /primary reviewers?\W+((?:@[^@\s]+(?:\s|$))+)/i);
+export function parseDescriptionUsers({ triggerText, bodyText, }) {
+    const [, match,] = safeMatch(bodyText, new RegExp(`${triggerText}s?\\W+((?:@[^@]+)+)(?:\n\n|$|\n#)`, 'i'));
     if (!match) {
         return [];
     }
-    const userTags = Array.from(match.matchAll(/@[\w-]+/g));
+    const [, restrictedMatch,] = safeMatch(match, /((?:@[\w-]+[^\w@]*)+)/);
+    const userTags = Array.from(restrictedMatch?.matchAll(/@[\w-]+/g) || []);
     return 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.0.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"
@@ -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": "^31.1.1",
+        "@augment-vir/common": "^31.1.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.2.0",
-        "@web/dev-server-esbuild": "^1.0.2",
+        "@augment-vir/test": "^31.1.1",
+        "@web/dev-server-esbuild": "^1.0.3",
         "@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",
         "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.3",
+        "typedoc": "^0.27.4",
+        "typescript": "~5.6.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[];