Helix Shared
Shared libraries for Project Helix.
Status
Usage
HelixConfig
to read Helix configuration files
Using Helix is using YAML files for configuration management, but with the HelixConfig
class, exported from @adobe/helix-shared
, you can read, validate, and access configuration files with ease:
const { HelixConfig } = require('@adobe/helix-shared');
// in an async function
const configfromyaml = new HelixConfig()
.withSource(yamlstring)
.init();
const configfromjson = new HelixConfig()
.withJSON(jsonobject)
.init();
const configfromfile = new HelixConfig()
.withDirectory('/path/to/dir') // the directory contains a `helix-config.yaml`
.init();
sequence
, functional
, and op
for functional programming
Using Development
Build
npm install
Test
npm test
Lint
npm run lint