virtual-code-owners 2.1.0 → 2.2.0

package/README.md

@@ -45,8 +45,8 @@ have the following choices:
 
 ### VIRTUAL-CODEOWNERS.txt
 
-`VIRTUAL_CODEOWNERS.txt` is a regular, valid GitHub [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-and-branch-protection) file.
-The only difference between VIRTUAL-CODEOWNERS and a CODEOWNERS file is that
+`VIRTUAL_CODEOWNERS.txt` is a regular, valid GitHub [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file.
+The only difference between VIRTUAL-CODEOWNERS.txt and a CODEOWNERS file is that
 the _teams_ the former uses might not exist yet, except in a `virtual-teams.yml`.
 
 Example:
@@ -54,7 +54,7 @@ Example:
 ```
 #! comments that start with #! won't appear in the CODEOWNERS output e.g.
 #! this is not the CODEOWNERS file - to get that one run
-#!   npx virtual-code-owners VIRTUAL-CODE-OWNERS.txt virtual-teams.yml > CODEOWNERS
+#!   npx virtual-code-owners
 #! on this.
 #!
 # Regular comments are retained
@@ -73,6 +73,7 @@ libs/components/ @ch/ux
 A valid YAML file that contains a list of teams, with for each team its members:
 
 ```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/sverweij/virtual-code-owners/main/src/virtual-teams.schema.json
 ch/after-sales:
   - john-doe-ch
   - pete-peterson-ch
@@ -114,14 +115,10 @@ team name and _virtual-code-owners_ will leave the real name alone.
 
 - Currently only works for _usernames_ to identify team members - not for e-mail
   addresses.
-- If people are in more than one team, chances are they get mentioned multiple
-  times on the same line if both teams are code owners of the same part of the
-  code. While maybe not _looking_ ideal, the resulting code owners file is still
-  valid & ready to rock'n roll.
 - _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
-  assumption is not met, but the error-messages might not be as clear as possible.
+  assumption is not met, but the error-messages might not be cryptic.
 
 ### Why the `.txt` extension?
 

package/dist/convert-virtual-code-owners.js

@@ -5,42 +5,52 @@ const DEFAULT_GENERATED_WARNING = `#${EOL}` +
     `# To make changes:${EOL}` +
     `#${EOL}` +
     `#   - edit .github/VIRTUAL-CODEOWNERS.txt${EOL}` +
+    `#   - and/ or add team members to .github/virtual-teams.yml${EOL}` +
     `#   - run 'npx virtual-code-owners'${EOL}` +
     `#${EOL}${EOL}`;
-function replaceTeamNames(pLine, pTeamMap) {
-    let lReturnValue = pLine;
-    for (let lTeamName of Object.keys(pTeamMap)) {
-        lReturnValue = lReturnValue.replace(new RegExp(`(\\s)@${lTeamName}(\\s|$)`, "g"), `$1${pTeamMap[lTeamName].map((pUserName) => `@${pUserName}`).join(" ")}$2`);
-    }
-    return lReturnValue;
+const LINE_PATTERN = /^(?<filesPattern>[^\s]+\s+)(?<userNames>.*)$/;
+export function convert(pCodeOwnersFileAsString, pTeamMap, pGeneratedWarning = DEFAULT_GENERATED_WARNING) {
+    return `${pGeneratedWarning}${pCodeOwnersFileAsString
+        .split(EOL)
+        .filter(shouldAppearInResult)
+        .map(convertLine(pTeamMap))
+        .map(deduplicateUserNames)
+        .join(EOL)}`;
+}
+function shouldAppearInResult(pLine) {
+    return !pLine.trimStart().startsWith("#!");
 }
 function convertLine(pTeamMap) {
     return (pUntreatedLine) => {
-        const lTrimmedLine = pUntreatedLine.trimStart();
+        const lTrimmedLine = pUntreatedLine.trim();
         if (lTrimmedLine.startsWith("#") || lTrimmedLine === "") {
             return pUntreatedLine;
         }
         else {
-            return replaceTeamNames(pUntreatedLine, pTeamMap);
+            return replaceTeamNames(lTrimmedLine, pTeamMap);
         }
     };
 }
-function deduplicateUserNames(pLine) {
-    const lTrimmedLine = pLine.trim();
-    const lSplitLine = lTrimmedLine.match(/^(?<filesPattern>[^\s]+)(?<theRest>.*)$/);
-    if (lTrimmedLine.startsWith("#") || !lSplitLine?.groups) {
-        return pLine;
+function replaceTeamNames(pTrimmedLine, pTeamMap) {
+    const lSplitLine = pTrimmedLine.match(LINE_PATTERN);
+    if (!lSplitLine?.groups) {
+        return pTrimmedLine;
     }
-    return `${lSplitLine.groups.filesPattern} ${Array.from(new Set(lSplitLine.groups.theRest.trim().split(/\s+/))).join(" ")}`;
+    let lUserNames = lSplitLine.groups.userNames.trim();
+    for (let lTeamName of Object.keys(pTeamMap)) {
+        lUserNames = lUserNames.replace(new RegExp(`(\\s|^)@${lTeamName}(\\s|$)`, "g"), `$1${stringifyTeamMembers(pTeamMap, lTeamName)}$2`);
+    }
+    return `${lSplitLine.groups.filesPattern}${lUserNames}`;
 }
-function shouldAppearInResult(pLine) {
-    return !pLine.trimStart().startsWith("#!");
+function stringifyTeamMembers(pTeamMap, pTeamName) {
+    return pTeamMap[pTeamName].map((pUserName) => `@${pUserName}`).join(" ");
 }
-export function convert(pCodeOwnersFileAsString, pTeamMap, pGeneratedWarning = DEFAULT_GENERATED_WARNING) {
-    return `${pGeneratedWarning}${pCodeOwnersFileAsString
-        .split(EOL)
-        .filter(shouldAppearInResult)
-        .map(convertLine(pTeamMap))
-        .map(deduplicateUserNames)
-        .join(EOL)}`;
+function deduplicateUserNames(pTrimmedLine) {
+    const lSplitLine = pTrimmedLine.match(LINE_PATTERN);
+    if (pTrimmedLine.startsWith("#") || !lSplitLine?.groups) {
+        return pTrimmedLine;
+    }
+    return `${lSplitLine.groups.filesPattern}${Array.from(new Set(lSplitLine.groups.userNames.trim().split(/\s+/)))
+        .sort()
+        .join(" ")}`;
 }

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "2.1.0";
+export const VERSION = "2.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "virtual-code-owners",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS",
   "type": "module",
   "exports": {
@@ -54,17 +54,17 @@
   "devDependencies": {
     "@types/js-yaml": "4.0.5",
     "@types/mocha": "10.0.1",
-    "@types/node": "18.14.6",
+    "@types/node": "18.15.3",
     "c8": "7.13.0",
-    "dependency-cruiser": "12.10.0",
+    "dependency-cruiser": "12.10.2",
     "husky": "8.0.3",
-    "lint-staged": "13.1.2",
+    "lint-staged": "13.2.0",
     "mocha": "10.2.0",
     "prettier": "2.8.4",
     "ts-node": "10.9.1",
-    "typescript": "4.9.5",
+    "typescript": "5.0.2",
     "upem": "7.3.2",
-    "watskeburt": "0.10.0"
+    "watskeburt": "0.10.1"
   },
   "dependencies": {
     "commander": "10.0.0",