markdown-dependencies
May 13, 2020 ยท View on GitHub
This tool has been created to create or update the Dependencies section in README.md of the SlimIO projects.
Requirements
- Node.js v12 or higher
Getting Started
Clone and link the project.
$ git clone https://github.com/SlimIO/Markdown-Dependencies.git
$ cd Markdown-Dependencies
$ npm link
Environment Variables
To configure the project you have to register (set) environment variables on your system. These variables can be set in a .env file (that file must be created at the root of the project).
NPM_TOKEN=
To known how to get a NPM_TOKEN or how to register environment variables follow our Governance Guide.
Usage example
When installed globally the mddep executable will be exposed in your terminal
$ cd yourProject
$ mddep generate
Use the argument -c or clipboard to copy the stdout to the clipboard.
How to complete
- Refactoring: Minor if the project can be easily replaced by another package (or by a native implementation).
- Security Risk: Does the project have indirect dependencies? Does it perform operations on http or fs ?
Dependencies
| Name | Refactoring | Security Risk | Usage |
|---|---|---|---|
| @slimio/npm-registry | Minor | Low | GET data from NPM registry |
| @slimio/pretty-json | Minor | Low | Stdout beautified JSON |
| clipboardy | Minor | High | Copy to clipboard |
| dotenv | Minor | Low | Loads environment variables from .env |
| kleur | Minor | Low | The fastest Node.js library for formatting terminal text with ANSI colors |
| make-promises-safe | Minor | Low | Force Node.js DEP00018 |
| marked | Minor | Low | Markdown tokenizer |
| sade | Minor | Low | Sade is a small but powerful tool for building command-line interface (CLI) applications for Node.js that are fast, responsive, and helpful! |
License
MIT