inquirer-fuzzy-path

Fuzzy file/directory search and select prompt for Inquirer.js

Usage

Register the prompt with inquirer:

1inquirer.registerPrompt('fuzzypath', require('inquirer-fuzzy-path'))

Call the prompt:

1  return inquirer.prompt([
2    {
3      type: 'fuzzypath',
4      name: 'path',
5      excludePath: nodePath => nodePath.startsWith('node_modules'),
6        // excludePath :: (String) -> Bool
7        // excludePath to exclude some paths from the file-system scan
8      excludeFilter: nodePath => nodePath == '.',
9        // excludeFilter :: (String) -> Bool
10        // excludeFilter to exclude some paths from the final list, e.g. '.'
11      itemType: 'any',
12        // itemType :: 'any' | 'directory' | 'file'
13        // specify the type of nodes to display
14        // default value: 'any'
15        // example: itemType: 'file' - hides directories from the item list
16      rootPath: 'app',
17        // rootPath :: String
18        // Root search directory
19      message: 'Select a target directory for your component:',
20      default: 'components/',
21      suggestOnly: false,
22        // suggestOnly :: Bool
23        // Restrict prompt answer to available choices or use them as suggestions
24      depthLimit: 5,
25        // depthLimit :: integer >= 0
26        // Limit the depth of sub-folders to scan
27        // Defaults to infinite depth if undefined
28    }
29  ]);

Change log

• In version 2.2.0 new option excludeFilter was added.
• In version 2.1.0 new option depthLimit was added.
• In version 2.0.0 option filterPath was deprecated. Please use excludePath and itemType instead.

Related

• inquirer - A collection of common interactive command line user interfaces

License

MIT © adelsz