ring-ui-license-checker
=======================

[![official JetBrains project](http://jb.gg/badges/official-flat-square.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[![npm (scoped)](https://img.shields.io/npm/v/@jetbrains/ring-ui-license-checker.svg)](npmjs.com/package/@jetbrains/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:

```javascript
      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,
      }),
```

#### Vite

The same checker is available as a Vite/Rollup plugin, imported from the
`/vite` subpath. It walks the Rollup module graph (all loaded modules,
including externalized dependencies) instead of webpack stats;
`devDependencies` and the webpack-specific `excludeUserRequest` filter don't
apply. `exclude` here is matched against resolved module ids.

```javascript
import licenseChecker from '@jetbrains/ring-ui-license-checker/vite'

export default {
  plugins: [
    licenseChecker({
      filename: 'third-party-libs.xml',
      forceAddPackages: ['some-runtime-dep'],
    }),
  ],
}
```