248f78bafe
Add support to the core SDKs for reporting resource source positions.
In each SDK, this is implemented by crawling the stack when a resource
is registered in order to determine the position of the user code that
registered the resource.
This is somewhat brittle in that it expects a call stack of the form:
- Resource class constructor
- abstract Resource subclass constructor
- concrete Resource subclass constructor
- user code
This stack reflects the expected class hierarchy of "cloud resource /
component resource < customresource/componentresource < resource".
For example, consider the AWS S3 Bucket resource. When user code
instantiates a Bucket, the stack will look like
this in NodeJS:
new Resource (/path/to/resource.ts:123:45)
new CustomResource (/path/to/resource.ts:678:90)
new Bucket (/path/to/bucket.ts:987:65)
<user code> (/path/to/index.ts:4:3)
In order to determine the source position, we locate the fourth frame
(the `<user code>` frame).
|
||
|---|---|---|
| .. | ||
| asset | ||
| automation | ||
| cmd | ||
| dist | ||
| dynamic | ||
| iterable | ||
| log | ||
| npm | ||
| proto | ||
| provider | ||
| queryable | ||
| runtime | ||
| tests | ||
| tests_with_mocks | ||
| .eslintrc.js | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| config.ts | ||
| errors.ts | ||
| index.ts | ||
| invoke.ts | ||
| metadata.ts | ||
| output.ts | ||
| package.json | ||
| resource.ts | ||
| rome.json | ||
| stackReference.ts | ||
| tsconfig.json | ||
| tsutils.ts | ||
| utils.ts | ||
| version.ts | ||
| yarn.lock | ||
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. Visit Pulumi's Download & Install to install the CLI.
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 any of the Current, Active and Maintenance LTS versions. 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
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 $HOME/.dev-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.