fix: rename startMark to directivesEndMarker, endMark to documentEndMarker

Author: fisker

changelog.md

@@ -10,7 +10,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Features
 
-- add `startMark` and `endMark` information to `Document` ([#298](https://github.com/prettier/yaml-unist-parser/issues/298)) ([7c4de43](https://github.com/prettier/yaml-unist-parser/commit/7c4de437de33793b6cacfc5bd87e0e08d45faf04))
+- add `directivesEndMarker` and `documentEndMarker` information to `Document` ([#298](https://github.com/prettier/yaml-unist-parser/issues/298)) ([7c4de43](https://github.com/prettier/yaml-unist-parser/commit/7c4de437de33793b6cacfc5bd87e0e08d45faf04))
 
 ## [2.0.5](https://github.com/prettier/yaml-unist-parser/compare/v2.0.4...v2.0.5) (2025-03-21)
 

src/factories/document.ts

@@ -10,17 +10,17 @@ import { createTrailingCommentAttachable } from "./trailing-comment-attachable.j
 
 export function createDocument(
   position: Position,
-  startMark: boolean,
-  endMark: boolean,
+  directivesEndMarker: boolean,
+  documentEndMarker: boolean,
   head: DocumentHead,
   body: DocumentBody,
   trailingComment: null | Comment,
 ): Document {
   return {
     ...createNode("document", position),
     ...createTrailingCommentAttachable(trailingComment),
-    startMark,
-    endMark,
+    directivesEndMarker,
+    documentEndMarker,
     children: [head, body],
   };
 }

src/transforms/__snapshots__/document.test.ts.snap

@@ -60,7 +60,7 @@ document (1:1 ~ 3:4)
 7 | ¶
 8 | ¶
 9 | ·¶
-<document endMark>
+<document documentEndMarker>
   <trailingComment value="123">
   <documentHead>
 
@@ -188,7 +188,7 @@ document (1:1 ~ 1:4)
 3 | #¶
 4 | ¶
 5 | ¶
-<document endMark>
+<document documentEndMarker>
   <documentHead>
 
   </documentHead>
@@ -310,7 +310,7 @@ document (2:1 ~ 6:4)
 11 | 456¶
 12 | ¶
 13 | ¶
-<document endMark startMark>
+<document documentEndMarker directivesEndMarker>
   <documentHead>
     <directive name="AAA" parameters=[] />
   </documentHead>
@@ -385,7 +385,7 @@ document (8:1 ~ 13:1)
    | ^
 13 | ¶
    | ^
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
     <directive name="BBB" parameters=[] />
   </documentHead>
@@ -459,7 +459,7 @@ document (2:1 ~ 6:4)
 10 | 456¶
 11 | ¶
 12 | ¶
-<document endMark startMark>
+<document documentEndMarker directivesEndMarker>
   <documentHead>
     <directive name="AAA" parameters=[] />
   </documentHead>
@@ -530,7 +530,7 @@ document (8:1 ~ 12:1)
    | ^
 12 | ¶
    | ^
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
 
   </documentHead>
@@ -599,7 +599,7 @@ document (2:1 ~ 6:4)
  8 | 456¶
  9 | ¶
 10 | ¶
-<document endMark startMark>
+<document documentEndMarker directivesEndMarker>
   <documentHead>
     <directive name="AAA" parameters=[] />
   </documentHead>
@@ -726,7 +726,7 @@ document (2:1 ~ 6:1)
  8 | 456¶
  9 | ¶
 10 | ¶
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
     <directive name="AAA" parameters=[] />
   </documentHead>
@@ -791,7 +791,7 @@ document (6:1 ~ 10:1)
    | ^
 10 | ¶
    | ^
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
 
   </documentHead>
@@ -852,7 +852,7 @@ document (2:1 ~ 4:4)
 6 | 456¶
 7 | ¶
 8 | ¶
-<document endMark>
+<document documentEndMarker>
   <documentHead>
 
   </documentHead>
@@ -1022,7 +1022,7 @@ document (4:1 ~ 8:1)
   | ^
 8 | ¶
   | ^
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
 
   </documentHead>
@@ -1127,7 +1127,7 @@ document (3:1 ~ 4:6)
   | ^^^^
 4 | -·BBB¶
   | ^^^^^
-<document startMark>
+<document directivesEndMarker>
   <documentHead>
 
   </documentHead>
@@ -1178,7 +1178,7 @@ document (1:1 ~ 3:4)
 3 | ...·#documentEndComment¶
   | ^^^
 4 | ¶
-<document endMark startMark>
+<document documentEndMarker directivesEndMarker>
   <trailingComment value="documentEndComment">
   <documentHead>
 
@@ -1196,7 +1196,7 @@ document (1:1 ~ 2:4)
 2 | ...¶
   | ^^^
 3 | 456¶
-<document endMark>
+<document documentEndMarker>
   <documentHead>
 
   </documentHead>
@@ -1234,7 +1234,7 @@ root (1:1 ~ 3:4)
       <plain value="123" />
     </documentBody>
   </document>
-  <document startMark>
+  <document directivesEndMarker>
     <documentHead>
       <trailingComment value="666">
     </documentHead>

src/transforms/document-head.ts

@@ -15,7 +15,7 @@ export function transformDocumentHead(
     context,
   );
 
-  const { position, endMarkerPoint } = getPosition(
+  const { position, documentEndMarkererPoint } = getPosition(
     cstNode,
     directives,
     context,
@@ -39,7 +39,7 @@ export function transformDocumentHead(
 
   return {
     createDocumentHeadWithTrailingComment,
-    documentHeadEndMarkerPoint: endMarkerPoint,
+    documentHeadEndMarkerPoint: documentEndMarkererPoint,
   };
 }
 
@@ -71,24 +71,27 @@ function getPosition(
   directives: Directive[],
   context: Context,
 ) {
-  let endMarkerIndex = getMatchIndex(
+  let documentEndMarkererIndex = getMatchIndex(
     context.text.slice(0, document.valueRange!.origStart),
     /---\s*$/,
   );
   // end marker should start with the first character on the line
-  if (endMarkerIndex > 0 && !/[\r\n]/.test(context.text[endMarkerIndex - 1])) {
-    endMarkerIndex = -1;
+  if (
+    documentEndMarkererIndex > 0 &&
+    !/[\r\n]/.test(context.text[documentEndMarkererIndex - 1])
+  ) {
+    documentEndMarkererIndex = -1;
   }
 
   const range: Range =
-    endMarkerIndex === -1
+    documentEndMarkererIndex === -1
       ? {
           origStart: document.valueRange!.origStart!,
           origEnd: document.valueRange!.origStart!,
         }
       : {
-          origStart: endMarkerIndex!,
-          origEnd: endMarkerIndex + 3,
+          origStart: documentEndMarkererIndex!,
+          origEnd: documentEndMarkererIndex + 3,
         };
 
   if (directives.length !== 0) {
@@ -97,7 +100,9 @@ function getPosition(
 
   return {
     position: context.transformRange(range),
-    endMarkerPoint:
-      endMarkerIndex === -1 ? null : context.transformOffset(endMarkerIndex),
+    documentEndMarkererPoint:
+      documentEndMarkererIndex === -1
+        ? null
+        : context.transformOffset(documentEndMarkererIndex),
   };
 }

src/types.ts

@@ -119,8 +119,8 @@ export interface Root extends Parent {
 
 export interface Document extends Parent, TrailingCommentAttachable {
   type: "document";
-  startMark: boolean;
-  endMark: boolean;
+  directivesEndMarker: boolean;
+  documentEndMarker: boolean;
   children: [DocumentHead, DocumentBody];
 }