{"_id":"@electrovir/oss-attribution-generator","name":"@electrovir/oss-attribution-generator","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@electrovir/oss-attribution-generator","version":"2.0.0","description":"utility to parse bower and npm packages used in a project and generate an attribution file to include in your product","keywords":["license","attribution","npm","bower","credit"],"homepage":"https://github.com/electrovir/oss-attribution-generator","bugs":{"url":"https://github.com/electrovir/oss-attribution-generator/issues"},"repository":{"type":"git","url":"git+https://github.com/electrovir/oss-attribution-generator.git"},"license":"MIT","author":{"name":"Dan Zumwalt"},"bin":{"generate-attribution":"dist/index.js"},"scripts":{"compile":"rm -rf dist && virmator compile","format":"virmator format","prepublishOnly":"npm run compile && npm run test:full","spellcheck":"virmator spellcheck","test":"bash scripts/run-tests.sh","test:full":"npm run test:types && npm test && npm run spellcheck && virmator format check","test:types":"tsc --noEmit"},"dependencies":{"augment-vir":"^2.5.1","fs-jetpack":"^5.0.0","license-checker":"^25.0.1","yargs":"^17.6.0"},"devDependencies":{"@types/chai":"^4.3.3","@types/license-checker":"^25.0.3","@types/lodash":"^4.14.186","@types/mocha":"^10.0.0","@types/node":"^18.8.2","@types/yargs":"^17.0.13","chai":"^4.3.6","cspell":"^6.12.0","mocha":"^10.0.0","prettier":"^2.7.1","prettier-plugin-jsdoc":"^0.4.2","prettier-plugin-multiline-arrays":"^1.1.1","prettier-plugin-organize-imports":"^3.1.1","prettier-plugin-packagejson":"^2.3.0","prettier-plugin-sort-json":"^0.0.3","prettier-plugin-toml":"^0.3.1","ts-node":"^10.9.1","typescript":"^4.8.4","virmator":"^4.0.1"},"publishConfig":{"access":"public"},"gitHead":"77a97f1fe9370a7647faab2a0b5291e539e72947","_id":"@electrovir/oss-attribution-generator@2.0.0","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-oUrRZRj7BkRUI+Y2A7sJFuMS5wH4Jo3sOvzRERcv81HomwlIrs8DAZC4HNhyedUmhcx5OihXVjMydaf7S+JIhA==","shasum":"d384106b6aeae375ff4228e5b3b87e145c6cb91e","tarball":"https://registry.npmjs.org/@electrovir/oss-attribution-generator/-/oss-attribution-generator-2.0.0.tgz","fileCount":5,"unpackedSize":15799,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCRNXPpClJVgtv4bpsQ/XzLPnc255/rgvlU3uz3Dn8SCwIgVF5VqJt3HbFGKdYVHzDv8SHU/txxb907Zm7FY4rvrpw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjPf7VACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpeoA//aDsJTk+DNUfpvXbZKAlbEhT/ctNvbICSUyfAcUku1RgSSp5O\r\noIACtfbsFuhRLzMXuw7nUWDyaySlIKblmlQIxs5GOxGecHYcqSORaDgZSedw\r\naRtcOqurm9ekfhZwmlFeI4Di/1LNUW0sa4os9XMm5XHO4YxfxQSpsIrg5qud\r\ntUMXcu/HxVkMxV9z/m42gIiPx/rSUYQ4X9GX/ZKKCY9Fjc1eUJOG/3KSvGWw\r\npq1HAdyw/XPxQZNF87UxvbBaPSfC2w1vbaK8gx9k/ZlVn+hYx6byVeX+3vH/\r\n/Y4o3mIL+Ywe2LExTtjEGGsQ+iN8Sp+WBh9iwGyCGOcfLEYBLt9G/Sr/tzxQ\r\nXrvERmjwUxLcXJdba3WZfFxNXLYbaEwxqDJG4c8A1xMaEVPe1edqhahV/bRp\r\nJ8zT2JJyizr4dFNo8j7Y1d5ISJsXReqmYxMNqQ1TW3jzp6Kkzt0qv8W4D54X\r\nQGIUAUfSSqMOK1NInly6G8bFDu9Y3sYxllu2qziyJuomJq/st4n2bmKm2nBP\r\nwUBTdgntdHvTWYcIgfz13BOHPzHrsKjscGE9zUGXIl8R5Qu/qA4+9qGMLTXx\r\nLe0iSqQZZgFGZq4hGfbcbq3aJ6vEvIZyt6+nV8VR4J2l3QC8/X6uU95B72R6\r\nc+jXkMYbrRQOXKopaLnee1WIgVpRuUpZfuw=\r\n=z2lZ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"electrovir","email":"pithy.gut0a@icloud.com"},"directories":{},"maintainers":[{"name":"electrovir","email":"pithy.gut0a@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/oss-attribution-generator_2.0.0_1665007317290_0.4209315357518013"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-05T22:01:57.208Z","2.0.0":"2022-10-05T22:01:57.471Z","modified":"2022-10-05T22:01:57.628Z"},"maintainers":[{"name":"electrovir","email":"pithy.gut0a@icloud.com"}],"description":"utility to parse bower and npm packages used in a project and generate an attribution file to include in your product","homepage":"https://github.com/electrovir/oss-attribution-generator","keywords":["license","attribution","npm","bower","credit"],"repository":{"type":"git","url":"git+https://github.com/electrovir/oss-attribution-generator.git"},"author":{"name":"Dan Zumwalt"},"bugs":{"url":"https://github.com/electrovir/oss-attribution-generator/issues"},"license":"MIT","readme":"# @electrovir/oss-attribution-generator\n\nModified by [electrovir](https://github.com/electrovir) from [oss-attribution-generator](https://github.com/zumwald/oss-attribution-generator/tree/147dbae73dce1cf190460be6a0074552c2b7bc19) by [zumwald](https://github.com/zumwald).\n\nChanges include:\n\n-   no longer supports bower\n-   updated dependencies that don't have vulnerabilities\n\nEverything else should be the same.\n\nUtility to parse npm packages used in a project and generate an attribution file to include in your product.\n\n## Installation\n\n```bash\nnpm i -D @electrovir/oss-attribution-generator\n```\n\n## Usage\n\n### For a single Node project\n\n```bash\ncd pathToYourProject\nnpx generate-attribution\ngit add ./oss-attribution\ngit commit -m 'adding open source attribution output from oss-attribution-generator'\n```\n\n### For multiple projects\n\nFor Node.js projects that use other Node.js projects located in different directories, the `-b` option can be used to provide a variable number of input directories. Each of the input directories are processed, and any duplicate entries (dependencies with same name and version number) are combined to produce a single attribution text.\n\n```bash\ncd pathToYourMainProject\nnpx generate-attribution -b pathToYourMainProject pathToYourFirstProjectDependency pathToYourSecondProjectDependency\ngit add ./oss-attribution\ngit commit -m 'adding open source attribution output from oss-attribution-generator'\n```\n\n### Help\n\nUse the `--help` argument to get further usage details about the various program arguments:\n\n```bash\nnpx generate-attribution --help\n```\n\n### Understanding the \"overrides\"\n\n#### Ignoring a package\n\nSometimes, you may have an \"internal\" module which you/your team developed, or a module where you've arranged a special license with the owner. These wouldn't belong in your license attributions, so you can ignore them by creating an `overrides.json` file like so:\n\n```json\n{\n    \"signaling-agent\": {\n        \"ignore\": true\n    }\n}\n```\n\n#### Changing the properties of package in the attribution file only\n\nOther times, you may need to supply your own text for the purpose of the attribution/credits. You have full control of this in the `overrides.json` file as well:\n\n```json\n{\n    \"some-package\": {\n        \"name\": \"some-other-package-name\",\n        \"version\": \"1.0.0-other-version\",\n        \"authors\": \"some person\",\n        \"url\": \"https://thatwebsite.com/since/their/original/link/was/broken\",\n        \"license\": \"MIT\",\n        \"licenseText\": \"you can even override the license text in case the original contents of the LICENSE file were wrong for some reason\"\n    }\n}\n```\n\n## Prior art\n\nLike most software, this component is built on the shoulders of giants; @electrovir/oss-attribution-generator was inspired in part by the following work:\n\n-   [The original oss-attribution-generator](https://github.com/zumwald/oss-attribution-generator)\n-   [license-checker](https://github.com/davglass/license-checker)\n-   [node-licensecheck](https://github.com/iceddev/node-licensecheck)\n-   [bower-license](https://github.com/AceMetrix/bower-license)\n","readmeFilename":"README.md"}