feat: support json option to get accurate line/column listings

.changeset/small-kings-pump/changes.json

@@ -0,0 +1,4 @@
+{
+  "releases": [{ "name": "better-ajv-errors", "type": "minor" }],
+  "dependents": []
+}

.changeset/small-kings-pump/changes.md

@@ -0,0 +1 @@
+Support json option to get accurate line/column listings

README.md

@@ -104,4 +104,14 @@ Or, use `js` if you are planning to use this with some API. Your output will loo
 Type: `number` `null`  
 Default: `null`
 
-If you have an unindented JSON payload and you want the error output indented
+If you have an unindented JSON payload and you want the error output indented.
+
+This option have no effect when using the `json` option.
+
+##### json
+
+Type: `string` `null`  
+Default: `null`
+
+Raw JSON payload used when formatting codeframe.
+Gives accurate line and column listings.

src/__fixtures__/default/data.json

@@ -0,0 +1,5 @@
+{
+  "type": "doc",
+  "version": 1,
+  "content": [{ "type": "paragarph" }]
+}

src/__tests__/__snapshots__/index.js.snap

@@ -0,0 +1,26 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Main should output error with codeframe 1`] = `
+"ENUM should be equal to one of the allowed values
+(paragraph, bulletList, mediaSingle, codeBlock, orderedList, heading, panel, blockquote, rule, mediaGroup, applicationCard, decisionList, taskList, table, extension, bodiedExtension, blockCard, layoutSection)
+
+  2 |   \\"type\\": \\"doc\\",
+  3 |   \\"version\\": 1,
+> 4 |   \\"content\\": [{ \\"type\\": \\"paragarph\\" }]
+    |                         ^^^^^^^^^^^ 👈🏽  Did you mean paragraph here?
+  5 | }
+  6 | "
+`;
+
+exports[`Main should output error with reconstructed codeframe 1`] = `
+"ENUM should be equal to one of the allowed values
+(paragraph, bulletList, mediaSingle, codeBlock, orderedList, heading, panel, blockquote, rule, mediaGroup, applicationCard, decisionList, taskList, table, extension, bodiedExtension, blockCard, layoutSection)
+
+  4 |   \\"content\\": [
+  5 |     {
+> 6 |       \\"type\\": \\"paragarph\\"
+    |               ^^^^^^^^^^^ 👈🏽  Did you mean paragraph here?
+  7 |     }
+  8 |   ]
+  9 | }"
+`;

src/__tests__/index.js

@@ -0,0 +1,33 @@
+import Ajv from 'ajv';
+import { getSchemaAndData } from '../test-helpers';
+import betterAjvErrors from '../';
+
+describe('Main', () => {
+  it('should output error with reconstructed codeframe', async () => {
+    const [schema, data] = await getSchemaAndData('default', __dirname);
+    const ajv = new Ajv({ jsonPointers: true });
+    const validate = ajv.compile(schema);
+    const valid = validate(data);
+    expect(valid).toBeFalsy();
+
+    const res = betterAjvErrors(schema, data, validate.errors, {
+      format: 'cli',
+      indent: 2,
+    });
+    expect(res).toMatchSnapshot();
+  });
+
+  it('should output error with codeframe', async () => {
+    const [schema, data, json] = await getSchemaAndData('default', __dirname);
+    const ajv = new Ajv({ jsonPointers: true });
+    const validate = ajv.compile(schema);
+    const valid = validate(data);
+    expect(valid).toBeFalsy();
+
+    const res = betterAjvErrors(schema, data, validate.errors, {
+      format: 'cli',
+      json,
+    });
+    expect(res).toMatchSnapshot();
+  });
+});

src/index.js

@@ -2,9 +2,9 @@ import parse from 'json-to-ast';
 import prettify from './helpers';
 
 export default (schema, data, errors, options = {}) => {
-  const { format = 'cli', indent = null } = options;
+  const { format = 'cli', indent = null, json = null } = options;
 
-  const jsonRaw = JSON.stringify(data, null, indent);
+  const jsonRaw = json || JSON.stringify(data, null, indent);
   const jsonAst = parse(jsonRaw, { loc: true });
 
   const customErrorToText = error => error.print().join('\n');

src/test-helpers.js

@@ -5,7 +5,8 @@ export async function getSchemaAndData(name, dirPath) {
   const schemaPath = await getFixturePath(dirPath, name, 'schema.json');
   const schema = JSON.parse(readFileSync(schemaPath, 'utf8'));
   const dataPath = await getFixturePath(dirPath, name, 'data.json');
-  const data = JSON.parse(readFileSync(dataPath, 'utf8'));
+  const json = readFileSync(dataPath, 'utf8');
+  const data = JSON.parse(json);
 
-  return [schema, data];
+  return [schema, data, json];
 }

typings.d.ts

@@ -9,6 +9,9 @@ declare namespace betterAjvErrors {
   export interface IInputOptions {
     format?: 'cli' | 'js';
     indent?: number | null;
+
+    /** Raw JSON used when highlighting error location */
+    json?: string | null;
   }
 
   export interface IOutputError {