Determine the potential deployment type of a project on Now
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
.yarnrc
license.md
package.json
readme.md
yarn.lock

readme.md

deployment-type

Build Status XO code style Slack Channel

This Node.js package inspects a certain file or directory path of your choice and then responds with the deployment type that will be selected for it when deployed with now.

All of ZEIT's now clients (like Now Desktop and Now CLI) are using this package.

Usage

Firstly, install the package:

yarn add deployment-type

And then:

// Load it
const deploymentType = require('deployment-type')

// Call it and pass it a directory or file path
await deploymentType(<path-here>)

Types

The package will return one of these deployment types:

  • "npm" (node deployment)
  • "static"
  • "docker"

Contribute

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Link the package to the global module directory: npm link
  3. Within the module you want to test your local development instance of the package, just link it to the dependencies: npm link deployment-type. Instead of the default one from npm, node will now use your clone of the package!

Author

Leo Lamprecht (@notquiteleo) - ▲ZEIT