Skip to content
master
Go to file
Code
This branch is 25 commits behind microsoft:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 

README.md

vscode-ripgrep

This is an npm module for using ripgrep in a Node project. It's used by VS Code.

How it works

  • Ripgrep is built in microsoft/ripgrep-prebuilt and published to releases for each tag in that repo.
  • In this module's postinstall task, it determines which platform it is being installed on and downloads the correct binary from ripgrep-prebuilt for the platform.
  • The path to the ripgrep binary is exported as rgPath.

Usage example

const { rgPath } = require('vscode-ripgrep');

// child_process.spawn(rgPath, ...)

Dev note

Runtime dependencies are not allowed in this project. This code runs on postinstall, and any dependencies would only be needed for postinstall, but they would have to be declared as dependencies, not devDependencies. Then if they were not cleaned up manually, they would end up being included in any project that uses this.

About

For consuming the ripgrep binary from microsoft/ripgrep-prebuilt in a Node project

Resources

License

Packages

No packages published
You can’t perform that action at this time.