virtual-code-owners 4.0.0 → 4.1.0

package/README.md

@@ -62,6 +62,7 @@ libs/ubc-sales/         @abraham-ableton-ch @boris-bubbleblower-ch @charlotte-ch
 libs/ubc-after-sales/   @daisy-duck @donald-duck @john-doe-ch @pete-peterson-ch @william-the-fourth-ch
 libs/ubc-pre-sales/     @averel-dalton-ch @jean-claude-ch @john-galt-ch @valerie-valerton-ch
 libs/ubc-refund/        @abraham-ableton-ch @boris-bubbleblower-ch @charlotte-charleston-ch @dagny-taggert-ch @daisy-duck @donald-duck @gregory-gregson-ch @jane-doe-ch @john-doe-ch @karl-marx-ch @pete-peterson-ch @william-the-fourth-ch
+libs/ubc-baarden/       jan@example.com korneel@example.com pier@example.com tjorus@example.com
 ```
 
 This is where `virtual-code-owners` comes in.
@@ -104,6 +105,7 @@ libs/ubc-sales/         @ch/sales
 libs/ubc-after-sales/   @ch/after-sales
 libs/ubc-pre-sales/     @ch/pre-sales
 libs/ubc-refund/        @ch/sales @ch/after-sales
+libs/ubc-baarden/       @ch/mannen-met-baarden
 ```
 
 ### virtual-teams.yml
@@ -167,8 +169,9 @@ team name and _virtual-code-owners_ will leave the real name alone.
 
 ### Any limitations I should know of?
 
-- Currently only works for _usernames_ to identify team members - not for e-mail
-  addresses.
+- ~~Currently only works for _user names_ to identify team members - not for e-mail
+  addresses.~~
+  Works with both user names and e-mail addresses
 - _virtual-code-owners_ assumes the VIRTUAL-CODEOWNERS.txt is a valid CODEOWNERS
   file and the virtual-teams.yml is a valid yaml file with teams names as keys
   and team members as arrays under these. It will likely throw errors when this
@@ -178,7 +181,7 @@ team name and _virtual-code-owners_ will leave the real name alone.
 
 Various editors assume an ALL_CAPS file name with `#` characters on various lines
 to be markdown, and will auto format them as such - making for either very ugly
-or in worst cases invalid CODOWNERS files. Usually such autoformatting is not
+or in worst cases invalid CODEOWNERS files. Usually such autoformatting is not
 present on text files.
 
 Apparently these editors know about CODEOWNERS, though so this auto formatting

package/dist/cli.js

@@ -1,71 +1,3 @@
 #!/usr/bin/env node
-import { VERSION } from "./version.js";
-import { readAndConvert } from "./read-and-convert.js";
-import { writeFileSync } from "node:fs";
-import { EOL } from "node:os";
-import { parseArgs } from "node:util";
-let lOptions;
-try {
-    let lParsedArgs = parseArgs({
-        args: process.argv.slice(2),
-        options: {
-            virtualCodeOwners: {
-                type: "string",
-                short: "v",
-                default: ".github/VIRTUAL-CODEOWNERS.txt",
-            },
-            virtualTeams: {
-                type: "string",
-                short: "t",
-                default: ".github/virtual-teams.yml",
-            },
-            codeOwners: { type: "string", short: "c", default: ".github/CODEOWNERS" },
-            help: { type: "boolean", short: "h", default: false },
-            version: { type: "boolean", short: "V", default: false },
-        },
-        strict: true,
-        allowPositionals: true,
-        tokens: false,
-    });
-    lOptions = lParsedArgs.values;
-    if (lOptions.help) {
-        showHelp();
-        process.exit(0);
-    }
-    if (lOptions.version) {
-        console.log(VERSION);
-        process.exit(0);
-    }
-}
-catch (pError) {
-    console.error(`${EOL}ERROR: ${pError.message}${EOL}`);
-    process.exit(1);
-}
-function showHelp() {
-    console.log(`Usage: virtual-code-owners [options]
-
-Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS
-
-Options:
-  -V, --version                        output the version number
-  -v, --virtualCodeOwners [file-name]  A CODEOWNERS file with team names in them 
-                                       that are defined in a virtual teams file
-                                       (default: ".github/VIRTUAL-CODEOWNERS.txt")
-  -t, --virtualTeams [file-name]       A YAML file listing teams and their 
-                                       members
-                                       (default: ".github/virtual-teams.yml")
-  -c, --codeOwners [file-name]         The location of the CODEOWNERS file 
-                                       (default: ".github/CODEOWNERS")
-  -h, --help                           display help for command`);
-}
-try {
-    const lCodeOwnersContent = readAndConvert(lOptions.virtualCodeOwners, lOptions.virtualTeams);
-    writeFileSync(lOptions.codeOwners, lCodeOwnersContent, {
-        encoding: "utf-8",
-    });
-    console.error(`${EOL}Wrote ${lOptions.codeOwners}${EOL}`);
-}
-catch (pError) {
-    console.error(`ERROR: ${pError.message}`);
-    process.exitCode = 1;
-}
+import { main } from "./main.js";
+main();

