If I have seen a little further it is by standing on the shoulders of giants.
—Isaac Newton, John of Salisbury, and others before them
Quickly view a list of open issues for the open-source packages that your project depends on.
shoulders will find dependencies in the
node_modules folder, identify corresponding repositories on GitHub, and query GitHub's API for open issues.
If your project depends on many packages you will likely run into rate limiting errors from the GitHub API; you can increase the limit by using a personal access token (the only scope needed is
public_repo) and passing it to
shoulders via the
$GITHUB_TOKEN environment variable:
GITHUB_TOKEN='<your token>' npx shoulders
||Filter issues by labels|
||Look for issues only
||Format the output|
In addition to listing all open issues, you can optionally include
a comma-separated list of labels to use. For example, to see only
issues with the
npx shoulders --labels bug
Or to include multiple labels, you can do:
npx shoulders --labels="bug,good first issue"
If you wish to look for issues only
n levels deep, you can specify
a depth parameter:
# Look for issues in your direct dependencies npx shoulders --depth=0
You can format the output by passing a format parameter:
npx shoulders --format html
If you'd like to create a new file you can pipe the output like this:
npx shoulders --format html > output.html
The available formats are currently
Modern software would not be possible without the mountains of previous work by others—much of it open source—as its foundation. In the spirit of Hacktoberfest 2019, this simple script makes it a little bit easier to find a way to support the projects that we depend on so heavily.
MIT © Matt Swensen