enhance namespace naming

Author: sprocketc

CONTRIBUTING.md

@@ -26,17 +26,6 @@ t           -> time
 h, m, s, ms -> hours, minutes, seconds, milliseconds
 </pre>
 
-We also use the following namespace aliases
-<pre>
-v  -> views
-e  -> events
-h  -> handlers
-s  -> subs
-fx -> effects
-</pre>
-
-If the namespace belongs to a dedicated module, we use `module.v`.
-
 ## App structure
 
 Main structure

portfolio/src/components/shortcuts_scenes.cljs

@@ -3,23 +3,23 @@
    [portfolio.reagent-18 :refer-macros [defscene]]
    [re-frame.core :as rf]
    [re-pressed.core :as rp]
-   [renderer.history.events :as-alias history.e]
+   [renderer.history.events :as-alias history.events]
    [renderer.ui :as ui]
-   [renderer.utils.keyboard :as keyb]))
+   [renderer.utils.keyboard :as utils.keyboard]))
 
-(rf/dispatch [::rp/set-keydown-rules keyb/keydown-rules])
+(rf/dispatch [::rp/set-keydown-rules utils.keyboard/keydown-rules])
 
 (defscene single-shortcut
   :title "Single shortcut"
   [:div.toolbar.bg-primary.h-10.p-2.gap-2
    "Undo"
-   [ui/shortcuts [::history.e/undo]]])
+   [ui/shortcuts [::history.events/undo]]])
 
 (defscene multiple-shortcuts
   :title "Multiple shortcuts"
   [:div.toolbar.bg-primary.h-10.p-2.gap-2
    "Redo"
-   [ui/shortcuts [::history.e/redo]]])
+   [ui/shortcuts [::history.events/redo]]])
 
 (defscene no-shortcuts
   :title "No shortcuts"

portfolio/src/sections/home_scenes.cljs

@@ -2,11 +2,11 @@
   (:require
    [portfolio.reagent-18 :refer-macros [defscene]]
    [renderer.app.subs]
-   [renderer.app.views :as app.v]))
+   [renderer.app.views :as app.views]))
 
 (defscene home
   :title "Home"
   :params (atom ["path/to/file/name.rps"])
   [store]
   [:div.flex.flex-col.h-dvh.overflow-hidden
-   [app.v/home @store]])
+   [app.views/home @store]])

src/dev.cljs

@@ -2,19 +2,19 @@
   {:dev/always true}
   (:require
    [clojure.pprint :refer (pprint)]
-   [clojure.string :as str]
+   [clojure.string :as string]
    [malli.dev.cljs :as dev]
    [re-frame.core :as rf]
-   [renderer.app.events :as app.e]))
+   [renderer.app.events :as app.events]))
 
 (comment
   ;; Enable full db validation
-  (rf/reg-global-interceptor app.e/schema-validator)
-  (rf/clear-global-interceptor ::app.e/schema-validator)
+  (rf/reg-global-interceptor app.events/schema-validator)
+  (rf/clear-global-interceptor ::app.events/schema-validator)
 
   ;; Enable function instrumentation
   ;; https://github.com/metosin/malli/blob/master/docs/clojurescript-function-instrumentation.md
   (dev/start!)
   (dev/stop!)
 
-  (pprint (str/trim "This line suppresses some clj-kondo warnings.")))
+  (pprint (string/trim "This line suppresses some clj-kondo warnings.")))

src/renderer/app/db.cljs

@@ -2,7 +2,7 @@
   (:require
    [config :as config]
    [malli.core :as m]
-   [malli.transform :as mt]
+   [malli.transform :as m.transform]
    [renderer.dialog.db :refer [Dialog]]
    [renderer.document.db :refer [Document]]
    [renderer.element.db :refer [Element]]
@@ -14,7 +14,7 @@
    [renderer.timeline.db :refer [Timeline]]
    [renderer.tool.db :refer [Handle Tool State Cursor]]
    [renderer.utils.bounds :refer [BBox]]
-   [renderer.utils.i18n :as i18n]
+   [renderer.utils.i18n :as utils.i18n]
    [renderer.utils.math :refer [Vec2]]
    [renderer.window.db :refer [Window]]))
 
