History

pat@pulumi.com 6ef0747219 Pad provider arguments on Windows. All of our providers expect to be invoked as `node path/to/provider ...provider_args`, but on Windows, we are invoking them as `node -e require(path/to/provider) ...provider_args`. This throws off the provider's argument processing and causes connections to the resource monitor to fail. Fixes #477, though I think that there is going to be another issue with dynamic resources.		2017-10-26 18:44:29 -07:00
..
asset	Many asset improvements	2017-10-22 13:39:21 -07:00
bin	Pad provider arguments on Windows.	2017-10-26 18:44:29 -07:00
cmd	Do not disconnect from the engine prematurely.	2017-10-26 12:16:32 -07:00
log	Enable tslinting of the nodejs sdk. (#433 )	2017-10-18 15:03:56 -07:00
runtime	Do not disconnect from the engine prematurely.	2017-10-26 12:16:32 -07:00
tests	Permit undefined in more places	2017-10-23 16:02:28 -07:00
.gitignore	Build, integration tests and publishing on Windows	2017-10-02 13:40:58 -07:00
config.ts	Enable 'use const' linter rule. (#405 )	2017-10-10 14:50:55 -07: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	Enable tslinting of the nodejs sdk. (#433 )	2017-10-18 15:03:56 -07:00
metadata.ts	Add accessors to fetch the Pulumi project and stack names	2017-10-19 08:26:57 -07: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
README.md	`push` is dead; long live `update`.	2017-09-22 17:23:40 -07:00
resource.ts	Simplify the type system around 'computed' a little. (#469 )	2017-10-25 12:52:49 -07: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

README.md

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.