A configuration DSL.
Provides facilities to:
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.
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.
This library is written in the Rust language and can be used:
Add as a dependency to your Cargo.toml:
[dependencies]
balena-cdsl = "0"
Evaluate simple JSON:
```rust let inputschema: serdeyaml::Value = serdeyaml::fromstr( include_str!("configuration.yml")). unwrap();
let (jsonschema, uiobject) = Generator::with(input_schema)?.generate(); ```
Install via npm
npm install --save balena-cdsl
Generate simple JSON Schema & UI Object Schema:
```js const cdsl = require('balena-cdsl');
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(cdsl.generate_ui(initialValue)); ```
An example of using this module in nodeJS is available in the examples/node folder:
bash
cd examples/node
npm install
npm start
An example of using this module in the browser is available in the examples/browser folder:
bash
cd examples/browser
npm install
npm start
Open localhost:8080 in your browser.
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.
balena-cdsl is open source software, and may be redistributed under the terms specified in
the [license].