virtual-code-owners 6.1.0 → 6.1.2

package/dist/generate-labeler-yml.js

@@ -23,8 +23,7 @@ export default function generateLabelerYml(pCodeOwners, pTeamMap, pGeneratedWarn
 function getPatternsForTeam(pCodeOwners, pTeamName) {
     return (pCodeOwners
         .filter((pLine) => {
-        const isARule = pLine.type === "rule";
-        return (isARule &&
+        return (pLine.type === "rule" &&
             lineContainsTeamName(pLine, pTeamName));
     })
         .map((pLine) => pLine.filesPattern));

package/dist/main.js

@@ -28,7 +28,7 @@ Options:
   --dryRun                             Just validate inputs, don't generate
                                        outputs (default: false)
   -h, --help                           display help for command`;
-export function cli(pArguments = process.argv.slice(2), pOutStream = process.stdout, pErrorStream = process.stderr) {
+export function cli(pArguments = process.argv.slice(2), pOutStream = process.stdout, pErrorStream = process.stderr, pErrorExitCode = 1) {
     try {
         const lOptions = getOptions(pArguments);
         if (lOptions.help) {
@@ -43,7 +43,7 @@ export function cli(pArguments = process.argv.slice(2), pOutStream = process.std
     }
     catch (pError) {
         pErrorStream.write(`${EOL}ERROR: ${pError.message}${EOL}${EOL}`);
-        process.exitCode = 1;
+        process.exitCode = pErrorExitCode;
     }
 }
 function getOptions(pArguments) {

package/dist/read-team-map.js

@@ -8,10 +8,10 @@ export default function readTeamMap(pVirtualTeamsFileName) {
         encoding: "utf-8",
     });
     const lTeamMap = parseYaml(lVirtualTeamsAsAString);
-    validateTeamMap(lTeamMap, pVirtualTeamsFileName);
+    assertTeamMapValid(lTeamMap, pVirtualTeamsFileName);
     return lTeamMap;
 }
-function validateTeamMap(pTeamMap, pVirtualTeamsFileName) {
+function assertTeamMapValid(pTeamMap, pVirtualTeamsFileName) {
     const ajv = new Ajv({
         allErrors: true,
         verbose: true,

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "6.1.0";
+export const VERSION = "6.1.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "virtual-code-owners",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "description": "Makes your CODEOWNERS file liveable again",
   "type": "module",
   "exports": {
@@ -30,7 +30,8 @@
   "types": "types/types.d.ts",
   "bin": "dist/cli.js",
   "files": [
-    "dist",
+    "dist/",
+    "types/",
     "package.json",
     "README.md",
     "LICENSE"
@@ -44,10 +45,10 @@
     "depcruise:graph:diff:dev": "depcruise src --prefix vscode://file/$(pwd)/ --output-type dot --reaches \"$(watskeburt $SHA -T regex)\"| dot -T svg | depcruise-wrap-stream-in-html | browser",
     "depcruise:graph:diff:mermaid": "depcruise src tools --output-type mermaid --output-to - --reaches \"$(watskeburt $SHA -T regex)\"",
     "depcruise:html": "depcruise src tools --output-type err-html --output-to dependency-violation-report.html",
-    "format": "prettier --loglevel warn --write \"**/*.{md,ts,json,yml}\"",
+    "format": "prettier --log-level warn --write \"**/*.{md,ts,json,yml}\"",
     "prepare": "husky install",
     "scm:stage": "git add .",
-    "test": "NODE_OPTIONS=--no-warnings c8 mocha",
+    "test": "c8 node --no-warnings --loader 'ts-node/esm' --test-reporter ./tools/dot-with-summary.reporter.js --test src/*.test.ts",
     "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",
@@ -68,18 +69,16 @@
     "url": "https://github.com/sverweij/virtual-code-owners/issues"
   },
   "devDependencies": {
-    "@types/mocha": "10.0.1",
-    "@types/node": "20.3.1",
-    "c8": "8.0.0",
-    "dependency-cruiser": "13.0.3",
+    "@types/node": "20.5.6",
+    "c8": "8.0.1",
+    "dependency-cruiser": "13.1.4",
     "husky": "8.0.3",
-    "lint-staged": "13.2.2",
-    "mocha": "10.2.0",
-    "prettier": "2.8.8",
+    "lint-staged": "14.0.1",
+    "prettier": "3.0.2",
     "ts-node": "10.9.1",
-    "typescript": "5.1.3",
+    "typescript": "5.2.2",
     "upem": "8.0.0",
-    "watskeburt": "0.11.3"
+    "watskeburt": "1.0.1"
   },
   "dependencies": {
     "ajv": "8.12.0",

package/types/generate-codeowners.d.ts

@@ -0,0 +1,6 @@
+import type { ITeamMap, IVirtualCodeOwnersCST } from "./types.js";
+export default function generateCodeOwners(
+  pVirtualCodeOwners: IVirtualCodeOwnersCST,
+  pTeamMap: ITeamMap,
+  pGeneratedWarning?: string,
+): string;

package/types/generate-labeler-yml.d.ts

@@ -0,0 +1,6 @@
+import type { ITeamMap, IVirtualCodeOwnersCST } from "./types.js";
+export default function generateLabelerYml(
+  pCodeOwners: IVirtualCodeOwnersCST,
+  pTeamMap: ITeamMap,
+  pGeneratedWarning?: string,
+): string;

package/types/parse-virtual-code-owners.d.ts

@@ -0,0 +1,18 @@
+import type { IAnomaly, ITeamMap, IVirtualCodeOwnersCST } from "./types.js";
+/**
+ * parses (virtual) codeowners as a string into a virtual codeowners CST
+ * which can be used to do further  rocessing on (e.g. generate codeowners,
+ * validate etc.)
+ *
+ * @param pVirtualCodeOwnersAsString CODEOWNERS or VIRTUAL-CODE-OWNERS.txt file  to parse
+ * @param pTeamMap a virtual team map  ()
+ * @returns a virtual code owners CST
+ */
+export declare function parse(
+  pVirtualCodeOwnersAsString: string,
+  pTeamMap?: ITeamMap,
+): IVirtualCodeOwnersCST;
+
+export declare function getAnomalies(
+  pVirtualCodeOwners: IVirtualCodeOwnersCST,
+): IAnomaly[];

package/types/types.d.ts

@@ -0,0 +1,44 @@
+export interface ITeamMap {
+  [teamName: string]: string[];
+}
+
+export type IVirtualCodeOwnersCST = IVirtualCodeOwnerLine[];
+export type IVirtualCodeOwnerLine = IBoringCSTLine | IInterestingCSTLine;
+export interface IBoringCSTLine {
+  type: "comment" | "ignorable-comment" | "empty" | "unknown";
+  line: number;
+  raw: string;
+}
+export interface IInterestingCSTLine {
+  type: "rule";
+  line: number;
+  filesPattern: string;
+  spaces: string;
+  users: IUser[];
+  raw: string;
+}
+export type UserType =
+  | "virtual-team-name"
+  | "e-mail-address"
+  | "other-user-or-team"
+  | "invalid";
+export type IUser = {
+  type: UserType;
+  userNumberWithinLine: number;
+  bareName: string;
+  raw: string;
+};
+
+export type IAnomaly = ILineAnomaly | IUserAnomaly;
+export interface ILineAnomaly {
+  type: "invalid-line";
+  line: number;
+  raw: string;
+}
+export interface IUserAnomaly {
+  type: "invalid-user";
+  line: number;
+  userNumberWithinLine: number;
+  bareName: string;
+  raw: string;
+}