rcfile

rcfile

Loads library configuration in all possible ways

Read library configurations from yaml, json, js files or from sections in package.json.

Installation

npm install --save rcfile

Usage

'use strict'
var rcfile = require('rcfile')

rcfile('eslint')
  .then(function (config) {
    console.log(config)
    //> { extends: 'standard',
    //    rules: 
    //     { 'comma-dangle': [ 2, 'always-multiline' ],
    //       'arrow-parens': [ 2, 'as-needed' ] } }
  })

rcfile('travis', { configFileName: '.travis' })
  .then(function (config) {
    console.log(config)
    //> { language: 'node_js',
    //    sudo: false,
    //    node_js: [ 'v0.10', 'v4' ],
    //    cache: { directories: [ 'node_modules' ] },
    //    before_install: [ 'npm install -g npm@3' ],
    //    install: [ 'npm install' ],
    //    after_success: 
    //     [ 'if [[ $TRAVIS_NODE_VERSION == "v4" ]]; then npm run coveralls; fi;',
    //       'if [[ $TRAVIS_NODE_VERSION == "v4" ]]; then npm run semantic-release; fi;' ] }
  })

License

MIT © Zoltan Kochan

Dependencies

• debug: small debugging utility
• find-up-glob: Find a file by walking up parent directories
• json5: JSON for the ES5 era.
• read-pkg-up: Read the closest package.json file
• require-uncached: Require a module bypassing the cache

Dev Dependencies

• chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
• cz-conventional-changelog: Commitizen adapter following the conventional-changelog format.
• eslint: An AST-based pattern checker for JavaScript.
• eslint-config-standard: JavaScript Standard Style - ESLint Shareable Config
• eslint-plugin-promise: Enforce best practices for JavaScript promises
• eslint-plugin-standard: ESlint Plugin for the Standard Linter
• ghooks: Simple git hooks
• istanbul: Yet another JS code coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. Supports all JS coverage use cases including unit tests, server side functional tests
• mocha: simple, flexible, fun test framework
• mos: A pluggable module that injects content into your markdown files via hidden JavaScript snippets
• mos-plugin-readme: A mos plugin for generating README
• semantic-release: automated semver compliant package publishing
• validate-commit-msg: Script to validate a commit message follows the conventional changelog standard