virtual-code-owners 2.1.0 → 2.2.1

package/README.md

@@ -22,8 +22,8 @@ or, if you want to be verbose
 ```
 npx virtual-code-owners \
   --virtual-code-owners .github/VIRTUAL-CODEOWNERS.txt \
-  --virtual-teams .github/virtual-teams.yml \
-  --code-owners .github/CODEOWNERS
+  --virtual-teams       .github/virtual-teams.yml \
+  --code-owners         .github/CODEOWNERS
 ```
 
 ## Why?
@@ -38,59 +38,114 @@ have the following choices:
   though there are good people on many levels in bureaucracies, it might
   eventually not pan out because #reasons.
 - Maintain a CODEOWNERS file with code assigned to large lists of individuals.  
-  An option, but laborious to maintain.
-- Use `virtual-code-owners`.
+  An option, but laborious to maintain, even for smaller projects; for example:
+
+```CODEOWNERS
+# catch-all to ensure there at least _is_ a code owner, even when
+# it's _everyone_
+
+* @cloud-heroes-all
+
+# admin & ci stuff => transversal
+
+.github/                @abraham-lincoln @benjamin-franklin @koos-koets @luke-the-lucky-ch @mary-the-merry-ch @naomi-the-namegiver-ch
+
+# generic stuff
+
+apps/framework/         @abraham-lincoln @benjamin-franklin @koos-koets @luke-the-lucky-ch @mary-the-merry-ch @naomi-the-namegiver-ch
+apps/ux-portal/         @abraham-lincoln @benjamin-franklin @charlotte-de-bourbon-ch @davy-davidson-ch @joe-dalton-ch @john-johnson-ch @koos-koets @luke-the-lucky-ch @mary-the-merry-ch @naomi-the-namegiver-ch
+libs/components/        @charlotte-de-bourbon-ch @davy-davidson-ch @joe-dalton-ch @john-johnson-ch @koos-koets
+
+# specific functionality
+
+libs/ubc-sales/         @abraham-ableton-ch @boris-bubbleblower-ch @charlotte-charleston-ch @dagny-taggert-ch @gregory-gregson-ch @jane-doe-ch @karl-marx-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
+```
+
+This is where `virtual-code-owners` comes in.
 
 ## Formats
 
 ### 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`.
+This enables you to write a _much_ easier to maintain list of code owners.
 
-Example:
+For example the CODEOWNERS file above can then look like this:
 
-```
-#! comments that start with #! won't appear in the CODEOWNERS output e.g.
+```CODEOWNERS
+#! comments that start with #! won't appear in the CODEOWNERS output
+#!
 #! this is not the CODEOWNERS file - to get that one run
-#!   npx virtual-code-owners VIRTUAL-CODE-OWNERS.txt virtual-teams.yml > CODEOWNERS
-#! on this.
+#!   npx virtual-code-owners
 #!
-# Regular comments are retained
+# catch-all to ensure there at least _is_ a code owner, even when
+# it's _everyone_
+
 * @cloud-heroes-all
-.github/ @ch/transversal
-apps/broker @ch/transversal
-apps/ux-portal/ @ch/ux @ch/transversal
-libs/ubc-sales/ @ch/sales
-libs/ubc-after-sales/ @ch/after-sales
-libs/ubc-pre-sales/ @ch/pre-sales
-libs/components/ @ch/ux
+
+# admin & ci stuff => transversal
+
+.github/                @ch/transversal
+
+# generic stuff
+
+apps/framework/         @ch/transversal
+apps/ux-portal/         @ch/ux @ch/transversal
+libs/components/        @ch/ux
+
+# specific functionality
+
+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
 ```
 
 ### virtual-teams.yml
 
-A valid YAML file that contains a list of teams, with for each team its members:
+A valid YAML file that contains a list of teams, with for each team its members.
+If a new team member joins, you can enter it here, run `npx virtual-code-owners`
+to update CODEOWNERS.
 
 ```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
   - william-the-fourth-ch
