superyay v1.0.10

Superyay ·

Superyay is a nice way to warn contributors that they aren't using the desired version of Node.js or npm.

Installation

npm install superyay

Configuration

Superyay's configuration is simply stored in your project's package.json file. When using this tool, both the Node.js version & npm version are required and must be stored in the engines property (per node standard). All additional options that are specific to superyay get stored in the superyay property.

info

Adds a string to the ouput that can be used to provide additional information.

# package.json
{
  "superyay": {
    "info": "https://awesome.wiki"
  }
}

installType

Provides the contributor with a command to run to update their version of Node.js. Supported types: nvm, n, apt & brew.

# package.json
{
  "superyay": {
    "installType": "nvm"
  }
}

If you would like to display a link with your warning add a property superyay to with the nested value link.

Example configuration

# package.json configuration
{
  ...,
  "engines": {
    "node": "6.10.2",
    "node": "5.5.1"
  },
  "superyay": {
    "info": "https://awesome.wiki"
  }
}

Usage

# package.json scripts prepend example
{
  ...,
  "scripts": {
    "deploy": "superyay webpack blah blah"
  }
}

# run directly in your project via bin
./node_modules/.bin/superyay