Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-basov/ember-cli-config-builder
⚙️ Edit Ember app configs in your addon blueprints!
https://github.com/m-basov/ember-cli-config-builder
config ember-addon ember-cli ember-util
Last synced: 24 days ago
JSON representation
⚙️ Edit Ember app configs in your addon blueprints!
- Host: GitHub
- URL: https://github.com/m-basov/ember-cli-config-builder
- Owner: m-basov
- License: mit
- Created: 2018-03-01T12:07:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T09:17:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T03:15:26.324Z (about 1 month ago)
- Topics: config, ember-addon, ember-cli, ember-util
- Language: TypeScript
- Homepage:
- Size: 430 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-config-builder
[](https://travis-ci.org/kolybasov/ember-cli-config-builder)
[](https://badge.fury.io/js/ember-cli-config-builder)
Extensible library to edit Ember’s config files with familiar API.
Why? Checkout this [blog post](https://kolybasov.github.io/posts/making-ember-addon-installation-smoother/).
## Installation
* `$ npm install --save ember-cli-config-builder`
Or
* `$ yarn add ember-cli-config-builder`
## Basic Usage
```javascript
// Import library
const ConfigBuilder = require('ember-cli-config-builder');
// Create builder instance. Notice: it is async operation which returns
// Promise because async fs.readFile method is used to read file contents
let config = await ConfigBuilder.create('./my-addon/config/environment.js');
// Read variables with #get(path) method. Notice: it is always returns string
// with raw value. Example: "'string value'", 'true', '{ object: true }' etc
config.get('rootURL'); // "'/'"
// Read nested values with dot-separated path
config.get('EmberENV.EXTEND_PROTOTYPES.Date'); // 'false'
// Read multiple values at once
config.get(['modulePrefix', 'locationType']); // { modulePrefix: "'dummy'", locationType: "'auto'" }
// Change existing properties with #set(path, value) method. It returns true
// if set was successful or false otherwise
config.set('rootURL', "'/dev'"); // true
// Create a new poperty
config.set('myNewProp', '{}'); // true
// Change nested properties
config.set('EmberENV.EXTEND_PROTOTYPES.Date', 'true'); // true
// Change or create multiple properties at once
config.setProperties({ 'myNewProp.child': "'works'", 'rootURL.child': "'rootURL is not an object'" }); // { 'myNewProp.child': true, 'rootURL.child': false }
// Or remove properties entirely with #remove(path) method. It returns true
// if key was found and removed and false otherwise
config.remove('rootURL'); // true
// You can remove only child keys.
config.remove('myNewProp.child'); // true
// Multiple remove is available as well
config.removeProperties(['myNewProp', 'modulePrefix']); // { myNewProp: true, modulePrefix: true }
// After editing is done there are a few options to save result.
// The most straightforward is save to the same file.
// Notice: this method is async as well because of usage non-blocking
// fs.writeFile method
await config.save(); // will write changes to disk and return string with file content
// Or you can write changes to another file
await config.save('./my-addon/config/new-environment.js');
// See Advanced Usage section for more use cases
```
## Built-in adapters
* environment.js
* ember-cli-build.js
## Alternatives
* [ember-cli-build-config-editor](https://github.com/srvance/ember-cli-build-config-editor) – uses the same approach with recast AST trees but is have many limits what you can edit and uses it owns non-Ember intuitive API. Also it moves reading and writing files to user responsibilities.
* [recast](https://github.com/benjamn/recast) – very powerful but yet very low-level tool to parse, edit and print JavaScript files. This addon wraps it to make editing much more easier.
## Advanced Usage
TODO: write this :)
## Contributing
### Installation
`git clone [email protected]:kolybasov/ember-cli-config-builder.git`
`cd ember-cli-config-builder`
`yarn install`
### Running tests
`yarn test` – Runs jest tests
## License
This project is licensed under the [MIT License](./LICENSE.md).