Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antfu/package-docs
Get packages' document homepages from package.json
https://github.com/antfu/package-docs
Last synced: 29 days ago
JSON representation
Get packages' document homepages from package.json
- Host: GitHub
- URL: https://github.com/antfu/package-docs
- Owner: antfu
- License: mit
- Created: 2018-08-26T21:24:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-13T22:14:10.000Z (over 4 years ago)
- Last Synced: 2024-10-04T22:12:26.277Z (about 1 month ago)
- Language: JavaScript
- Size: 89.8 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Package Docs
[](https://www.npmjs.com/package/package-docs)
[](https://depfu.com/github/antfu/package-docs?project=Npm)
[](https://github.com/antfu/package-docs#readme)
Get packages' document homepages from `package.json`
## Install
```bash
$ npm i -g package-docs
```
## Usage
```bash
$ package-docs
```
It will read `package.json` and get packages in the `dependencies`/`devDependencies`/`peerDependencies` fields and save their document homepage urls into `package-docs.json`.
```json
// pacakge.json
{
"name": "package-docs",
"dependencies": {
"axios": "^0.18.0",
"chalk": "^2.4.1",
"lodash": "^4.17.10",
"minimist": "^1.2.0",
"prettyjson": "^1.2.1"
},
"devDependencies": {
"eslint": "^5.4.0",
"eslint-config-standard": "^11.0.0"
}
}
```
output:
```json5
dependencies:
axios: https://github.com/axios/axios
chalk: https://github.com/chalk/chalk#readme
lodash: https://lodash.com/
minimist: https://github.com/substack/minimist
prettyjson: http://rafeca.com/prettyjson
devDependencies:
eslint: https://eslint.org
eslint-config-standard: https://standardjs.com
```
### Output to file
You may also save the output to json file by specifying the option `-o`, the output will save to `package-docs.json` by default
```bash
$ package-docs -o
```
### Inline query
```bash
$ package-docs vue vuex
```
```
vue: http://vuejs.org
vuex: https://vuex.vuejs.org
```
### Open in browser
```bash
$ package-docs vue --open
```
`--open` option will make a prompt to confirm when opening more than 5 urls. You can specify `-y` to bypass the prompt.
## TODO
- [x] Open in browser
- [ ] Better error handling
- [x] Querying indicator
- [x] Publish to npm
- [ ] Unit tests
- [x] Rewrite use class
- [ ] Node.js API
- [ ] Cache
## License
MIT [@antfu](https://github.com/antfu) 2018