@jetbrains/ring-ui-license-checker

Ring UI License Checker is webpack plugin intended to generate third-party libraries list with license information from dependency tree

Stats

StarsIssuesVersionUpdatedCreatedSize
@jetbrains/ring-ui-license-checker
301.5.66 months ago4 years agoMinified + gzip package size for @jetbrains/ring-ui-license-checker in KB

Readme

ring-ui-license-checker

official JetBrains project npm (scoped)

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: 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,
      }),

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.