Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.
Go to file
2016-09-18 16:10:07 +02:00
dist compiled 2016-09-18 16:10:07 +02:00
test compiled 2016-09-18 16:10:07 +02:00
ts now adheres to standard js 2016-09-16 22:28:38 +02:00
.gitignore now adheres to standard js 2016-09-16 22:28:38 +02:00
.gitlab-ci.yml fix README 2016-09-17 18:12:32 +02:00
package.json 1.0.11 2016-09-17 18:12:59 +02:00
README.md improve README 2016-09-18 16:09:27 +02:00
tslint.json now adheres to standard js 2016-09-16 22:28:38 +02:00

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 * 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
})

npm