virtual-code-owners 1.0.0 → 2.1.0

package/README.md

@@ -5,16 +5,25 @@ This takes a
 - VIRTUAL-CODEOWNERS.txt file with (virtual) teams
 - a `virtual-teams.yml` file which define the teams
 
-... and churns out a CODEOWNERS with user names.
+... and merges them into a CODEOWNERS with user names.
 
 ## Usage
 
-- Rename your `CODEOWNERS` to `VIRTUAL-CODEOWNERS.txt` and put team names in them.
-- Specify team names that don't (yet) exist on GitHub level in a `virtual-teams.yml`
+- Rename your `.github/CODEOWNERS` to `.github/VIRTUAL-CODEOWNERS.txt` and put team names in them.
+- Specify team names that don't (yet) exist on GitHub level in a `.github/virtual-teams.yml`
 - Run this:
 
 ```
-npx virtual-code-owners VIRTUAL-CODEOWNERS.txt virtual-teams.yml > .github/CODEOWNERS
+npx virtual-code-owners
+```
+
+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
 ```
 
 ## Why?
@@ -43,6 +52,12 @@ the _teams_ the former uses might not exist yet, except in a `virtual-teams.yml`
 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
+#! on this.
+#!
+# Regular comments are retained
 * @cloud-heroes-all
 .github/ @ch/transversal
 apps/broker @ch/transversal
@@ -88,7 +103,7 @@ It might be you already have a team or two defined, but just want to use
 _additional_ teams. In that case just don't specify the already-defined teams
 in `virtual-teams.yml` and _virtual-code-owners_ will leave them alone.
 
-### Can I still use usernames in `VIRTUAL-CODEOWNERS.txt`
+### Can I still use usernames in `VIRTUAL-CODEOWNERS.txt`?
 
 Yes.
 
@@ -117,3 +132,18 @@ present on text files.
 
 Apparently these editors know about CODEOWNERS, though so this auto formatting
 doesn't seem to be happening over there.
+
+### Do I have to run this each time I edit `VIRTUAL-CODEOWNERS.txt`?
+
+Yes. But please automate this for your own sake.
+
+You can for instance set up a rule for `lint-staged` in a `.lintstagedrc.json`
+like this:
+
+```json
+{
+  ".github/VIRTUAL-CODEOWNERS.txt|.github/virtual-teams.yml": [
+    "npx virtual-code-owners"
+  ]
+}
+```

package/dist/cli.js

@@ -2,14 +2,23 @@
 import { program } from "commander";
 import { VERSION } from "./version.js";
 import { readAndConvert } from "./read-and-convert.js";
+import { writeFileSync } from "node:fs";
+import { EOL } from "node:os";
 program
-    .description("Takes a VIRTUAL-CODEOWNERS.txt & a virtual-teams.yml and emits a CODEOWNERS to stdout")
+    .description("Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS")
     .version(VERSION)
-    .arguments("<virtual-code-owners-file> <virtual-teams.yml>")
+    .option("-v, --virtual-code-owners [file-name]", "A CODEOWNERS file with team names in them that are defined in a virtual teams file", ".github/VIRTUAL-CODEOWNERS.txt")
+    .option("-t, --virtual-teams [file-name]", "A YAML file listing teams and their members", ".github/virtual-teams.yml")
+    .option("-c, --code-owners [file-name]", "The location of the CODEOWNERS file", ".github/CODEOWNERS")
     .parse(process.argv);
 try {
-    console.log(readAndConvert(program.args[0], program.args[1]));
+    const lCodeOwnersContent = readAndConvert(program.opts().virtualCodeOwners, program.opts().virtualTeams);
+    writeFileSync(program.opts().codeOwners, lCodeOwnersContent, {
+        encoding: "utf-8",
+    });
+    console.error(`${EOL}Wrote ${program.opts().codeOwners}${EOL}`);
 }
 catch (pError) {
     console.error(`ERROR: ${pError.message}`);
+    process.exitCode = 1;
 }

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

@@ -4,13 +4,13 @@ const DEFAULT_GENERATED_WARNING = `#${EOL}` +
     `#${EOL}` +
     `# To make changes:${EOL}` +
     `#${EOL}` +
