@rmtc/plugin-mit-license
v1.0.0
Published
The toolchain mit-license syncing plugin
Downloads
9
Readme
@rmtc/plugin-mit-license
A plugin for @rmtc/toolchain that ensures a project has a valid MIT license file and entry in package.json
.
[!WARNING] This project is intended for use in @rowanmanning's projects. It's free to use but I don't offer support for use-cases outside of what I need.
Table of Contents
Requirements
This library requires the following to run:
Usage
Install the module with npm:
npm install --save-dev @rmtc/plugin-mit-license
Include it in your .rmtc.json
file:
{
plugins: [
// ...
'@rmtc/plugin-mit-license'
]
// ...
}
Workflows
This plugin defines the following workflows:
postinstall
: a general workflow used to indicate steps that should be run after dependencies have been installed.
Steps
This plugin defines the following steps that can be added to any workflow:
mit-license:install
: override theLICENSE
file in the project folder as well aspackage.json
license
property ensuring that they're consistent.
Configuration
config.holders
string
. Use this configuration to set the list of entities who hold the copyright for the project. E.g.
{
plugins: [
['@rmtc/plugin-mit-license', {
holders: 'Rowan Manning'
}]
]
}
Contributing
See the central README for a contribution guide and code of conduct.
License
Licensed under the MIT license. Copyright © 2023, Rowan Manning