Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .license-checker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
'use strict';

module.exports = {

permittedLicenses: [
'BSD-2-Clause',
'BSD-3-Clause',
'Python-2.0',
'BSD*',
],

permittedPackages: [
'tslib@1.13.0'
]

};
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
All notable changes to this project will be documented in this file.
See [our coding standards][commit-messages] for commit guidelines.

## [2.2.0](https://github.com/silvermine/standardization/compare/v2.1.1...v2.2.0) (2023-07-20)


### Features

* Add custom rule 'indent-alignment' ([e9644c9](https://github.com/silvermine/standardization/commit/e9644c97d4092cd4f52f390c94ef0bb01de2056b))
* install markdownlint-cli2 and add configuration ([523fb68](https://github.com/silvermine/standardization/commit/523fb6881bd355a1beeae32d5002a817a29906f1))


### Bug Fixes

* markdownlint ignore settings apply to subdirectories ([b419416](https://github.com/silvermine/standardization/commit/b4194164926f9e8c5f1222c3aab2135c2d891a53))


### [2.1.1](https://github.com/silvermine/standardization/compare/v2.1.0...v2.1.1) (2023-02-09)


Expand Down
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.js` to the root
of your project with the following contents:

```cjs
'use strict';

module.exports = {

permittedLicenses: [ 'My-Custom-License' ]

};

```

### Executing ESLint

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