JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 41198
  • Score
    100M100P100Q166149F
  • License MIT

A module for using ripgrep in a Node project

Package Exports

  • @lvce-editor/ripgrep
  • @lvce-editor/ripgrep/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@lvce-editor/ripgrep) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ripgrep

A module for using ripgrep in a Node project.

Same as vscode-ripgrep, but fixes the github rate limiting error Downloading ripgrep failed: Error: Request failed: 403 by downloading the files directly instead of also using the github rest api.

Install

$ npm install @lvce-editor/ripgrep

Usage

import { rgPath } from '@lvce-editor/ripgrep'
import { spawn } from 'node:child_process'

const childProcess = spawn(rgPath, ['abc', '.'], {
  stdio: 'inherit',
})

Environment Variables

  • RIPGREP_PREBUILT_BINARIES_MIRROR: Specify a custom mirror URL for downloading ripgrep prebuilt binaries. This is useful for users in regions where GitHub releases are slow or inaccessible, or for organizations using internal mirrors.
    • Default: https://github.com/microsoft/ripgrep-prebuilt/releases/download
    • Example: export RIPGREP_PREBUILT_BINARIES_MIRROR=https://your-mirror.com/ripgrep-prebuilt/releases/download
    • Note: The mirror URL should follow the same path structure as the official repository, with binaries available at {mirror-url}/{version}/ripgrep-{version}-{target}

Credits

This project is very much based on https://github.com/microsoft/vscode-ripgrep by Microsoft.