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
Fraser Waters 6576ab28ef Prototype of moving engine interface to gRPC 
This changes the "about" command in pkg/cmd to simply be a formatting
shim, all the core logic of looking up backends/plugins/stacks etc is
now done by a new interface that cmd calls via grpc.

There's also a new "pulumi host-engine" hidden command to get the cli to
simply start up and print the address of the new grpc interface.

About was a fairly simple command to move over, it doesn't do any
explict logging or interactivity and is ok to block until all results
are collected and returned. But it lays the skeleton framework for the
new interface such that we can start iterating on this for other
commands, especially the new pulumi-deploy commands.
 		2022-10-24 11:39:28 +01:00
..
asset Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
automation Merge #10955 2022-10-24 02:52:30 +00:00
cmd chore: Update doc comments, coding style, fix lint 2022-10-13 13:50:49 -07:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Avoid importing typescript unless necessary (#10185) 2022-07-20 17:38:55 -04:00
iterable Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
log Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
npm ci: Prevent yarn mutex timeout by single-threading yarn commands 2022-09-14 10:07:21 -07:00
proto Prototype of moving engine interface to gRPC 2022-10-24 11:39:28 +01:00
provider [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
queryable Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
runtime Inherit the providers map between components 2022-10-20 15:35:50 -07:00
tests Merge #10955 2022-10-24 02:52:30 +00:00
tests_with_mocks [sdk/{nodejs,python}] Fix errors when testing remote components with mocks (#8053) 2021-09-24 06:08:13 -07:00
.eslintrc.js [sdk/nodejs] Avoid eslint error in VS Code 2022-10-19 16:39:22 -07:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
README.md adjust link text in node sdk readme (#8816) 2022-01-28 16:45:55 -08:00
config.ts fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
errors.ts Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
index.ts Removing x namespace from go/python/nodejs automation packages (#6518) 2021-04-14 19:32:18 +01:00
invoke.ts [sdk/nodejs] Add pluginServerURL (#8698) 2022-01-10 15:54:41 -08:00
metadata.ts Make getOrganization total, default to 'organization' 2022-09-22 11:06:51 -07:00
output.ts Remove undefined cases from inputs to `all` function 2022-10-17 14:24:58 +01:00
package.json Make tracing conditional. Add gRPC instrumentation. 2022-09-15 07:26:52 -04:00
resource.ts fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
stackReference.ts Tidy Nodejs SDK imports (#9658) 2022-05-30 09:31:28 +01:00
tsconfig.json Enable ESModule interoperability 2022-09-20 10:34:00 -04:00
tsutils.ts [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
utils.ts fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -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. 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.