Fix remaining todos and add a section to practices about this new action

novakda · Feb 21, 2023 · b78c689 · b78c689
1 parent 25c1505
commit b78c689
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 11 deletions.
diff --git a/docs/dev-practices.md b/docs/dev-practices.md
@@ -77,6 +77,22 @@ error if it detects an invalid query.
 Our translations can be configured incorrectly. We can catch some of these
 mistakes [as noted here](./contributing-to-translations.md#fix-mistakes).
 
+### Spell Checker
+
+We use [typos](https://github.com/crate-ci/typos) to spell check our source code.
+
+To install it locally and use it:
+
+```sh
+$ brew install typos-cli
+# Catch any errors
+$ typos
+# Fix errors
+$ typos -w
+```
+
+To configure it e.g. for dealing with false positives, see `typos.toml`.
+
 ## Testing
 
 We have unit, performance and end to end tests.

diff --git a/src/main/frontend/components/settings.cljs b/src/main/frontend/components/settings.cljs
@@ -78,12 +78,12 @@
                nil)]
 
        [:div.text-sm.cursor
-        {:title (str "Revision: " config/revison)
+        {:title (str "Revision: " config/revision)
          :on-click (fn []
                      (notification/show! [:div "Current Revision: "
                                           [:a {:target "_blank"
-                                               :href (str "https://github.com/logseq/logseq/commit/" config/revison)}
-                                           config/revison]]
+                                               :href (str "https://github.com/logseq/logseq/commit/" config/revision)}
+                                           config/revision]]
                                          :info
                                          false))}
         version]

diff --git a/src/main/frontend/config.cljs b/src/main/frontend/config.cljs
@@ -17,7 +17,7 @@
 (defonce publishing? PUBLISHING)
 
 (goog-define REVISION "unknown")
-(defonce revison REVISION)
+(defonce revision REVISION)
 
 (reset! state/publishing? publishing?)
 

diff --git a/src/main/frontend/modules/instrumentation/sentry.cljs b/src/main/frontend/modules/instrumentation/sentry.cljs
@@ -18,8 +18,8 @@
    :environment (if config/dev? "development" "production")
    :initialScope {:tags
                   (merge
-                   (when (not-empty config/revison)
-                     {:revision config/revison})
+                   (when (not-empty config/revision)
+                     {:revision config/revision})
                    {:platform (cond
                                 (util/electron?) "electron"
                                 (mobile-util/native-platform?) "mobile"

diff --git a/typos.toml b/typos.toml
@@ -1,14 +1,16 @@
 [default.extend-words]
+# Technical words
 edn = "edn"
 datas = "datas"
-BA = "BA"
 juxt = "juxt"
+Ded = "Ded"  # Shows up in ANDed
+referer = "referer" # This is a misspelling in the http spec so not much we can do
+
+# False positives
+collapsable = "collapsable" # This an ok alternative to collapsible
+BA = "BA"
 fo = "fo"
-collapsable = "collapsable" # TODO: should be collapsible
-Ded = "Ded"
 aks = "aks"
 Mannor = "Mannor"
-revison = "revison"         # TODO: should be revision
-referer = "referer"         # TODO: should be referrer
 [files]
 extend-exclude = ["resources/*", "templates/*", "dicts.cljc"]