Acid JS - Config :file_folder:

Configuration schema for Acid JS.

Note: All projects within the @acidjs ecosystem (with some exceptions) are configurable through this package. Each package will have its own key within the main confiuguration object(lib/defaults/index.js). The options can be overwritten using YAML - Live Demo

Install

npm install @acidjs/config

Usage

const config = require('@acidjs/config')

console.log(config)

Configure

To overwrite defaults, create .acid/config.yml in the root directory of your project. If there is a mistake in your config file, you will be notified, else you'll get back a merged_object(defaults, your_configs).

Here is a simple example of changing the prefix for the @acidjs/log package. For more details on configurations, check out the specific package you want to configure.

# .acid/config.yml

log:
  prefix: my-app

License

MIT License

Copyright (c) 2020 Michael Arakilian

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.