feat: Require unique anchors during composition

Author: eemeli

src/compose/compose-doc.ts

@@ -24,6 +24,7 @@ export function composeDoc(
   const opts = Object.assign({ _directives: directives }, options)
   const doc = new Document(undefined, opts) as Document.Parsed
   const ctx: ComposeContext = {
+    anchors: options.version === 'next' ? new Map() : null,
     atRoot: true,
     directives: doc.directives,
     options: doc.options,

src/compose/compose-node.ts

@@ -11,6 +11,7 @@ import { resolveEnd } from './resolve-end.js'
 import { emptyScalarPosition } from './util-empty-scalar-position.js'
 
 export interface ComposeContext {
+  anchors: Map<string, ParsedNode> | null
   atRoot: boolean
   directives: Directives
   options: Readonly<Required<Omit<ParseOptions, 'lineCounter'>>>
@@ -52,13 +53,13 @@ export function composeNode(
     case 'double-quoted-scalar':
     case 'block-scalar':
       node = composeScalar(ctx, token, tag, onError)
-      if (anchor) node.anchor = anchor.source.substring(1)
+      if (anchor) setAnchor(ctx, node, anchor, onError)
       break
     case 'block-map':
     case 'block-seq':
     case 'flow-collection':
       node = composeCollection(CN, ctx, token, tag, onError)
-      if (anchor) node.anchor = anchor.source.substring(1)
+      if (anchor) setAnchor(ctx, node, anchor, onError)
       break
     default: {
       const message =
@@ -138,3 +139,21 @@ function composeAlias(
   if (re.comment) alias.comment = re.comment
   return alias as Alias.Parsed
 }
+
+function setAnchor(
+  { anchors }: ComposeContext,
+  node: ParsedNode,
+  anchor: SourceToken,
+  onError: ComposeErrorHandler
+) {
+  const name = anchor.source.substring(1)
+  if (anchors) {
+    if (anchors.has(name)) {
+      const msg = `Anchors must be unique, ${name} is repeated`
+      onError(node.range, 'DUPLICATE_ANCHOR', msg)
+    } else {
+      anchors.set(name, node)
+    }
+  }
+  node.anchor = name
+}

src/errors.ts

@@ -10,6 +10,7 @@ export type ErrorCode =
   | 'BAD_SCALAR_START'
   | 'BLOCK_AS_IMPLICIT_KEY'
   | 'BLOCK_IN_FLOW'
+  | 'DUPLICATE_ANCHOR'
   | 'DUPLICATE_KEY'
   | 'IMPOSSIBLE'
   | 'KEY_OVER_1024_CHARS'

tests/next.ts

@@ -53,3 +53,24 @@ describe('relative-path alias', () => {
     expect(() => doc.toJS()).toThrow(ReferenceError)
   })
 })
+
+describe('unique anchors', () => {
+  test('repeats are fine without flag', () => {
+    const src = source`
+      - &a 1
+      - &a 2
+      - *a
+    `
+    expect(parse(src)).toEqual([1, 2, 2])
+  })
+
+  test("repeats are an error with 'next'", () => {
+    const src = source`
+      - &a 1
+      - &a 2
+      - *a
+    `
+    const doc = parseDocument(src, { version: 'next' })
+    expect(doc.errors).toMatchObject([{ code: 'DUPLICATE_ANCHOR' }])
+  })
+})