ACNA-4221: fixing alias rt to display help commands

Author: Elanthenral Elangovan

package.json

@@ -66,7 +66,10 @@
     "commands": "./src/commands",
     "bin": "aio",
     "topicSeparator": " ",
-    "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>"
+    "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
+    "hooks": {
+      "init": "./src/hooks/init/AliasHelpHook"
+    }
   },
   "repository": "adobe/aio-cli-plugin-runtime",
   "scripts": {

src/commands/runtime/index.js

@@ -16,7 +16,7 @@ const RuntimeBaseCommand = require('../../RuntimeBaseCommand')
 class IndexCommand extends RuntimeBaseCommand {
   async run () {
     const help = new Help(this.config)
-    await help.showHelp(['runtime', '--help'])
+    await help.showHelp([this.id])
   }
 }
 

src/hooks/init/AliasHelpHook.js

@@ -0,0 +1,41 @@
+/*
+Copyright 2025 Adobe Inc. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { Help } = require('@oclif/core')
+
+/**
+ * Init hook to fix help display for the 'rt' alias.
+ *
+ * Issue: When users run "aio rt --help", oclif's help system doesn't recognize
+ * that "rt" is an alias for "runtime" and should display all subcommands.
+ *
+ * Solution: This hook intercepts help requests for 'rt' and shows help for
+ * 'runtime' instead, which properly displays all TOPICS and COMMANDS.
+ *
+ * @param {object} options - Hook options containing id and argv
+ * @returns {Promise<void>}
+ */
+module.exports = async function (options) {
+  const { id, argv } = options
+
+  // Check if this is a help request for the 'rt' alias
+  const isHelpRequest = argv.includes('--help') || argv.includes('-h')
+  const isRtCommand = id === 'rt'
+
+  if (isHelpRequest && isRtCommand) {
+    // Show help for 'runtime' which includes all subcommands
+    const help = new Help(this.config)
+    await help.showHelp(['runtime'])
+    // eslint-disable-next-line no-process-exit
+    process.exit(0)
+  }
+}

test/commands/runtime/index.test.js

@@ -52,8 +52,9 @@ describe('instance methods', () => {
     test('returns help file for runtime command', () => {
       const spy = jest.spyOn(Help.prototype, 'showHelp').mockReturnValue(true)
       command.config = {}
+      command.id = 'runtime' // Set the command ID for the test
       return command.run().then(() => {
-        expect(spy).toHaveBeenCalledWith(['runtime', '--help'])
+        expect(spy).toHaveBeenCalledWith(['runtime'])
       })
     })
   })

test/hooks/init/AliasHelpHook.test.js

@@ -0,0 +1,59 @@
+/*
+Copyright 2019 Adobe Inc. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const hook = require('../../../src/hooks/init/AliasHelpHook')
+const { Help } = require('@oclif/core')
+
+describe('AliasHelpHook', () => {
+  let exitSpy
+  let helpSpy
+
+  beforeEach(() => {
+    helpSpy = jest.spyOn(Help.prototype, 'showHelp').mockResolvedValue()
+    exitSpy = jest.spyOn(process, 'exit').mockImplementation()
+  })
+
+  afterEach(() => {
+    helpSpy.mockRestore()
+    exitSpy.mockRestore()
+  })
+
+  test('intercepts rt with help flag', async () => {
+    const context = { config: {} }
+    const options = { id: 'rt', argv: ['--help'] }
+
+    await hook.call(context, options)
+
+    expect(helpSpy).toHaveBeenCalledWith(['runtime'])
+    expect(exitSpy).toHaveBeenCalledWith(0)
+  })
+
+  test('does not intercept runtime with help flag', async () => {
+    const context = { config: {} }
+    const options = { id: 'runtime', argv: ['--help'] }
+
+    await hook.call(context, options)
+
+    expect(helpSpy).not.toHaveBeenCalled()
+    expect(exitSpy).not.toHaveBeenCalled()
+  })
+
+  test('does not intercept rt without help flag', async () => {
+    const context = { config: {} }
+    const options = { id: 'rt', argv: [] }
+
+    await hook.call(context, options)
+
+    expect(helpSpy).not.toHaveBeenCalled()
+    expect(exitSpy).not.toHaveBeenCalled()
+  })
+})