verb-trees
Verb plugin for generating files trees for documentation.
Table of Contents
(TOC generated by verb using markdown-toc)
Real examples
Example projects that use this plugins:
Install
Install with npm:
$ npm install --save verb-trees
Usage
;
fn
{Function}: generator function (Generate, not es6)options
{Object|Array}: Options object or array of task names.
Plugin usage
Register as a plugin, where app
is an instance of generate, assemble, verb, or update:
app;
Sub-generator
This creates a sub-generator named treeGenerator
, along with a few tasks on the sub-generator for controlling flow. The sub-generator tasks probably don't need to be accessed directly though.
"tree" trask
A trees
task is added to app
for running the sub-generator, which builds the trees for the specified tasks.
Example
app;app;
Trees
Generated "dest" trees look something like this:
. ├─┬ test │ ├─┬ fixtures │ │ ├── content.tmpl │ │ ├── default.tmpl │ │ └── nothing.tmpl │ └── test.js ├── .editorconfig ├── .gitignore ├── LICENSE ├── package.json ├── README.md └── index.js
Diffs
When one of the tasks is named default
, diffs are generated automatically, and each diff is based on a comparison to the default.
.-├─┬ test-│ ├─┬ fixtures-│ │ ├── content.tmpl-│ │ ├── default.tmpl-│ │ └── nothing.tmpl-│ └── test.js-├── .editorconfig-├── .gitignore-├── LICENSE-├── package.json-├── README.md └── index.js
Examples
Basic example
var project = ;var trees = ; module { // generate trees for the `default`, `minimal` and `gulp` tasks app;};
Full example
var path = ;var trees = ;var genFn = ;var del = ; module { // register verb-generate-readme as a plugin app; // specify the tasks to run and generate trees for, from `generate-project` app; // delete temp files after the build is finished app; // run the `trees` task first, so the `readme` generator // can use the trees as includes app;};
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.28, on July 31, 2016.