History

Matt Ellis ce5eaa8343 Support TypeScript in a more first-class way This change lets us set runtime specific options in Pulumi.yaml, which will flow as arguments to the language hosts. We then teach the nodejs host that when the `typescript` is set to `true` that it should load ts-node before calling into user code. This allows using typescript natively without an explicit compile step outside of Pulumi. This works even when a tsconfig.json file is not present in the application and should provide a nicer inner loop for folks writing typescript (I'm pretty sure everyone has run into the "but I fixed that bug! Why isn't it getting picked up? Oh, I forgot to run tsc" problem. Fixes #958		2018-08-06 14:00:58 -07:00
..
asset	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
cmd	Support TypeScript in a more first-class way	2018-08-06 14:00:58 -07:00
dist	Don't set NODE_PATH in dynamic provider	2018-06-15 11:12:24 -07:00
dynamic	Compute required packages during closure serialization (#1457 )	2018-06-03 21:55:37 -07:00
log	Add support for providing a log stream-id to our RPC interface. (#1627 )	2018-07-11 15:04:00 -07:00
proto	Save resources obtained from ".get" in the snapshot (#1654 )	2018-08-03 14:06:00 -07:00
runtime	Actually export function. (#1710 )	2018-08-06 15:45:06 -04:00
tests	Ensure we can capture non-built-in modules with 'require'. (#1685 )	2018-08-02 16:25:49 -04:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Go back to capturing non-user modules by 'require' reference. (#1655 )	2018-07-31 11:37:46 -04:00
errors.ts	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
index.ts	Ensure we can capture non-built-in modules with 'require'. (#1685 )	2018-08-02 16:25:49 -04:00
Makefile	Stop including native serialization modules	2018-06-04 14:27:01 -07:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
package.json	Support TypeScript in a more first-class way	2018-08-06 14:00:58 -07:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
resource.ts	Fix doc comment for ComponentResource (#1700 )	2018-08-03 13:31:19 -07:00
tsconfig.json	Support async function serialization. (#1311 )	2018-05-03 12:25:52 -07:00
tslint.json	Add license headers	2018-05-22 15:02:47 -07:00
version.ts	Add license headers	2018-05-22 15:02:47 -07:00
yarn.lock	Support TypeScript in a more first-class way	2018-08-06 14:00:58 -07:00

README.md

Pulumi Node.js SDK

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

Installation

Using npm:

$ npm install --save @pulumi/pulumi

Using yarn:

$ yarn add @pulumi/pulumi

This SDK is meant for use with the Pulumi CLI. Please visit pulumi.io for installation instructions.

Building and Testing

For anybody who wants to build from source, here is how you do it.

Prerequisites

This SDK uses Node.js and we support the Active LTS and Current releases, as defined by this table. We support both NPM and Yarn for package management.

At the moment, we only support building on macOS and Linux, where standard GNU tools like make are available.

Make Targets

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

$ make ensure

This is only necessary if you intend to produce a build that is capable of running older versions of the SDK contained in this directory. If you do intend to do this, you must have node 6.10.2 installed.

To build the SDK, simply run make from the root directory (where this README lives, at sdk/nodejs/ from the repo's root). This will build the code, run tests, and install the package and its supporting artifacts.

At the moment, for local development, we install everything into /opt/pulumi. You will want this on your $PATH.

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.