Skip to content

chore: add README describing the purpose of pl-model-common package #1646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DenKoren wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: add README describing the purpose of pl-model-common package #1646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f923fc9
chore: add README describing the purpose of pl-model-common package
DenKoren May 18, 2026
3b9eecb
Update lib/model/common/README.md
DenKoren May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/major-clocks-cheer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
Comment thread
DenKoren marked this conversation as resolved.
15 changes: 15 additions & 0 deletions lib/model/common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# What is it for?

The purpose of this package is to keep primitives and functions, that have to be shared between all our execution contexts:
Comment thread
DenKoren marked this conversation as resolved.

- node
- quickjs sandbox
- browser
- browser preload

We have code that can work in a single specific context (like UI of the block) or in a mixture of contexts.

This package is a meeting point for code that can exist in all possible places.

- NEVER put context-dependent code here. This may (and probably will) ruin the build in some other place (i.e. Desktop App).
- Keep list of dependencies limited and clear. Each new dependency is a moment to think wether you really need it.
Comment thread
DenKoren marked this conversation as resolved.
Comment thread
DenKoren marked this conversation as resolved.
Loading