{"_id":"@acransac/legal-notice","name":"@acransac/legal-notice","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@acransac/legal-notice","version":"1.0.0","description":"List the copyright holders and licenses of a module and its dependencies","bin":{"legal-notice":"dist/legal-notice.cjs"},"type":"module","scripts":{"build":"webpack","test":"node --experimental-vm-modules node_modules/jest/bin/jest test"},"repository":{"type":"git","url":"git+https://github.com/acransac/legal-notice.git"},"keywords":["compliance","copyright","legal","license","notice"],"author":{"name":"Adrien Cransac"},"license":"MIT","bugs":{"url":"https://github.com/acransac/legal-notice/issues"},"homepage":"https://github.com/acransac/legal-notice#readme","devDependencies":{"jest":"^29.4.2","license-checker":"^25.0.1","terser-webpack-plugin":"^5.3.6","webpack":"^5.75.0","webpack-cli":"^5.0.1","webpack-shebang-plugin":"^1.1.8","yargs":"^17.6.2"},"gitHead":"cc927d99e21201403ae1bbc01d5c17108adf346c","_id":"@acransac/legal-notice@1.0.0","_nodeVersion":"18.4.0","_npmVersion":"8.12.1","dist":{"integrity":"sha512-zNirWlnPJ3YWlt1f6HHOXzHnIOISaY+OeXY1O7R9pjD9Q0MzHexh+fyAslJo8TZSL7H7qyzsd7h+2MNpEkqIEg==","shasum":"ec4d1a113374e232147d2e891300484a01c04d9c","tarball":"https://registry.npmjs.org/@acransac/legal-notice/-/legal-notice-1.0.0.tgz","fileCount":5,"unpackedSize":840331,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDGk15x0yzGYI9e2SBBfVhNRYUfDXpkWM/+C15RUUu6vgIgOK8tGDxkeBFgEC+4ZQ7S1gF6FMbc7/aGKX4zONKwByE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj7HsSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqYxg/9Hl4YajjUctfRt/7y0MfgO4cQcD0o5+YfKk9OZp0E6F0+nG/v\r\n6g3ftBlgatAiFccctKcSftFkctYUTUakLSk/Cec1Pij9+kHmKqTvFkuAlD/N\r\nZz/YigWRmV5bIxWU7iNsKXB2Hs2HKYg9+dhpq+N54VnRpd53Zg/bJC3q9FCp\r\njp59AKRTVtTREtYSbSyJN9K9EqTulkuUxZGjHbWt+o5kreTuMKkn7MT1HMU2\r\nLStThAgIIMQJ9C4QWdRO/vpLQoY7eiZ9inXokp4OCMjCW3YZReQ2hHw1epYp\r\nSBjr9oLj4XR6m9tVBFiRTx457+fIHvIH63j40uzBDSq8R6znXxPiBDAKCAhi\r\nS1mKiJjBc4g0O7paWBOwmoz+hEeORNl8youbQyrP5SXrNACUDTwWzuwwG3fR\r\nR7sp3V4kt47TuOgCfHy7GKg5AtQ6s1sw+6gf5/1l2MpoD+DYc77SMYTjWLs0\r\nczPNTiAVP2hZ1o/0DRDMKwoZoyOWz+JeURWyZGIm6ezVmXQAUOz5jaIMESQ5\r\nkiCn8h4gMvwOxIdX083Tp7zsD3XjOM5yC60PlihbxlDD6X1U/JPh3pOs6CoQ\r\nVk2ysICmfMcokPE/WE3pgLycbKBunya58AT0ijr6s65QeEv9D8Tv19JwByar\r\nUckNHo3+tRByUgwVzJnd4e/ZhfaFtDk032Y=\r\n=azzK\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"acransac","email":"adrien.cransac@gmail.com"},"directories":{},"maintainers":[{"name":"acransac","email":"adrien.cransac@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/legal-notice_1.0.0_1676442386005_0.33761128787481054"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-15T06:26:25.939Z","1.0.0":"2023-02-15T06:26:26.326Z","modified":"2023-02-15T06:26:26.484Z"},"maintainers":[{"name":"acransac","email":"adrien.cransac@gmail.com"}],"description":"List the copyright holders and licenses of a module and its dependencies","homepage":"https://github.com/acransac/legal-notice#readme","keywords":["compliance","copyright","legal","license","notice"],"repository":{"type":"git","url":"git+https://github.com/acransac/legal-notice.git"},"author":{"name":"Adrien Cransac"},"bugs":{"url":"https://github.com/acransac/legal-notice/issues"},"license":"MIT","readme":"# Introduction\n**legal-notice** is a command-line tool that lists the copyright holders and licenses of a npm\nmodule and its dependencies.\n\nMost open-source licenses allow to use one's work as long as the attribution to the copyright\nholders and the license they give to their users are included in the derivative work. One way to\ninclude this information, proposed for example in the Apache License 2.0, is to write the\nhuman-readable copyright attribution and license in a NOTICE file shipped with the distribution.\n **legal-notice** generates the content of such a proposed file so you can deliver it with your\npiece of software.\n\nAlternative approaches, typically implemented in module bundlers, gather this licensing information\nin source-code comments or humand-and-machine-readable formats like json or csv. **legal-notice**\naims for better visibility and easier access to this information. It is independent from your choice\n of bundler, if any.\n\nThis tool formats to a human-readable text document the output of\n [license-checker](https://github.com/davglass/license-checker). This latter piece of software can\nbe used to generate a short summary of the types of licenses used by your module's dependencies. You\ncan then check whether your license complies with your dependencies' with\n [this compatibility checker](https://joinup.ec.europa.eu/collection/eupl/solution/joinup-licensing-assistant/jla-compatibility-checker).\n\n# Installation\nTo install **legal-notice** globally, run:\n\n```bash\n    $ npm install --global @acransac/legal-notice\n```\n\nWithin your module, you can install it with:\n\n```bash\n    $ npm install --save-dev @acransac/legal-notice\n```\n\nOr you can try it directly with:\n\n```bash\n    $ npx @acransac/legal-notice\n```\n\n# Usage\n**legal-notice** does not take any argument but looks for `package.json` where it is executed from.\n It writes to the standard output the list of copyright holders and licenses of the module in the\ncurrent directory and its dependencies.\n\nFor example, to write a NOTICE file with the attribution and licensing information, after installing\nthe tool in your module you can run from the directory where your `package.json` is:\n\n```bash\n    $ npx legal-notice > NOTICE\n```\n\nOr add a script in `package.json`:\n\n```json\n  ...\n  \"scripts\": {\n    \"legal\": \"legal-notice > NOTICE\",\n    ...\n  },\n```\n\nAnd run it with:\n\n```bash\n    $ npm run legal\n```\n\nUpdate the NOTICE after installing, updating or uninstalling any dependency in your module.\n\nNote that you can get help about the tool with:\n\n```bash\n    $ npx legal-notice --help\n```\n","readmeFilename":"README.md"}