npmextra/README.md
2016-09-24 16:52:38 +02:00

2.3 KiB

npmextra

do more with npm.

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

Availabililty

npm git git docs

Status for master

build status coverage report Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

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 { Npmextra } from 'npmextra'

let myNpmExtra = new Npmextra('my/path/to/cwd') // cwd argument is optional 
mergedData = myNpmExtra.dataFor(
    'sometool',
    { // 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
    }
)

npm