https://github.com/jopemachine-arvis/arvis-extension-validator

Extension validator for Arvis
https://github.com/jopemachine-arvis/arvis-extension-validator

arvis arvis-extension cli json-schema-validator

Last synced: 4 months ago
JSON representation

Extension validator for Arvis

• Host: GitHub
• URL: https://github.com/jopemachine-arvis/arvis-extension-validator
• Owner: jopemachine-arvis
• License: mit
• Created: 2021-06-05T06:11:46.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-22T12:48:14.000Z (over 3 years ago)
• Last Synced: 2025-02-17T17:03:46.063Z (4 months ago)
• Topics: arvis, arvis-extension, cli, json-schema-validator
• Language: JavaScript
• Homepage:
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# arvis-extension-validator

[![CodeFactor](https://www.codefactor.io/repository/github/jopemachine/arvis-extension-validator/badge)](https://www.codefactor.io/repository/github/jopemachine/arvis-extension-validator)

[![NPM download total](https://img.shields.io/npm/dt/arvis-extension-validator)](http://badge.fury.io/js/arvis-extension-validator)

[![CI](https://github.com/jopemachine/arvis-extension-validator/actions/workflows/main.yml/badge.svg)]()

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

[![GitHub issues](https://img.shields.io/github/issues/jopemachine/arvis-extension-validator.svg)](https://GitHub.com/jopemachine/arvis-extension-validator/issues/)

> [Arvis](https://github.com/jopemachine/arvis) extension's JSON schema, cli and library to validate this.

## Install

```

$ npm install -g arvis-extension-validator

```

## Schema

All schema files could be developed in the `schema` folder.

The files in the project root path are there to be imported from online directly.

`non-strict` files allow `additionalProperties`.

library's validator use `non-strict` file.

Recommend to use normal `strict` file when developing extension.

## How to add schema

Just add to below line to `arvis-workflow.json`

```json

{

  "$schema": "https://raw.githubusercontent.com/jopemachine/arvis-extension-validator/master/workflow-schema.json"

}

```

In case of `plugin`,

```json

{

  "$schema": "https://raw.githubusercontent.com/jopemachine/arvis-extension-validator/master/plugin-schema.json"

}

```

## Cli Usage

```

Usage

  $ arvis-validate workflow arvis-workflow.json

  $ arvis-validate plugin arvis-plugin.json

```

## Related

- [arvish](https://github.com/jopemachine/arvish) - Arvis workflow, plugin creator tools