mirror of
https://github.com/logseq/logseq.git
synced 2026-05-15 16:32:21 +00:00
79c25837cb
* migrate yarn to pnpm
* chore: update pnpm version to 10.33.0 across all package.json files
* chore: update .npmrc and package.json for improved dependency management
* chore: unify Clojure, Node, and Java version in workflow files
* fix: enable shamefully-hoist for now and add electron, keytar to onlyBuiltDependencies
* feat: add cider/piggieback dependency and update nREPL middleware configuration to silence warnings
* ensure pnpm setup prior to node setup
* fix: update logseq/bb-tasks git SHA
* feat: add pnpm configuration for onlyBuiltDependencies in package.json
* feat: add onlyBuiltDependencies configuration for better-sqlite3 in pnpm settings
* chore: update pnpm lockfile
* fix: resolve merge conflicts
* fix: remove invisible characters from markdown headers
* fix: update .npmrc comments for clarity on lockfile usage
* Revert "feat: add cider/piggieback dependency and update nREPL middleware configuration to silence warnings"
This reverts commit 70a111936f.
* fix: remove invisible characters from various README files and add .editorconfig
* fix: clarify lockfile resolution process in SKILL.md
---------
Co-authored-by: Tienson Qin <tiensonqin@gmail.com>
47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
## @logseq/libs
|
|
|
|
🚀 Logseq SDK libraries.
|
|
|
|
#### Installation
|
|
|
|
```shell
|
|
pnpm add @logseq/libs
|
|
```
|
|
|
|
#### Usage
|
|
|
|
Load `logseq` plugin sdk as global namespace
|
|
|
|
```js
|
|
import "@logseq/libs"
|
|
```
|
|
|
|
#### APIs & Samples & References
|
|
- https://logseq.github.io/plugins/
|
|
- https://github.com/logseq/logseq-plugin-samples
|
|
- [The New DB properties developer guide - A](./development-notes/db_properties_guide.md)
|
|
- [The New DB properties developer guide - B](./development-notes/db_properties_skill.md)
|
|
- [Logseq Plugin Development Agents Guide](./development-notes/AGENTS.md)
|
|
|
|
#### Community templates
|
|
|
|
1. https://github.com/logseq/cljs-plugin-example
|
|
2. https://github.com/YU000jp/logseq-plugin-sample-kit-typescript
|
|
|
|
#### Feedback
|
|
If you have any feedback or encounter any issues, feel free to join Logseq's discord group.
|
|
https://discord.gg/KpN4eHY
|
|
|
|
#### Generate CLJS SDK wrappers
|
|
|
|
To regenerate the ClojureScript facade from the JS SDK declarations (keeping the same argument shapes as the JS APIs while auto-converting to/from CLJS data):
|
|
|
|
```bash
|
|
pnpm generate:schema # emits dist/logseq-sdk-schema.json
|
|
bb libs:generate-cljs-sdk # emits logseq/core.cljs and per-proxy files under target/generated-cljs
|
|
```
|
|
|
|
Non-proxy methods (those defined on `ILSPluginUser`, e.g. `ready`, `provide-ui`) land in `logseq.core`. Each proxy (`IAppProxy`, `IEditorProxy`, ...) is emitted to its own namespace such as `logseq.app` or `logseq.editor`, preserving the original JS argument ordering while automatically bean-converting CLJS data.
|
|
|
|
Pass `--out-dir` to change the output location or `--ns-prefix` to pick a different namespace root.
|