@unifig/validation-presenter-table

Table validation presenter for Unifig

Transforms configuration validation errors into clear table.

Table of contents

• Installation
• Quick Start
• Example output
• License

Installation

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

Quick Start

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

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

bootstrap();

Example output

┌──────────────────┬─────────────┬────────┬─────────────┬───────────────┬────────────────────┐
│ Template         │ Property    │ Type   │ Source      │ Current Value │ Failed constraints │
├──────────────────┼─────────────┼────────┼─────────────┼───────────────┼────────────────────┤
│                  │ port        │ Number │ PORT        │ "not-a-port"  │ isInt              │
│                  ├─────────────┼────────┼─────────────┼───────────────┼────────────────────┤
│ TemplateMock     │ db.url      │ String │ DB_URL      │ undefined     │ isString           │
│                  ├─────────────┼────────┼─────────────┼───────────────┼────────────────────┤
│                  │ db.password │ String │ DB_PASSWORD │ undefined     │ isString           │
└──────────────────┴─────────────┴────────┴─────────────┴───────────────┴────────────────────┘

Source column presents where property value was taken from.

Example: from env variables in case of Env Adapter.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

0.13.0 (2023-02-07)

Features

• adapter-env: changed interface to synchronous variant (f0c81f0)
• core: added possible reasons to config not initialized message (57896d8)
• core: added properties types to validation error (967f4a5)
• core: synchronous option to load configuration (b61db11)
• validation-presenter-json: added properties types (9aaa50d)
• validation-presenter-table: added properties types (22d9b95)