Gathering detailed insights and metrics for @stoplight/better-ajv-errors
Gathering detailed insights and metrics for @stoplight/better-ajv-errors
JSON Schema validation for Human 👨🎤
Installations
npm install @stoplight/better-ajv-errorsReleases
Unable to fetch releases
Developer
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
^12.20 || >= 14.13
Typescript Support
No
Node Version
16.17.0
NPM Version
8.15.0
Statistics
2 Stars
103 Commits
3 Forks
2 Watching
9 Branches
54 Contributors
Updated on 07 Sept 2022
Bundle Size
5.51 kB
Minified
2.20 kB
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
57,517,385
Last day
-4.1%
161,857
Compared to previous day
Last week
2%
834,143
Compared to previous week
Last month
15.6%
3,335,513
Compared to previous month
Last year
71.7%
30,035,071
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
1
Versions
JSON Schema validation for Human 👨🎤
Main goal of this library is to provide relevant AJV error messages. It's a fork of great better-ajv-errors by Atlassian, with focus on being leaner.
Installation
1$ yarn add @stoplight/better-ajv-errors
or
1$ npm i @stoplight/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 '@stoplight/better-ajv-errors'; 3// const Ajv = require('ajv'); 4// const betterAjvErrors = require('better-ajv-errors'); 5 6// You need to pass `jsonPointers: true` 7const ajv = new Ajv({ jsonPointers: true }); 8 9// Load schema and data 10const schema = ...; 11const data = ...; 12 13const validate = ajv.compile(schema); 14const valid = validate(data); 15 16if (!valid) { 17 const output = betterAjvErrors(schema, validate.errors, { 18 propertyPath: [], 19 targetValue: data, 20 }); 21 console.log(output); 22}
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.
errors
Type: Array
Array of ajv validation errors
options
Type: Object
propertyPath
Type: Array
Property path of a validated object that is a part of a bigger document. Might be empty if the validated object equals the whole document.
targetValue
Type: Object
The JSON payload you validate against using ajv.
No vulnerabilities found.
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
Found 1/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
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
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 1 are checked with a SAST tool
Reason
32 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.9
/10
Last Scanned on 2024-11-18
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