cy6erskunk / ring-ui-license-checker

ring-ui-license-checker

Options

• filename: String
• format: (params = {modules: module[]}) => String
• exclude: RegExp
• forceAddPackages: module[]
• customLicenses: module[]
• surviveLicenseErrors: Boolean
• ignoreTeamcity: Boolean - never use TeamCity service messages
• teamcityMessageStatus: 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,
      }),