create-neon-manual-test-project v0.1.8
create-neon-manual-test-project
This project was bootstrapped by create-neon.
Building create-neon-manual-test-project
Building create-neon-manual-test-project requires a supported version of Node and Rust.
To run the build, run:
$ npm run build
This command uses the @neon-rs/cli utility to assemble the binary Node addon from the output of cargo
.
Exploring create-neon-manual-test-project
After building create-neon-manual-test-project, you can explore its exports at the Node console:
$ npm i
$ npm run build
$ node
> require('.').greeting()
{ message: 'hello node' }
Available Scripts
In the project directory, you can run:
npm run build
Builds the Node addon (index.node
) from source, generating a release build with cargo --release
.
Additional cargo build
arguments may be passed to npm run build
and similar commands. For example, to enable a cargo feature:
npm run build -- --feature=beetle
npm run debug
Similar to npm run build
but generates a debug build with cargo
.
npm run cross
Similar to npm run build
but uses cross-rs to cross-compile for another platform. Use the CARGO_BUILD_TARGET
environment variable to select the build target.
npm run release
Initiate a full build and publication of a new patch release of this library via GitHub Actions.
npm run dryrun
Initiate a dry run of a patch release of this library via GitHub Actions. This performs a full build but does not publish the final result.
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:
create-neon-manual-test-project/
├── Cargo.toml
├── README.md
├── lib/
├── src/
| ├── index.mts
| └── index.cts
├── crates/
| └── create-neon-manual-test-project/
| └── src/
| └── lib.rs
├── platforms/
├── package.json
└── target/
Entry | Purpose |
---|---|
Cargo.toml | The Cargo manifest file, which informs the cargo command. |
README.md | This file. |
lib/ | The directory containing the generated output from tsc. |
src/ | The directory containing the TypeScript source files. |
index.mts | Entry point for when this library is loaded via ESM import syntax. |
index.cts | Entry point for when this library is loaded via CJS require . |
crates/ | The directory tree containing the Rust source code for the project. |
lib.rs | Entry point for the Rust source code. |
platforms/ | The directory containing distributions of the binary addon backend for each platform supported by this library. |
package.json | The npm manifest file, which informs the npm command. |
target/ | Binary artifacts generated by the Rust build. |
Learn More
Learn more about: