mirror of
https://github.com/logseq/logseq.git
synced 2026-05-29 15:09:41 +00:00
b513b94026
when created from app or cli. Moving db-worker to node changed the js/process exist check in db-ident ns. Brought back env var for straightforward fix. I checked other process checks and this was the only one affected this way. Also remove double testing for graph-parser as it hasn't provided any benefit and yet another place where we kept juggling this env var
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
## Description
|
|
|
|
This library parses a file graph directory and returns it as a datascript
|
|
database connection. This library mainly exists to convert file graphs to DB graphs.
|
|
This library is compatible with ClojureScript and with
|
|
[nbb-logseq](https://github.com/logseq/nbb-logseq) to respectively provide
|
|
frontend and commandline functionality.
|
|
|
|
## API
|
|
|
|
This library is under the parent namespace `logseq.graph-parser`. This library
|
|
provides two main namespaces, `logseq.graph-parser.exporter` and
|
|
`logseq.graph-parser.extract`.
|
|
|
|
## Usage
|
|
|
|
See [nbb-logseq example
|
|
scripts](https://github.com/logseq/nbb-logseq/tree/main/examples) for example
|
|
usage.
|
|
|
|
## 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-graph-parser.yml) for linting examples.
|
|
|
|
### Setup
|
|
|
|
To run linters and tests, you'll want to install yarn dependencies once:
|
|
```
|
|
yarn install
|
|
```
|
|
|
|
This step is not needed if you're just running the frontend application.
|
|
|
|
### Testing
|
|
|
|
Testing is done with nbb-logseq and
|
|
[nbb-test-runner](https://github.com/nextjournal/nbb-test-runner). Some basic usage:
|
|
|
|
```
|
|
# Run all tests
|
|
$ yarn test
|
|
# List available options
|
|
$ yarn test -H
|
|
# Run tests with :focus metadata flag
|
|
$ yarn test -i focus
|
|
```
|
|
|
|
### Managing dependencies
|
|
|
|
The package.json dependencies are just for testing and should be updated if there is
|
|
new behavior to test.
|
|
|
|
The deps.edn dependencies are used by both ClojureScript and nbb-logseq. Their
|
|
versions should be backwards compatible with each other with priority given to
|
|
the frontend. _No new dependency_ should be introduced to this library without
|
|
an understanding of the tradeoffs of adding this to nbb-logseq.
|