npm package: @haiilo/license-check
Description: Easily check the npm dependencies of your Haiilo project against the [Blue Oak License List](https://blueoakcouncil.org/list). Dependencies in the `@coyoapp` or `@haiilo` scope are automatically ignored. Additional dependencies can be ignored using the `-
Latest version: 1.4.0

# Node License Check

Easily check the npm dependencies of your Haiilo project against the
[Blue Oak License List](https://blueoakcouncil.org/list). Dependencies in the
`@coyoapp` or `@haiilo` scope are automatically ignored. Additional dependencies
can be ignored using the `--exclude` or `--excludeAll` options.

Note that this package is published publicly on `npmjs.com` to allow for easier
execution via `npx`.

## Execution

Simply use `npx` to execute the binary.

```
$ npx @haiilo/license-check
```

Note that `npx` will ask to install `@haiilo/license-check` upon first execution.
If you want to run the license check as part of your CI, use `--yes` to suppress
this prompt and avoid dead locks in your pipeline.

```
"scripts": {
  "license": "npx --yes @haiilo/license-check"
}
```

### Arguments

* `--exclude [file]` exclude modules listed in the specified whitelist file.
Example `--exclude license-whitelist`, where the file lists allowed modules as
one module per line.
* `--excludeAll [list]` exclude modules which names start with the
comma-separated list from the output (useful for excluding modules from a
specific vendor and such). Example: `--excludeAll "@types;@babel"`. Note that
`@coyoapp` or `@haiilo` scope are automatically ignored.

## Publishing

For each new commit added to the `main` branch with git push or by merging a pull request or merging from another branch, a CI build is triggered and runs the semantic-release command to make a release if there are codebase changes since the last release that affect the package functionalities.

The table below shows which commit message gets you which release type when `semantic-release` runs:

| Commit message                                                                                                                                                                                   | Release type                                                                                                    |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release                                                                                           |
| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release                                                                                       |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |