Remove redundant information from repository, homepage, bugs fields in package.json
This script turns
{
"repository": {
"type": "git",
"url": "https://github.com/octocat/hello-world.git"
},
"bugs": {
"url": "https://github.com/octocat/hello-world/issues"
},
"homepage": "https://github.com/octocat/hello-world/#readme"
}
into
{
"repository": "github:octocat/hello-world"
}
"bugs"
and "homepage"
are derived from the repository if it is hosted on GitHub. Learn more about package.json
's repository, bugs, and homepage fields
Minimal usage
npx octoherd-script-normalize-package-repository-field
Pass all options as CLI flags to avoid user prompts
npx octoherd-script-normalize-package-repository-field \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "gr2m/*"
option | type | description |
---|---|---|
--octoherd-token , -T
|
string | A personal access token (create). Script will create one if option is not set |
--octoherd-repos , -R
|
array of strings | One or multiple space-separated repositories in the form of repo-owner/repo-name . repo-owner/* will find all repositories for one owner. * will find all repositories the user has access to. Will prompt for repositories if not set |
--octoherd-bypass-confirms |
boolean | Bypass prompts to confirm mutating requests |
See CONTRIBUTING.md
@octoherd is project to help you keep your GitHub repositories in line.