license-report-config.json

license report tool configuration file

Type object
File match license-report-config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/license-report-config-json/latest.json
Source https://www.schemastore.org/license-report-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

output string

license report output format

Default: "json"
Values: "json" "table" "csv" "html"
html object

HTML output format

2 nested properties
cssFile string
Default: "path.resolve(__dirname, '..', 'defaultHtmlStyle.css')"
tableify object

passed directly to tableify (see: https://github.com/kessler/node-tableify)

delimiter string

CSV output format

Default: ","
escapeCsvFields boolean

CSV output format: escape fields containing delimiter character

Default: "false"
only object

export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything

Default: "null"
registry string

NPM registry URL

Default: "https://registry.npmjs.org/"
exclude string[]

package names that will be excluded from the report

fields string[]

fields participating in the report and their order

comment object

export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything

2 nested properties
label string
Default: "comment"
value string
Default: ""
httpRetryOptions object
2 nested properties
delay number
Default: 1000
maxAttempts number
Default: 5
package string

path to the package.json

Default: "./package.json"