@review-vir/common 3.1.0 → 3.1.2

package/dist/code-owners-markdown.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Defines the Markdown that identifies a code owners block in a pull request description.
+ *
+ * @category Main
+ */
+export declare const codeOwnersMarkdown: Readonly<{
+    blockEnd: "<!-- code owners end -->";
+    blockStart: "<!-- code owners start -->";
+    heading: "## Code Owners";
+}>;
+/**
+ * Formats the code owners content that pull-request-vir writes into a pull request description.
+ *
+ * @category Main
+ */
+export declare function createCodeOwnersMarkdownBlock(content: string): string;

package/dist/code-owners-markdown.js

@@ -0,0 +1,23 @@
+/**
+ * Defines the Markdown that identifies a code owners block in a pull request description.
+ *
+ * @category Main
+ */
+export const codeOwnersMarkdown = Object.freeze({
+    blockEnd: '<!-- code owners end -->',
+    blockStart: '<!-- code owners start -->',
+    heading: '## Code Owners',
+});
+/**
+ * Formats the code owners content that pull-request-vir writes into a pull request description.
+ *
+ * @category Main
+ */
+export function createCodeOwnersMarkdownBlock(content) {
+    return [
+        codeOwnersMarkdown.blockStart,
+        codeOwnersMarkdown.heading,
+        content,
+        codeOwnersMarkdown.blockEnd,
+    ].join('\n');
+}

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/parse-description-users.js

@@ -16,8 +16,10 @@ export function parseDescriptionUsers({ triggerText, bodyText, }) {
     }
     const [, restrictedMatch,] = safeMatch(match, /((?:@[\w-]+[^\w@]*)+)/);
     const userTags = Array.from(restrictedMatch?.matchAll(/@[\w-]+/g) || []);
-    return userTags.map((userTag) => removePrefix({
-        value: userTag[0],
-        prefix: '@',
-    }));
+    return userTags.map((userTag) => {
+        return removePrefix({
+            value: userTag[0],
+            prefix: '@',
+        });
+    });
 }

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

@@ -5,7 +5,7 @@
  * line followed by a collapsible list of their owned files:
  *
  *     <!-- code owners start -->
- *     **Code owners**:
+ *     ## Code Owners
  *     (at)username1
  *     <details>
  *     <summary>Owned files</summary>

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

@@ -1,5 +1,6 @@
 import { removeDuplicates, removePrefix, safeMatch } from '@augment-vir/common';
-const insertedCodeOwnersRegExp = /<!-- code owners start -->([\S\s]*?)<!-- code owners end -->/i;
+import { codeOwnersMarkdown } from './code-owners-markdown.js';
+const insertedCodeOwnersRegExp = new RegExp(String.raw `${codeOwnersMarkdown.blockStart}([\S\s]*?)${codeOwnersMarkdown.blockEnd}`, 'i');
 const fileLinkLineRegExp = /^\s*-\s/;
 const userTagRegExp = /@[\w-]+/g;
 /**
@@ -9,7 +10,7 @@ const userTagRegExp = /@[\w-]+/g;
  * line followed by a collapsible list of their owned files:
  *
  *     <!-- code owners start -->
- *     **Code owners**:
+ *     ## Code Owners
  *     (at)username1
  *     <details>
  *     <summary>Owned files</summary>
@@ -39,8 +40,10 @@ export function parseInsertedCodeOwners(body) {
         .filter((line) => !fileLinkLineRegExp.test(line))
         .join('\n');
     const userTags = Array.from(ownerLines.matchAll(userTagRegExp));
-    return removeDuplicates(userTags.map((userTag) => removePrefix({
-        value: userTag[0],
-        prefix: '@',
-    })));
+    return removeDuplicates(userTags.map((userTag) => {
+        return removePrefix({
+            value: userTag[0],
+            prefix: '@',
+        });
+    }));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@review-vir/common",
-    "version": "3.1.0",
+    "version": "3.1.2",
     "description": "Common functionality that review-vir primary uses but other external packages need as well.",
     "keywords": [
         "review-vir",
@@ -35,11 +35,11 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^32.2.1",
-        "@augment-vir/common": "^32.2.1"
+        "@augment-vir/assert": "^32.5.0",
+        "@augment-vir/common": "^32.5.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^32.2.1",
+        "@augment-vir/test": "^32.5.0",
         "@web/dev-server-esbuild": "^2.0.0",
         "@web/test-runner": "^1.0.0",
         "@web/test-runner-commands": "^1.0.1",