01b28e26ee
This will prevent future occurrences of #5548 |
||
|---|---|---|
| .. | ||
| .carve | ||
| .clj-kondo | ||
| src/logseq | ||
| test/logseq | ||
| .gitignore | ||
| README.md | ||
| deps.edn | ||
| package.json | ||
| yarn.lock | ||
README.md
Description
This library parses a logseq graph directory and returns it as a datascript database connection. This library powers the Logseq app and also runs from the commandline, independent of the app. This is powerful as this can run anywhere that a Node.js script has access to a Logseq graph e.g. on CI processes like Github Actions. This library is compatible with ClojureScript and with 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 for parsing, logseq.graph-parser and
logseq.graph-parser.cli. logseq.graph-parser/parse-file is the main fn for
the frontend. logseq.graph-parser.cli/parse-graph is the main fn for node.js
CLIs.
Usage
See logseq.graph-parser.cli-test for now. A real world example is coming soon.
Dev
This follows the practices that the Logseq frontend follows. Most of the same linters are used, with configurations that are specific to this library. See this library's CI file 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 application.
Testing
Since this file is compatible with cljs and nbb-logseq, tests are run against both languages.
ClojureScript tests use https://github.com/Olical/cljs-test-runner. To run tests:
clojure -M:test
To see available options that can run specific tests or namespaces: clojure -M:test --help
To run nbb-logseq tests:
yarn nbb-logseq -cp src:test -m logseq.graph-parser.nbb-test-runner/run-tests
Managing dependencies
The package.json dependencies are just for testing and should be updated if there is new behavior to test.
The deps.edn dependecies 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.