sourcebot/packages/shared/README.md
Gabriel Dugny 9b13492cb3
chore: Misc typos (UI, docs, code...), Makefile PATH with spaces (#369)
* chore: Fix misc typos (UI, docs, code...)

* chore(dev): Support PATH with spaces in Makefile

E.g. `Application Support` on MacOS

* chore: Typos in schema v2 description

* chore: more typos

* chore(dev): Add _typos.toml
2025-07-16 11:59:01 -07:00

674 B

This package contains shared code between the backend & webapp packages.

Why two index files?

This package contains two index files: index.server.ts and index.client.ts. There is some code in this package that will only work in a Node.JS runtime (e.g., because it depends on the fs package. Entitlements are a good example of this), and other code that is runtime agnostic (e.g., constants.ts). To deal with this, we these two index files export server code and client code, respectively.

For package consumers, the usage would look like the following:

  • Server: import { ... } from @sourcebot/shared
  • Client: import { ... } from @sourcebot/shared/client