@tyler.thayn/pkg-tools

Various development and management tools for design packages/repos.

Installation

npm install @tyler.thayn/pkg-tools --save-dev

Usage

1. Run pkg init tools

pkg-tools pkg merge
pkg-tools pkg install
pkg-tools copy

2. Grunt

• Modify Gruntfile.js so that correct file paths are used

grunt || grunt docs

3. CLI

pkg-tools --help

4. README.md customization
   • build/templates/README.MD

Code/Api

AST

• ∌ Load(file) => {Promise.<AST>}
• Data {object}
• Filter(filters) => {AST}
• Outline() => {object}

cli

• bump {object}
• docs {object}

tasks/bump

tasks/readme

• Options
• ast {boolean|string} AST output file or false to skip
• output {null|string} Output folder or null (stdout)
• template {string} Template path

Docs

• Options
• ast {boolean|string} AST output file or false to skip
• output {null|string} Output folder or null (stdout)
• template {string} Template path

License

Licensed under the MIT License (see MIT).