@nomad-xyz/configuration
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Nomad Config file

This is a crate for working with nomad configuration files. These config files contain information about the state of Nomad deployments.

It also includes an auto-generated TS/WASM library.

Design Notes

The core library is mostly a JSON config file format. We define Rust structs and TS types for all parts of this config.

In TS, the object is a native JS object. It is not a reference to a wasm type. Assignment and access can be done as normal. However, we have also exported functions that perform consistency-critical operations like addNetwork and addCore. We strongly recommend using these instead of assigning to the relevant sections.

Usage

Typescript

import * as configuration from "@nomad-xyz/configuration"

const config = configuration.getBuiltin("production")

console.log(`Environment: ${config.environment}`)

Rust

// TODO

Building

  • $ cargo build

To build the wasm library:

wasm-pack docs are found here.

Testing

  • $ cargo test

Documenting

  • $ cargo docs --open

Releasing

Prepare Release

  • Update Changelog from unreleased to next version
  • Bump package version in cargo.toml to <new-package-version>
  • Run the tests locally: cargo test
  • Make a PR and merge it

Release / Publish

  • Tag newly-merged commit: git tag -s @nomad-xyz/configuration@<new-package-version>
  • Push tags: git push --tags
  • Publish to NPM: ./publish_npm.sh

Development note

To work around some wasm-bindgen limitations, we currently (unfortunately) have to manually define TS types for the rust structs. These are found in the data directory. When a rust struct is updated or added, the corresponding definitions should be added in data/definitions.ts and data/types.rs. At compile-time these files are combind to src/wasm/types.rs.

In the future it'd be cool to auto-generate this code :)

Readme

Keywords

none

Package Sidebar

Install

npm i @nomad-xyz/configuration

Weekly Downloads

6

Version

2.0.1

License

MIT OR Apache-2.0

Unpacked Size

1.06 MB

Total Files

9

Last publish

Collaborators

  • rswanson
  • annascarroll
  • prestwich
  • erinhales