cli-node: document new package fields

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-06-08 12:17:53 +02:00
parent 09049a612b
commit cb61f04da8
1 changed files with 12 additions and 0 deletions
@@ -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;