serverless-plugin-required-option/README.md

A serverless framework plugin to require a command line option

# serverless-plugin-required-option

Serverless Framework plugin to require an option to be provided

## Usage

1. Install the plugin

    ```sh
    npm install --save serverless-plugin-required-option
    ```

2. Add the plugin to the `serverless.yml` configuration file

    ```yaml
    plugins:
      - serverless-plugin-required-option
    ```

3. Use `requiredOpt:NAME` variable references when an option must be provided

    ```yaml
    custom:
      userPoolId: ${requiredOpt:user_pool_id}
    ```

   If the `user_pool_id` is provided as option the `custom.userPoolId` value will be set to it, if the option is not provided
   then an error will be raised and the serverless operation will be aborted.

## License

```text
MIT License

Copyright (c) 2021 Collaborne B.V.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```