fix: 'section' -> 'section-heading'

sverweij · May 11, 2024 · c225876 · c225876
1 parent b89fc04
commit c225876
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 16 deletions.
diff --git a/dist/codeowners/generate.js b/dist/codeowners/generate.js
diff --git a/dist/virtual-code-owners/parse.js b/dist/virtual-code-owners/parse.js
diff --git a/dist/virtual-code-owners/read.js b/dist/virtual-code-owners/read.js
diff --git a/src/codeowners/generate.ts b/src/codeowners/generate.ts
@@ -45,7 +45,7 @@ function generateLine(
       (pCSTLine.inlineComment ? ` #${pCSTLine.inlineComment}` : "")
     );
   }
-  if (pCSTLine.type === "section") {
+  if (pCSTLine.type === "section-heading") {
     return (
       (pCSTLine.optional ? "^" : "") +
       "[" +

diff --git a/src/virtual-code-owners/__fixtures__/corpus/empty-teams/022-section-optional.yml b/src/virtual-code-owners/__fixtures__/corpus/empty-teams/022-section-optional.yml
@@ -31,7 +31,7 @@
     raw: "^[optional-section-with-default] @koos-koets",
     sectionName: "optional-section-with-default",
     spaces: " ",
-    type: "section",
+    type: "section-heading",
     users:
       [
         {

diff --git a/...-code-owners/__fixtures__/corpus/empty-teams/023-section-required-with-default-owners.yml b/...-code-owners/__fixtures__/corpus/empty-teams/023-section-required-with-default-owners.yml
@@ -6,7 +6,7 @@
     raw: "[required-section] @default-user @default-group",
     sectionName: "required-section",
     spaces: " ",
-    type: "section",
+    type: "section-heading",
     users:
       [
         {

diff --git a/..._fixtures__/corpus/empty-teams/024-section-required-with-default-owners-min-approvers.yml b/..._fixtures__/corpus/empty-teams/024-section-required-with-default-owners-min-approvers.yml
@@ -7,7 +7,7 @@
     raw: "[required-section][42] @default-user @default-group",
     sectionName: "required-section",
     spaces: " ",
-    type: "section",
+    type: "section-heading",
     users:
       [
         {

diff --git a/src/virtual-code-owners/__fixtures__/corpus/teams/051-the-kitchen-sink-with-sections.yml b/src/virtual-code-owners/__fixtures__/corpus/teams/051-the-kitchen-sink-with-sections.yml
@@ -55,7 +55,7 @@
   },
   { "type": "empty", "line": 11, "raw": "" },
   {
-    "type": "section",
+    "type": "section-heading",
     "line": 12,
     "optional": false,
     "sectionName": "generic stuff",
@@ -235,7 +235,7 @@
   },
   { "type": "empty", "line": 23, "raw": "" },
   {
-    "type": "section",
+    "type": "section-heading",
     "line": 24,
     "optional": true,
     "sectionName": "non critical stuff",

diff --git a/src/virtual-code-owners/cst.d.ts b/src/virtual-code-owners/cst.d.ts
@@ -1,6 +1,6 @@
 export type IVirtualCodeOwnersCST = IVirtualCodeOwnerLine[];
 export type IVirtualCodeOwnerLine = IBoringCSTLine | IInterestingCSTLine;
-export type IInterestingCSTLine = IRuleCSTLine | ISectionCSTLine;
+export type IInterestingCSTLine = IRuleCSTLine | ISectionHeadingCSTLine;
 export interface IBoringCSTLine {
   type:
     | "comment"
@@ -20,8 +20,8 @@ export interface IRuleCSTLine {
   inlineComment: string;
   raw: string;
 }
-export interface ISectionCSTLine {
-  type: "section";
+export interface ISectionHeadingCSTLine {
+  type: "section-heading";
   line: number;
   optional: boolean;
   sectionName: string;

diff --git a/src/virtual-code-owners/parse.ts b/src/virtual-code-owners/parse.ts
@@ -1,7 +1,7 @@
 import { EOL } from "node:os";
 import type { ITeamMap } from "../team-map/team-map.js";
 import type {
-  ISectionCSTLine,
+  ISectionHeadingCSTLine,
   IUser,
   IVirtualCodeOwnerLine,
   IVirtualCodeOwnersCST,
@@ -81,8 +81,8 @@ function parseSection(
           raw: pUntreatedLine,
         };
   }
-  const lReturnValue: ISectionCSTLine = {
-    type: "section",
+  const lReturnValue: ISectionHeadingCSTLine = {
+    type: "section-heading",
     line: pLineNo,
     optional: lSection.groups.optionalIndicator === "^",
     sectionName: lSection.groups.sectionName as string,

diff --git a/src/virtual-code-owners/read.ts b/src/virtual-code-owners/read.ts
@@ -32,7 +32,7 @@ function reportAnomalies(pFileName: string, pAnomalies: IAnomaly[]): string {
   return pAnomalies
     .map((pAnomaly) => {
       if (pAnomaly.type === "invalid-line") {
-        return `${pFileName}:${pAnomaly.line}:1 invalid line - neither a rule, section head, 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). ` +