@ronin/schemas

RONIN Schemas

This package contains a set of primitives that can be used to define RONIN schemas in code.

Setup

You don't need to install this package explicitly, as it is already included in the RONIN client.

However, we would be excited to welcome your feature suggestions or bug fixes for the RONIN schemas. Read on to learn more about how to suggest changes.

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/schemas or npm install @ronin/schemas, except that it doesn't install @ronin/schemas from npm, but instead uses your local clone of the package:

bun link @ronin/schemas

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).

Developing

import { model, string } from 'ronin/schema';

export const Account = model({
    slug: 'account',

    fields: {
        name: string({ required: true }),
    },
});

In order to be compatible with a wide range of projects, the source code of the schemas repo needs to be compiled (transpiled) whenever you make changes to it. To automate this, you can keep this command running in your terminal:

bun run dev

Whenever you make a change to the source code, it will then automatically be transpiled again.

Running Tests

The RONIN schemas repo 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 schemas repo, it is therefore advised to run those tests in order to ensure everything works as expected:

# Run all tests
bun test

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