logseq

History

Tienson Qin 40bffa32b0 Use forked datascript		2023-11-25 09:12:59 +08:00
..
.carve	add docs for new linter	2023-11-02 09:32:51 -04:00
script	enhance: make bb dev:db-transact usable for any task	2023-11-16 16:40:35 -05:00
src/logseq/outliner	First pass at a general transact script for db graphs	2023-10-27 17:40:12 -04:00
test/logseq/outliner	chore: move frontend db namespaces to a dedicated parent ns	2023-10-16 17:24:51 -04:00
README.md	Add readme, lint and CI for outliner dep	2023-09-06 17:03:04 -04:00
bb.edn	Add readme, lint and CI for outliner dep	2023-09-06 17:03:04 -04:00
deps.edn	Use forked datascript	2023-11-25 09:12:59 +08:00
nbb.edn	Move recalculate-block-path-refs to outliner dep	2023-09-06 16:20:29 -04:00
package.json	First pass at a general transact script for db graphs	2023-10-27 17:40:12 -04:00
yarn.lock	First pass at a general transact script for db graphs	2023-10-27 17:40:12 -04:00

README.md

Description

This library provides outliner operation related functionality. This library is compatible with ClojureScript and with node/nbb-logseq to respectively provide frontend and commandline functionality.

API

This library is under the parent namespace logseq.outliner. This library provides two main namespaces: logseq.outliner.datascript-report and logseq.outliner.pipeline.

Usage

See the frontend for cljs 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

Testing is done with nbb-logseq and 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

See standard nbb/cljs library advice in graph-parser.