README.md

neon-hello-world-starter

Return a hello world string in Node from Rust.

Requirements

• Git
• Node.js
• Rust
• Python (2.7+)
• Visual Studio C++ Build tools

Local development

Follow below npm scripts command to run locally.

Install and Build

Install npm and cargo packages also build typescript and rust.

npm i
# or
npm install

Output

npm start
# Output
Hello, World from RUST!

Lint

Run lint using npm run lint for rust (cargo clippy) and typescript (eslint)

Format

Run format using npm run format for rust (cargo fmt) and typescript (prettier)

Test

Test project using npm run lint. Test covered both rust (cargo test native --release) and typescript (jest).

Clean

Clean project with npm run clean. It includes neon clean as well.

Pack

Minifiy and pack the projects(npm run pack).

Setup

Setup the project by npm run setup.

TODO

• clean script should be more programmatically.
• write code format automatically.
• code coverage with grcov

Note

• --release is required because neon only builds with release flag. E.g: for tests, try cargo test --release

• If you are in windows make sure you follow issue