Numerous Philanthropic Misanthropes
    Have ideas to improve npm?Join in the discussion! »

    ripgrep-js
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    ripgrep-js

    A Node.js wrapper around ripgrep

    Note: I have nothing to do with ripgrep or the search functionality of this JS library. This is only a wrapper to expose ripgrep results in Node.js. All credit for the underlying tool go to @BurntSushi and the lovely contributors to the original project.

    Also Note: ripgrep must be installed somewhere in your $PATH for this to work.

    Usage

    import { ripGrep as rg } from 'ripgrep-js';
    
    // Give `rg` an absolute path to search in and the search term
    const results = await rg('path/to/search', 'foo');
    
    // `results` is an array of matches
    const [firstMatch] = results;
    
    // Match info provided by each result object
    firstMatch.file;
    firstMatch.line;
    firstMatch.column;
    firstMatch.match;

    You can also pass an object as the second argument, which supports the following keys:

    • regex: string A regex pattern to match by. Note: this is a Rust-flavored regex pattern, not a JS one
    • string: string A string to match by. Same as passing a string as the second argument.
    • globs: Array<string> An array of glob patterns to limit the results by
    • fileType: Array<string> | string File type or types to limit the search to

    For further details and information, you can find real usage examples in test/test.js.

    Keywords

    none

    Install

    npm i ripgrep-js

    DownloadsWeekly Downloads

    253

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    9.36 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar