mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Luke Hoban d9a18f0aa8
Revert back to ts-node ^7.0.0 (#4007) 
We upgraded to `ts-node@^8.0.0`  2.5 months ago as part of https://github.com/pulumi/pulumi/pull/3627, though it seems it wasn't really necessary to make that update for the purposes of the PR - updating the default TypeScript version.

The `8.0.0` series of `ts-node` unfortunately dropped all of it's caching support, due to what appear to be some corner-case correctness issues with the cache.  We have not seen reports of those issues for Pulumi, and have much more experience with the `7.0.0` series overall (2 years vs. 2 months).  The performance difference between `7.0.0` and `8.0.0` of ts-node for Pulumi is massive - it adds 4-4.5s to each of `pulumi preview` and `pulumi up` even on a trivial program.

As a result, for now we will revert back to `ts-node@^7.0.0`.  In the future, we may want to look into our own caching layer or alternative to `ts-node` to ensure we get the behaviour and performance we expect.

Part of #3671.
 		2020-03-02 08:33:01 -08:00
..
asset Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
cmd Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Fixed 'transacational' misspelling. 2020-01-13 10:45:07 -08:00
iterable Break out Resource and Output into their own files (#2420) 2019-01-31 18:08:17 -08:00
log Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
proto Regenerate protocol buffers code 2020-02-28 11:53:47 +00:00
queryable Use TypeScript's built-in `Omit` (#3597) 2019-12-02 22:50:18 +00:00
runtime Mock resource monitor (#3738) 2020-02-28 17:22:50 -08:00
tests Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
.gitignore Add a SxS test for `@pulumi/pulumi` to help catch when we make breaking changes to core types. (#2610) 2019-03-29 12:27:42 -07:00
Makefile Fix typing for 'Lifted<T>' to work better across versions of TS (#3658) 2019-12-13 11:18:19 -08:00
README.md Update references to pulumi.io (#2979) 2019-07-25 09:58:12 -07:00
config.ts Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
errors.ts Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
index.ts Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -07:00
invoke.ts Add an option to allow callers to specify they would like make invoke calls asynchronously. (#2947) 2019-07-18 17:19:41 -07:00
metadata.ts Enable unit testing for Pulumi programs (#2638) 2019-04-16 22:20:01 -07:00
output.ts Do not allocate outputs for nested prompt values. (#3851) 2020-02-04 19:21:37 -08:00
package.json Revert back to ts-node ^7.0.0 (#4007) 2020-03-02 08:33:01 -08:00
resource.ts Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
stackReference.ts Support sxs with old outputs with sync resources only. (#3680) 2019-12-17 19:04:09 -08:00
tsconfig.json Mock resource monitor (#3738) 2020-02-28 17:22:50 -08:00
tslint.json Fix issue with comments throwing off function/class serialization (#2438) 2019-02-08 14:58:24 -08:00
utils.ts Mark internal APIs `@internal` to filter from API docs (#3809) 2020-01-26 09:06:35 -08:00
version.ts Add license headers 2018-05-22 15:02:47 -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.com 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 up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.