mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-06 21:42:49 +00:00
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# @openstapps/configuration
|
|
|
|
[](https://gitlab.com/openstapps/configuration/commits/master)
|
|
[](https://npmjs.com/package/@openstapps/configuration)
|
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
|
[](https://openstapps.gitlab.io/configuration)
|
|
|
|
Checks your `@openstapps` project's configuration and automatically adjusts it to adhere to the suggested defaults.
|
|
|
|
## Installation
|
|
|
|
Install it as a dev dependency in your project and it will check your configuration and add a script in your `package.json` to check the configuration again easily afterwards.
|
|
|
|
```shell
|
|
npm install --save-dev @openstapps/configuration
|
|
npm run check-configuration
|
|
```
|
|
|
|
You can also install it globally and use it as a cli.
|
|
|
|
```shell
|
|
npm install -g @openstapps/configuration
|
|
openstapps-configuration --help
|
|
```
|
|
|
|
## Configuration
|
|
|
|
To configure how your project's configuration is checked add a property `"openstappsConfiguration"` to your `package.json` with all or some properties of the [configuration](https://openstapps.gitlab.io/configuration/interfaces/_common_.configuration.html).
|