npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

load-config-file

v2.0.0

Published

Load the config file as a plain object. The config file format can be registered.

Downloads

4,574

Readme

load-config-file npm

Build Status Code Climate Test Coverage downloads license

Load the config file as a plain object.

  • The config file format can be registered.
  • The registered file format order is the search order.
  • the virtual file system can be specfied: loadConfig.setFileSystem(fs)
    • fs.path = require('path.js/lib/path').path for the virtual POSIX path.
      • you must set the path first before call setFileSystem.

Usage

import { Config as loadConfig } from 'load-config-file'
import { parse as parseYaml } from 'yaml'
import * as cson from 'cson';

loadConfig.register(['.yaml', '.yml'], parseYaml); //first search.
loadConfig.register('.cson', cson.parseCSONString.bind(cson)); //second search
loadConfig.register('.json', JSON.parse); //third search.

//Synchronously load config from file.
//it will search config.yaml, config.yml, config.cson, config.json in the current folder.
//the first exist file will be loaded.
//the default encoding is "utf8" if no encoding.
//loadConfig('config', {encoding: 'ascii'})
//the non-enumerable "$cfgPath" property added.
console.log(loadConfig('config'));

const result = await loadConfig('config')
//Asynchronously load config from file
loadConfig('config', function(err, result){
  if (err) {
    console.log('error:', err);
  } else {
    console.log(result);
  }
})

API

var config = require('load-config-file');
  • config.register(extensionNames, parserFunc): register the configuration file format to load. return the configurators if successful.
    • extensionNames (Sting|ArrayOf String): the configuration file extension name(s) with dot.
    • parserFunc Function(context): the configuration context parser function:
      • parse the configuration context and return the plain object.
  • config.setFileSystem(fs): set your favour file system. defaults to 'fs'.
    • the "file system" must implement readFile(path[, options], done) and readFileSync(path[, options])
  • load(path, options, done): Asynchronously load config from file
    • options
      • raiseError (Boolean): raise error if nothing loaded defaults to false.
      • exclude (String|ArrayOf String): excludes some files.
      • encoding (String): the file encoding name. defaults to 'utf8'.
    • return the plain object and the $cfgPath property added if successful.
  • loadSync(path, options): Synchronously load config from file
    • return the plain object and the $cfgPath property added if successful.

Changes

v0.2

  • raiseError option to load function asynchronously.

  • add the $cfgPath(String) non-enumerable property to the result.

  • add object usage supports:

    var cfgObj = new Config(aPath, aOptions) //create a configuration object.
    result = cfgObj.loadSync()

TODO

  • ! how to use the specified promise library via any-promise?
    • currently use the bluebird by default.

License

MIT