Skip to content

kakkun61/elm-license-checker

Repository files navigation

Elm License Checker

NPM Pursuit

Treats the licenses of the dependencies of a package.

This is inspired by NPM License Checker.

Library Interface

The following is how to use this as a module.

The JavaScript interface is compatible with NPM License Checker, but is actually a subset.

const elc = require('elm-license-checker');

elc.init(
  { start: '/path/to/elm-application' },
  function (err, packages) {
    if (err) {
      // handle the error
    } else {
      // use the packages
    }
  }
);

The PureScript interface is also available.

import Prelude
import Effect (Effect)
import ElmLicenseChecker (init)

main :: Effect Unit
main = do
  packages <- init "/path/to/elm-application"
  -- use the packages

CLI interface

The CLI interface is not yet provided.