pulumi/sdk/nodejs
Luke Hoban 96e4b74b15
Support for stack outputs (#581)
Adds support for top-level exports in the main script of a Pulumi Program to be captured as stack-level output properties.

This create a new `pulumi:pulumi:Stack` component as the root of the resource tree in all Pulumi programs.  That resources has properties for each top-level export in the Node.js script.

Running `pulumi stack` will display the current value of these outputs.
2017-11-17 15:22:41 -08:00
..
asset Many asset improvements 2017-10-22 13:39:21 -07:00
bin Adopt new makefile system 2017-11-16 23:56:29 -08:00
cmd Support for stack outputs (#581) 2017-11-17 15:22:41 -08:00
log Format logs the same way Node.js console APIs do (#561) 2017-11-14 09:55:54 -08:00
runtime Support for stack outputs (#581) 2017-11-17 15:22:41 -08:00
tests Support for stack outputs (#581) 2017-11-17 15:22:41 -08:00
.gitignore Build, integration tests and publishing on Windows 2017-10-02 13:40:58 -07:00
config.ts Fix outdated config error message 2017-11-17 08:53:58 -08:00
dynamic.ts Add a newline. 2017-10-16 23:06:53 -07:00
errors.ts Improve output formatting 2017-09-23 05:20:11 -07:00
index.ts Add accessors to fetch the Pulumi project and stack names 2017-10-19 08:26:57 -07:00
Makefile Adopt new makefile system 2017-11-16 23:56:29 -08:00
metadata.ts Fix a function comment 2017-11-08 16:20:27 -08:00
package.json Move from acorn to TypeScript as the parser we use when computing free variables. (#431) 2017-10-18 13:29:53 -07:00
pulumi-langhost-nodejs Adopt new makefile system 2017-11-16 23:56:29 -08:00
pulumi-provider-pulumi-nodejs Adopt new makefile system 2017-11-16 23:56:29 -08:00
README.md push is dead; long live update. 2017-09-22 17:23:40 -07:00
resource.ts Support for stack outputs (#581) 2017-11-17 15:22:41 -08:00
tsconfig.json Permit undefined in more places 2017-10-23 16:02:28 -07:00
tslint.json Enable tslinting of the nodejs sdk. (#433) 2017-10-18 15:03:56 -07:00
yarn.lock Enable tslinting of the nodejs sdk. (#433) 2017-10-18 15:03:56 -07:00

Pulumi Fabric Node.js SDK

The Pulumi Fabric Node.js SDK lets you write cloud programs in JavaScript.

Installing

For now, we only support developers building from source. Eventually we will have a nice installer.

Prerequisites

To build and install the SDK, you will first need a few things.

First, install Node.js 6.10.2. We recommend nvm, since it makes it easier to switch between versions of Node.js. Afterwards, run nvm install 6.10.2.

Next, we suggest using Yarn for package management. NPM works too, but Yarn is faster and therefore preferred. Please follow the directions on Yarn's website.

Building and Testing

The first time you build, you must make configure to install and prepare native plugins for V8:

$ make configure

Make sure to run this after installing the right version of Node.js above, otherwise it may bind to the wrong version.

To build the SDK, simply run make from the root directory (sdk/nodejs/). This will build the code, run tests, and then "install" the package (by yarn linking the resulting bin/ directory).

We recommend putting bin/ on your $PATH, since the pulumi-langhost-nodejs executable will be loaded dynamically by the pulumi tool whenever it encounters a Node.js program.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi update from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.