Skip to content

auto-discovery.md

Latest commit

 

History

History
131 lines (98 loc) · 2.56 KB

auto-discovery.md

File metadata and controls

131 lines (98 loc) · 2.56 KB

Auto-Discovery

Commands are automatically discovered from module exports - no manual registration required.

How It Works

  1. List modules in .commando/config.yml
  2. Export commands from those modules
  3. Framework discovers and registers them automatically

Config

# .commando/config.yml
modules:
  - ./website
  - ./examples

That's it! No command mapping needed.

Module Patterns

Named Exports

// website.ts
export const build: CommandoCommand = {
  description: 'Build website',
  execute: async (options, args, context) => {
    // implementation
  }
};

export const deploy: CommandoCommand = {
  description: 'Deploy website',
  execute: async () => { ... }
};

Result: build and deploy commands available

Default Export (Object)

// examples.ts
export default {
  hello: {
    description: 'Say hello',
    execute: async () => console.log('Hello!')
  },
  version: {
    description: 'Show version',
    execute: async () => console.log('v2.0.0')
  }
};

Result: hello and version commands available

Both (Mix and Match)

// commands.ts
export const build: CommandoCommand = { ... };

export default {
  build,  // Re-export
  'special-name': { ... }  // Custom name in object
};

Discovery Logic

The framework checks each module for:

  1. Named exports - Any export that looks like a CommandoCommand (has description and execute)
  2. Default export - If it's an object, treat keys as command names

Detection:

function isCommandoCommand(obj: any): boolean {
  return obj
    && typeof obj === 'object'
    && typeof obj.description === 'string'
    && typeof obj.execute === 'function';
}

Command Naming

  • Named export: Command name = export name

    export const build = { ... }  // Command: "build"

  • Default export: Command name = object key

    export default { hello: { ... } }  // Command: "hello"

  • Kebab-case: Use default export for custom names

    export default {
  'get-config': getConfig,
  'clear-cache': clearCache
}

Benefits

✅ Zero boilerplate - Export a command, it works ✅ Flexible - Named exports, default export, or both ✅ Type-safe - TypeScript validates CommandoCommand structure ✅ Simple - config.yml is just a module list

See Also