ripgrepjs
ripgrepjs: Node.js bindings to the ripgrep library, for direct integration with JS programs without spawning an extra subprocess!
This project was bootstrapped by create-neon.
Installing ripgrepjs
Installing ripgrepjs requires a supported version of Node and Rust.
You can install the project with npm. In the project directory, run:
$ npm install
This fully installs the project, including installing any dependencies and running the build.
Building ripgrepjs
If you have already installed the project and only want to run the build, run:
$ npm run build
This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node.
Exploring ripgrepjs
After building ripgrepjs, you can explore its exports at the Node REPL:
$ npm install
$ node
> require('.').hello()
"hello node"
Available Scripts
In the project directory, you can run:
npm install
Installs the project, including running npm run build.
npm build
Builds the Node addon (index.node) from source.
Additional cargo build arguments may be passed to npm build and npm build-* commands. For example, to enable a cargo feature:
npm run build -- --feature=beetle
npm build-debug
Alias for npm build.
npm build-release
Same as npm build but, builds the module with the release profile. Release builds will compile slower, but run faster.
npm test
Runs the unit tests by calling cargo test. You can learn more about adding tests to your Rust code from the Rust book.
Project Layout
The directory structure of this project is:
ripgrepjs/
├── Cargo.toml
├── README.md
├── index.node
├── package.json
├── src/
| └── lib.rs
└── target/
Cargo.toml
The Cargo manifest file, which informs the cargo command.
README.md
This file.
index.node
The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the "main" key in package.json.
Under the hood, a Node addon is a dynamically-linked shared object. The "build" script produces this file by copying it from within the target/ directory, which is where the Rust build produces the shared object.
package.json
The npm manifest file, which informs the npm command.
src/
The directory tree containing the Rust source code for the project.
src/lib.rs
The Rust library's main module.
target/
Binary artifacts generated by the Rust build.
Learn More
To learn more about Neon, see the Neon documentation.
To learn more about Rust, see the Rust documentation.
To learn more about Node, see the Node documentation.
8 Jan 13, 2023
7k Jan 4, 2023
385 May 9, 2023
14 Jun 16, 2022
25.4k Dec 31, 2022
7 Nov 16, 2022
35 Aug 12, 2022
6 Dec 19, 2022
9.8k Jan 2, 2023
5.9k Jan 8, 2023
32 Jun 16, 2021
122 Dec 15, 2022
47 Dec 5, 2022
1k Jan 5, 2023
4 Aug 30, 2021
15 Nov 28, 2022
2 Nov 27, 2021
7 Oct 7, 2022
7.3k Jan 8, 2023