Simplify management of local npm and node.js development resources and processes, such as symlinks, global dependencies, etc. It's like grunt or gulp, but with 100x less code and a flatter learning curve.
npm install nex
Simplify management of local npm and node.js development resources and processes. Add stuff to your package.json and watch it work. It's like grunt or gulp, but with 100x less code and a flatter learning curve. It is a pure essentialization of the "task-runner", and is designed to be magical, but not mysterious. nex is un-opinionated, npm-integrated, and fully-discombobulated.
sh
$ npm install -g nex
`Use
#### 1. Create a
nex array to define the general order of execution
nex do will do all the things in this array.package.json:
`json
{
"nex": [
"repository",
"engines",
"globalDependencies",
"linkDependencies"
]
}
`#### 2. Intercept the
npm phases you want nex to control
package.json:
`json
{
"scripts": {
"preinstall": "nex do",
"pretest": "nex do engines"
}
}
`
nex operates by declarative fiat. There's no special build file to contstruct, environment to define, or configs to set. Your existing package.json declares which nex routines run during each npm phase.nex routines####
repository (npm)
`sh
$ nex do repository
`
Use this when you want to download and extract this module from the repository defined in the repository field. Useful for hosting Github-authenticated private modules publicly on npmjs.org. If the module is private, you'll be prompted for your Github credentials.package.json:
`json
{
"license": "Proprietary",
"repository": {
"type": "git",
"url": "git://github.com/tjwebb/super-nex.git",
"private": true
}
}`
.npmignore
`
index.js
lib/
private-stuff/
`
####
globalDependencies (npm)
`sh
$ nex do globalDependencies
`
Install dependencies globally, automatically as part of npm's normal installation process.package.json
`json
{
"globalDependencies": {
"": "",
"jshint": "^2.5"
}
}
`
####
linkDependencies (npm)
`sh
$ nex do linkDependencies
`
Create symlinks from node_modules/ to package.json
`json
{
"linkDependencies": {
"": "",
"module1": "./lib/module1"
}
}
`
####
symlinks (npm)
`sh
$ nex do symlinks
`
Create arbitrary to any package.json
`json
{
"symlinks": {
"": ",
"./lib/shared.js": "/usr/share/superlib/shared.js"
}
}
`
####
engines (npm)
`sh
$ nex do engines
`
Ensure that all npm commands are invoked with the correct version of node as defined in the standard engines fieldpackage.json
`json
{
"engines": {
"node": "^0.11.13"
}
}
`Extend
nex yourself
Anyone can extend nex. Create a node module that exposes the methods do and undo, name it after the package.json field you want to operate on, and publish it to npmjs.org as nex-.API
####
do (package)
- @param package {Object} package.json object
- Do something####
undo (package)
- @param package {Object} package.json object`