Normally Pleasant Mixture

    apeman-tree

    5.0.3 • Public • Published

    apeman-tree

    Build Status Code Climate Code Coverage npm Version JS Standard

    Inheritance tree inspector for apeman.

    Installation

    Install apeman-tree module via npm.

    $ npm install apeman-tree -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: [
        require('apeman-proto-abstract'),
        require('apeman-proto-plain')
      ],
      $tmpls: { /* ... */ },
      $tasks: { /* ... */ },
      $apps: { /* ... */ },
      $wchs: { /* ... */ }
    }

    Then,

    $ apeman-tree
     
    my-demo-pkg
    ├── apeman-proto-abstract
    └── apeman-proto-plain
         ├── apeman-proto-npm
         │   └── apeman-proto-abstract
         ├── apeman-proto-basic
         │   └── apeman-proto-abstract
         └── apeman-proto-abstract
    CLI Options
    $ apeman-tree -h
     
      Usage: apeman-tree [options] 
     
      Show project inheritance in the tree.
     
      Options:
     
        -h, --help                           output usage information
        -V, --version                        output the version number
        -c, --configuration <configuration>  Pathname of Apemanfile
     
      Examples:
     
      $ apeman-tree                   # Show inheritance tree of current project. 
     
     

    Programmatic API

    apeman-tree also provide programmatic API.

    Firstly, install the module locally.

    $ npm install apeman-tree --save-dev

    Then,

    'use strict'
     
    const apemanTree = require('apeman-tree')
     
    apemanTree({}).then(() => {
      /* ... */
    })
     
    Programmatic Options
    Key Description Default
    configuration Pathname of Apemanfile

    License

    This software is released under the MIT License.

    Links

    Install

    npm i apeman-tree

    DownloadsWeekly Downloads

    6

    Version

    5.0.3

    License

    MIT

    Last publish

    Collaborators

    • okunishinishi