+  - daisy-duck
+  - donald-duck
 ch/sales:
   - gregory-gregson-ch
   - jane-doe-ch
+  - abraham-ableton-ch
+  - boris-bubbleblower-ch
+  - charlotte-charleston-ch
+  - dagny-taggert-ch
+  - karl-marx-ch
 ch/pre-sales:
   - jean-claude-ch
   - valerie-valerton-ch
   - averel-dalton-ch
+  - john-galt-ch
 ch/ux:
   - davy-davidson-ch
   - john-johnson-ch
   - joe-dalton-ch
+  - koos-koets
+  - charlotte-de-bourbon-ch
 ch/transversal:
+  - mary-the-merry-ch
   - luke-the-lucky-ch
-# etc
+  - naomi-the-namegiver-ch
+  - benjamin-franklin
+  - koos-koets
+  - abraham-lincoln
 ```
 
 ## FAQ
@@ -114,14 +169,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 be cryptic.
 
 ### Why the `.txt` extension?
 

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

@@ -1,46 +1,49 @@
 import { EOL } from "node:os";
-const DEFAULT_GENERATED_WARNING = `#${EOL}` +
+const DEFAULT_WARNING = `#${EOL}` +
     `# DO NOT EDIT - this file is generated and your edits will be overwritten${EOL}` +
     `#${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;
+export function convert(pCodeOwnersFileAsString, pTeamMap, pGeneratedWarning = DEFAULT_WARNING) {
+    return (pGeneratedWarning +
+        pCodeOwnersFileAsString
+            .split(EOL)
+            .filter(shouldAppearInResult)
+            .map(convertLine(pTeamMap))
+            .join(EOL));
+}
+function shouldAppearInResult(pLine) {
+    return !pLine.trimStart().startsWith("#!");
 }
 function convertLine(pTeamMap) {
     return (pUntreatedLine) => {
-        const lTrimmedLine = pUntreatedLine.trimStart();
-        if (lTrimmedLine.startsWith("#") || lTrimmedLine === "") {
+        const lTrimmedLine = pUntreatedLine.trim();
+        const lSplitLine = lTrimmedLine.match(/^(?<filesPattern>[^\s]+\s+)(?<userNames>.*)$/);
+        if (lTrimmedLine.startsWith("#") ||
+            lTrimmedLine === "" ||
+            !lSplitLine?.groups) {
             return pUntreatedLine;
         }
-        else {
-            return replaceTeamNames(pUntreatedLine, pTeamMap);
-        }
+        const lUserNames = replaceTeamNames(lSplitLine.groups.userNames, pTeamMap);
+        return lSplitLine.groups.filesPattern + uniqAndSortUserNames(lUserNames);
     };
 }
-function deduplicateUserNames(pLine) {
-    const lTrimmedLine = pLine.trim();
-    const lSplitLine = lTrimmedLine.match(/^(?<filesPattern>[^\s]+)(?<theRest>.*)$/);
-    if (lTrimmedLine.startsWith("#") || !lSplitLine?.groups) {
-        return pLine;
+function replaceTeamNames(pUserNames, pTeamMap) {
+    let lReturnValue = pUserNames;
+    for (let lTeamName of Object.keys(pTeamMap)) {
+        lReturnValue = lReturnValue.replace(new RegExp(`(\\s|^)@${lTeamName}(\\s|$)`, "g"), `$1${stringifyTeamMembers(pTeamMap, lTeamName)}$2`);
     }
-    return `${lSplitLine.groups.filesPattern} ${Array.from(new Set(lSplitLine.groups.theRest.trim().split(/\s+/))).join(" ")}`;
+    return lReturnValue;
 }
-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 uniqAndSortUserNames(pUserNames) {
+    return Array.from(new Set(pUserNames.split(/\s+/)))
+        .sort()
+        .join(" ");
 }

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "virtual-code-owners",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "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.11.0",
     "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",