Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinedied/fuzz-run
:runner: Run all your NPM scripts more easily with fuzzy matching
https://github.com/sinedied/fuzz-run
cli fuzzy hacktoberfest javascript nodejs npm runner scripts yarn
Last synced: 3 months ago
JSON representation
:runner: Run all your NPM scripts more easily with fuzzy matching
- Host: GitHub
- URL: https://github.com/sinedied/fuzz-run
- Owner: sinedied
- License: mit
- Created: 2018-07-27T07:13:46.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T17:03:31.000Z (12 months ago)
- Last Synced: 2024-10-20T12:53:18.549Z (3 months ago)
- Topics: cli, fuzzy, hacktoberfest, javascript, nodejs, npm, runner, scripts, yarn
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# :runner: fuzz-run
[](https://www.npmjs.com/package/fuzz-run)
[](https://github.com/sinedied/fuzz-run/actions)
[](https://packagephobia.now.sh/result?p=fuzz-run)
[](https://github.com/sindresorhus/xo)
[](LICENSE)
> Run all your NPM scripts more easily with fuzzy matching.
**Features:**
- Fuzzy matching of NPM script name, optimized for commands (see [alternatives](#alternatives))
- Yarn and PNPM support: automatically detect the package manager used and adapt commands accordingly
- No need for `--` to pass extra options when using NPM
- Extra actions for common recurrent tasks
## Installation
```sh
npm install -g fuzz-run
```
## CLI Usage
```sh
Usage: fr | [script_options]
Actions:
-u, --update Show outdated packages and run an interactive update
-r, --refresh Delete node_modules and lockfile, and reinstall packages
```
If no arguments are 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 **n**pm **r**un) instead of `fr` (**f**uzz **r**un) if you prefer :wink:
You can pass any arguments to your script if needed, like `fr t --coverage`. You don't need to use `--` to pass extra options to your script like when using `npm` directly.
### Actions
There are a few scripted actions you can use for common day-to-day tasks in your projects:
- `-u` or `--update`: It will show outdated packages, then ask if you want to update. If you accept, it will first update all package within their allowed range according to your `package.json` using `npm update`, `pnpm update` or `yarn upgrade`. Then it will run an interactive update, using under the hood `npx npm-check -u` if NPM or PNPM is your package manager or `yarn upgrade-interactive` if you use Yarn.
- `-r` or `--refresh`: It will delete `node_modules` folder and lockfile, and reinstall all your packages. I probably use that more than I should, but it's always a handy fix.
### Package manager
Supported package managers are [NPM](https://www.npmjs.com), [Yarn](https://yarnpkg.com) and [PNPM](https://pnpm.io).
By default, your package manager will be autodetected based on your project's lockfile format, and corresponding commands will be used.
You can also force a package manager by setting the `NODE_PACKAGE_MANAGER` environment variable.
## API
You can also integrate this script runner in your own CLI by using the function `fuzzyRun(args, packageManager)`:
- `args`: array of arguments, the same you would use for the CLI usage
- `packageManager`: *optional*, can be `'npm'`, `'yarn'` or `'pnpm'` to force a specific command to run the scripts. If `null` or `undefined`, it will be autodetected based on your project's lockfile format.
Example:
```js
const fuzzyRun = require('fuzzy-run');
fuzzyRun(process.argv.slice(2));
```
## Alternatives
- [fuzzy-npm-run](https://www.npmjs.com/package/fuzzy-npm-run)
- [fuzzy-run](https://www.npmjs.com/package/fuzzy-run)
Why making a new tool when some other exists, you might ask?
Both are based on [fuse.js](http://fusejs.io) 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](https://www.npmjs.com/package/fuzzysort), that solves these issues.