Coder Social home page Coder Social logo

confer's Introduction

confer

Locate and parse a JSON file.

Confer begins its search in the specified directory or process.cwd(). If a file is not found, confer then walks up the directory tree one level at a time until a file is found. If confer has not found a file after the walk, it will look for a file in $HOME.

Build Status

Installation

npm install confer

Usage

var config = require('confer')('config.json') || {};

API

confer(file, [dir])

Locate and parse a JSON file. Returns a JSON object or false if a file was not found.

  • file {String} filename or path
  • dir {String} (optional) directory to begin from; default is process.cwd()

If file is a path then confer will parse the given file directly, bypassing the locate step.

confer.locateFile(file, [dir])

Locate a file by walking up the directory tree. Returns a file path or false if a file was not found.

  • file {String} filename
  • dir {String} (optional) directory to begin from; default is process.cwd()

Tests

npm test

confer's People

Contributors

brettstimmerman avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

confer's Issues

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.