@review-vir/common 1.0.0 → 1.0.2

package/dist/index.js

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

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

@@ -0,0 +1,13 @@
+/**
+ * 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/{src/parse-primary-reviewers.ts → dist/parse-primary-reviewers.js}

@@ -1,5 +1,4 @@
-import {removePrefix, safeMatch} from '@augment-vir/common';
-
+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:
@@ -10,17 +9,11 @@ import {removePrefix, safeMatch} from '@augment-vir/common';
  *
  * `['username', 'otherUsername']`
  */
-export function parsePrimaryReviewers({bodyText}: {bodyText: string}): string[] {
-    const [
-        ,
-        match,
-    ] = safeMatch(bodyText, /primary reviewers?((?:[^@]*@[\w\-_\d]+(?:[\s\n]|$))+)/i);
-
+export function parsePrimaryReviewers({ bodyText }) {
+    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: '@'}));
+    return userTags.map((userTag) => removePrefix({ value: userTag[0], prefix: '@' }));
 }

package/package.json

@@ -1,20 +1,18 @@
 {
     "name": "@review-vir/common",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "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"
-    },
+    "repository": "git+https://github.com/review-vir/review-vir.git",
     "license": "(MIT or CC0 1.0)",
     "author": {
         "name": "electrovir",
         "url": "https://github.com/electrovir"
     },
-    "module": "dist/index.js",
+    "type": "module",
+    "main": "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/",

package/configs/typedoc.config.ts

@@ -1,15 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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/src/parse-primary-reviewers.test.ts

@@ -1,36 +0,0 @@
-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/tsconfig.json

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