clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-05-01 01:16:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve and update lint documentation

Browse Source
This commit is contained in:
Gabriel Horner
2022-07-07 09:34:08 -04:00
parent 56afc59304
commit f39f26c8d3
2 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/dev-practices.md
View File

@@ -5,7 +5,8 @@ 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.
https://github.com/babashka/babashka#installation. To invoke all the linters in
this section, run `bb dev:lint`.
### Clojure code
@@ -49,7 +50,7 @@ and understand them. To run this linter:
bb lint:large-vars
```
To configure the linter, see its `config` var.
To configure the linter, see the `[:tasks/config :large-vars]` path of bb.edn.
### Datalog linting
@@ -60,6 +61,11 @@ queries and rules. Our queries are linted through clj-kondo and
[datalog-parser](https://github.com/lambdaforge/datalog-parser). clj-kondo will
error if it detects an invalid query.
### Invalid translations
Our translations can be configured incorrectly. We can catch some of these
mistakes [as noted here](./contributing-to-translations.md#fix-mistakes).
## Testing
We have unit and end to end tests.