From 11ec28f19958d7bdcf0e0d801196029af3b0bcca Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Mon, 6 Jan 2025 15:15:33 -0600 Subject: [PATCH] docs: more backport realignment --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 273a1878..e88f704b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,7 @@ When writing command logic, avoid using `console` statements (and correspondingl Updated Guidance -When writing command logic, avoid using `console` statements. As modeled by [the `openapi upload` command](https://github.com/readmeio/rdme/blob/1e199064b0418b11b56ce08bad3d96ff2bead10c/src/commands/openapi/upload.ts), we use [`oclif`'s command methods](https://oclif.io/docs/commands/#command-methods) for writing to the console. This allows us to seamlessly integrate [`oclif`'s support for JSON output](https://oclif.io/docs/json/). +When writing command logic, avoid using `console` statements. As modeled by [the `openapi upload` command](https://github.com/readmeio/rdme/blob/1e199064b0418b11b56ce08bad3d96ff2bead10c/src/commands/openapi/upload.ts) (only available in `v10` and above), we use [`oclif`'s command methods](https://oclif.io/docs/commands/#command-methods) for writing to the console. This allows us to seamlessly integrate [`oclif`'s support for JSON output](https://oclif.io/docs/json/). [The `@oclif/test` helper](https://github.com/oclif/test) automatically mocks any writes to `stdout` or `stderr`. This is great for properly asserting `rdme` outputs, but can be a bit confusing to develop with at first if you rely on `console.log` as part of your debugging since those statements won't get written to the console the way you'd expect. diff --git a/README.md b/README.md index ecb9c8d4..1994a577 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ To set this up, check out [1Password's documentation on the ReadMe shell plugin] ```sh export HTTPS_PROXY=https://proxy.example.com:5678 -rdme openapi upload +rdme login ``` # GitHub Actions Configuration