@@ -24,7 +24,7 @@
 (def Lang
   [:fn {:error/fn (fn [{:keys [value]} _]
                     (str value " is not a supported language"))}
-   i18n/lang?])
+   utils.i18n/lang?])
 
 (def App
   [:map {:closed true}
@@ -84,7 +84,8 @@
 
 (def explain (m/explainer App))
 
-(def default (m/decode App {:version config/version} mt/default-value-transformer))
+(def default
+  (m/decode App {:version config/version} malli.transform/default-value-transformer))
 
 (def persisted-keys
   "Top level keys that should be persisted to local storage."

src/renderer/app/effects.cljs

@@ -4,11 +4,10 @@
    [config :as config]
    [re-frame.core :as rf]
    [re-frame.db :as rf.db]
-   [renderer.app.db :as db]
-   [renderer.app.events :as-alias e]
-   [renderer.history.handlers :as history.h]
-   [renderer.notification.events :as-alias notification.e]
-   [renderer.utils.dom :as dom]))
+   [renderer.app.db :as app.db]
+   [renderer.history.handlers :as history.handlers]
+   [renderer.notification.events :as-alias notification.events]
+   [renderer.utils.dom :as utils.dom]))
 
 (rf.storage/reg-co-fx! config/app-key {:cofx :store})
 
@@ -28,8 +27,8 @@
    (let [db @rf.db/app-db
          db (cond-> db
               (:active-document db)
-              history.h/drop-rest)]
-     (->> (select-keys db db/persisted-keys)
+              history.handlers/drop-rest)]
+     (->> (select-keys db app.db/persisted-keys)
           (rf.storage/->store config/app-key)))))
 
 (rf/reg-fx
@@ -55,7 +54,7 @@
 (rf/reg-fx
  ::focus
  (fn [id]
-   (when-let [element (if id (.getElementById js/document id) (dom/canvas-element!))]
+   (when-let [element (if id (.getElementById js/document id) (utils.dom/canvas-element!))]
      (.focus element))))
 
 (rf/reg-fx
@@ -83,7 +82,7 @@
                                                                       formatter))))))))))
          (.catch #(when on-error (rf/dispatch (conj on-error %)))))
      (rf/dispatch
-      [::notification.e/unavailable-feature
+      [::notification.events/unavailable-feature
        "Save File Picker"
        "https://developer.mozilla.org/en-US/docs/Web/API/Window/showSaveFilePicker#browser_compatibility"]))))
 
