Gathering detailed insights and metrics for better-ajv-errors
Gathering detailed insights and metrics for better-ajv-errors
JSON Schema validation for Human 👨🎤
Installations
npm install better-ajv-errorsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Min. Node Version
>= 18.20.6
Node Version
22.14.0
NPM Version
10.9.2
Score
97.6
Supply Chain
99.5
Quality
86.1
Maintenance
100
Vulnerability
100
License
Releases
14
Languages
4
JavaScript
Nix
TypeScript
Shell
JavaScript (97.22%)
Nix (1.39%)
TypeScript (1.21%)
Shell (0.18%)
Developer
Download Statistics
Total Downloads
84,963,605
Last Day
28,345
Last Week
627,936
Last Month
2,724,650
Last Year
20,208,715
GitHub Statistics
NOASSERTION License
242 Stars
179 Commits
47 Forks
6 Watchers
6 Branches
70 Contributors
Updated on Jun 26, 2025
Bundle Size
47.38 kB
Minified
19.65 kB
Minified + Gzipped
Maintainers
3
Package Meta Information
Latest Version
2.0.2
Package Id
better-ajv-errors@2.0.2
Unpacked Size
102.50 kB
Size
19.95 kB
File Count
64
NPM Version
10.9.2
Node Version
22.14.0
Published on
May 31, 2025
Total Downloads
Cumulative downloads
Total Downloads
84,963,605
Last Day
-0.1%
28,345
Compared to previous day
Last Week
-5.8%
627,936
Compared to previous week
Last Month
5.2%
2,724,650
Compared to previous month
Last Year
33.6%
20,208,715
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
JSON Schema validation for Human 👨🎤
Main goal of this library is to provide relevant error messages like the following:
Installation
1$ npm i better-ajv-errors 2$ # Or 3$ yarn add better-ajv-errors
Also make sure that you installed ajv package to validate data against JSON schemas.
Usage
First, you need to validate your payload with ajv. If it's invalid then you can pass validate.errors object into better-ajv-errors.
1import Ajv from 'ajv'; 2import betterAjvErrors from 'better-ajv-errors'; 3// const Ajv = require('ajv'); 4// const betterAjvErrors = require('better-ajv-errors').default; 5// Or 6// const { default: betterAjvErrors } = require('better-ajv-errors'); 7 8// You need to pass `{ jsonPointers: true }` for older versions of ajv 9const ajv = new Ajv(); 10 11// Load schema and data 12const schema = ...; 13const data = ...; 14 15const validate = ajv.compile(schema); 16const valid = validate(data); 17 18if (!valid) { 19 const output = betterAjvErrors(schema, data, validate.errors); 20 console.log(output); 21}
API
betterAjvErrors(schema, data, errors, [options])
Returns formatted validation error to print in console. See options.format for further details.
schema
Type: Object
The JSON Schema you used for validation with ajv
data
Type: Object
The JSON payload you validate against using ajv
errors
Type: Array
Array of ajv validation errors
options
Type: Object
format
Type: string
Default: cli
Values: cli js
Use default cli output format if you want to print beautiful validation errors like following:
Or, use js if you are planning to use this with some API. Your output will look like following:
1[ 2 { 3 start: { line: 6, column: 15, offset: 70 }, 4 end: { line: 6, column: 26, offset: 81 }, 5 error: 6 '/content/0/type should be equal to one of the allowed values: panel, paragraph, ...', 7 suggestion: 'Did you mean paragraph?', 8 }, 9];
indent
Type: number null
Default: null
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.
No vulnerabilities found.
Reason
22 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 17 commits out of 27 are checked with a SAST tool
Reason
Found 1/7 approved changesets -- score normalized to 1
Reason
dangerous workflow patterns detected
Details
- Warn: script injection with untrusted input ' github.event.pull_request.head.ref ': .github/workflows/dependabot.yml:18
- Warn: script injection with untrusted input ' github.event.pull_request.head.ref ': .github/workflows/dependabot.yml:51
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:17
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:18
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/dependabot.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependabot.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/dependabot.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabot.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/dependabot.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependabot.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/dependabot.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/release.yml/main?enable=pin
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
4
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More