소스 검색

add docs for new linter

also fix outliner lint
Gabriel Horner 1 년 전
부모
커밋
3ccf80fcba
3개의 변경된 파일15개의 추가작업 그리고 1개의 파일을 삭제
  1. 2 0
      deps/outliner/.carve/ignore
  2. 12 0
      docs/dev-practices.md
  3. 1 1
      scripts/src/logseq/tasks/dev/db_and_file_graphs.clj

+ 2 - 0
deps/outliner/.carve/ignore

@@ -0,0 +1,2 @@
+;; API fn
+logseq.outliner.cli.persist-graph/add-listener

+ 12 - 0
docs/dev-practices.md

@@ -109,6 +109,18 @@ $ typos -w
 
 To configure it e.g. for dealing with false positives, see `typos.toml`.
 
+### Separate DB and File Graph Code
+
+There is a growing number of code and features that are only for file or DB graphs. Run this linter to
+ensure that code you add or modify keeps with existing conventions:
+
+```
+$ bb lint:db-and-file-graphs-separate
+✅ All checks passed!
+```
+
+The main convention is that file and db specific files go under directories named `file_based` and `db_based` respectively. To see the full list of file and db specific namespaces and files see the top of [the script](/scripts/src/logseq/tasks/dev/db_and_file_graphs.clj).
+
 ## Testing
 
 We have unit, performance and end to end tests.

+ 1 - 1
scripts/src/logseq/tasks/dev/db_and_file_graphs.clj

@@ -10,7 +10,7 @@
           ["." "?"]))
 
 (def db-graph-ns
-  "Namespaces or parent namespaces _only_ for DB graphs"
+  "Namespaces or parent namespaces _only_ for DB graphs. Use a '.' at end of a namespace for parent namespaces"
   (mapv escape-shell-regex
         ["logseq.db.sqlite." "logseq.db.frontend.property" "logseq.db.frontend.malli-schema"
          "electron.db"