@jetbrains/ring-ui-license-checker
v1.5.6
Published
Ring UI License Checker is webpack plugin intended to generate third-party libraries list with license information from dependency tree
Downloads
2,481
Keywords
Readme
ring-ui-license-checker
This repository SSH URL: ssh://github.com/JetBrains/ring-ui-license-checker.git This repository HTTPS URL: https://github.com/JetBrains/ring-ui-license-checker.git
Develop with pleasure(R)
Options
filename
: Stringformat
: (params = {modules: module[]}) => Stringexclude
: RegExpforceAddPackages
: module[]customLicenses
: module[]surviveLicenseErrors
: BooleanignoreTeamcity
: Boolean - never use TeamCity service messagesteamcityMessageStatus
: String - message status to report (NORMAL, WARNING, FAILURE, ERROR)
Options usage and module
object structure example:
new LicenseChecker({
filename: 'third-party-licenses.txt',
format: params =>
params.modules
.map(
mod => `${mod.name} (${mod.url})
${mod.license.name} (${mod.license.url})`,
)
.join('\n\n'),
// stackframe has wrong license field in 0.3.1
exclude: [/stackframe/],
customLicenses: [{
name: 'stackframe',
version: '0.3.1',
url: 'https://www.npmjs.com/package/stackframe',
license: {
name: 'Unlicense',
url: 'http://unlicense.org/'
}
}],
surviveLicenseErrors: true,
}),