From 2331e2a66b842c4862fee777bb52d9c8dd47805f Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 15 Nov 2023 13:46:21 +0100 Subject: [PATCH] frontend-test-utils: README + doc cleanup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Camila Belo Co-authored-by: Fredrik Adelöw Co-authored-by: Philipp Hugenroth Signed-off-by: Patrik Oldsberg --- .changeset/bright-eyes-film.md | 2 +- packages/frontend-test-utils/README.md | 6 +++--- packages/frontend-test-utils/api-report.md | 2 -- packages/frontend-test-utils/src/index.ts | 6 ++++++ 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.changeset/bright-eyes-film.md b/.changeset/bright-eyes-film.md index 5c6211622a..503079ad00 100644 --- a/.changeset/bright-eyes-film.md +++ b/.changeset/bright-eyes-film.md @@ -2,4 +2,4 @@ '@backstage/frontend-test-utils': minor --- -New testing utility library for `@backstage/frontend-app-api` and `@backstagr/frontend-plugin-api`. +New testing utility library for `@backstage/frontend-app-api` and `@backstage/frontend-plugin-api`. diff --git a/packages/frontend-test-utils/README.md b/packages/frontend-test-utils/README.md index b3325ac192..50f853d9ed 100644 --- a/packages/frontend-test-utils/README.md +++ b/packages/frontend-test-utils/README.md @@ -1,12 +1,12 @@ # @backstage/frontend-test-utils -_This package was created through the Backstage CLI_. +Contains utilities that can be used when testing frontend features such as extensions. ## Installation -Install the package via Yarn: +Install the package via Yarn into your own packages: ```sh cd # if within a monorepo -yarn add @backstage/frontend-test-utils +yarn add --dev @backstage/frontend-test-utils ``` diff --git a/packages/frontend-test-utils/api-report.md b/packages/frontend-test-utils/api-report.md index 2703efa228..8d7837b90a 100644 --- a/packages/frontend-test-utils/api-report.md +++ b/packages/frontend-test-utils/api-report.md @@ -27,6 +27,4 @@ export class ExtensionTester { // (undocumented) render(options?: { config?: JsonObject }): RenderResult; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/frontend-test-utils/src/index.ts b/packages/frontend-test-utils/src/index.ts index 6c49276721..6a28cc2abe 100644 --- a/packages/frontend-test-utils/src/index.ts +++ b/packages/frontend-test-utils/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * @packageDocumentation + * + * Contains utilities that can be used when testing frontend features such as extensions. + */ + export * from './app';