npmpackage.info

Gathering detailed insights and metrics for better-ajv-errors

better-ajv-errors

JSON Schema validation for Human 👨‍🎤

1.2.0

235

NOASSERTION

JavaScript

20.18 kB

72,914,073 1.9

Installations

npm install better-ajv-errors

Pull Requests

Open

19

Total

126

Closed

21

Merged

86

Issues

Open

29

Total

59

Closed

30

Releases

v1.2.0

Published on 12 Apr 2022

v1.1.2

Published on 26 Nov 2021

v1.1.1

Published on 19 Nov 2021

v1.1.0

Published on 13 Nov 2021

v1.0.0

Published on 10 Nov 2021

v0.8.2

Published on 07 Nov 2021

View all 11 releases

Developer

atlassian

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

>= 12.13.0

Typescript Support

Yes

Node Version

12.22.11

NPM Version

6.14.16 Statistics

235 Stars

157 Commits

45 Forks

7 Watching

14 Branches

76 Contributors

Updated on 13 Nov 2024

Bundle Size

49.86 kB

Minified

20.18 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (98.92%)

TypeScript (0.76%)

Shell (0.32%)

Total Downloads

Cumulative downloads

Total Downloads

72,914,073

Last day

-5.4%

59,213

Compared to previous day

Last week

0.9%

345,109

Compared to previous week

Last month

2.2%

1,479,022

Compared to previous month

Last year

4.5%

16,001,612

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependabot.yml:24: 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:15: 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: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:30: 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:38: 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:41: 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: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: 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:32: update your workflow using https://app.stepsecurity.io/secureworkflow/atlassian/better-ajv-errors/release.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/dependabot.yml:30
Warn: npmCommand not pinned by hash: .github/workflows/main.yml:47
Warn: npmCommand not pinned by hash: .github/workflows/main.yml:24
Warn: npmCommand not pinned by hash: .github/workflows/release.yml:28
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 4 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.9

/10

Last Scanned on 2024-11-25

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

better-ajv-errors

Installations

Pull Requests

19

126

21

86

Issues

29

59

30

Releases

Developer

Developer Guide

CommonJS, ESM

>= 12.13.0

Yes

12.22.11

6.14.16

Statistics

Bundle Size

49.86 kB

20.18 kB

Languages

Total Downloads

72,914,073

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Installation

Usage

API

betterAjvErrors(schema, data, errors, [options])

schema

data

errors

options

format

indent

json

10

9

7

1

0

0

0

0

0

0

0

0

1.9

/10