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 reader and writer.
The config spec can be read here.
Usage
.load()
Loads the bower configuration from the configuration files.
.get(key) - NOT YET IMPLEMENTED
Returns a configuration value by key
.
Keys with dots are supported to access deep values.
.set(key, value) - NOT YET IMPLEMENTED
Sets a configuration value for key
.
Keys with dots are supported to set deep values.
.del(key) - NOT YET IMPLEMENTED
Removes configuration named key
.
Keys with dots are supported to delete deep keys.
.save(where, callback) - NOT YET IMPLEMENTED
Saves changes to where
.
The where
argument can be a path to a configuration file or:
local
to save it in the configured current working directory (defaulting to process.cwd
)user
to save it in the configuration file located in the home directory
.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)
Alias for:
var configObject = (new Config(cwd)).load().toJson();
#normalise(config)
Returns a new normalised config object based on config
.
Object keys will be converted to camelCase.
License
Released under the MIT License.