maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
joeduffy a2ae4accf4 Switch to parent pointers; display components nicely 
This change switches from child lists to parent pointers, in the
way resource ancestries are represented.  This cleans up a fair bit
of the old parenting logic, including all notion of ambient parent
scopes (and will notably address pulumi/pulumi#435).

This lets us show a more parent/child display in the output when
doing planning and updating.  For instance, here is an update of
a lambda's text, which is logically part of a cloud timer:

    * cloud:timer:Timer: (same)
          [urn=urn:pulumi:malta::lm-cloud:☁️timer:Timer::lm-cts-malta-job-CleanSnapshots]
        * cloud:function:Function: (same)
              [urn=urn:pulumi:malta::lm-cloud:☁️function:Function::lm-cts-malta-job-CleanSnapshots]
            * aws:serverless:Function: (same)
                  [urn=urn:pulumi:malta::lm-cloud::aws:serverless:Function::lm-cts-malta-job-CleanSnapshots]
                ~ aws:lambda/function:Function: (modify)
                      [id=lm-cts-malta-job-CleanSnapshots-fee4f3bf41280741]
                      [urn=urn:pulumi:malta::lm-cloud::aws:lambda/function:Function::lm-cts-malta-job-CleanSnapshots]
                    - code            : archive(assets:2092f44) {
                        // etc etc etc

Note that we still get walls of text, but this will be actually
quite nice when combined with pulumi/pulumi#454.

I've also suppressed printing properties that didn't change during
updates when --detailed was not passed, and also suppressed empty
strings and zero-length arrays (since TF uses these as defaults in
many places and it just makes creation and deletion quite verbose).

Note that this is a far cry from everything we can possibly do
here as part of pulumi/pulumi#340 (and even pulumi/pulumi#417).
But it's a good start towards taming some of our output spew.
2017-11-26 08:14:01 -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 Switch to parent pointers; display components nicely 2017-11-26 08:14:01 -08:00
dynamic Switch to parent pointers; display components nicely 2017-11-26 08:14:01 -08:00
log Format logs the same way Node.js console APIs do (#561) 2017-11-14 09:55:54 -08:00
runtime Switch to parent pointers; display components nicely 2017-11-26 08:14:01 -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
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 Switch to parent pointers; display components nicely 2017-11-26 08:14:01 -08:00
tsconfig.json Switch to parent pointers; display components nicely 2017-11-26 08:14:01 -08: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.