npmextra/README.md

npmextra

do more with npm.

npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.

Availabililty

Status for master

Usage

The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.

npmextra.json

{
    "sometool": {
        "defaultKey1": "awesomeValueFromConfig"
    }
}

import * as npmextra from 'npmextra'

npmextra.dataFor({
    toolName:'sometool',
    defaultSettings: { // gets merged with whatever is in the configfile
        defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
        defaultKey2: 'defaultValue2' // this one will pass through unaltered
    },
    cwd?: string // lets you specifiy a custom current working directory to look for the npmextra.json
})