@ronin/blade

RONIN Blade

This package renders React at the edge.

Contributing

To start contributing code, first make sure you have Bun installed, which is a JavaScript runtime.

Next, clone the repo and install its dependencies:

bun install

Once that's done, link the package to make it available to all of your local projects:

bun link

Inside your project, you can then run the following command, which is similar to bun add @ronin/blade or npm install @ronin/blade, except that it doesn't install @ronin/blade from npm, but instead uses your local clone of the package:

bun link @ronin/blade

If your project is not yet compatible with Bun, feel free to replace all of the occurrences of the word bun in the commands above with npm instead.

You will just need to make sure that, once you create a pull request on the current repo, it will not contain a package-lock.json file, which is usually generated by npm. Instead, we're using the bun.lockb file for this purpose (locking sub dependencies to a certain version).

Running Tests

The package has 100% test coverage, which means that every single line of code is tested automatically, to ensure that any change to the source code doesn't cause a regression.

Before you create a pull request on the blade repo, it is therefore advised to run those tests in order to ensure everything works as expected:

# Run all tests
bun run test

# Alternatively, run a single test
bun run test -- -t 'your test name'