From cb61f04da8877eddc293fd6e348c133d3cfedeb6 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sat, 8 Jun 2024 12:17:53 +0200
Subject: [PATCH] cli-node: document new package fields

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/cli-node/src/monorepo/PackageGraph.ts | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/packages/cli-node/src/monorepo/PackageGraph.ts b/packages/cli-node/src/monorepo/PackageGraph.ts
index 016704b9c9..f6b563202e 100644
--- a/packages/cli-node/src/monorepo/PackageGraph.ts
+++ b/packages/cli-node/src/monorepo/PackageGraph.ts
@@ -46,8 +46,20 @@ export interface BackstagePackageJson {
   backstage?: {
     role?: PackageRole;
     moved?: string;
+
+    /**
+     * The ID of the plugin if this is a plugin package. Must always be set for plugin and module packages, and may be set for library packages.
+     */
     pluginId?: string;
+
+    /**
+     * The parent plugin package of a module. Must always and only be set for module packages.
+     */
     pluginPackage?: string;
+
+    /**
+     * All packages that are part of the plugin. Must always and only be set for plugin packages and plugin library packages.
+     */
     pluginPackages?: {
       frontend?: string;
       backend?: string;