Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.11 KB

DEVELOP.md

File metadata and controls

47 lines (30 loc) · 1.11 KB
Raw

Developer Guide

Local Development

Build and watch the library:

npm i
npm run watch

Then launch a local server in a separate terminal:

Optionally, you can build the documentation:

npm run typedoc
npm run serve

The server will be available at http://localhost:3000/:

  • Test files are located at http://localhost:3000/test.
  • Documentation is located at http://localhost:3000/docs.

Formatting

Project uses Prettier for code formatting.

Run the following command to format the code:

npm run prettier:format

Run the following command to check if the code is formatted:

npm run prettier:check

Please make sure to run the prettier:format command before committing your changes. As a security measure, the CI will fail if the code is not formatted.

If you are using Visual Studio Code, you can install the Prettier extension. We have included a configuration file in the project that will automatically use the project's Prettier settings. You can enable the "Format on Save" option in the settings to format the code automatically when saving a file.