aaf7c09384
If a `tsconfig.json` file is not present at the root of the Pulumi project, ts-node will look up the directory tree to see if there is one. If there is, it will treat that as the root of the project. While reasonable for some cases, this isn't the behavior we want for our use of ts-node. We actually set compiler options such that in the common case you don't even need a `tsconfig.json` and for pure JavaScript projects, there wouldn't be a `tsconfig.json` file. In both of these cases, there's a big foot-gun waiting. For example in pulumi/pulumi#1772 we ran into a case where there was a tsconfig.json file in $HOME, causing the entirety of $HOME to be analyzed by TypeScript which made it look like Pulumi hung. To address this, tell ts-node to not use a project in cases where there is not a `tsconfig.json` at the root of the project. Fixes #1772 |
||
|---|---|---|
| .. | ||
| asset | ||
| cmd | ||
| dist | ||
| dynamic | ||
| log | ||
| proto | ||
| runtime | ||
| tests | ||
| .gitignore | ||
| config.ts | ||
| errors.ts | ||
| index.ts | ||
| invoke.ts | ||
| Makefile | ||
| metadata.ts | ||
| package.json | ||
| README.md | ||
| resource.ts | ||
| tsconfig.json | ||
| tslint.json | ||
| version.ts | ||
| yarn.lock | ||
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.