depgrep v2.0.0

depgrep

Search dependents of a node module.

As a module and/or maintenance developer it can be handy to gather information on which modules are actually using your module, e.g. which parts of the api it uses, variable names etc. This can be particularly useful when changing the API and helps answering the question How will this change affect the users of my module?.

Features

• Finds dependents of a module using module-dependents
• Uses the GitHub Search API to search for keywords
• Output heavily influenced by the_silver_searcher but points out blobs on GitHub rather than files on the local file system
• Search results are indexed based on the queried module and query which helps with repetetive and offline queries
• Dependent modules are cached for faster and offline queries

Data is stored using level. Storage path defaults to ~/.depgrep/db but can be configured by the depgrep_db environment variable (determined by rc).

Install

$ npm i depgrep -g

Usage

Search Dependents

Search for testBuffer in dependents of abstract-leveldown

Options

To clear search results and cached dependents:

$ depgrep -c | --clear-cache

Display help:

$ depgrep -h | --help

License

GPL-3.0 © 2018-present Lars-Magnus Skog.