Loader Plugin

The Loader Plugin provides automatic discovery and dependency management for CLI applications built with Wizard.

Installation


npm install @hyperse/wizard-plugin-loader


pnpm add @hyperse/wizard-plugin-loader


yarn add @hyperse/wizard-plugin-loader


bun add @hyperse/wizard-plugin-loader

Quick Start

cli.ts


import { createWizard } from '@hyperse/wizard';
import { createLoaderPlugin } from '@hyperse/wizard-plugin-loader';
 
const cli = createWizard({
  name: 'my-cli',
  description: 'My CLI application',
  version: '1.0.0',
});
 
cli
  .use(
    createLoaderPlugin({
      plugins: ['version-plugin'],
      pluginPackPattern: ['help-*/package.json'],
      pluginSearchDirs: ['./plugins'],
      cwd: process.cwd(),
    })
  )
  .parse();
 
// execute command
// node ./cli.js --version
 
// print version information
// v1.0.0

API Reference

Parameters:

Name	Type	Default
`options`	`LoaderPluginOptions` The options for the plugin.

Returns:

Promise<Plugin<CommandNameToContext, CommandNameToContext, Flags>>

LoaderPluginOptions

Name	Type	Default
`pluginPackPattern`	`string[]` The plugin pack pattern to load.
`pluginSearchDirs`	`string[]` The directory search from, it should not include `node_modules`
`cwd`	`string` The directory to begin resolving from	`process.cwd()`
`plugins`	`string[]` The manual load external plugin package names	`[]`