What is bower-config?
The bower-config npm package is used to manage Bower configuration files. It allows you to read, modify, and write Bower configuration settings programmatically.
What are bower-config's main functionalities?
Reading Configuration
This feature allows you to read the Bower configuration settings from the .bowerrc file or other configuration sources.
const Config = require('bower-config');
const config = Config.read();
console.log(config);
Modifying Configuration
This feature allows you to modify the Bower configuration settings and write them back to the configuration file.
const Config = require('bower-config');
const config = Config.read();
config.directory = 'new_components';
Config.write(config);
Setting Defaults
This feature allows you to set default values for Bower configuration settings.
const Config = require('bower-config');
const config = Config.read();
config.defaults = { directory: 'default_components' };
Config.write(config);
Other packages similar to bower-config
rc
The rc package is a non-opinionated configuration loader for Node.js. It allows you to load configuration files from various sources, including JSON, INI, and environment variables. Unlike bower-config, which is specific to Bower, rc is more general-purpose and can be used for any Node.js application.
config
The config package is a configuration manager for Node.js applications. It allows you to define configuration settings for different environments and load them based on the current environment. While bower-config is specific to Bower, config is more versatile and can be used for any Node.js application.
nconf
The nconf package is a hierarchical configuration manager for Node.js. It allows you to load configuration settings from multiple sources, including command-line arguments, environment variables, and configuration files. Unlike bower-config, which is tailored for Bower, nconf is more flexible and can be used for various types of Node.js applications.
bower-config
The Bower config (.bowerrc
) reader and writer.
Bower can be configured using JSON in a .bowerrc
file. For example:
{
"directory": "app/components/",
"timeout": 120000,
"registry": {
"search": [
"http://localhost:8000",
"https://registry.bower.io"
]
}
}
View the complete .bowerrc specification on the website for more details. Both the bower.json
and .bowerrc
specifications are maintained at github.com/bower/spec.
Install
$ npm install --save bower-config
Usage
.load(overwrites)
Loads the bower configuration from the configuration files.
Configuration is overwritten (after camelcase normalisation) with overwrites
argument.
This method overwrites following environment variables:
HTTP_PROXY
with proxy
configuration variableHTTPS_PROXY
with https-proxy
configuration variableNO_PROXY
with no-proxy
configuration variable
It also clears http_proxy
, https_proxy
, and no_proxy
environment variables.
To restore those variables you can use restore
method.
restore()
Restores environment variables overwritten by .load
method.
.toObject()
Returns a deep copy of the underlying configuration object.
The returned configuration is normalised.
The object keys will be camelCase.
#create(cwd)
Obtains a instance where cwd
is the current working directory (defaults to process.cwd
);
var config = require('bower-config').create();
var config2 = require('bower-config').create('./some/path');
#read(cwd, overrides)
Alias for:
var configObject = (new Config(cwd)).load(overrides).toJson();
License
Released under the MIT License.