fuzz-run

:runner: fuzz-run

Run all your NPM scripts faster with fuzzy matching

Features:

• Fuzzy matching of NPM script name, optimized for commands (see alternatives)
• Yarn support: if a yarn.lock file is found, yarn <script> will be used instead of npm run <script>
• No need for -- to pass extra options when using NPM

Installation

npm install -g fuzz-run

CLI Usage

fr <fuzzy_script_name>

If no arguments is provided, it will list all available scripts.

As the name of the script to run is fuzzy matched, you can try:

• typing only some letters of the script name, regardless of their position (first letters weights more), like t for test script
• typing first letter of compound script names like tc for test:ci script
• making some typos, like ets for test script

Note that you can use the alias nr (for npm run) instead of fr (fuzz run) if you prefer :wink:

API

You can also integrate this script runner in your own CLI by using the function fuzzyRun(args, runner):

• args: array of arguments, the same you would use for the CLI usage
• runner: optional, can be 'npm' or 'yarn' to force a specific command to run the scripts. If null or undefined, it will be autodetected based on the presence of the yarn.lock file.

Example:

const fuzzyRun = require('fuzzy-run');
fuzzyRun(process.argv.slice(2));

Alternatives

• fuzzy-npm-run
• fuzzy-run

Why making a new tool when some other exists, you might ask? Both are based on fuse.js for the fuzzy matching, which is not great for matching commands, as it doesn't weight properly specific features like subcommands separation (using characters like -, _, :) or first character of words :disappointed:

Some examples:

• if you have 2 scripts test and test:ci, typing tc matches test instead of test:ci
• if you have 2 scripts test:ci and other, typing t matches other

So I benchmarked many fuzzy matching libraries, and kept the best one I found suited for the job, fuzzysort, that solves these issues.