Skip to content

zingchart/zingchart-config-validator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZingChart Config Validator

A TypeScript + Zod-based validator for ZingChart configuration files.

Features

  • Schema validation using Zod
  • Reusable validator function
  • CLI validation tool
  • Full TypeScript support

Installation

npm install
npm run build

Using the Validator Function

import { validateZingChartConfig } from "zingchart-config-validator";
import * as z from "zod";

// Valid config should pass
const config = {
  type: 'bar',
  series: [{
      values: [20, 40, 25, 50, 15, 45, 0, 0]
    },
    {
      values: [null, null, 21, 18, 59, 50, 28, 33]
    }
  ]
};

const result = validateZingChartConfig(config);

if (!result.success) {
  console.error("Config is invalid!");
  console.error(z.prettifyError(result.errors));
} else {
  console.log("Config is valid!");
};

Using the CLI

Validate a JSON file:

npx zc-validate path/to/config.json

Example:

npx zc-validate examples/valid-config.json

If valid:

✅ Config is valid.

If invalid:

❌ Validation failed:
<error details>

Project Structure

src/
  schema/
    zingchart.schema.ts
  validator/
    validator.ts
    types.ts
  cli
    validate-config.ts
examples/
  valid-config.json

Development

Rebuild after changes:

npm run build

Requirements

  • Node.js >= 18
  • TypeScript 5+

About

A TypeScript + Zod-based validator for ZingChart configuration files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors