apemanfile

Configuration file handler for apeman framework.

Usage no npm install needed!

<script type="module">
  import apemanfile from 'https://cdn.skypack.dev/apemanfile';
</script>

README

apemanfile

Build Status Code Climate Code Coverage npm Version JS Standard

Configuration file handler for apeman framework.

Installation

npm install apemanfile --save

Usage

Load an apemanfile for a project.

'use strict'

const apemanfile = require('apemanfile')

// Create an apemanfile instance
let configuration = apemanfile('my_project_dir/Apemanfile.js')

// Get property with keypath
let task = configuration.get('$task.build')
/* ... */

Spec

Properties in Apemanfile.js

Property Type Description
$api API interfaces
$children Child projects
$ctx Context values
$cwd Working directory path
$defaultCtx Default context values
$name Name of this apeman file
$needs Needed commands
$notes Description of properties
$parent Parent project
$pkg Package data
$proto Prototype projects
$src Path of loaded file
$ui User interface settings

License

This software is released under the MIT License.