refactor: 💡 Common help command handler to prevent misses (#49)

## Why?

Common help command handler to prevent misses

## How?

- The subcommand are now returned to main initialisation
- Attach command commands to subcommand
- Solve common `help` handler for all commands

## Tickets?

-
[PLAT-1665](https://linear.app/fleekxyz/issue/PLAT-1665/the-domains-help-subcommand-should-display-help)

## Contribution checklist?

- [x] The commit messages are detailed
- [x] The `build` command runs locally
- [ ] Assets or static content are linked and stored in the project
- [x] You have manually tested
- [ ] You have provided tests

## Security checklist?

- [ ] Sensitive data has been identified and is being protected properly
- [ ] Injection has been prevented (parameterized queries, no eval or
system calls)

## Preview?

<img width="807" alt="Screenshot 2024-10-28 at 12 28 20"
src="https://github.com/user-attachments/assets/2d2907dd-5b7d-4f9e-8220-3016f55a4c80">

.changeset/strange-dryers-eat.md

@@ -0,0 +1,5 @@
+---
+"@fleek-platform/cli": minor
+---
+
+Add common help command handler to prevent misses

src/cli.ts

@@ -51,6 +51,9 @@ export const init = ({ version, parser }: InitArgs) => {
     .action(() => program.outputHelp())
     .version(version);
 
+  // TODO: The ascii logo should only be displayed
+  // on default command, or general help
+  // a minimal version can be used instead
   program.addHelpText('beforeAll', logo).showHelpAfterError();
 
   type CmdVersionArgs = typeof program;
@@ -79,7 +82,17 @@ export const init = ({ version, parser }: InitArgs) => {
   ];
 
   for (const cmd of commands) {
-    cmd(program);
+    const subCmd = cmd(program);
+
+    // Attach common subcommands
+    if (subCmd) {
+      // TODO: Identify common subcommands
+      // refactor to handle them here
+      subCmd
+        .command('help')
+        .description(t('printHelp'))
+        .action(() => subCmd.help());
+    }
   }
 
   // Init parser (unawaited)

src/commands/applications/index.ts

@@ -6,7 +6,7 @@ import { deleteApplicationActionHandler } from './delete';
 import { listApplicationsActionHandler } from './list';
 import { updateApplicationActionHandler } from './update';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('applications')
     .description(t('appCmdDescription'));
@@ -61,4 +61,6 @@ export default (program: Command) => {
       deleteApplicationActionHandler(options),
     )
     .addHelpCommand();
+
+  return cmd;
 };

src/commands/auth/index.ts

@@ -6,7 +6,7 @@ import { t } from '../../utils/translation';
 import { loginActionHandler } from './login';
 import { logoutActionHandler } from './logout';
 
-export default (cmd: Command) => {
+export default (cmd: Command): Command => {
   cmd
     .command('login')
     .description(t('cmdAuthLoginDescription'))
@@ -30,4 +30,6 @@ export default (cmd: Command) => {
     .description(t('cmdAuthLogoutDescription'))
     .action(logoutActionHandler)
     .addHelpCommand();
+
+  return cmd;
 };

src/commands/domains/index.ts

@@ -7,7 +7,7 @@ import { detailDomainActionHandler } from './detail';
 import { listDomainsActionHandler } from './list';
 import { verifyDomainActionHandler } from './verify';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('domains')
     .option('-h, --help', t('printHelp'))
@@ -83,5 +83,5 @@ export default (program: Command) => {
     )
     .addHelpCommand();
 
-  cmd.command('help').description(t('printHelp'));
+  return cmd;
 };

src/commands/ens/index.ts

@@ -7,7 +7,7 @@ import { detailEnsRecordsActionHandler } from './detail';
 import { listEnsRecordsActionHandler } from './list';
 import { verifyEnsRecordActionHandler } from './verify';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('ens')
     .option('-h, --help', t('printHelp'))
@@ -105,4 +105,6 @@ export default (program: Command) => {
     .addHelpCommand();
 
   cmd.command('help').description(t('printHelp'));
+
+  return cmd;
 };

src/commands/functions/index.ts

@@ -18,7 +18,7 @@ type DeployOptions = {
   sgx?: boolean;
 };
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('functions')
     .option('-h, --help', t('printHelp'))
@@ -106,9 +106,5 @@ export default (program: Command) => {
     )
     .addHelpCommand();
 
-  cmd
-    .command('help')
-    .description(t('printHelp'))
-    .action(() => cmd.help())
-    .addHelpCommand();
+  return cmd;
 };

src/commands/gateways/index.ts

@@ -6,7 +6,7 @@ import { deletePrivateGatewayActionHandler } from './delete';
 import { detailPrivateGatewayActionHandler } from './detail';
 import { listPrivateGatewaysActionHandler } from './list';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('gateways')
     .option('-h', '--help', t('printHelp'))
@@ -73,5 +73,5 @@ export default (program: Command) => {
     )
     .addHelpCommand();
 
-  cmd.command('help').description(t('printHelp'));
+  return cmd;
 };

src/commands/ipfs/index.ts

@@ -3,7 +3,7 @@ import type { Command } from 'commander';
 import { t } from '../../utils/translation';
 import { addActionHandler } from './add';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('ipfs')
     .option('-h, --help', t('printHelp'))
@@ -17,8 +17,5 @@ export default (program: Command) => {
     .action((path: string) => addActionHandler({ path }))
     .addHelpCommand();
 
-  cmd
-    .command('help')
-    .description(t('printHelp'))
-    .action(() => program.help());
+  return cmd;
 };

src/commands/ipns/index.ts

@@ -7,7 +7,7 @@ import { listActionHandler } from './list';
 import { publishActionHandler } from './publish';
 import { resolveActionHandler } from './resolve';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('ipns')
     .option('-h, --help', 'Print help')
@@ -73,8 +73,5 @@ export default (program: Command) => {
     .action((name: string) => resolveActionHandler({ name }))
     .addHelpCommand();
 
-  cmd
-    .command('help')
-    .description(t('printHelp'))
-    .action(() => cmd.help());
+  return cmd;
 };

src/commands/pat/index.ts

@@ -7,7 +7,7 @@ import { createPersonalAccessTokenActionHandler } from './create';
 import { deletePersonalAccessTokenActionHandler } from './delete';
 import { listPersonalAccessTokensActionHandler } from './list';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('pat')
     .option('-h, --help', t('printHelp'))
@@ -55,5 +55,5 @@ export default (program: Command) => {
     )
     .addHelpCommand();
 
-  cmd.command('help').description(t('printHelp'));
+  return cmd;
 };

