Skip to content

jopemachine-arvis/arvis-extension-validator

Repository files navigation

arvis-extension-validator

CodeFactor NPM download total CI MIT license PR's Welcome GitHub issues

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

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

In case of plugin,

{
  "$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 - Arvis workflow, plugin creator tools