fix: calculate location for a mapping with no value (#11)

* fix: introduce YamlParserResult type

* fix: calculate location for a mapping with no value

* chore: remove test.each

src/__tests__/fixtures/spectral-170.yaml

@@ -0,0 +1,36 @@
+swagger: '2.0'
+
+info:
+  title: Repro two
+  description: Endpoint definition
+  version: "1.0.0"
+  contact:
+    name: toto
+host: not-example.com
+schemes:
+  - https
+basePath: /repro/two
+
+paths:
+  /quotes_requests:
+    post:
+      summary: Gets nothing either.
+      operationId: "12"
+      description: Cf. summary
+      tags: [yep]
+      parameters:
+        - name: body
+          description: Content.
+          in: body
+          schema:
+            $ref: '#/definitions/AnotherDefinition'
+      responses:
+        204:
+          description: Zip
+
+definitions:
+  AnotherDefinition:
+    type: object
+    properties:
+      special:
+        description:

src/__tests__/getLocationForJsonPath.spec.ts

@@ -4,6 +4,7 @@ import { getLocationForJsonPath } from '../getLocationForJsonPath';
 import { parseWithPointers } from '../parseWithPointers';
 
 const petStore = fs.readFileSync(join(__dirname, './fixtures/petstore.oas2.yaml'), 'utf-8');
+const spectral170 = fs.readFileSync(join(__dirname, './fixtures/spectral-170.yaml'), 'utf-8');
 const simple = `hello: world
 address:
   street: 123`;
@@ -63,4 +64,25 @@ describe('getLocationForJsonPath', () => {
       });
     });
   });
+
+  describe('spectral bug #170 fixture', () => {
+    const result = parseWithPointers(spectral170);
+
+    test('should return proper location for empty mapping value', () => {
+      expect(
+        getLocationForJsonPath(result, ['definitions', 'AnotherDefinition', 'properties', 'special', 'description'])
+      ).toEqual({
+        range: {
+          start: {
+            character: 20,
+            line: 35,
+          },
+          end: {
+            character: 20,
+            line: 35,
+          },
+        },
+      });
+    });
+  });
 });

src/getLocationForJsonPath.ts

@@ -10,8 +10,15 @@ export const getLocationForJsonPath: GetLocationForJsonPath<YAMLNode, number[]>
 };
 
 function getStartPosition(node: YAMLNode): number {
-  if (node.parent && node.parent.kind === Kind.MAPPING && node.kind !== Kind.SCALAR) {
-    return node.parent.key.endPosition + 1; // offset for colon
+  if (node.parent && node.parent.kind === Kind.MAPPING) {
+    // the parent is a mapping with no value, let's default to the end of node
+    if (node.parent.value === null) {
+      return node.parent.endPosition;
+    }
+
+    if (node.kind !== Kind.SCALAR) {
+      return node.parent.key.endPosition + 1; // offset for colon
+    }
   }
 
   return node.startPosition;
@@ -35,6 +42,13 @@ function getEndPosition(node: YAMLNode): number {
       if (node.value !== null && node.mappings.length !== 0) {
         return getEndPosition(node.mappings[node.mappings.length - 1]);
       }
+      break;
+    case Kind.SCALAR:
+      // the parent is a mapping with no value, let's default to the end of node
+      if (node.parent.kind === Kind.MAPPING && node.parent.value === null) {
+        return node.parent.endPosition;
+      }
+
       break;
   }
 
@@ -47,7 +61,11 @@ function findNodeAtPath(node: YAMLNode, path: JsonPath) {
       case Kind.MAP:
         for (const item of node.mappings) {
           if (item.key.value === segment) {
-            node = item.value;
+            if (item.value === null) {
+              node = item.key;
+            } else {
+              node = item.value;
+            }
             continue pathLoop;
           }
         }

src/index.ts

@@ -2,3 +2,4 @@ export * from './getJsonPathForPosition';
 export * from './getLocationForJsonPath';
 export * from './parseWithPointers';
 export * from './safeStringify';
+export * from './types';

src/parseWithPointers.ts

@@ -1,4 +1,4 @@
-import { DiagnosticSeverity, IDiagnostic, IParserResult } from '@stoplight/types';
+import { DiagnosticSeverity, IDiagnostic } from '@stoplight/types';
 import {
   Kind,
   load as loadAST,
@@ -8,12 +8,13 @@ import {
   YAMLNode,
   YAMLSequence,
 } from 'yaml-ast-parser';
+import { YamlParserResult } from './types';
 
-export const parseWithPointers = <T>(value: string): IParserResult<T, YAMLNode, number[]> => {
+export const parseWithPointers = <T>(value: string): YamlParserResult<T> => {
   const lineMap = computeLineMap(value);
   const ast = loadAST(value);
 
-  const parsed: IParserResult<T, YAMLNode, number[]> = {
+  const parsed: YamlParserResult<T> = {
     ast,
     lineMap,
     data: {} as T, // fixme: we most likely should have undefined here, but this might be breaking

src/types.ts

@@ -0,0 +1,4 @@
+import { IParserResult } from '@stoplight/types';
+import { YAMLNode } from 'yaml-ast-parser';
+
+export type YamlParserResult<T> = IParserResult<T, YAMLNode, number[]>;