rust-to-npm

Deploy a rust project to npm in one command.

Getting Started

This project converts your rust project into a npm package that can be installed on all systems by leveraging cargo.

The Cargo.toml properties map to package.json.

You need to have a valid name, version and description set in your Cargo.toml.

Installation

```sh

cargo

cargo install rust-to-npm ```

You may want to add the following to yout .gitignore and just reference the project being made with.

package.json package-lock.json start.js uninstall.js pre-install.js

Usage

If your package is private make sure to have the private set in your Cargo.toml file.

```sh

run the command inside the repo with the Cargo.toml file

rust-to-npm ```

Consuming

To use the node_module you just published run npm i $PACKAGE.

Then use it via node node node_modules/$PACKAGE/start.js. Replace $PACKAGE with your package name as kebab case. You can also import the module directly at root as a normal module.

Goals

1. Easy convert installs to npm.
2. Allows full transparency of Rust code that user installs instead of dangerous binaries.

About

This project is used to convert the rust A11yWatch CLI for usage in node.

See example usage converting the rust crawler library as a sidecar into a node project.

TODO

1. Allow include local rust src files for non CLI type bins for easy node_module imports like the crawler project.