feat: creation of a new cli-array format for hybrid output (#243)

* chore(deps-dev): bumping out of date deps

* feat: creation of a new `cli-array` format for cli/array hybrids

* fix: prettier problem

Author: erunion

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.codeActionsOnSave": {
     "source.fixAll": "explicit"
-  }
+  },
+  "editor.formatOnSave": true
 }

package-lock.json

@@ -51,14 +51,14 @@
     "@babel/core": "^7.26.7",
     "@babel/plugin-transform-runtime": "^7.25.9",
     "@babel/preset-env": "^7.26.7",
-    "@readme/eslint-config": "^14.1.2",
+    "@readme/eslint-config": "^14.4.2",
     "@readme/openapi-schemas": "^3.1.0",
-    "@vitest/coverage-v8": "^3.0.4",
+    "@vitest/coverage-v8": "^3.0.7",
     "ajv": "^8.17.1",
     "babel-plugin-add-module-exports": "^1.0.4",
     "eslint": "^8.44.0",
     "prettier": "^3.4.2",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.7"
   },
   "peerDependencies": {
     "ajv": "4.11.8 - 8"

package.json

@@ -41,20 +41,35 @@ exports[`Main > complex schema examples > should output an error on an unrecogni
   20 |         "responses": {"
 `;
 
-exports[`Main > should output error with codeframe 1`] = `
+exports[`Main > given a format of \`cli\` > should output error with reconstructed codeframe [without colors] 1`] = `
+"ENUM must be equal to one of the allowed values
+(paragraph, codeBlock, blockquote)
+
+  4 |   "content": [
+  5 |     {
+> 6 |       "type": "paragarph"
+    |               ^^^^^^^^^^^ Did you mean paragraph here?
+  7 |     }
+  8 |   ]
+  9 | }"
+`;
+
+exports[`Main > given a format of \`cli\` > should output error with reconstructed codeframe 1`] = `
 "ENUM must be equal to one of the allowed values
 (paragraph, codeBlock, blockquote)
 
-  2 |   "type": "doc",
-  3 |   "version": 1,
-> 4 |   "content": [{ "type": "paragarph" }]
-    |                         ^^^^^^^^^^^ Did you mean paragraph here?
-  5 | }
-  6 |"
+  4 |   "content": [
+  5 |     {
+> 6 |       "type": "paragarph"
+    |               ^^^^^^^^^^^ Did you mean paragraph here?
+  7 |     }
+  8 |   ]
+  9 | }"
 `;
 
-exports[`Main > should output error with reconstructed codeframe [without colors] 1`] = `
-"ENUM must be equal to one of the allowed values
+exports[`Main > given a format of \`cli-array\` > should output error with reconstructed codeframe [without colors] 1`] = `
+[
+  "ENUM must be equal to one of the allowed values
 (paragraph, codeBlock, blockquote)
 
   4 |   "content": [
@@ -63,11 +78,13 @@ exports[`Main > should output error with reconstructed codeframe [without colors
     |               ^^^^^^^^^^^ Did you mean paragraph here?
   7 |     }
   8 |   ]
-  9 | }"
+  9 | }",
+]
 `;
 
-exports[`Main > should output error with reconstructed codeframe 1`] = `
-"ENUM must be equal to one of the allowed values
+exports[`Main > given a format of \`cli-array\` > should output error with reconstructed codeframe 1`] = `
+[
+  "ENUM must be equal to one of the allowed values
 (paragraph, codeBlock, blockquote)
 
   4 |   "content": [
@@ -76,5 +93,18 @@ exports[`Main > should output error with reconstructed codeframe 1`] = `
     |               ^^^^^^^^^^^ Did you mean paragraph here?
   7 |     }
   8 |   ]
-  9 | }"
+  9 | }",
+]
+`;
+
+exports[`Main > should output error with codeframe 1`] = `
+"ENUM must be equal to one of the allowed values
+(paragraph, codeBlock, blockquote)
+
+  2 |   "type": "doc",
+  3 |   "version": 1,
+> 4 |   "content": [{ "type": "paragarph" }]
+    |                         ^^^^^^^^^^^ Did you mean paragraph here?
+  5 | }
+  6 |"
 `;

src/__tests__/__snapshots__/index.test.js.snap

@@ -8,22 +8,25 @@ import betterAjvErrorsBabelExport from '../../lib';
 import { getSchemaAndData } from '../test-helpers';
 
 describe('Main', () => {
-  it.each([
-    ['should output error with reconstructed codeframe', true],
-    ['should output error with reconstructed codeframe [without colors]', false],
-  ])('%s', async (_, colorize) => {
-    const [schema, data] = await getSchemaAndData('default', __dirname);
-    const ajv = new Ajv();
-    const validate = ajv.compile(schema);
-    const valid = validate(data);
-    expect(valid).toBe(false);
+  describe.each(['cli', 'cli-array'])('given a format of `%s`', format => {
+    it.each([
+      ['should output error with reconstructed codeframe', true],
+      ['should output error with reconstructed codeframe [without colors]', false],
+    ])('%s', async (_, colorize) => {
+      const [schema, data] = await getSchemaAndData('default', __dirname);
+      const ajv = new Ajv();
+      const validate = ajv.compile(schema);
+      const valid = validate(data);
+      expect(valid).toBe(false);
 
-    const res = betterAjvErrors(schema, data, validate.errors, {
-      colorize,
-      format: 'cli',
-      indent: 2,
+      const res = betterAjvErrors(schema, data, validate.errors, {
+        colorize,
+        format,
+        indent: 2,
+      });
+
+      expect(res).toMatchSnapshot();
     });
-    expect(res).toMatchSnapshot();
   });
 
   it('should output error with codeframe', async () => {

src/__tests__/index.test.js

@@ -20,6 +20,8 @@ export default function betterAjvErrors(schema, data, errors, options = {}) {
 
   if (format === 'cli') {
     return customErrors.map(customErrorToText).join('\n\n');
+  } else if (format === 'cli-array') {
+    return customErrors.map(customErrorToText);
   }
 
   return customErrors.map(customErrorToStructure);

src/index.js

@@ -9,7 +9,7 @@ export interface IOutputError {
 }
 
 export interface IInputOptions {
-  format?: 'cli' | 'js';
+  format?: 'cli-array' | 'cli' | 'js';
   indent?: number | null;
 
   /** Raw JSON used when highlighting error location */