package/dist/{convert-virtual-code-owners.js → convert-to-codeowners.js}

@@ -40,7 +40,16 @@ function replaceTeamNames(pUserNames, pTeamMap) {
     return lReturnValue;
 }
 function stringifyTeamMembers(pTeamMap, pTeamName) {
-    return pTeamMap[pTeamName].map((pUserName) => `@${pUserName}`).join(" ");
+    return pTeamMap[pTeamName]
+        .map((pUserName) => userNameToCodeOwner(pUserName))
+        .join(" ");
+}
+function userNameToCodeOwner(pUserName) {
+    const lEmailIshUsernameRE = /^.+@.+$/;
+    if (pUserName.match(lEmailIshUsernameRE)) {
+        return pUserName;
+    }
+    return `@${pUserName}`;
 }
 function uniqAndSortUserNames(pUserNames) {
     return Array.from(new Set(pUserNames.split(/\s+/)))

package/dist/main.js

@@ -0,0 +1,69 @@
+import { VERSION } from "./version.js";
+import { readAndConvert } from "./read-and-convert.js";
+import { writeFileSync } from "node:fs";
+import { EOL } from "node:os";
+import { parseArgs } from "node:util";
+const HELP_MESSAGE = `Usage: virtual-code-owners [options]
+
+Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS
+
+Options:
+  -V, --version                        output the version number
+  -v, --virtualCodeOwners [file-name]  A CODEOWNERS file with team names in them 
+                                       that are defined in a virtual teams file
+                                       (default: ".github/VIRTUAL-CODEOWNERS.txt")
+  -t, --virtualTeams [file-name]       A YAML file listing teams and their 
+                                       members
+                                       (default: ".github/virtual-teams.yml")
+  -c, --codeOwners [file-name]         The location of the CODEOWNERS file 
+                                       (default: ".github/CODEOWNERS")
+  -h, --help                           display help for command`;
+export function main(pArguments = process.argv.slice(2), pOutStream = process.stdout, pErrorStream = process.stderr) {
+    try {
+        let lOptions = getOptions(pArguments);
+        if (lOptions.help) {
+            pOutStream.write(`${HELP_MESSAGE}${EOL}`);
+            return;
+        }
+        if (lOptions.version) {
+            pOutStream.write(`${VERSION}${EOL}`);
+            return;
+        }
+        const lCodeOwnersContent = readAndConvert(lOptions.virtualCodeOwners, lOptions.virtualTeams);
+        writeFileSync(lOptions.codeOwners, lCodeOwnersContent, {
+            encoding: "utf-8",
+        });
+        pErrorStream.write(`${EOL}Wrote ${lOptions.codeOwners}${EOL}${EOL}`);
+    }
+    catch (pError) {
+        pErrorStream.write(`${EOL}ERROR: ${pError.message}${EOL}${EOL}`);
+        process.exitCode = 1;
+    }
+}
+function getOptions(pArguments) {
+    return parseArgs({
+        args: pArguments,
+        options: {
+            virtualCodeOwners: {
+                type: "string",
+                short: "v",
+                default: ".github/VIRTUAL-CODEOWNERS.txt",
+            },
+            virtualTeams: {
+                type: "string",
+                short: "t",
+                default: ".github/virtual-teams.yml",
+            },
+            codeOwners: {
+                type: "string",
+                short: "c",
+                default: ".github/CODEOWNERS",
+            },
+            help: { type: "boolean", short: "h", default: false },
+            version: { type: "boolean", short: "V", default: false },
+        },
+        strict: true,
+        allowPositionals: true,
+        tokens: false,
+    }).values;
+}

package/dist/read-and-convert.js

@@ -1,6 +1,6 @@
 import { readFileSync } from "node:fs";
 import yaml from "js-yaml";
-import { convert } from "./convert-virtual-code-owners.js";
+import { convert } from "./convert-to-codeowners.js";
 export function readAndConvert(pVirtualCodeOwnersFileName, pVirtualTeamsFileName) {
     const lVirtualCodeOwnersAsAString = readFileSync(pVirtualCodeOwnersFileName, {
         encoding: "utf-8",

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "4.0.0";
+export const VERSION = "4.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "virtual-code-owners",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS",
   "type": "module",
   "exports": {
@@ -54,9 +54,9 @@
   "devDependencies": {
     "@types/js-yaml": "4.0.5",
     "@types/mocha": "10.0.1",
-    "@types/node": "20.2.1",
-    "c8": "7.13.0",
-    "dependency-cruiser": "13.0.1",
+    "@types/node": "20.2.5",
+    "c8": "7.14.0",
+    "dependency-cruiser": "13.0.2",
     "husky": "8.0.3",
     "lint-staged": "13.2.2",
     "mocha": "10.2.0",
@@ -64,7 +64,7 @@
     "ts-node": "10.9.1",
     "typescript": "5.0.4",
     "upem": "7.3.2",
-    "watskeburt": "0.11.2"
+    "watskeburt": "0.11.3"
   },
   "dependencies": {
     "js-yaml": "4.1.0"