-    `#   - edit VIRTUAL-CODEOWNERS.txt${EOL}` +
-    `#   - run 'npx virtual-code-owners VIRTUAL-CODE-OWNERS.txt virtual-teams.yml > CODEOWNERS'${EOL}` +
+    `#   - edit .github/VIRTUAL-CODEOWNERS.txt${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(`@${lTeamName}`, pTeamMap[lTeamName].map((pUserName) => `@${pUserName}`).join(" "));
+        lReturnValue = lReturnValue.replace(new RegExp(`(\\s)@${lTeamName}(\\s|$)`, "g"), `$1${pTeamMap[lTeamName].map((pUserName) => `@${pUserName}`).join(" ")}$2`);
     }
     return lReturnValue;
 }
@@ -25,9 +25,22 @@ function convertLine(pTeamMap) {
         }
     };
 }
+function deduplicateUserNames(pLine) {
+    const lTrimmedLine = pLine.trim();
+    const lSplitLine = lTrimmedLine.match(/^(?<filesPattern>[^\s]+)(?<theRest>.*)$/);
+    if (lTrimmedLine.startsWith("#") || !lSplitLine?.groups) {
+        return pLine;
+    }
+    return `${lSplitLine.groups.filesPattern} ${Array.from(new Set(lSplitLine.groups.theRest.trim().split(/\s+/))).join(" ")}`;
+}
+function shouldAppearInResult(pLine) {
+    return !pLine.trimStart().startsWith("#!");
+}
 export function convert(pCodeOwnersFileAsString, pTeamMap, pGeneratedWarning = DEFAULT_GENERATED_WARNING) {
     return `${pGeneratedWarning}${pCodeOwnersFileAsString
         .split(EOL)
+        .filter(shouldAppearInResult)
         .map(convertLine(pTeamMap))
+        .map(deduplicateUserNames)
         .join(EOL)}`;
 }

package/dist/version.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "virtual-code-owners",
-  "version": "1.0.0",
-  "description": "merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS",
+  "version": "2.1.0",
+  "description": "Merges a VIRTUAL-CODEOWNERS.txt and a virtual-teams.yml into CODEOWNERS",
   "type": "module",
   "exports": {
     ".": [
@@ -16,21 +16,23 @@
   "files": [
     "dist",
     "package.json",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
-    "build": "rm -rf dist && node tools/get-version.mjs > src/version.ts && tsc",
-    "depcruise": "depcruise src --config .dependency-cruiser.cjs",
+    "build": "rm -rf dist && ts-node --esm tools/get-version.ts > src/version.ts && tsc",
+    "check": "npm run format && npm run build && npm run depcruise -- --no-progress && npm test",
+    "depcruise": "depcruise src tools --config .dependency-cruiser.cjs",
     "depcruise:graph": "depcruise src --include-only '^(src)' --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html > dependency-graph.html",
     "depcruise:graph:dev": "depcruise src --prefix vscode://file/$(pwd)/ --config --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser",
     "depcruise:graph:diff:dev": "depcruise src --prefix vscode://file/$(pwd)/ --config --output-type dot --reaches \"$(watskeburt $SHA -T regex)\"| dot -T svg | depcruise-wrap-stream-in-html | browser",
-    "depcruise:graph:diff:mermaid": "depcruise src --config --output-type mermaid --output-to - --reaches \"$(watskeburt $SHA -T regex)\"",
-    "depcruise:html": "depcruise src --config --output-type err-html --output-to dependency-violation-report.html",
+    "depcruise:graph:diff:mermaid": "depcruise src tools --config --output-type mermaid --output-to - --reaches \"$(watskeburt $SHA -T regex)\"",
+    "depcruise:html": "depcruise src tools --config --output-type err-html --output-to dependency-violation-report.html",
     "format": "prettier --loglevel warn --write \"**/*.{md,ts,json,yml}\"",
+    "prepare": "husky install",
     "scm:stage": "git add .",
-    "test": "NODE_OPTIONS=--no-warnings mocha",
-    "test:cover": "NODE_OPTIONS=--no-warnings c8 mocha",
-    "update-dependencies": "npm run upem:update && npm run upem:install && npm run format && npm run build && npm test",
+    "test": "NODE_OPTIONS=--no-warnings c8 mocha",
+    "update-dependencies": "npm run upem:update && npm run upem:install && npm run check",
     "upem-outdated": "npm outdated --json --long | upem --dry-run",
     "upem:install": "npm install",
     "upem:update": "npm outdated --json --long | upem | pbcopy && pbpaste",
@@ -51,9 +53,12 @@
   },
   "devDependencies": {
     "@types/js-yaml": "4.0.5",
-    "@types/node": "18.14.5",
+    "@types/mocha": "10.0.1",
+    "@types/node": "18.14.6",
     "c8": "7.13.0",
     "dependency-cruiser": "12.10.0",
+    "husky": "8.0.3",
+    "lint-staged": "13.1.2",
     "mocha": "10.2.0",
     "prettier": "2.8.4",
     "ts-node": "10.9.1",