feat: experiment with a decorator to hide commands from the help screen

__tests__/__snapshots__/index.test.ts.snap

@@ -23,7 +23,6 @@ Options
 Related commands
 
   $ rdme validate   Validate your OpenAPI/Swagger definition. 
-  $ rdme swagger    Alias for \`rdme openapi\`. [deprecated]    
 "
 `;
 
@@ -50,7 +49,6 @@ Options
 Related commands
 
   $ rdme validate   Validate your OpenAPI/Swagger definition. 
-  $ rdme swagger    Alias for \`rdme openapi\`. [deprecated]    
 "
 `;
 
@@ -77,7 +75,6 @@ Options
 Related commands
 
   $ rdme validate   Validate your OpenAPI/Swagger definition. 
-  $ rdme swagger    Alias for \`rdme openapi\`. [deprecated]    
 "
 `;
 

src/cmds/swagger.ts

@@ -2,9 +2,11 @@ import type { CommandOptions } from '../lib/baseCommand';
 import type { Options } from './openapi';
 
 import Command from '../lib/baseCommand';
+import isHidden from '../lib/decorators/isHidden';
 
 import OpenAPICommand from './openapi';
 
+@isHidden()
 export default class SwaggerCommand extends OpenAPICommand {
   constructor() {
     super();

src/lib/baseCommand.ts

@@ -58,6 +58,11 @@ export default class Command {
    */
   position: number;
 
+  /**
+   * Should the command be hidden from our `--help` screens?
+   */
+  hidden: boolean;
+
   /**
    * Arguments to hide from the individual command help screen
    * (typically used for hiding default arguments)

src/lib/commands.ts

@@ -10,6 +10,7 @@ export function getCategories(): Record<
       name: string;
       description: string;
       position: number;
+      hidden: boolean;
     }[];
   }
 > {
@@ -74,6 +75,7 @@ export function listByCategory() {
       name: c.command.command,
       description: c.command.description,
       position: c.command.position,
+      hidden: c.command.hidden,
     });
   });
 
@@ -82,5 +84,5 @@ export function listByCategory() {
 
 export function getSimilar(cmdCategory: CommandCategories, excludeCommand: string) {
   const categories = listByCategory();
-  return categories[cmdCategory].commands.filter(cmd => cmd.name !== excludeCommand);
+  return categories[cmdCategory].commands.filter(cmd => cmd.name !== excludeCommand && !cmd.hidden);
 }

src/lib/decorators/isHidden.ts

@@ -0,0 +1,7 @@
+export default function hideFromHelpScreen() {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  return function (constructor: Function) {
+    // eslint-disable-next-line no-param-reassign
+    constructor.prototype.hidden = true;
+  };
+}

src/lib/help.ts

@@ -7,9 +7,10 @@ import config from 'config';
 
 import * as commands from './commands';
 
-function formatCommands(cmds: { name: string; description: string; position: number }[]) {
+function formatCommands(cmds: { name: string; description: string; hidden: boolean; position: number }[]) {
   return cmds
     .sort((a, b) => (a.position > b.position ? 1 : -1))
+    .filter(command => !command.hidden)
     .map(command => {
       return {
         name: `${chalk.grey('$')} ${config.get('cli')} ${command.name}`,

tsconfig.json

@@ -4,6 +4,7 @@
     "baseUrl": "./src",
     "downlevelIteration": true,
     "esModuleInterop": true,
+    "experimentalDecorators": true,
     "lib": ["es2020"],
     "noImplicitAny": true,
     "outDir": "dist/",