Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.37 KB

README.md

File metadata and controls

72 lines (53 loc) · 2.37 KB
Raw

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 and nbb-logseq example scripts for example usage.

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 frontend application.

Testing

Since this library is compatible with cljs and nbb-logseq, tests are run against both languages.

Nbb tests use 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

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

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.