Skip to content

Commit

Permalink
docs: usage notes for license compliance check tool
Browse files Browse the repository at this point in the history
  • Loading branch information
pbredenberg committed Aug 10, 2023
1 parent 98ba9f0 commit c030afd
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,42 @@ possible that some processes in some projects could fail when the wrong version
is enabled in the developer's environment. This helps eliminate one factor from the
equation when troubleshooting.

### License Compliance Checker Tool

This project contains a tool to verify that the licenses used by libraries in our
projects that contain NPM dependencies are among our list of accepted licenses. To
view the list of accepted licenses, see the `ALLOWED_LICENSES` list in:
[check-license-compliance.js](scripts/check-license-compliance.js)

To use this tool, `@silvermine/standardization` must be installed in your project:

`npm i -DE @silvermine/standardization`

You should then be able to run the tool in a NPM script:

```json
{
"scripts": {
"check-license-compliance": "check-license-compliance"
}
}
```

The tool also allows you to configure exceptions for license types using a configuration
file. To configure these exceptions, add a file called `.license-checker.cjs` to the root
of your project with the following contents:

```cjs
'use strict';

module.exports = {

exclusions: [ 'My-Custom-License' ]

};

```

### Executing ESLint

When ESLint is needed for a project, add an `eslint` task to package.json, and execute it
Expand Down

0 comments on commit c030afd

Please sign in to comment.