pulumi/sdk/nodejs
bors[bot] 2a69c25241
Merge #13241
13241: Add --secret to config set hints when needed r=justinvp a=Frassle

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes https://github.com/pulumi/pulumi/issues/12207

Added some tests for this, which should eventually become a matrix test to ensure we check every language returns the expected error for this.

## Checklist

- [x] I have run `make tidy` to update any new dependencies
- [x] I have run `make lint` to verify my code passes the lint check
  - [ ] I have formatted my code using `gofumpt`

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [x] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: Fraser Waters <fraser@pulumi.com>
2023-06-24 22:55:17 +00:00
..
asset Apply autoformat 2023-04-28 18:27:10 -04:00
automation Add a better error message for invalid NodeJS AutoAPI workdir 2023-06-24 11:57:22 -07:00
cmd Merge #13078 2023-06-23 15:38:56 +00:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Apply autoformat 2023-04-28 18:27:10 -04:00
iterable Apply autoformat 2023-04-28 18:27:10 -04:00
log Apply autoformat 2023-04-28 18:27:10 -04:00
npm Merge #13021 #13054 2023-05-30 19:48:20 +00:00
proto Send old inputs to diff and update 2023-06-21 21:04:50 +01:00
provider [sdk/nodejs] Write port as string to avoid colorized output 2023-06-19 16:24:14 -07:00
queryable This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
runtime Merge #13070 2023-06-15 23:23:12 +00:00
tests Add a better error message for invalid NodeJS AutoAPI workdir 2023-06-24 11:57:22 -07:00
tests_with_mocks Add testing for async TS mocks 2023-06-01 14:13:04 +02:00
.eslintrc.js Apply autoformat 2023-04-28 18:27:10 -04:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile Fix makefiles 2023-05-26 11:00:45 +01:00
README.md fix some links 2023-05-19 19:39:26 -07:00
config.ts Add --secret to config set hints when needed 2023-06-22 17:25:30 +01:00
errors.ts Remove Useless Constructors. 2023-05-15 19:48:47 -04: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 This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
package.json Merge #13237 2023-06-24 06:46:40 +00:00
resource.ts Don't use the `delete` operator. 2023-04-28 22:07:35 -04:00
rome.json Remove Useless Constructors. 2023-05-15 19:48:47 -04:00
stackReference.ts Apply autoformat 2023-04-28 18:27:10 -04:00
tsconfig.json sdk/node/StackReference: Add getOutputDetails 2023-02-03 16:47:27 -08:00
tsutils.ts [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
utils.ts Apply autoformat 2023-04-28 18:27:10 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock Merge #13237 2023-06-24 06:46:40 +00: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.