virtual-code-owners 8.0.5 → 8.1.0

package/README.md

@@ -143,7 +143,10 @@ libs/baarden/       jan@example.com korneel@example.com pier@example.com tjorus@
 
 ### Any gotcha's?
 
-It won't check whether the users or teams you entered exist.
+- It won't check whether the users or teams you entered exist.
+- Only relevant when you're on GitLab: Section heading support is experimental
+  and when generating labeler.yml default section owners aren't expanded to
+  section rules.
 
 ### Do I have to run this each time I edit `VIRTUAL-CODEOWNERS.txt`?
 
@@ -207,6 +210,10 @@ user/team names but doesn't verify their existence in the project.
 
 - valid user/team names start with an `@` or are an e-mail address
 - valid rules have a file pattern and at least one user/team name
+- valid sections headings comply with the syntax described over at [GitLab](https://docs.gitlab.com/ee/user/project/codeowners/reference.html#sections)
+  > different from GitLab's syntax the line `[bla @group` is not interpreted
+  > as a rule, but as an erroneous section heading. This behaviour might change
+  > to be the same as GitLab's in future releases without a major version bump.
 
 ### I want to specify different locations for the files (e.g. because I'm using GitLab)
 

package/dist/codeowners/generate.js

@@ -26,20 +26,32 @@ export default function generateCodeOwners(
 }
 function generateLine(pCSTLine, pTeamMap) {
 	if (pCSTLine.type === "rule") {
-		const lUserNames = uniq(
-			pCSTLine.users.flatMap((pUser) => expandTeamToUserNames(pUser, pTeamMap)),
-		)
-			.sort(compareUserNames)
-			.join(" ");
 		return (
 			pCSTLine.filesPattern +
 			pCSTLine.spaces +
-			lUserNames +
+			expandTeamsToUsersString(pCSTLine.users, pTeamMap) +
+			(pCSTLine.inlineComment ? ` #${pCSTLine.inlineComment}` : "")
+		);
+	}
+	if (pCSTLine.type === "section-heading") {
+		return (
+			(pCSTLine.optional ? "^" : "") +
+			"[" +
+			pCSTLine.sectionName +
+			"]" +
+			(pCSTLine.minApprovers ? `[${pCSTLine.minApprovers}]` : "") +
+			pCSTLine.spaces +
+			expandTeamsToUsersString(pCSTLine.users, pTeamMap) +
 			(pCSTLine.inlineComment ? ` #${pCSTLine.inlineComment}` : "")
 		);
 	}
 	return pCSTLine.raw;
 }
+function expandTeamsToUsersString(pUsers, pTeamMap) {
+	return uniq(pUsers.flatMap((pUser) => expandTeamToUserNames(pUser, pTeamMap)))
+		.sort(compareUserNames)
+		.join(" ");
+}
 function expandTeamToUserNames(pUser, pTeamMap) {
 	if (pUser.type === "virtual-team-name") {
 		return stringifyTeamMembers(pTeamMap, pUser.bareName);

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "8.0.5";
+export const VERSION = "8.1.0";

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

@@ -19,6 +19,9 @@ function parseLine(pUntreatedLine, pTeamMap, pLineNo) {
 	if (lTrimmedLine.startsWith("#")) {
 		return { type: "comment", line: pLineNo, raw: pUntreatedLine };
 	}
+	if (lTrimmedLine.startsWith("[") || lTrimmedLine.startsWith("^[")) {
+		return parseSection(pUntreatedLine, pLineNo, pTeamMap);
+	}
 	if (!lRule?.groups) {
 		if (lTrimmedLine === "") {
 			return { type: "empty", line: pLineNo, raw: pUntreatedLine };
@@ -35,6 +38,40 @@ function parseLine(pUntreatedLine, pTeamMap, pLineNo) {
 		raw: pUntreatedLine,
 	};
 }
+function parseSection(pUntreatedLine, pLineNo, pTeamMap) {
+	const lTrimmedLine = pUntreatedLine.trim();
+	const lCommentSplitLine = lTrimmedLine.split(/\s*#/);
+	const lSection = lCommentSplitLine[0]?.match(
+		/^(?<optionalIndicator>\^)?\[(?<sectionName>[^\]]+)\](\[(?<minApprovers>[0-9]+)\])?(?<spaces>\s+)(?<userNames>.*)$/,
+	);
+	if (!lSection?.groups) {
+		return lTrimmedLine.endsWith("]")
+			? {
+					type: "section-without-users",
+					line: pLineNo,
+					raw: pUntreatedLine,
+				}
+			: {
+					type: "unknown",
+					line: pLineNo,
+					raw: pUntreatedLine,
+				};
+	}
+	const lReturnValue = {
+		type: "section-heading",
+		line: pLineNo,
+		optional: lSection.groups.optionalIndicator === "^",
+		sectionName: lSection.groups.sectionName,
+		spaces: lSection.groups.spaces,
+		users: parseUsers(lSection.groups.userNames, pTeamMap),
+		inlineComment: lTrimmedLine.split(/\s*#/)[1] ?? "",
+		raw: pUntreatedLine,
+	};
+	if (lSection.groups.minApprovers) {
+		lReturnValue.minApprovers = parseInt(lSection.groups.minApprovers, 10);
+	}
+	return lReturnValue;
+}
 function parseUsers(pUserNamesString, pTeamMap) {
 	const lUserNames = pUserNamesString.split(/\s+/);
 	return lUserNames.map((pUserName, pIndex) => {

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

@@ -25,7 +25,7 @@ function reportAnomalies(pFileName, pAnomalies) {
 	return pAnomalies
 		.map((pAnomaly) => {
 			if (pAnomaly.type === "invalid-line") {
-				return `${pFileName}:${pAnomaly.line}:1 invalid line - neither a rule, comment nor empty: "${pAnomaly.raw}"`;
+				return `${pFileName}:${pAnomaly.line}:1 invalid line - neither a rule, section heading, comment nor empty: "${pAnomaly.raw}"`;
 			} else {
 				return (
 					`${pFileName}:${pAnomaly.line}:1 invalid user or team name "${pAnomaly.raw}" (#${pAnomaly.userNumberWithinLine} on this line). ` +

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "virtual-code-owners",
-	"version": "8.0.5",
+	"version": "8.1.0",
 	"description": "CODEOWNERS with teams for teams that can't use GitHub teams",
 	"type": "module",
 	"bin": {