Git Product home page Git Product logo

helix-shared's Introduction

Helix Shared

Shared libraries for Project Helix.

Status

NPM Version codecov CircleCI GitHub license GitHub issues LGTM Code Quality Grade: JavaScript Known Vulnerabilities

Helix Configuration Files

  • helix-fstab.yaml: maps paths to source URLs, use this to pull content from sources other than GitHub
  • helix-config.yaml: defines Strains (variants) of a Helix site, use this to create "environments", tests, or other variants
  • helix-query.yaml: define what can be indexed and queried in a Helix site
  • helix-markup.yaml: define what Markdown should generate which HTML, use this to tweak the HTML output

Usage

Using HelixConfig to read Helix configuration files

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();

Using sequence, functional, and op for functional programming

Development

Build

npm install

Test

npm test

Lint

npm run lint

helix-shared's People

Contributors

trieloff avatar semantic-release-bot avatar renovate[bot] avatar tripodsan avatar renovate-bot avatar dominique-pfister avatar stefan-guggisberg avatar greenkeeper[bot] avatar koraa avatar rofe avatar dependabot[bot] avatar kptdobe avatar ramboz avatar medusalix avatar stacksharebot avatar danrocha avatar dlemstra avatar filmaj avatar marquiserosier avatar maxakuru avatar 2lambda123 avatar lgtm-com[bot] avatar

Watchers

 avatar

helix-shared's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Failed to decrypt field npmToken. Please re-encrypt and try again.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.