# {{package.name}}

{{#if package.description}}
**{{package.name}}:** {{package.description}}

{{/if}}
This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).

## Building {{package.name}}

Building {{package.name}} requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).

To run the build, run:

```sh
$ npm run build
```

This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli) utility to assemble the binary Node addon from the output of `cargo`.

## Exploring {{package.name}}

After building {{package.name}}, you can explore its exports at the Node console:

{{#if options.library}}
```sh
$ npm i
$ npm run build
$ node
> require('.').greeting('node')
{ message: 'hello node' }
```
{{else}}
```sh
$ npm i
$ npm run build
$ node
> require('.').hello('node')
'hello node'
```
{{/if}}

## Available Scripts

In the project directory, you can run:

{{#unless options.library}}
#### `npm install`

Installs the project, including running `npm run build`.

{{/unless}}
#### `npm run build`

Builds the Node addon (`index.node`) from source, generating a release build with `cargo --release`.

Additional [`cargo build`](https://doc.rust-lang.org/cargo/commands/cargo-build.html) arguments may be passed to `npm run build` and similar commands. For example, to enable a [cargo feature](https://doc.rust-lang.org/cargo/reference/features.html):

```
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](https://github.com/cross-rs/cross) to cross-compile for another platform. Use the [`CARGO_BUILD_TARGET`](https://doc.rust-lang.org/cargo/reference/config.html#buildtarget) environment variable to select the build target.

{{#eq options.library.ci.type compare="github"}}
#### `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.

{{/eq}}
#### `npm test`

Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).

## Project Layout

The directory structure of this project is:

```
{{package.name}}/
├── Cargo.toml
├── README.md
{{#if options.library}}
├── lib/
{{#eq options.library.lang compare="ts"}}
├── src/
|   ├── index.mts
|   └── index.cts
├── crates/
|   └── {{package.name}}/
|       └── src/
|           └── lib.rs
{{/eq}}
├── platforms/
{{else}}
├── src/
|   └── lib.rs
├── index.node
{{/if}}
├── package.json
└── target/
```

| Entry          | Purpose                                                                                                                                  |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `Cargo.toml`   | The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.                   |
| `README.md`    | This file.                                                                                                                               |
{{#if options.library}}
{{#eq options.library.lang compare="ts"}}
| `lib/`         | The directory containing the generated output from [tsc](https://typescriptlang.org).                                                    |
| `src/`         | The directory containing the TypeScript source files.                                                                                    |
| `index.mts`    | Entry point for when this library is loaded via [ESM `import`](https://nodejs.org/api/esm.html#modules-ecmascript-modules) syntax.       |
| `index.cts`    | Entry point for when this library is loaded via [CJS `require`](https://nodejs.org/api/modules.html#requireid).                          |
| `crates/`      | The directory tree containing the Rust source code for the project.                                                                      |
| `lib.rs`       | Entry point for the Rust source code.                                                                                                          |
{{else}}
| `lib/`         | The directory containing The directory containing the JavaScript source files.                                                           |
{{/eq}}
| `platforms/`   | The directory containing distributions of the binary addon backend for each platform supported by this library.                          |
{{else}}
| `src/`         | The directory tree containing the Rust source code for the project.                                                                      |
| `lib.rs`       | Entry point for the Rust source code.                                                                                                          |
| `index.node`   | The main module, a [Node addon](https://nodejs.org/api/addons.html) generated by the build and pointed to by `"main"` in `package.json`. |
{{/if}}
| `package.json` | The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.                    |
| `target/`      | Binary artifacts generated by the Rust build.                                                                                            |

## Learn More

Learn more about:

- [Neon](https://neon-bindings.com).
- [Rust](https://www.rust-lang.org).
- [Node](https://nodejs.org).