Fix: show the correct parameters at help

.changeset/clean-donkeys-tickle.md

@@ -0,0 +1,5 @@
+---
+"yax-cli": patch
+---
+
+Fix: show the correct parameters at help

package.json

@@ -7,7 +7,6 @@
   "files": [
     "/dist",
     "/types",
-    "/docs",
     "tsconfig.json"
   ],
   "scripts": {

src/Register.ts

@@ -1,6 +1,5 @@
-import { readdirSync } from "node:fs";
 import { parser, getArgs } from "./parser";
-import { Arguments, CommandInterface, Options, Rule, RegisterOptions, ProcessType } from "./types";
+import { Arguments, CommandInterface, Options, Rule, RegisterOptions, ProcessType, CommandRoute } from "./types";
 import { showHelp } from "./helpers";
 import { verify } from "./validations";
 import { pathfinder } from "./pathfinder";
@@ -11,7 +10,8 @@ const isClass = (v: CommandInterface | object): boolean => {
 
 export class Register implements CommandInterface {
   examples = [];
-  commands: string[] = [];
+  commands: CommandRoute[] = [];
+  command?: CommandRoute;
   description: string;
   commandsPath: string;
   process: ProcessType;
@@ -32,6 +32,11 @@ export class Register implements CommandInterface {
     this.process = ops.process;
     this.errors = [];
     this.args = getArgs(this.process.argv);
+    const { command, commands } = pathfinder(ops.commandsPath, this.args);
+
+    this.commands = commands;
+    this.command = command;
+
     this.resolve(this);
   }
 
@@ -41,7 +46,6 @@ export class Register implements CommandInterface {
 
   resolve(context: CommandInterface) {
     const options = parser(this.args.flags, this.validations);
-    this.commands = readdirSync(this.commandsPath);
     const { isValid, errors } = verify(options, context.validations);
     this.errors = errors;
 
@@ -53,9 +57,8 @@ export class Register implements CommandInterface {
   }
 
   async handler(ops: Options, args: Arguments) {
-    const resolution  = pathfinder(this.commandsPath, this.args);
-    if (resolution.config) {
-      const module = await import(resolution.config.filePath);
+    if (this.command) {
+      const module = await import(this.command.filePath);
 
       const Command = module.default;
       const cmd = isClass(Command) ? new Command() : Command;

src/helpers.ts

@@ -1,4 +1,4 @@
-import { Arguments, CommandInterface, Rule } from "./types";
+import { Arguments, CommandInterface, CommandRoute, Rule } from "./types";
 
 export const toList = (title: string, items: string[]): string[] => {
   return items.length ? [`${title}:`, ...items.map((i) => `  * ${i}`)] : [];
@@ -20,13 +20,21 @@ export const getFlags = (validations: Rule[]): string[] => {
   return validations.length > 0 ? ['OPTIONS:', ...flags] : [];
 };
 
-export const showHelp = (cmd: CommandInterface, args: Arguments, commands: string[] = [], errors: string[] = []): string[] => {
+export const getCommands = (commands: CommandRoute[]): string[] => {
+  const cmds = commands
+    .filter((i) => i.commands[0] !== '')
+    .map((c) => `  *  ${c.commands.join(' ')}`);
+
+  return commands.length > 0 ? ["COMMANDS:", ...cmds]: [];
+};
+
+export const showHelp = (cmd: CommandInterface, args: Arguments, commands: CommandRoute[] = [], errors: string[] = []): string[] => {
   const commandInfo = args.commands.length ? [`COMMAND: ${args.commands.join(' ')}`] : [];
   const content = [
     `USAGE: ${args.bin} <COMMAND> [OPTIONS]`,
     ...commandInfo,
     `DESCRIPTION: ${cmd.description}`,
-    ...toList('COMMANDS', commands),
+    ...getCommands(commands),
     ...toList('EXAMPLES', cmd.examples),
     ...toList('ERRORS', errors),
     ...getFlags(cmd.validations)

src/pathfinder.ts

@@ -1,20 +1,10 @@
 import { readdirSync, statSync } from "node:fs";
 import { basename, extname } from "node:path";
-import { Arguments } from "./types";
+import { Arguments, CommandRoute } from "./types";
 
 const supportedExtensions = ['.ts', '.js'];
 
-export type CommandFile = {
-  filePath: string
-  commands: string[],
-}
-
-export type PathfinderResolution = {
-  commandFiles: CommandFile[],
-  config?: CommandFile,
-}
-
-export const resolveCommands = (root: string, commandsPath: string, commandFiles: CommandFile[] = []): CommandFile[] => {
+export const resolveCommands = (root: string, commandsPath: string, commandFiles: CommandRoute[]): CommandRoute[] => {
   const fileList = readdirSync(commandsPath);
   for (const file of fileList) {
     const filePath = `${commandsPath}/${file}`;
@@ -47,14 +37,14 @@ export const resolveCommands = (root: string, commandsPath: string, commandFiles
   return commandFiles;
 };
 
-export const pathfinder =  (commandsPath: string, args: Arguments): PathfinderResolution => {
-  const commandFiles = resolveCommands(commandsPath, commandsPath, []);
+export const pathfinder =  (commandsPath: string, args: Arguments): { commands: CommandRoute[], command?: CommandRoute  } => {
+  const commands = resolveCommands(commandsPath, commandsPath, []);
   const cmd = args.commands.join(' ');
-  const config = commandFiles.find((c) => c.commands.join(' ') === cmd);
+  const command = commands.find((c) => c.commands.join(' ') === cmd);
 
   return {
-    commandFiles,
-    config
+    commands,
+    command
   };
 };
 

src/types.ts

@@ -1,20 +1,25 @@
 export type All = boolean | string | number | number[] | string[]
 
-export type Options =  Map<string, All>;
+export type Options = Map<string, All>;
+
+export type CommandRoute = {
+  filePath: string;
+  commands: string[];
+}
 
 export type Rule = {
-    flag: string,
-    alias: string,
-    description: string,
-    required: boolean,
-    list?: boolean,
-    type: 'boolean' | 'string' | 'number' | 'list'
-    default?: All
+  flag: string,
+  alias: string,
+  description: string,
+  required: boolean,
+  list?: boolean,
+  type: 'boolean' | 'string' | 'number' | 'list'
+  default?: All
 }
 
 export type Arguments = {
   node: string
-  bin: string, 
+  bin: string,
   path: string;
   commands: string[],
   flags: string[],
@@ -24,8 +29,8 @@ export type Arguments = {
 export interface CommandInterface {
   description: string,
   examples: string[],
-  handler: (options: Options, args: Arguments)=> void;
   validations: Rule[]
+  handler: (options: Options, args: Arguments) => void;
 }
 
 export type RegisterOptions = {

tests/pathfinder.test.ts

@@ -3,7 +3,7 @@ import { Arguments, pathfinder, resolveCommands } from '../src';
 describe('get files', () => {
   test('resolve posible cmds', () => {
     const commandsPath = `${__dirname}/cmds`;
-    const commandFiles = resolveCommands(commandsPath, commandsPath);
+    const commandFiles = resolveCommands(commandsPath, commandsPath, []);
 
     expect(commandFiles.length).toBe(4);
     expect(commandFiles).toEqual(
@@ -30,7 +30,7 @@ describe('pathfinder', () => {
     };
 
     const resolution = await pathfinder(commandsPath, args);
-    expect(resolution.config).toBeUndefined();
+    expect(resolution.command).toBeUndefined();
   });
   test('should resolve command', async () => {
     const commandsPath = `${__dirname}/cmds`;
@@ -44,6 +44,6 @@ describe('pathfinder', () => {
     };
 
     const resolution = await pathfinder(commandsPath, args);
-    expect(resolution.config).toBeDefined();
+    expect(resolution.command).toBeDefined();
   });
 });