logseq/docs/dev-practices.md

Description

This page describes development practices for this codebase.

Linting

Most of our linters require babashka. Before running them, please install https://github.com/babashka/babashka#installation.

Clojure code

To lint:

clojure -M:clj-kondo --lint src

We lint our Clojure(Script) code with https://github.com/clj-kondo/clj-kondo/. If you need to configure specific linters, see this documentation. Where possible, a global linting configuration is used and namespace specific configuration is avoided.

There are outstanding linting items that are currently ignored to allow linting the rest of the codebase in CI. These outstanding linting items should be addressed at some point:

• Comments starting with TODO:lint
• Code marked with #_:clj-kondo/ignore require a good understanding of the context to address as they usually involve something with a side effect or require changing multiple fns up the call stack.

Unused vars

We use https://github.com/borkdude/carve to detect unused vars in our codebase.

To run this linter:

scripts/carve.clj

By default, the script runs in CI mode which prints unused vars if they are found. The script can be run in an interactive mode which prompts for keeping (ignoring) an unused var or removing it. Run this mode with:

scripts/carve.clj '{:interactive true}'

When a var is ignored, it is added to .carve/ignore. Please add a comment for why a var is ignored to help others understand why it's unused.

Large vars

Large vars have a lot of complexity and make it hard for the team to maintain and understand them. To run this linter:

scripts/large_vars.clj

To configure the linter, see its config var.

Testing

We have unit and end to end tests.

End to End Tests

To run end to end tests

yarn electron-watch
# in another shell
yarn e2e-test # or npx playwright test

Unit Testing

Our unit tests use the shadow-cljs test-runner. To run them:

yarn test

There are a couple different ways to develop with tests:

Autorun Tests

To run tests automatically on file save, run yarn shadow-cljs watch test --config-merge '{:autorun true}'. The test output may appear where shadow-cljs was first invoked e.g. where yarn watch is running. Specific namespace(s) can be auto run with the :ns-regexp option e.g. npx shadow-cljs watch test --config-merge '{:autorun true :ns-regexp "frontend.text-test"}'.

Focus Tests

Tests can be automatically compiled and then selectively run on the commandline using https://github.com/lucywang000/shadow-test-utils. For this workflow:

1. Run clj -M:test watch test in one terminal
2. Focus a test by adding a ^:focus metadata flag
3. In another terminal, run node node static/tests.js