src/commands/projects/index.ts

@@ -5,7 +5,7 @@ import { createProjectActionHandler } from './create';
 import { listProjectsActionHandler } from './list';
 import { switchProjectActionHandler } from './switch';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('projects')
     .option('-h, --help', t('printHelp'))
@@ -31,4 +31,6 @@ export default (program: Command) => {
     .description(t('projectsCreateNewDesc'))
     .action((options: { name: string }) => createProjectActionHandler(options))
     .addHelpCommand();
+
+  return cmd;
 };

src/commands/sites/index.ts

@@ -7,7 +7,7 @@ import { initActionHandler } from './init';
 import { listActionHandler } from './list';
 import { listDeploymentsActionHandler } from './listDeployments';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('sites')
     .option('-h, --help', t('printHelp'))
@@ -63,8 +63,5 @@ export default (program: Command) => {
     )
     .addHelpCommand();
 
-  cmd
-    .command('help')
-    .description(t('printHelp'))
-    .action(() => cmd.help());
+  return cmd;
 };

src/commands/storage/index.ts

@@ -7,7 +7,7 @@ import { deleteStorageActionHandler } from './delete';
 import { getStorageActionHandler } from './get';
 import { listStorageActionHandler } from './list';
 
-export default (program: Command) => {
+export default (program: Command): Command => {
   const cmd = program
     .command('storage')
     .description(t('storageCmdDescription'));
@@ -80,4 +80,6 @@ export default (program: Command) => {
     .argument('<path>', t('ipfsAddPathDescription'))
     .action((path: string) => addStorageActionHandler({ path }))
     .addHelpCommand();
+
+  return cmd;
 };