feat: include path for duplicate key exception (#19)

stoplightio · Jul 15, 2019 · a10d450 · a10d450
1 parent badb1ef
commit a10d450
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 47 deletions.
diff --git a/src/__tests__/parseWithPointers.spec.ts b/src/__tests__/parseWithPointers.spec.ts
@@ -241,6 +241,7 @@ european-cities: &cities
       {
         code: 'YAMLException',
         message: 'duplicate key',
+        path: ['foo'],
         range: {
           start: {
             line: 1,
@@ -271,6 +272,7 @@ european-cities: &cities
       {
         code: 'YAMLException',
         message: 'duplicate key',
+        path: ['baz', 'duplicated'],
         range: {
           start: {
             line: 3,
@@ -286,6 +288,7 @@ european-cities: &cities
       {
         code: 'YAMLException',
         message: 'duplicate key',
+        path: ['baz', 'duplicated'],
         range: {
           start: {
             line: 4,

diff --git a/src/buildJsonPath.ts b/src/buildJsonPath.ts
@@ -0,0 +1,46 @@
+import { JsonPath } from '@stoplight/types';
+import { Kind, YAMLMapping, YAMLNode, YAMLScalar, YAMLSequence } from 'yaml-ast-parser';
+import { isValidNode } from './utils';
+
+export function buildJsonPath(node: YAMLNode) {
+  const path: JsonPath = [];
+
+  let prevNode: YAMLNode = node;
+
+  while (node) {
+    switch (node.kind) {
+      case Kind.SCALAR:
+        path.unshift((node as YAMLScalar).value);
+        break;
+      case Kind.MAPPING:
+        if (prevNode !== (node as YAMLMapping).key) {
+          if (
+            path.length > 0 &&
+            isValidNode((node as YAMLMapping).value) &&
+            (node as YAMLMapping).value.value === path[0]
+          ) {
+            path[0] = (node as YAMLMapping).key.value;
+          } else {
+            path.unshift((node as YAMLMapping).key.value);
+          }
+        }
+        break;
+      case Kind.SEQ:
+        if (prevNode) {
+          const index = (node as YAMLSequence).items.indexOf(prevNode);
+          if (prevNode.kind === Kind.SCALAR) {
+            path[0] = index;
+            // always better to point to parent node rather than nothing
+          } else if (index !== -1) {
+            path.unshift(index);
+          }
+        }
+        break;
+    }
+
+    prevNode = node;
+    node = node.parent;
+  }
+
+  return path;
+}
diff --git a/src/getJsonPathForPosition.ts b/src/getJsonPathForPosition.ts
@@ -1,5 +1,7 @@
-import { GetJsonPathForPosition, JsonPath } from '@stoplight/types';
-import { Kind, YamlMap, YAMLMapping, YAMLNode, YAMLScalar, YAMLSequence } from 'yaml-ast-parser';
+import { GetJsonPathForPosition } from '@stoplight/types';
+import { Kind, YamlMap, YAMLMapping, YAMLNode, YAMLSequence } from 'yaml-ast-parser';
+import { buildJsonPath } from './buildJsonPath';
+import { isValidNode } from './utils';
 
 export const getJsonPathForPosition: GetJsonPathForPosition<YAMLNode, number[]> = (
   { ast, lineMap },
@@ -19,8 +21,6 @@ export const getJsonPathForPosition: GetJsonPathForPosition<YAMLNode, number[]>
   return path;
 };
 
-const isValidNode = (node: YAMLNode) => node !== null && node !== undefined;
-
 function* walk(node: YAMLNode): IterableIterator<YAMLNode> {
   switch (node.kind) {
     case Kind.MAP:
@@ -115,46 +115,3 @@ function findClosestScalar(container: YAMLNode, offset: number, line: number, li
 
   return container;
 }
-
-function buildJsonPath(node: YAMLNode) {
-  const path: JsonPath = [];
-
-  let prevNode: YAMLNode = node;
-
-  while (node) {
-    switch (node.kind) {
-      case Kind.SCALAR:
-        path.unshift((node as YAMLScalar).value);
-        break;
-      case Kind.MAPPING:
-        if (prevNode !== (node as YAMLMapping).key) {
-          if (
-            path.length > 0 &&
-            isValidNode((node as YAMLMapping).value) &&
-            (node as YAMLMapping).value.value === path[0]
-          ) {
-            path[0] = (node as YAMLMapping).key.value;
-          } else {
-            path.unshift((node as YAMLMapping).key.value);
-          }
-        }
-        break;
-      case Kind.SEQ:
-        if (prevNode) {
-          const index = (node as YAMLSequence).items.indexOf(prevNode);
-          if (prevNode.kind === Kind.SCALAR) {
-            path[0] = index;
-            // always better to point to parent node rather than nothing
-          } else if (index !== -1) {
-            path.unshift(index);
-          }
-        }
-        break;
-    }
-
-    prevNode = node;
-    node = node.parent;
-  }
-
-  return path;
-}
diff --git a/src/parseWithPointers.ts b/src/parseWithPointers.ts
@@ -9,6 +9,7 @@ import {
   YAMLNode,
   YAMLSequence,
 } from 'yaml-ast-parser';
+import { buildJsonPath } from './buildJsonPath';
 import { lineForPosition } from './lineForPosition';
 import { YamlParserResult } from './types';
 
@@ -184,6 +185,7 @@ const transformDuplicatedMappingKeys = (nodes: YAMLNode[], lineMap: number[]): I
     validations.push({
       code: 'YAMLException',
       message: 'duplicate key',
+      path: buildJsonPath(node),
       range: {
         start: {
           line: startLine,

diff --git a/src/utils.ts b/src/utils.ts
@@ -0,0 +1,3 @@
+import { YAMLNode } from 'yaml-ast-parser';
+
+export const isValidNode = (node: YAMLNode) => node !== null && node !== undefined;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { YAMLNode } from 'yaml-ast-parser';

		export const isValidNode = (node: YAMLNode) => node !== null && node !== undefined;