inquirer-file-selector

inquirer-file-selector

An file selector prompt implementation for Inquirer.js.

Installation

npm install inquirer-file-selector

Usage

import fileSelector from 'inquirer-file-selector'

const filePath = await fileSelector({
  message: 'Select a file:',
  ...
})

Options

Option	Type	Required	Description
message	string	✔	The message to display in the prompt.
path	string		The path to the directory where it will be started. Default: process.cwd()
pageSize	number		The maximum number of items to display in the list. Default: 10
extensions	string[]		The extensions to filter the files. Default: []
disabledLabel	string		The label to display when a file is disabled. Default: (not allowed)
noFilesFound	string		The message to display when no files are found. Default: No files found
theme	See Theming		The theme to use for the file selector.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type FileSelectorTheme = {
  icon: {
    /**
     * The prefix to use for the line.
     * @default isLast => isLast ? └── : ├──
     */
    linePrefix: (isLast: boolean) => string
  }
  style: {
    /**
     * The style to use for the disabled items.
     * @default chalk.dim
     */
    disabled: (text: string) => string
    /**
     * The style to use for the active item.
     * @default chalk.cyan
     */
    active: (text: string) => string
    /**
     * The style to use for the no files found message.
     * @default chalk.red
     */
    noFilesFound: (text: string) => string
    /**
     * The style to use for items of type directory.
     * @default chalk.yellow
     */
    directory: (text: string) => string
    /**
     * The style to use for items of type file.
     * @default chalk.white
     */
    file: (text: string) => string
    /**
     * The style to use for the current directory header.
     * @default chalk.magenta
     */
    currentDir: (text: string) => string
    /**
     * The style to use for the key bindings help.
     * @default chalk.white
     */
    help: (text: string) => string
    /**
     * The style to use for the keys in the key bindings help.
     * @default chalk.cyan
     */
    key: (text: string) => string
  }
}

Copyright & License

© 2024 Brian Fernandez

This project is licensed under the MIT license. See the file LICENSE for details.