https://github.com/ralphtheninja/depgrep

Search dependents of a node module.
https://github.com/ralphtheninja/depgrep

dependents github search

Last synced: 9 days ago
JSON representation

Search dependents of a node module.

• Host: GitHub
• URL: https://github.com/ralphtheninja/depgrep
• Owner: ralphtheninja
• License: gpl-3.0
• Created: 2018-01-01T16:12:15.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-11T17:21:04.000Z (over 4 years ago)
• Last Synced: 2024-12-27T17:39:58.649Z (13 days ago)
• Topics: dependents, github, search
• Language: JavaScript
• Homepage:
• Size: 110 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# depgrep

> Search dependents of a node module.

[![Build Status](https://travis-ci.org/ralphtheninja/depgrep.svg?branch=master)](https://travis-ci.org/ralphtheninja/depgrep)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

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`](https://github.com/doowb/module-dependents)

* Uses the [GitHub Search API](https://developer.github.com/v3/search/) to search for keywords

* Output heavily influenced by [`the_silver_searcher`](https://github.com/ggreer/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`](https://github.com/level/level). Storage path defaults to `~/.depgrep/db` but can be configured by the `depgrep_db` environment variable (determined by [`rc`](https://github.com/dominictarr/rc)).

## Install

```

$ npm i depgrep -g

```

## Usage

### Search Dependents

Search for `testBuffer` in dependents of `abstract-leveldown`

![image](depgrep.gif)

### Options

To clear search results and cached dependents:

```

$ depgrep -c | --clear-cache

```

Display help:

```

$ depgrep -h | --help

```

## License

[GPL-3.0](LICENSE) © 2018-present Lars-Magnus Skog.