dry-parser

A simple tool for parsing JavaScript objects to avoid repetition.

Usage no npm install needed!

<script type="module">
  import dryParser from 'https://cdn.skypack.dev/dry-parser';
</script>

README

Dry Parser

NPM Version NPM Downloads Travis Coveralls

semantic-release

A simple tool for parsing JavaScript objects to avoid repetition.

This tool was primarily developed to parse config files.

Installation

$ npm install dry-parser

Usage - Parsing an Object

config.json - input

{
    "dir": {
        "assets": "assets",
        "less": "{dir.assets}/less",
        "bower": "{dir.assets}/bower_components"
    },
    "lib": {
        "jquery": "{dir.bower}/jquery/jquery.js"
    }
}

app.js

// Load dry-parser.
var dry = require('dry-parser');

// Load our configuration file.
var config = require('./config.json');

// Parse our config and get the real values.
config = dry.parse(config);

config.json - output

{
    "dir": {
        "assets": "assets",
        "less": "assets/less",
        "bower": "assets/bower_components"
    },
    "lib": {
        "jquery": "assets/bower_components/jquery/jquery.js"
    }
}

Usage - Bi-Parsing two objects

dir.json - input

{
    "assets": "assets",
    "less": "{assets}/less",
    "bower": "{assets}/bower_components"
}

lib.json - input

{
    "jquery": "{bower}/jquery/jquery.js"
}

app.js

// Load dry-parser.
var dry = require('dry-parser');

// Load our configuration file.
var dir = require('./dir.json');

var lib = require('./lib.json');

// Parse our config and get the real values.
lib = dry.parse(lib, dir);

lib.json - output

{
    "jquery": "assets/bower_components/jquery/jquery.js"
}

License

The MIT License

Copyright (c) 2016 Salte. https://www.salte.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.