Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gr2m/octoherd-script-normalize-package-repository-field
Octoherd script which sets "repository" to "github:{owner}/{repo}" and removes redundant "homepage" and "bugs" fields
https://github.com/gr2m/octoherd-script-normalize-package-repository-field
octoherd-script
Last synced: 17 days ago
JSON representation
Octoherd script which sets "repository" to "github:{owner}/{repo}" and removes redundant "homepage" and "bugs" fields
- Host: GitHub
- URL: https://github.com/gr2m/octoherd-script-normalize-package-repository-field
- Owner: gr2m
- License: isc
- Created: 2021-03-05T01:29:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-23T19:40:57.000Z (about 2 years ago)
- Last Synced: 2024-04-13T22:27:43.113Z (7 months ago)
- Topics: octoherd-script
- Language: JavaScript
- Size: 45.9 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-octoherd-scripts - Normalize package repository field - Remove redundant information from repository, homepage, bugs fields in `package.json`. (Scripts)
README
# octoherd-script-normalize-package-repository-field
> Remove redundant information from repository, homepage, bugs fields in package.json
[](https://www.npmjs.com/package/octoherd-script-normalize-package-repository-field)
[](https://github.com/gr2m/octoherd-script-normalize-package-repository-field/actions?query=workflow%3ATest+branch%3Amain)
This script turns
```json
{
"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
```json
{
"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](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#repository), [bugs](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#bugs), and [homepage](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#homepage) fields
## Usage
Minimal usage
```js
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/*"
```
## Options
| option | type | description |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--octoherd-token`, `-T` | string | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). 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 |
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## About Octoherd
[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.
## License
[ISC](LICENSE.md)