https://github.com/a-tokyo/packages-list-extractor
📝Extracts packages with multiple options from package.json.
https://github.com/a-tokyo/packages-list-extractor
documentation-tool legal-citation lister opensource package-json
Last synced: 6 months ago
JSON representation
📝Extracts packages with multiple options from package.json.
- Host: GitHub
- URL: https://github.com/a-tokyo/packages-list-extractor
- Owner: a-tokyo
- License: mit
- Created: 2017-06-06T00:45:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-06T10:15:14.000Z (over 8 years ago)
- Last Synced: 2025-02-05T01:44:41.977Z (8 months ago)
- Topics: documentation-tool, legal-citation, lister, opensource, package-json
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# packages-list-extractor
A simple node module that extracts npm packages from package.json with multiple options.
## Getting Started
- Run `npm i -g packages-list-extractor`
- In your project directory run `packages-list-extractor`
- This will generate a file called dependancies.md in your app's root directory.
## Path Customization
The `packages-list-extractor` takes 2 argumnets.
The first being the file path to write to, defaults to 'dependencies.md'.
The second being the file path to package.json, defaults to 'package.json'.
To fallback to default arguments, add -d as the argument.
## Template Customization
Run `git clone https://github.com/A-Tokyo/packages-list-extractor`
Edit the template text in `src/index.js`
Run `npm link`
Use as mentioned in the getting started section.
## Examples:
- `packages-list-extractor` Runs with default paths.
- `packages-list-extractor -d assets/filename.md` Runs with default path for `package.json` and writes into `assets/filename.md`
- `packages-list-extractor ../../package.json` Runs on `../../package.json` and writes to the default path `dependancies.md`.
#### dependancies.md file preview:
```
# Dependancies:
Package Name: package-name, Package Url: https://www.npmjs.com/package/package-name, Version: ^1.0.0
# Dev Dependancies:
Package Name: dev-package-name, Package Url: https://www.npmjs.com/package/dev-package-name, Version: ^1.0.0
```