pulumi/sdk/nodejs
Pat Gavlin 960a044abc [testing/nodejs] Support gathering coverage data.
- Update istanbul and mocha to their most recent versions. The istanbul
  CLI has been replaced by the nyc CLI. This is required in order to
  exclude tests from test sets and to exclude certain files (closure
  cases) from instrumentation.
- Add support for gathering and reporting coverage data under the
  `PULUMI_TEST_COVERAGE_PATH` environment variable.
2021-11-24 10:58:46 -08:00
..
asset Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
automation .NET & python SDKs parity for bad pulumi versions (#8297) 2021-10-27 20:54:23 -07:00
cmd Add tsconfig option to specify tsconfig path (#8452) 2021-11-22 11:42:39 -08:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Enable nodejs dynamic provider caching by default on program side (#6704) 2021-04-14 19:32:18 +01: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 skip installing dev dependencies for nodejs plugin setup (#7188) 2021-06-02 11:09:03 -07:00
proto Add monitor feature for output values (#7870) 2021-09-15 14:16:00 -07:00
provider Add tests that return failures from Call (#8424) 2021-11-16 08:58:46 -08:00
queryable Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
runtime Expand dependencies when marshaling output values (#8301) 2021-11-01 11:10:27 -07:00
tests Skip flaky tests for now (#8420) 2021-11-15 15:17:20 -05: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 Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
.gitignore [testing/nodejs] Support gathering coverage data. 2021-11-24 10:58:46 -08:00
config.ts Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07: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 Breaking changes due to Feature 2.0 work 2020-04-14 09:30:25 +01:00
Makefile [testing/nodejs] Support gathering coverage data. 2021-11-24 10:58:46 -08:00
metadata.ts Enable unit testing for Pulumi programs (#2638) 2019-04-16 22:20:01 -07:00
output.ts Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
package.json [testing/nodejs] Support gathering coverage data. 2021-11-24 10:58:46 -08:00
README.md Move /opt/pulumi to $HOME/.pulumi (#8437) 2021-11-17 10:37:38 -08:00
resource.ts Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
stackReference.ts Breaking changes due to Feature 2.0 work 2020-04-14 09:30:25 +01:00
tsconfig.json [testing/nodejs] Support gathering coverage data. 2021-11-24 10:58:46 -08:00
tslint.json Fix issue with comments throwing off function/class serialization (#2438) 2019-02-08 14:58:24 -08:00
utils.ts Enable resource reference feature by default (#5905) 2020-12-10 11:21:05 -07:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00

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 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/.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.