From 3c705f93095cc201fa292273c86008b5085a2edb Mon Sep 17 00:00:00 2001 From: Kiss Miklos Date: Wed, 15 Jun 2022 12:55:18 +0200 Subject: [PATCH] rename package Signed-off-by: Kiss Miklos --- .changeset/red-games-decide.md | 4 ++-- .../.eslintrc.js | 0 .../README.md | 6 +++--- .../api-report.md | 2 +- .../package.json | 8 ++++---- .../src/index.ts | 0 .../src/setupTests.ts | 0 .../src/widgets.tsx | 0 8 files changed, 10 insertions(+), 10 deletions(-) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/.eslintrc.js (100%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/README.md (87%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/api-report.md (85%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/package.json (78%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/src/index.ts (100%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/src/setupTests.ts (100%) rename plugins/{api-docs-react => api-docs-module-protoc-gen-doc}/src/widgets.tsx (100%) diff --git a/.changeset/red-games-decide.md b/.changeset/red-games-decide.md index cbf36de833..ca5ff580b4 100644 --- a/.changeset/red-games-decide.md +++ b/.changeset/red-games-decide.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-api-docs-react': major +'@backstage/plugin-api-docs-module-protoc-gen-doc': major --- -Adds an api widget to render protoc-gen-doc generated descriptors by the grpc-docs package +Added the new `grpcDocsApiWidget` to render `protoc-gen-doc` generated descriptors by the `grpc-docs` package. diff --git a/plugins/api-docs-react/.eslintrc.js b/plugins/api-docs-module-protoc-gen-doc/.eslintrc.js similarity index 100% rename from plugins/api-docs-react/.eslintrc.js rename to plugins/api-docs-module-protoc-gen-doc/.eslintrc.js diff --git a/plugins/api-docs-react/README.md b/plugins/api-docs-module-protoc-gen-doc/README.md similarity index 87% rename from plugins/api-docs-react/README.md rename to plugins/api-docs-module-protoc-gen-doc/README.md index d030aba222..4d90cd74c2 100644 --- a/plugins/api-docs-react/README.md +++ b/plugins/api-docs-module-protoc-gen-doc/README.md @@ -1,4 +1,4 @@ -# @backstage/plugin-api-docs-react +# @backstage/plugin-api-docs-module-protoc-gen-doc This package contains ApiDefinitionWidgets for the following projects: @@ -7,7 +7,7 @@ This package contains ApiDefinitionWidgets for the following projects: ## Setup ``` -yarn add @backstage/plugin-api-docs-react +yarn add @backstage/plugin-api-docs-module-protoc-gen-doc ``` ## Add the GrpcDocsApiWidget to your apis @@ -15,7 +15,7 @@ yarn add @backstage/plugin-api-docs-react Add the widget to your `apiDocsConfigRef`. ```ts -import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-react'; +import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-module-protoc-gen-doc'; // packages/app/apis.ts export const apis: AnyApiFactory[] = [ createApiFactory({ diff --git a/plugins/api-docs-react/api-report.md b/plugins/api-docs-module-protoc-gen-doc/api-report.md similarity index 85% rename from plugins/api-docs-react/api-report.md rename to plugins/api-docs-module-protoc-gen-doc/api-report.md index 2f7c6db7c1..0573573682 100644 --- a/plugins/api-docs-react/api-report.md +++ b/plugins/api-docs-module-protoc-gen-doc/api-report.md @@ -1,4 +1,4 @@ -## API Report File for "@backstage/plugin-api-docs-react" +## API Report File for "@backstage/plugin-api-docs-module-protoc-gen-doc" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). diff --git a/plugins/api-docs-react/package.json b/plugins/api-docs-module-protoc-gen-doc/package.json similarity index 78% rename from plugins/api-docs-react/package.json rename to plugins/api-docs-module-protoc-gen-doc/package.json index dfea494ced..81e7b7ea45 100644 --- a/plugins/api-docs-react/package.json +++ b/plugins/api-docs-module-protoc-gen-doc/package.json @@ -1,6 +1,6 @@ { - "name": "@backstage/plugin-api-docs-react", - "description": "Common functionalities for the api-docs-react plugin", + "name": "@backstage/plugin-api-docs-module-protoc-gen-doc", + "description": "Additional functionalities for the api-docs plugin that renders the output of the protoc-gen-doc", "version": "0.0.0", "main": "src/index.ts", "types": "src/index.ts", @@ -11,13 +11,13 @@ "types": "dist/index.d.ts" }, "backstage": { - "role": "web-library" + "role": "frontend-plugin-module" }, "homepage": "https://backstage.io", "repository": { "type": "git", "url": "https://github.com/backstage/backstage", - "directory": "plugins/api-docs-react" + "directory": "plugins/api-docs-module-protoc-gen-doc" }, "keywords": [ "backstage" diff --git a/plugins/api-docs-react/src/index.ts b/plugins/api-docs-module-protoc-gen-doc/src/index.ts similarity index 100% rename from plugins/api-docs-react/src/index.ts rename to plugins/api-docs-module-protoc-gen-doc/src/index.ts diff --git a/plugins/api-docs-react/src/setupTests.ts b/plugins/api-docs-module-protoc-gen-doc/src/setupTests.ts similarity index 100% rename from plugins/api-docs-react/src/setupTests.ts rename to plugins/api-docs-module-protoc-gen-doc/src/setupTests.ts diff --git a/plugins/api-docs-react/src/widgets.tsx b/plugins/api-docs-module-protoc-gen-doc/src/widgets.tsx similarity index 100% rename from plugins/api-docs-react/src/widgets.tsx rename to plugins/api-docs-module-protoc-gen-doc/src/widgets.tsx