{"_id":"@bepo65/license-report","_rev":"1-eed092bec608f2bcea482f3b8462502c","name":"@bepo65/license-report","dist-tags":{"latest":"5.0.0-beta.1"},"versions":{"5.0.0-beta.1":{"name":"@bepo65/license-report","version":"5.0.0-beta.1","description":"creates a short report about project's dependencies (license, url etc)","main":"index.js","scripts":{"test":"npx mocha -R spec"},"bin":{"license-report":"index.js"},"repository":{"type":"git","url":"git+https://github.com/ironSource/license-report.git"},"author":{"name":"Yaniv Kessler"},"license":"MIT","bugs":{"url":"https://github.com/ironSource/license-report/issues"},"homepage":"https://github.com/ironSource/license-report","dependencies":{"@kessler/tableify":"^1.0.2","debug":"^4.3.3","eol":"^0.9.1","got":"^11.8.3","rc":"^1.2.8","semver":"^7.3.5","text-table":"^0.2.0","visit-values":"^2.0.0"},"devDependencies":{"mocha":"^9.1.3","nock":"^13.2.1"},"engines":{"node":">=7.6"},"gitHead":"202e603c536d9af916785524dcfc3b6ce812d526","_id":"@bepo65/license-report@5.0.0-beta.1","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-Ub0+lls4OZyMYaqVUYnC68pSJbx2kcP7Jyo4DB365pw+7Nk7zHGlxezSq9wcrYu6Fw9rB1aVSsTuav4NFmJHWg==","shasum":"20791f233917ad18c0fc36b190c783ee0af95ab7","tarball":"https://registry.npmjs.org/@bepo65/license-report/-/license-report-5.0.0-beta.1.tgz","fileCount":34,"unpackedSize":450933,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhtimMCRA9TVsSAnZWagAA5IQP/RmT0Cia8vkbmH4+oOCk\n5MqwCUteuoStF5xLEvZFADruSVyiippeHZyhR3sR6k9NfabzZQtHq/LFti/o\nyfXYorj1nMDuYFLWXsClg6681m8J+zhsnxv7ESdOdwgStJp2O5jzVJxp5sTV\nGu5+XA5kX47DwOnzRjBx3BTTfAWeHVTl9UvQlyQgRGZ3ZfJ80G/ZcoREkQCx\n8CxZeiwUqIR5HDQUO6Pwtdd94moxVhGpapZKtCAcCWY604rFtxFqCbjacB6C\n9lyUW2vfSkfz/yr/jQbDbF9jOeB6nih0obYg/gx2MPhOOO/m3Ad1U1iMFKQH\nH9V70QeDdAfwziEMCg8r2d/A/KLhHTIMftHUm3dtzvHGKjtq4xzJwa0W3Fxg\nivT1TS1EnXy5g4cJ6axvJgkFxqfbRy5V+7Kq93HGEwM97GDP5t8FiHpH8g5Z\nekj/y5l/Pvz2PXjDdJXzryfFhMInoc1FopTvTQ4XiX56m5hEyClNH5d08Zea\nqmgdkRGG7bKlOENyAt2iAmyB7nrKPM76XkwZFvzrS7eZa7e8TpCHpPKVF+PQ\naMNfcfF+r+sHRnFyxXXCazQX3jJ1ceTGZc9hfdWbIqKAiqiSTfuv3yDw/lBj\n+LrH9ubX188Q8MK1G3eXhNlhUVXr045nMJ1BoMYweOJeG5O9UAjrN7FoMMlX\n8Hdy\r\n=PzRT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHWbFARi09Jdp3clIlrEY72Es9pn4LsG49FX5kQfLOGYAiEApZgF3eVt0/5/JrEphIVUWcjNHxVx5c7ZV8Lo+arA2IE="}]},"_npmUser":{"name":"bepo65","email":"bepo65@t-online.de"},"directories":{},"maintainers":[{"name":"bepo65","email":"bepo65@t-online.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/license-report_5.0.0-beta.1_1639328139922_0.9594602209202203"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-12T16:55:39.877Z","5.0.0-beta.1":"2021-12-12T16:55:40.078Z","modified":"2022-04-04T18:28:38.712Z"},"maintainers":[{"name":"bepo65","email":"bepo65@t-online.de"}],"description":"creates a short report about project's dependencies (license, url etc)","homepage":"https://github.com/ironSource/license-report","repository":{"type":"git","url":"git+https://github.com/ironSource/license-report.git"},"author":{"name":"Yaniv Kessler"},"bugs":{"url":"https://github.com/ironSource/license-report/issues"},"license":"MIT","readme":"# license report tool\r\ngenerate a license report of the projects dependencies\r\n\r\n**This is a preliminary beta release of the latest changes to the [license-report](https://github.com/ironSource/license-report) project.**\r\n\r\n## Installation\r\n```\r\nnpm install -g license-report\r\n```\r\n## Functionality\r\n`license-report` reads data from a `package.json` file and adds detailed version information about the installed versions from the corresponding `package-lock.json` file and about the latest available version from the (npm) registry.\r\n\r\n## Usage\r\n\r\n#### simple:\r\n```\r\ncd your/project/\r\nlicense-report\r\n```\r\nby default, `license-report` outputs all licenses from `dependencies`, `devDependencies`, `optionalDependencies` and `peerDependencies`.  \r\nTo specify one or the other, use `--only`; e.g.\r\n```\r\nlicense-report --only=dev\r\n```\r\n```\r\nlicense-report --only=prod\r\n```\r\n```\r\nlicense-report --only=prod,opt,peer\r\n```\r\nThe 'only' option is a comma separated list of the dependencies to use.  \r\nPossible values are:\r\n|value|segment of package.json|\r\n|---|---|\r\n|prod|dependencies|\r\n|dev|devDependencies|\r\n|opt|optionalDependencies|\r\n|peer|peerDependencies|\r\n\r\n#### explicit package.json:\r\n```\r\nlicense-report --package=/path/to/package.json\r\n```\r\n\r\n#### customize a field's label:\r\nUsed as column headers in table / csv / html output. For html output the labels of all fields in the output must be unique.\r\n```\r\nlicense-report --department.label=division\r\n```\r\n\r\n#### customize a fields default value:\r\nOnly applicable for the fields in the list later in this document (look for \"Fields with data set in the configuration of license-report\")\r\n```\r\nlicense-report --department.value=ninjaSquad\r\n```\r\n\r\n#### use another registry:\r\n```\r\nlicense-report --registry=https://myregistry.com/\r\n```\r\n\r\n#### registry with authorization:\r\nTo use a npm registry that requires authorization, the option `npmTokenEnvVar` must contain the name of an environment variable that contains the required npm authorization token (the default name is 'NPM_TOKEN'). An example:\r\n```\r\n# if the name of the environment variable containing the bearer token for npm authorization is 'NPM_TOKEN'\r\nlicense-report --registry=https://myregistry.com/ --npmTokenEnvVar=NPM_TOKEN\r\n```\r\nThe name of this environment variable (in the example: 'npm_token') should not be added as an option to the license-report config file, as this implies a severe security risk, when this file is checked in into a git repository. A warning is emitted if such an option is found in the config file.\r\n\r\n#### generate different outputs:\r\n```\r\nlicense-report --output=table\r\nlicense-report --output=json\r\nlicense-report --output=csv\r\nlicense-report --output=html\r\n\r\n# replace default ',' separator with something else\r\nlicense-report --output=csv --delimiter=\"|\" \r\n\r\n# output csv headers (fields) on first row\r\nlicense-report --output=csv --csvHeaders\r\n\r\n# use custom stylesheet for html output\r\nlicense-report --output=html --html.cssFile=/a/b/c.css\r\n\r\n# see the output immediately in your browser, use hcat (npm i -g hcat)\r\nlicense-report --output=html | hcat\r\n```\r\n\r\n#### select fields for output:\r\n```\r\n# set options with command line options and config file\r\nlicense-report --output=csv --config license-report-config.json\r\n```\r\n```\r\n# example of config file for backward compatible output:\r\n{\r\n  \"fields\": [\r\n    \"department\",\r\n    \"relatedTo\",\r\n    \"name\",\r\n    \"licensePeriod\",\r\n    \"material\",\r\n    \"licenseType\",\r\n    \"link\",\r\n    \"comment\",\r\n    \"installedVersion\",\r\n    \"author\"\r\n  ]\r\n}\r\n```\r\n\r\n#### exclude packages:\r\n```\r\nlicense-report --exclude=async --exclude=rc\r\n```\r\n\r\n## Screenshots\r\n\r\n![screenshot](screenshot.png)\r\n![screenshot1](html.png)\r\n\r\n## Available fields\r\nFields with data of the installed packages:\r\n| fieldname | column title | data source |\r\n|---|---|---|\r\n| name | name | name of the package |\r\n| licenseType | license type | type of the license of the package (e.g. MIT) |\r\n| link | link | link to the repository of the package |\r\n| remoteVersion | remote version | latest available version of the package (can be different from the installed version) |\r\n| installedVersion | installed version | installed version of the package (can be different from the remote version) |\r\n| definedVersion | defined version | version of the package as defined in the (dev-) dependencies entry (can start with a semver range character) |\r\n| comment | comment | deprecated (replaced by field 'remoteVersion'); will be removed in a future version |\r\n| author | author | author of the package |\r\n\r\nFields with data set in the configuration of license-report:\r\n| fieldname | column title | set value |\r\n|--|---|---|\r\n| department | department | --department.value=kessler |\r\n| relatedTo | related to | --relatedTo.value=stuff |\r\n| licensePeriod | license period | --licensePeriod.value=perpetual |\r\n| material | material / not material | --material.value=material |\r\n\r\n## More configuration options\r\nSee lib/config.js for more details e.g. on customizing the generated html data.\r\n\r\nUse [rc](https://github.com/dominictarr/rc) for further customization.\r\n\r\n## Debug report generation\r\n\r\nBy setting the debug environment variable as follows, detailed log information is generated during the report generation. For details see the documentation of the debug package on npm.\r\n```\r\nexport DEBUG=license-report*\r\n```\r\n\r\n![ironSource logo](ironsource.png)\r\n","readmeFilename":"README.md"}