Development

This repository is a (nx) monorepo that contains the following npm packages:

Features
- kairo: the core library
- concurrency the concurrency extension
- router
Integrations
- react
- angular
- vue Note: it's for vue 3
- svelte
- solid
- preact
Dev dependencies
- vue-sfc-transformer: Make kairo work in vue sfc with no effort
- vite-vue-plugin: Hooking @vitejs/plugin-vue
- svelte-preprocessor: Make kairo work in svelte with no effort (by hooking svelte-preprocess)

They are all in the packages folder

Package Manager

We use yarn as the package manager. If you add or remove dependencies, please make sure the yarn.lock file is up-to-date.

Remember to run yarn install after every sync from remote and at the first clone.

Simply use nx test [package-name]. We use jest as testing framework.

Some packages have more than one test preset

react: nx run react:test-cm for testing react integeration with concurrent features
svelte: nx run svelte:test-ssr for testing svelte integration in ssr mode

They are in fixtures folder. Use nx serve [name] to start dev server.

Do not commit any changes inside this folder unless it's intentional (e.g. update dependencies;solve breaking changes).

Before submitting a pull request, make sure the package can be built without error

npm run build-tools
nx build [package-name]

The bundling script is in /tools/executors/rollup

To test svelte, you should build svelte-preprocess first. nx build svelte-preprocess
Visual Studio Code is recommanded.
- Use Volar to get .vue IntelliSense features