1.1.0 • Published 4 years ago
dep_to_doc_cli v1.1.0
Cross platform Command Line Interface utility with Node.js
Document your npm dependencies into your README.md file : dep to doc !
TODO: write a better README.md
Table of Contents
Install
We recommend to install dep to doc globally
$ npm install deptodoc --globalUsage
$ deptodocREADME file
~~{dependencies}~~Add the following tag ~~{dependencies}~~ into your README.md file, then run the command deptodoc, the cli will replace the tag with your list of installed dependencies.
List of Packages
Dependencies
| Package | Description |
|---|---|
| cross-env | Run scripts that set and use environment variables across platforms |
| inquirer | A collection of common interactive command line user interfaces |
| underscore | JavaScript's functional programming helper library |
devDependencies
| Package | Description |
|---|---|
| better-docs | JSdoc theme |
| chai | BDD/TDD assertion library for node.js and the browser. Test framework agnostic |
| chai-as-promised | Extends Chai with assertions about promises |
| chalk | Terminal string styling done right |
| debug | Small debugging utility |
| eslint | An AST-based pattern checker for JavaScript |
| eslint-config-standard | JavaScript Standard Style - ESLint Shareable Config |
| eslint-plugin-import | Import with sanity |
| eslint-plugin-node | Additional ESLint's rules for Node.js |
| eslint-plugin-promise | Enforce best practices for JavaScript promises |
| eslint-plugin-standard | ESlint Plugin for the Standard Linter |
| jsdoc | An API documentation generator for JavaScript |
| jsdoc-mermaid | A tool to automagically create flowcharts and diagrams in your jsdocs |
| mocha | Simple, flexible, fun test framework |
| nyc | The Istanbul command line interface |
| sinon | JavaScript test spies, stubs and mocks |
List of Packages generated by Dep to Doc CLI 1.0.0
Coverage
Author
- Thomas G. aka Drozerah - GitHub
License
- ISC © Thomas G. aka Drozerah