d00528918e
This adds a conformance test checking we can use map keys like "MY_KEY" and maintain their casing through program gen. For Python we need to simplify the type passed to genObjectConsExpression so that we can reliably determine the target type and check if it's a `TypedDict` or not, otherwise we might treat it as a plain object and preserve the keys, instead of `PyName`ing them. This deletes the "typeddict" test from the codegen tests. Firstly this is now covered by these conformance tests, secondly it wasn't actually valid because the schema it was testing against wasn't a valid schema, and the program snapshot was only how it was because of a bug in programgen. That bug is now fixed in this change which fixes https://github.com/pulumi/pulumi/issues/17294. --------- Co-authored-by: Julien Poissonnier <julien@caffeine.lu> |
||
---|---|---|
.. | ||
asset | ||
automation | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
npm | ||
proto | ||
provider | ||
queryable | ||
runtime | ||
tests | ||
tests_with_mocks | ||
types | ||
vendor | ||
.eslintrc.js | ||
.gitignore | ||
.npmignore | ||
Makefile | ||
README.md | ||
biome.json | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
output.ts | ||
package.json | ||
resource.ts | ||
stackReference.ts | ||
tsconfig.json | ||
tsutils.ts | ||
typescript-shim.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.