toolkit-tree

Generates a formatted tree with all toolkit-related module dependencies. Useful for creating a tree to include in developer documentation of a toolkit project.

Install

Install with npm:

$ npm install --save toolkit-tree

Node.js usage

var toTree = require('toolkit-tree');
console.log(toTree());

CLI Usage

Run the following from the root of a toolkit project (any base generate, assemble, verb, or update project):

$ toolkit-tree

For example, when run from the root of generate-project results in the following tree:

generate-project
├─┬ generate-contributing
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
├─┬ generate-defaults
│ └─┬ generate-data
│   └── base-data
├── generate-editorconfig
├── generate-eslint
├── generate-gitattributes
├─┬ generate-gitignore
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
├─┬ generate-install
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
├─┬ generate-license
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
├─┬ generate-package
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
├─┬ generate-readme
│ └─┬ generate-defaults
│   └─┬ generate-data
│     └── base-data
└── generate-travis

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.4.1, on January 14, 2017.