Socket
Socket
Sign inDemoInstall

home-config

Package Overview
Dependencies
1
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

home-config

Simple library for managing a config file in a user's home dir.


Version published
Maintainers
1
Weekly downloads
1,255
decreased by-7.72%

Weekly downloads

Readme

Source

home-config Build status npm package

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. 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:

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):

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, so if you pass an absolute path to .load() or .save() then it will be used as-is.

Keywords

FAQs

Last updated on 20 Oct 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc