adbaf10abc
* fix(lint): make worker/frontend separation lint work on Windows * chore: update cljs:electron-watch script to include test flag * chore: remove dead root dependencies * chore(deps): converge better-sqlite3 to 12.6.2 across deps packages * chore(deps): converge fs-extra to ^11.3.0 across package roots * fix(test): correct parameters for create-if-not-exists function * chore(deps): converge cljs-bean to 1.9.0 across deps roots * fix(tests): escape regex in cljs:run-test script * chore: pin root packageManager to yarn 1.22.22 * chore(build): replace del with fs.rmSync in gulp clean * chore(build): replace npm-run-all with npm-run-all2 * chore(security): upgrade dompurify and unify sanitizer path * chore(observability): upgrade web sentry to 8.x * chore: remove unused react-draggable dependencies * chore(ci): fix windows release artifact collection * fix(build): create static dir before gulp clean scans it * fix: update nbb-logseq dependency to version feat-db-v33 * fix(test): move start-time initialization after clone repo * fix(deps): update nbb dependencies and adjust test script paths to compatible with windows path delimiter * chore(deps): remove dead meander dependency --------- Co-authored-by: Tienson Qin <tiensonqin@gmail.com>
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 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 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.