briskly-json

briskly.json parser

Usage no npm install needed!

<script type="module">
  import brisklyJson from 'https://cdn.skypack.dev/briskly-json';
</script>

README

briskly-json

Find and parse briskly.json in Briskly projects

NPM version Travis build status

Installation

npm install briskly-json --save

Usage

{
    "main": "path/to/index.html",
    "port": 80, // Web server port number
    "host": "localhost", // Web server hostname
    "routes": {
        "/example": { // route path
            "method": "GET", // request method
            "handler": "routes/example.js" // route handler function
        },
        ...
    },
    "components": {
        "br-header": { // Name of web component
            "template": "components/header/template.html", // Location of view template markup
            "viewModel": "components/header/model.js" // Location of view model constructor
        },
        ...
    }
}
// TypeScript
import BrisklyJson = require('briskly-json');


var config = BrisklyJson.json;
// Returns briskly.json contents as a JavaScript object

var jsonPath = BrisklyJson.path;
// Returns the expected path of briskly.json

License

MIT