@unifig/validation-presenter-json NPM

JSON validation presenter for Unifig

Transforms configuration validation errors into json string.

JSON of contents

Installation

npm i @unifig/validation-presenter-json
# or
yarn add @unifig/validation-presenter-json

Quick Start

// main.ts
import { Config, PlainConfigAdapter } from '@unifig/core';
import { toJSON } from '@unifig/validation-presenter-json';

async function bootstrap() {
  const validationError = await Config.register({
    templates: [StorageOptions, NetworkOptions],
    adapter: new PlainConfigAdapter({}),
  });
  if (validationError) {
    console.error(toJSON(validationError));
    process.exit(1);
  }
}

bootstrap();

Example output

[
  {
    "template": "StorageOptions",
    "errors": [
      {
        "property": "port",
        "source": "PORT",
        "currentValue": "not-a-port",
        "failedConstraints": [
          {
            "details": "port must be an integer number",
            "name": "isInt"
          }
        ]
      },
      {
        "property": "db",
        "children": [
          {
            "property": "url",
            "source": "DB_URL",
            "failedConstraints": [
              {
                "details": "url must be a string",
                "name": "isString"
              }
            ]
          },
          {
            "property": "password",
            "source": "DB_PASSWORD",
            "failedConstraints": [
              {
                "details": "password must be a string",
                "name": "isString"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "template": "NetworkOptions",
    "errors": [
      {
        "property": "ipRange",
        "failedConstraints": [
          {
            "details": "ipRange must be defined",
            "name": "isDefined"
          }
        ],
        "children": []
      }
    ]
  }
]