apeman-need

Needs checker for apeman.

Usage no npm install needed!

<script type="module">
  import apemanNeed from 'https://cdn.skypack.dev/apeman-need';
</script>

README

apeman-need

Build Status Code Climate Code Coverage npm Version JS Standard

Needs checker for apeman.

Installation

Install apeman-need module via npm.

$ npm install apeman-need -g

Usage

  1. Prepare an Apemanfile.js at your project root.
  2. Run the command via CLI.

Apemanfile.js

/** Example of Apemanfile.js */

'use strict'

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $aou: { /* ... */ }
}

Then,

$ apeman-need
CLI Options
$ apeman-need -h

  Usage: apeman-need [options] 

  Check project needs.

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -c, --configuration <configuration>  Pathname of Apemanfile

  Examples:

    $ apeman-need                     # Check projects needs.

Programmatic API

apeman-need also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-need --save-dev

Then,

'use strict'

const apemanNeed = require('apeman-need')

apemanNeed({}).then(() => {
  /* ... */
})
Programmatic Options
Key Description Default
configuration Pathname of Apemanfile

License

This software is released under the MIT License.

Links