@vodafoneuk/licenses-generator
v1.0.2
Published
licenses generator
Downloads
4
Keywords
Readme
Licenses generator
The licenses generator will generate licenses for a given package/repository based on package dependencies specified in package.json
Dev dependencies are excluded.
It will only scan for licenses at the first level - it will not go through all dependent packages of the given package.
How it works
Read package.json
Get all dependencies from the package.json file
Iterate through all dependencies and try to find
**/**/{LICENSE,LICENCE,COPYING}
ignoring node_modulesParse and save output
How to run it
node node_modules/@vodafoneuk/licenses-generator/index.js get --root packages/packageA
node node_modules/@vodafoneuk/licenses-generator/index.js get --root [path_to_package_json]
or
node node_modules/@vodafoneuk/licenses-generator/index.cjs get --root [path_to_package_json]
Contents
Contributing
- Fork the repository.
- Make your changes.
- Send a pull request, ensuring that the application still runs and tests are passing.
- A member of our team will review and discuss your changes.
Releases
- Create a PR.
- Make your changes.
- Manually prepare the release and release notes.
- Bump versions of the modified packages.
- Send a pull request, ensuring that the application still runs and tests are passing.
- Once merged, new release will be created automatically through
publish
action.
People
Author: Vodafone UK
Current lead maintainer: Radek Swiat
See all contributors here