balena cdsl
A configuration DSL.
Provides facilities to:
- transform configuration DSL into the JSON Schema & UI Object Schema with custom extensions
- parse configuration DSL
Current crate status is experimental. It's because the API is evolving, we're not fully using it yet and we will probably move the transformation functionality to another crate in the future. This crate will become a simple configuration DSL parser and nothing else.
Goal
balena-cdsl
crate is one small piece of the balena.io configuration project. This project has
no public / open specification yet, but we're working on it and it will be public once finished.
Supported platforms
This library is written in the Rust language and can be used:
- directly, as a Rust crate
- as an isomorphic NPM package (NodeJS & browser)
Documentation
Usage
Rust
Add as a dependency to your Cargo.toml
:
[dependencies]
balena-cdsl = "0.2"
Evaluate simple JSON:
let input_schema: Value = from_str.
unwrap;
let = with?.generate;
Javascript
Install via npm
npm install --save balena-cdsl
Generate simple JSON Schema & UI Object Schema:
const cdsl = require;
const initialValue = `
title: demo
version: 1
properties:
- network:
title: Network
properties:
- ssid:
title: Network SSID
type: string
minLength: 1
maxLength: 32
- passphrase:
title: Network Key
type: password
minLength: 8
`;
console.log;
An example of using this module in nodeJS is available in the examples/node
folder:
An example of using this module in the browser is available in the examples/browser
folder:
Open localhost:8080
in your browser.
Support
If you're having any problem, please raise an issue on GitHub or contact us, and the balena.io team will be happy to help.
License
balena-cdsl
is open source software, and may be redistributed under the terms specified in
the license.