@xriptjs/validate

Validate xript manifests against the specification schema.

Install

npm install @xriptjs/validate

CLI

npx xript-validate manifest.json

Validates one or more manifest files and prints results:

✓ manifest.json
✗ bad-manifest.json
  /bindings/greet: missing required property "description"
  /xript: must match pattern "^\d+\.\d+$"

Exit code is 1 if any file fails validation.

API

import { validateManifest, validateManifestFile } from "@xriptjs/validate";

const result = await validateManifest({
  xript: "0.1",
  name: "my-app",
  bindings: {
    greet: {
      description: "Returns a greeting.",
      params: [{ name: "name", type: "string" }],
      returns: "string",
    },
  },
});

console.log(result.valid);  // true
console.log(result.errors); // []

validateManifest(manifest): Promise<ValidationResult>

Validates a manifest object against the xript JSON Schema.

validateManifestFile(path): Promise<ValidationResult & { filePath: string }>

Reads a JSON file from disk and validates it.

ValidationResult

interface ValidationResult {
  valid: boolean;
  errors: ValidationError[];
}

interface ValidationError {
  path: string;
  message: string;
  keyword: string;
}

Documentation

xript.dev: full docs and manifest specification.

License

MIT