@entur-partner/rich-text-editor

Entur Rich Text Editor

This package contains a rich text editor.

This package is maintained by Team Produkt.

Installation

npm install @entur-partner/rich-text-editor

# or if you are using Yarn:
yarn add @entur-partner/rich-text-editor

Requirements

• Node.JS ~24
• yarn ~4.13

We use mise to set up basic tooling and tasks to be used in the project. To install mise, run the following:

# Install mise
brew install mise

# Activate mise. If you use another shell than zsh, please refer to https://mise.jdx.dev/cli/activate.html
echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

# Mark the mise configuration as trusted. This is needed due to using experimental features in the .mise.toml file.
mise trust

Then, navigate to the project root and run:

mise install

This will install the required tools and dependencies specified in the .mise.toml file. Note! Remember to reload your terminal to ensure all changes take effect.

Development

Setup

All dependencies are defined in package.json and are managed with yarn. To initially install all dependencies and when the list dependency has changed, run yarn.

$ yarn

Build

To build all packages run:

$ yarn build

Code style

Oxc is used for automatic code formatting and linting.

Format code:

$ yarn format

Check that code is formatted correctly:

$ yarn format-check

Tip: See Editor integration for how to configure your editor to format code on save.

Linting

Oxc is used for linting. Check linting:

$ yarn lint

Testing

Uses Vitest to test unit and reducer testing

yarn test

Contributing

This project follows the Conventional Commits specification. This lets us create new version numbers and change logs based on commit messages, instead of spending time on doing it manually.

We have added a tool called commitizen that helps you with following this standard. Simply write git commit, and you'll be guided through a UI that creates nice commit messages that contain all the info we need. If that does not work, you may instead write npx git-cz