Refine cli-plugin-api: use packageJson, inline types, rename context fields

Replace pluginId with packageJson input for createCliPlugin, remove
CommandExecuteFn type alias by inlining it, and rename
CommandContext.info.description to info.name.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor

packages/cli/src/modules/auth/index.ts

@@ -15,9 +15,10 @@
  */
 
 import { createCliPlugin } from '../../wiring/factory';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'auth',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['auth', 'login'],

packages/cli/src/modules/build/index.ts

@@ -15,9 +15,10 @@
  */
 
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export const buildPlugin = createCliPlugin({
-  pluginId: 'build',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['package', 'build'],

packages/cli/src/modules/config/index.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export const configOption = [
   '--config <path>',
@@ -23,7 +24,7 @@ export const configOption = [
 ] as const;
 
 export default createCliPlugin({
-  pluginId: 'config',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['config:docs'],

packages/cli/src/modules/create-github-app/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'new',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['create-github-app'],

packages/cli/src/modules/info/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'info',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['info'],

packages/cli/src/modules/lint/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'lint',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['package', 'lint'],

packages/cli/src/modules/maintenance/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'maintenance',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['repo', 'fix'],

packages/cli/src/modules/migrate/commands/versions/bump.test.ts

@@ -125,7 +125,7 @@ const expectLogsToMatch = (
   expect(receivedLogs.filter(Boolean).sort()).toEqual(expected.sort());
 };
 
-const info = { usage: 'backstage-cli versions:bump', description: '' };
+const info = { usage: 'backstage-cli versions:bump', name: 'versions:bump' };
 
 describe('bump', () => {
   const mockDir = createMockDirectory();

packages/cli/src/modules/migrate/commands/versions/migrate.test.ts

@@ -123,7 +123,7 @@ describe('versions:migrate', () => {
     });
 
     const { warn, log: logs } = await withLogCollector(async () => {
-      await migrate({ args: [], info: { usage: 'test', description: 'test' } });
+      await migrate({ args: [], info: { usage: 'test', name: 'test' } });
     });
 
     expectLogsToMatch(logs, [
@@ -229,7 +229,7 @@ describe('versions:migrate', () => {
     });
 
     await withLogCollector(async () => {
-      await migrate({ args: [], info: { usage: 'test', description: 'test' } });
+      await migrate({ args: [], info: { usage: 'test', name: 'test' } });
     });
 
     expect(runObj.run).toHaveBeenCalledTimes(1);
@@ -311,7 +311,7 @@ describe('versions:migrate', () => {
     });
 
     await withLogCollector(async () => {
-      await migrate({ args: [], info: { usage: 'test', description: 'test' } });
+      await migrate({ args: [], info: { usage: 'test', name: 'test' } });
     });
 
     expect(runObj.run).toHaveBeenCalledTimes(1);

packages/cli/src/modules/migrate/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'migrate',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['versions:migrate'],

packages/cli/src/modules/new/commands/new.test.ts

@@ -41,7 +41,7 @@ describe.each([
     }
     const context: CommandContext = {
       args,
-      info: { usage: 'backstage-cli new', description: 'test' },
+      info: { usage: 'backstage-cli new', name: 'new' },
     };
     await newCommand(context);
     expect(createNewPackage).toHaveBeenCalledWith(

packages/cli/src/modules/new/index.ts

@@ -15,9 +15,10 @@
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
 import { NotImplementedError } from '@backstage/errors';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'new',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['new'],

packages/cli/src/modules/test/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'test',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['repo', 'test'],

packages/cli/src/modules/translations/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 import { createCliPlugin } from '@backstage/cli-plugin-api';
+import packageJson from '../../../package.json';
 
 export default createCliPlugin({
-  pluginId: 'translations',
+  packageJson,
   init: async reg => {
     reg.addCommand({
       path: ['translations', 'export'],

packages/cli/src/wiring/CliInitializer.test.ts

@@ -29,7 +29,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg =>
           reg.addCommand({
             path: ['test'],
@@ -51,7 +51,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg =>
           reg.addCommand({
             path: ['test'],
@@ -73,7 +73,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg =>
           reg.addCommand({
             path: ['test'],
@@ -98,7 +98,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg => {
           reg.addCommand({
             path: ['visible'],
@@ -125,7 +125,7 @@ describe('CliInitializer', () => {
     const initializer2 = new CliInitializer();
     initializer2.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg => {
           reg.addCommand({
             path: ['visible'],
@@ -153,7 +153,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg => {
           reg.addCommand({
             path: ['visible'],
@@ -188,7 +188,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg => {
           reg.addCommand({
             path: ['group', 'alpha'],
@@ -224,7 +224,7 @@ describe('CliInitializer', () => {
     const initializer = new CliInitializer();
     initializer.add(
       createCliPlugin({
-        pluginId: 'test',
+        packageJson: { name: '@backstage/test' },
         init: async reg =>
           reg.addCommand({
             path: ['test', 'nested', 'command'],

packages/cli/src/wiring/CliInitializer.ts

@@ -56,7 +56,9 @@ export class CliInitializer {
   async #register(feature: CliFeature) {
     if (OpaqueCliPlugin.isType(feature)) {
       const internal = OpaqueCliPlugin.toInternal(feature);
-      await internal.init(this.commandRegistry);
+      for (const command of await internal.commands) {
+        this.commandRegistry.addCommand(command);
+      }
     } else {
       throw new Error(`Unsupported feature type: ${(feature as any).$$type}`);
     }
@@ -138,7 +140,7 @@ export class CliInitializer {
                 args: [...positionalArgs, ...args.unknown],
                 info: {
                   usage: [programName, ...node.command.path].join(' '),
-                  description: node.command.description,
+                  name: node.command.path.join(' '),
                 },
               };
 

packages/cli/src/wiring/types.ts

@@ -16,7 +16,6 @@
 
 export type {
   CommandContext,
-  CommandExecuteFn,
   BackstageCommand,
   CliFeature,
   CliPlugin,