@@ -141,9 +140,9 @@
 (rf/reg-fx
  ::validate-db
  (fn [[db event]]
-   (when (not (db/valid? db))
+   (when (not (app.db/valid? db))
      (js/console.error (str "Event: " (first event)))
-     (throw (js/Error. (str "Spec check failed: " (db/explain db)))))))
+     (throw (js/Error. (str "Spec check failed: " (app.db/explain db)))))))
 
 (rf/reg-fx
  ::scroll-into-view

src/renderer/app/events.cljs

@@ -1,15 +1,15 @@
 (ns renderer.app.events
   (:require
    [config :as config]
-   [malli.error :as me]
+   [malli.error :as malli.error]
    [re-frame.core :as rf]
-   [renderer.app.db :as db]
-   [renderer.app.effects :as-alias fx]
-   [renderer.notification.events :as-alias notification.e]
-   [renderer.notification.handlers :as notification.h]
-   [renderer.notification.views :as notification.v]
-   [renderer.utils.i18n :as i18n]
-   [renderer.window.effects :as-alias window.fx]))
+   [renderer.app.db :as app.db]
+   [renderer.app.effects :as-alias app.effects]
+   [renderer.notification.events :as-alias notification.events]
+   [renderer.notification.handlers :as notification.handlers]
+   [renderer.notification.views :as notification.views]
+   [renderer.utils.i18n :as utils.i18n]
+   [renderer.window.effects :as-alias window.effects]))
 
 (def persist
   (rf/->interceptor
@@ -19,26 +19,26 @@
                   fx (rf/get-effect context :fx)]
               (cond-> context
                 db
-                (rf/assoc-effect :fx (conj (or fx []) [::fx/persist])))))))
+                (rf/assoc-effect :fx (conj (or fx []) [::app.effects/persist])))))))
 
 (rf/reg-event-db
  ::initialize-db
  (fn [_ _]
-   db/default))
+   app.db/default))
 
 (rf/reg-event-fx
  ::load-local-db
  [(rf/inject-cofx :store)]
  (fn [{:keys [db store]} _]
    (let [app-db (merge db store)]
-     (if (db/valid? app-db)
+     (if (app.db/valid? app-db)
        {:db app-db}
-       {::fx/local-storage-clear nil
+       {::app.effects/local-storage-clear nil
         :db (cond-> db
               config/debug?
-              (notification.h/add (notification.v/spec-failed
-                                   "Invalid local configuration"
-                                   (-> app-db db/explain me/humanize str))))}))))
+              (notification.handlers/add (notification.views/spec-failed
+                                          "Invalid local configuration"
+                                          (-> app-db app.db/explain malli.error/humanize str))))}))))
 
 (rf/reg-event-db
  ::set-system-fonts
@@ -49,7 +49,7 @@
  ::set-lang
  (fn [db [_ lang]]
    (cond-> db
-     (i18n/lang? lang)
+     (utils.i18n/lang? lang)
      (assoc :lang lang))))
 
 (rf/reg-event-db
@@ -82,7 +82,7 @@
 (rf/reg-event-fx
  ::focus
  (fn [_ [_ id]]
-   {::fx/focus id}))
+   {::app.effects/focus id}))
 
 (defn ->font-map
   [^js/FontData font-data]
@@ -94,22 +94,22 @@
 (rf/reg-event-fx
  ::load-system-fonts
  (fn [_ _]
-   {::window.fx/ipc-invoke {:channel "load-system-fonts"
-                            :on-success [::set-system-fonts]
-                            :on-error [::notification.e/exception]
-                            :formatter #(js->clj % :keywordize-keys true)}}))
+   {::window.effects/ipc-invoke {:channel "load-system-fonts"
+                                 :on-success [::set-system-fonts]
+                                 :on-error [::notification.events/exception]
+                                 :formatter #(js->clj % :keywordize-keys true)}}))
 
 (rf/reg-event-fx
  ::query-local-fonts
  (fn [_ _]
-   {::fx/query-local-fonts {:on-success [::set-system-fonts]
-                            :on-error [::notification.e/exception]
-                            :formatter #(mapv ->font-map %)}}))
+   {::app.effects/query-local-fonts {:on-success [::set-system-fonts]
+                                     :on-error [::notification.events/exception]
+                                     :formatter #(mapv ->font-map %)}}))
 
 (rf/reg-event-fx
  ::file-open
  (fn [_ [_ options]]
-   {::fx/file-open options}))
+   {::app.effects/file-open options}))
 
 (def schema-validator
   (rf/->interceptor
@@ -122,14 +122,14 @@
               (cond-> context
                 db
                 (rf/assoc-effect :fx (conj (or fx [])
-                                           [::fx/validate-db [db event]])))))))
+                                           [::app.effects/validate-db [db event]])))))))
 
 (rf/reg-event-fx
  ::scroll-into-view
  (fn [_ [_ el]]
-   {::fx/scroll-into-view el}))
+   {::app.effects/scroll-into-view el}))
 
 (rf/reg-event-fx
  ::scroll-to-bottom
  (fn [_ [_ el]]
-   {::fx/scroll-to-bottom el}))
+   {::app.effects/scroll-to-bottom el}))