https://github.com/nylen/home-config
Simple Node.js library for managing a config file in a user's home dir.
https://github.com/nylen/home-config
Last synced: 10 months ago
JSON representation
Simple Node.js library for managing a config file in a user's home dir.
- Host: GitHub
- URL: https://github.com/nylen/home-config
- Owner: nylen
- Created: 2014-09-05T01:50:52.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-10-20T16:33:23.000Z (over 11 years ago)
- Last Synced: 2025-08-09T07:55:45.609Z (11 months ago)
- Language: JavaScript
- Size: 156 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# home-config [](https://travis-ci.org/nylen/home-config) [](https://www.npmjs.org/package/home-config)
This Node.js module provides an easy way to read and write configuration files in
a user's home directory, where many Linux applications store configuration
files.
To install it: `npm install home-config`
The home directory is `process.env.HOME`, unless you are on Windows, in which
case it is `process.env.USERPROFILE`.
Configuration files are stored in ini format as parsed by
[isaacs/ini](https://github.com/isaacs/ini). `key = value` lines work, and
`[section]` appears as an object with any properties under it as keys.
## Usage
Basic usage is to require the module and call `.load()` with your desired
config filename:
```js
var cfg = require('home-config').load('.myapprc');
// or
var cfg = require('home-config').load('.myapprc', {
optionName : 'defaultValue'
});
```
You can make changes then save your config file (but any user comments or
indentation will be removed):
```js
cfg.section = {
property : 'x'
};
cfg.save();
// or
cfg.save('some-other-filename');
```
The following top-level config key names are prohibited and will not be saved
or loaded:
- `save`
- `getAll`
- `__filename`
Finally, this package is designed to work with config files in the current
user's home directory, but all filenames are passed to
[`path.resolve`](http://nodejs.org/api/path.html#path_path_resolve_from_to), so
if you pass an absolute path to `.load()` or `.save()` then it will be used
as-is.