https://github.com/torifat/adf-validator

ADF document validator
https://github.com/torifat/adf-validator

adf atlassian json-schema-validator

Last synced: about 2 months ago
JSON representation

ADF document validator

• Host: GitHub
• URL: https://github.com/torifat/adf-validator
• Owner: torifat
• Created: 2020-03-10T04:30:36.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T20:57:01.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T02:04:32.505Z (8 months ago)
• Topics: adf, atlassian, json-schema-validator
• Language: JavaScript
• Homepage:
• Size: 614 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## ADF Validator

[ADF](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) document validator

### Install

```

$ npm i -g adf-validator

$ # or

$ npm install --global adf-validator

```

### Usage

```

  $ adfv 

  Options

    --stage-0           Validate against the stage-0 ADF Schema  [Default: false]

    --version    Specify version of @atlaskit/adf-schema  [Default: latest]

    --force             Ignore current cache and re-download the Schemas  [Default: false]

    --schema    Use a local schema for validation. Ignores all online validation flags

  Examples

    $ adfv sample-document-1.json

    $ adfv --stage-0 sample-document-2.json

    $ adfv --version 5.0.0 sample-document-3.json

    $ adfv --force --stage-0 sample-document-4.json

    $ adfv --schema local-schema.json sample-document-4.json

  Notes

    - By default it validates against the full ADF Schema.

```

## Demo

[![ADF Validator](https://asciinema.org/a/l4i4yNQIOiGpox0fNPfZFjRWT.svg)](https://asciinema.org/a/l4i4yNQIOiGpox0fNPfZFjRWT)