@review-vir/common 1.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @review-vir/common
+
+Code used within multiple git code review tools, especially [review-vir](https://review-vir.github.io/review-vir) itself.
+
+See https://review-vir.github.io/review-vir/common for docs.

package/configs/typedoc.config.ts

@@ -0,0 +1,15 @@
+import {join, resolve} from 'path';
+import type {TypeDocOptions} from 'typedoc';
+import {baseTypedocConfig} from 'virmator/dist/compiled-base-configs/base-typedoc';
+
+const repoRoot = resolve(__dirname, '..');
+const indexTsFile = join(repoRoot, 'src', 'index.ts');
+
+export const typeDocConfig: Partial<TypeDocOptions> = {
+    ...baseTypedocConfig,
+    out: join(repoRoot, 'dist-pages'),
+    entryPoints: [
+        indexTsFile,
+    ],
+    intentionallyNotExported: [],
+};

package/configs/web-test-runner.config.mjs

@@ -0,0 +1,23 @@
+import {dirname} from 'path';
+import {fileURLToPath, pathToFileURL} from 'url';
+import {getWebTestRunnerConfigWithCoveragePercent} from 'virmator/base-configs/base-web-test-runner.mjs';
+
+const baseConfig = getWebTestRunnerConfigWithCoveragePercent({
+    coveragePercent: 100,
+    packageRootDirPath: dirname(dirname(fileURLToPath(import.meta.url))),
+    extraScreenshotOptions: {},
+});
+
+/** @type {import('@web/test-runner').TestRunnerConfig} */
+const webTestRunnerConfig = {
+    ...baseConfig,
+    concurrency: 1,
+    port: 8001,
+};
+
+export default webTestRunnerConfig;
+
+// check if the current file is being run directly as a script
+if (import.meta.url === pathToFileURL(process.argv[1]).href) {
+    console.info(JSON.stringify(webTestRunnerConfig, null, 4));
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+    "name": "@review-vir/common",
+    "version": "1.0.0",
+    "homepage": "https://github.com/review-vir/review-vir",
+    "bugs": {
+        "url": "https://github.com/review-vir/review-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/review-vir/review-vir"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "npm run docs && mkdir -p ../../dist-pages/common && cp -r ./dist-pages/* ../../dist-pages/common/",
+        "compile": "tsc -b -f --pretty",
+        "docs": "virmator docs",
+        "start": "virmator frontend",
+        "test": "virmator test-web",
+        "test:all": "concurrently --colors --kill-others-on-fail -c auto --names test,docs \"npm run test:coverage\" \"npm run test:docs\"",
+        "test:coverage": "npm run test coverage",
+        "test:docs": "virmator docs check",
+        "test:types": "npm run compile"
+    },
+    "dependencies": {
+        "@augment-vir/common": "^28.0.2"
+    },
+    "devDependencies": {
+        "@augment-vir/browser-testing": "^28.0.2",
+        "@open-wc/testing": "^4.0.0",
+        "@types/mocha": "^10.0.6",
+        "@web/dev-server-esbuild": "^1.0.2",
+        "@web/test-runner": "^0.18.2",
+        "@web/test-runner-commands": "^0.9.0",
+        "@web/test-runner-playwright": "^0.11.0",
+        "@web/test-runner-visual-regression": "^0.9.0",
+        "istanbul-smart-text-reporter": "^1.1.4",
+        "markdown-code-example-inserter": "^1.0.0",
+        "typedoc": "^0.25.13"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './parse-primary-reviewers.js';

package/src/parse-primary-reviewers.test.ts

@@ -0,0 +1,36 @@
+import {itCases} from '@augment-vir/browser-testing';
+import {parsePrimaryReviewers} from './parse-primary-reviewers';
+
+describe(parsePrimaryReviewers.name, () => {
+    itCases(parsePrimaryReviewers, [
+        {
+            it: 'handles "reviewer"',
+            input: {bodyText: 'primary reviewer @my-name'},
+            expect: ['my-name'],
+        },
+        {
+            it: 'handles "reviewers"',
+            input: {bodyText: 'primary reviewers @my-name'},
+            expect: ['my-name'],
+        },
+        {
+            it: 'handles an actual pull request body',
+            input: {
+                bodyText:
+                    'https://my-ticket-url.com/ticket-number\nPrimary reviewer:\n@my-name1\n@my-name2\nChanges\n\nadd primary reviewer support\n\nHow to test\nNothing to test.',
+            },
+            expect: [
+                'my-name1',
+                'my-name2',
+            ],
+        },
+        {
+            it: 'handles no reviewers',
+            input: {
+                bodyText:
+                    'https://my-ticket-url.com/ticket-number\nPrimary rev name1\n@my-name2\nChanges\n\nadd primary reviewer support\n\nHow to test\nNothing to test.',
+            },
+            expect: [],
+        },
+    ]);
+});

package/src/parse-primary-reviewers.ts

@@ -0,0 +1,26 @@
+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}: {bodyText: string}): string[] {
+    const [
+        ,
+        match,
+    ] = safeMatch(bodyText, /primary reviewers?((?:[^@]*@[\w\-_\d]+(?:[\s\n]|$))+)/i);
+
+    if (!match) {
+        return [];
+    }
+
+    const userTags = Array.from(match.matchAll(/@[\w\-\d]+/g));
+
+    return userTags.map((userTag) => removePrefix({value: userTag[0], prefix: '@'}));
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "outDir": "dist/",
+        "rootDir": "src/"
+    },
+    "exclude": [
+        "./configs",
+        "./coverage",
+        "./dist",
+        "./dist-*",
+        "./node_modules",
+        "./test-files",
+        "./ts.out"
+    ],
+    "extends": "../../configs/tsconfig.base.json"
+}