feat: add startMark and endMark information to Document (#298)

Author: fisker

.yarn/releases/yarn-4.11.0.cjs

@@ -10,4 +10,4 @@ plugins:
   - .yarn/plugins/plugin-setup-editor.cjs
   - .yarn/plugins/plugin-run-patch-package.cjs
 
-yarnPath: .yarn/releases/yarn-4.7.0.cjs
+yarnPath: .yarn/releases/yarn-4.11.0.cjs

.yarn/releases/yarn-4.7.0.cjs

@@ -59,5 +59,6 @@
   },
   "files": [
     "/lib/**/*"
-  ]
+  ],
+  "packageManager": "yarn@4.11.0"
 }

.yarnrc.yml

@@ -22,7 +22,7 @@ index 53eb011..dcb722e 100644
      schema: Schema
    }
 diff --git a/node_modules/yaml/parse-cst.d.ts b/node_modules/yaml/parse-cst.d.ts
-index 9fd2ebf..45c1923 100644
+index 9fd2ebf..4e25756 100644
 --- a/node_modules/yaml/parse-cst.d.ts
 +++ b/node_modules/yaml/parse-cst.d.ts
 @@ -10,8 +10,8 @@ export namespace CST {
@@ -45,14 +45,18 @@ index 9fd2ebf..45c1923 100644
    }
 
    interface FlowCollection extends Node {
-@@ -184,6 +184,7 @@ export namespace CST {
+@@ -184,8 +184,11 @@ export namespace CST {
      type: Type.DOCUMENT
      directives: Array<BlankLine | Comment | Directive>
      contents: Array<BlankLine | Comment | ContentNode>
 +    setOrigRanges(cr: number[], offset: number): number
      readonly anchor: null
      readonly comment: null
      readonly tag: null
++    readonly directivesEndMarker: Range | null
++    readonly documentEndMarker: Range | null
+   }
+ }
 diff --git a/node_modules/yaml/types.d.ts b/node_modules/yaml/types.d.ts
 index 411e74e..0c60eb0 100644
 --- a/node_modules/yaml/types.d.ts

package.json

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

patches/yaml+1.10.2.patch

@@ -179,8 +179,12 @@ function stringifyNode(
     return "<null />";
   }
 
-  const attributes = Object.keys(node)
-    .filter(key => {
+  const attributes = Object.entries(node)
+    .filter(([key, value]) => {
+      if (value === false) {
+        return false;
+      }
+
       switch (key) {
         case "type":
         case "position":
@@ -198,7 +202,9 @@ function stringifyNode(
           return true;
       }
     })
-    .map(key => `${key}=${JSON.stringify(node[key as keyof typeof node])}`)
+    .map(([key, value]) =>
+      value === true ? key : `${key}=${JSON.stringify(value)}`,
+    )
     .sort()
     .map((attribute, index) => (index === 0 ? " " + attribute : attribute))
     .join(" ");

src/factories/document.ts

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

src/helpers.ts

@@ -28,8 +28,12 @@ export function transformDocument(
     context.comments.push(documentTrailingComment);
   }
 
+  const cstNode = document.cstNode!;
+
   return createDocument(
     createPosition(documentHead.position.start, documentEndPoint),
+    Boolean(cstNode.directivesEndMarker),
+    Boolean(cstNode.documentEndMarker),
     documentHead,
     documentBody,
     documentTrailingComment,

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

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