{"_id":"@bigfootds/npm-compliance-helper","name":"@bigfootds/npm-compliance-helper","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bigfootds/npm-compliance-helper","version":"1.0.0","description":"Tool to help generate legal & copyright notices about project dependencies.","main":"src/index.js","bin":{"npm-compliance-helper":"src/index.js"},"scripts":{"@bigfootds/nch/start":"node src/index.js","@bigfootds/nch/dev":"mkdir -p ./out && node src/index.js > ./out/apptesto.json"},"keywords":["cli","documentation","continous compliance","license","licence"],"author":{"name":"BigfootDS","email":"contact@bigfootds.com","url":"https://bigfootds.com"},"repository":{"type":"git","url":"git+https://github.com/BigfootDS/npm-compliance-helper.git"},"bugs":{"url":"https://github.com/BigfootDS/npm-compliance-helper/issues"},"homepage":"https://github.com/BigfootDS/npm-compliance-helper#readme","funding":{"type":"github","url":"https://github.com/sponsors/BigfootDS"},"license":"MIT","dependencies":{"commander":"^12.0.0","generate-license-file":"^3.4.0"},"_id":"@bigfootds/npm-compliance-helper@1.0.0","gitHead":"1c7a156b4d148dac3f6cb35a0bf4532c7faed2f6","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-hRHkCWsIdDCoL3Ay+soTxa5rr0W2rnsxm4sNhsu1yV8rqpoe/Um8BNN3xdhqdTDShLx6je9iSRNOlw/EMxWRjg==","shasum":"f83e5e062477a399069867a44a0e04972d98d40b","tarball":"https://registry.npmjs.org/@bigfootds/npm-compliance-helper/-/npm-compliance-helper-1.0.0.tgz","fileCount":8,"unpackedSize":37610,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAibfNv/izVve8hdaUP9HW1Ktwfi9+vbR2mcf2Lg0lw/AiEAkzvdIJNX9Zkmz8ctMo6VpN6Kok+2ItOFtDxPspaOy4A="}]},"_npmUser":{"name":"alexstormwood","email":"alex@bigfootds.com"},"directories":{},"maintainers":[{"name":"alexstormwood","email":"alex@bigfootds.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/npm-compliance-helper_1.0.0_1714738847958_0.47182241422607607"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-03T12:20:47.882Z","1.0.0":"2024-05-03T12:20:48.106Z","modified":"2024-05-03T12:20:48.380Z"},"maintainers":[{"name":"alexstormwood","email":"alex@bigfootds.com"}],"description":"Tool to help generate legal & copyright notices about project dependencies.","homepage":"https://github.com/BigfootDS/npm-compliance-helper#readme","keywords":["cli","documentation","continous compliance","license","licence"],"repository":{"type":"git","url":"git+https://github.com/BigfootDS/npm-compliance-helper.git"},"author":{"name":"BigfootDS","email":"contact@bigfootds.com","url":"https://bigfootds.com"},"bugs":{"url":"https://github.com/BigfootDS/npm-compliance-helper/issues"},"license":"MIT","readme":"# @bigfootds/npm-compliance-helper\r\n\r\nTool to help generate legal & copyright notices about project dependencies.\r\n\r\nIntended usage is to provide data in an organized way for a front-end to then display.\r\n\r\n## Legal Disclaimer\r\n\r\nThis tool should not be used blindly or without further human activity to process its output.\r\n\r\nDon't come blaming us for your poor business decisions.\r\n\r\n## Installation\r\n\r\nThis package can be used as a dependency, with its functions imported into your dev or production or other code.\r\nOr, this package can be used as a command line tool.\r\n\r\nTo install in your production dependencies, run this: \r\n\r\n```bash\r\nnpm install @bigfootds/npm-compliance-helper\r\n```\r\n\r\nTo install in your production dependencies, run this: \r\n\r\n```bash\r\nnpm install --save-dev @bigfootds/npm-compliance-helper\r\n```\r\n\r\nTo run as a command line tool without installing it into a project, run this:\r\n\r\n`npx @bigfootds/npm-compliance-helper`\r\n\r\n## Basic Usage\r\n\r\nDefault usage of this package will meet most peoples' needs.\r\n\r\nDefault usage will search for the `package.json` file in the current working directory and create license data based on that file.\r\n\r\n### Command Line Usage\r\n\r\nIf using this package as a command line tool, you can pass in customisation options with these flags:\r\n\r\n```bash\r\n  -p, --packageJsonPath <packageJsonPath>            A path to a package.json. If not provided, the package.json in the current working directory will be used. (default: Result of `path.join(process.cwd(), \"package.json\")` )\r\n  -lo, --licenseOverrides <licensesToOverride>       The licenses you want to allow in your project. (default: [])\r\n  -ex, --excludedLicenses <excludedSpdxIdentifiers>  The licenses you want to forbid in your project. (default: [])\r\n  -h, --help                                         display help for command\r\n\r\n```\r\n\r\nPlease note that the license overrides and license exclusions are not yet implemented as of 4th May 2024.\r\n\r\nTypical usage of this command may look like:\r\n\r\n```bash\r\nnpx @bigfootds/npm-compliance-helper > ./out/organizedLicenseData.json\r\n```\r\n\r\nYou could even create a bit of robust NPM/bash scripting like so, to guarantee that the `out` folder exists:\r\n\r\n```bash\r\nmkdir -p ./out && npx @bigfootds/npm-compliance-helper > ./out/organizedLicenseData.json\r\n```\r\n\r\n### Imported Package Usage\r\n\r\nIf you wish to use this package within your own JavaScript code, you can import the package like so:\r\n\r\n```js\r\nconst {organiseProjectLicenseInfo} = require(\"@bigfootds/npm-compliance-helper\");\r\n```\r\n\r\nYou can provide that function with a custom path to a `package.json` file, or just give it nothing and it will find the `package.json` file in the current working directory.\r\n\r\nLike so:\r\n\r\n```js\r\nasync function someFunction(){\r\n\tlet output = \"\";\r\n\t\r\n\toutput = await organiseProjectLicenseInfo().catch(error => error);\r\n\r\n\tconsole.log(Object.keys(output));\r\n\r\n\tconsole.log(output.directDependencies);\r\n\r\n\treturn output;\r\n}\r\n```","readmeFilename":"README.md"}