Giter Club home page Giter Club logo

node-bash-conf's Introduction

bash-conf

Read a simple bash config file (simple variables and values) and convert into a Javascript object.

This allows you to keep API keys, Database names etc out your source code and in a shareable location that both bash and node scripts can read.

Example config

It's intended to read a simple text file like this:

EMPTY_VAR=
FOO=BAR
this line will be ignored

Which has been used in a bash script like this:

# set vars
. /path/to/config/file.cfg
export FOO

Usage

var path = process.argv[ 2 ],
	BashConf = require('bash-conf'),
	bashConf = new BashConf();

bashConf
	.read( path )
	.then(function( data ) {
		console.log( 'what is foo', data.FOO );
		console.log( 'this should be empty -> [', data.EMPTY_VAR, ']' );
	})
	.catch( function( err ) {
		console.log( err );
	});

Error Handling

Lines that don't match the regex pattern are simply ignored and not parsed.

Missing config path

$ node test.js
No path supplied

Invalid config path

$ node test.js aintnofile.cfg
Could not read conf file aintnofile.cfg

node-bash-conf's People

Stargazers

Roman avatar

Watchers

Peter Williamson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.