Initial import of LogDarioSeq baseline
Establishes version control for the personal Logseq DB fork before starting the server-client architecture migration and domain features described in docs/agent-guide and the approved implementation plan. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
52
deps/common/README.md
vendored
Normal file
52
deps/common/README.md
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
## Description
|
||||
|
||||
This library provides common util namespaces and resources to share between the
|
||||
frontend and other non-frontend contexts. This library is not supposed to depend
|
||||
on other logseq libraries. This library is compatible with ClojureScript and
|
||||
with node/[nbb-logseq](https://github.com/logseq/nbb-logseq) to respectively
|
||||
provide frontend and Electron/commandline functionality.
|
||||
|
||||
|
||||
## API
|
||||
|
||||
This library is under the parent namespace `logseq.common`.
|
||||
|
||||
## Dev
|
||||
|
||||
This follows the practices that [the Logseq frontend
|
||||
follows](/docs/dev-practices.md). Most of the same linters are used, with
|
||||
configurations that are specific to this library. See [this library's CI
|
||||
file](/.github/workflows/deps-common.yml) for linting examples.
|
||||
|
||||
### Setup
|
||||
|
||||
To run linters and tests, you'll want to install pnpm dependencies once:
|
||||
```
|
||||
pnpm install
|
||||
```
|
||||
### Testing
|
||||
|
||||
To run nbb-logseq tests:
|
||||
|
||||
```
|
||||
# Run all tests
|
||||
$ pnpm test
|
||||
# List available options
|
||||
$ pnpm test -H
|
||||
# Run tests with :focus metadata flag
|
||||
$ pnpm test -i focus
|
||||
```
|
||||
|
||||
To run ClojureScript tests:
|
||||
```
|
||||
clojure -M:test
|
||||
```
|
||||
|
||||
To auto-run ClojureScript tests while writing tests:
|
||||
|
||||
```
|
||||
clojure -M:test -w src
|
||||
```
|
||||
### Managing dependencies
|
||||
|
||||
See [standard nbb/cljs library advice in graph-parser](/deps/graph-parser/README.md#managing-dependencies).
|
||||
Reference in New Issue
Block a user