[mod] [BREAKING] [#322 #353] Reorganise community appenders

Before this commit: Community appender namespaces: `taoensso.timbre.appenders.3rd-party.X` After this commit: Community appender namespaces: `taoensso.timbre.appenders.community.X`. This is a BREAKING change for you iff: You're using any of the included community appenders. In this case, just change `3rd-party` in your ns imports to `community`. Motivation for change: The `3rd-party` namespace segment beginning with a numeric has long caused minor issues with tooling, etc. (e.g. #322). Took the opportunity to also exclude community code from the default Lein profiles to help prevent community code with strange dependencies and/or environment expectations (e.g. Android platform) from interfering with builds, cljdoc, etc.
taoensso · Oct 23, 2022 · 1c9fbb4 · 1c9fbb4
1 parent e5851f7
commit 1c9fbb4
Show file tree

Hide file tree

Showing 21 changed files with 32 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ Happy hacking!
  * [Logs as Clojure values][] (v3+).
  * Small, simple, cross-platform codebase.
 
-## 3rd-party tools, appenders, etc.
+## Community tools, appenders, etc.
 
 Link                     | Description
 ------------------------ | -----------------------------------------------------
@@ -211,7 +211,7 @@ See also `car-appender/query-entries`.
 
 #### Other included appenders
 
-A number of 3rd-party appenders are included out-the-box [here](https://github.com/ptaoussanis/timbre/tree/master/src/taoensso/timbre/appenders/3rd_party). **Please see the relevant docstring for details**. Thanks goes to the respective authors! 
+A number of community appenders are included out-the-box [here](https://github.com/ptaoussanis/timbre/tree/master/src/taoensso/timbre/appenders/community). **Please see the relevant docstring for details**. Thanks goes to the respective authors! 
 
 Just give me a shout if you've got an appender you'd like to have added.
 
@@ -230,7 +230,7 @@ Otherwise, you can reach me at [Taoensso.com]. Happy hacking!
 ## License
 
 Distributed under the [EPL v1.0] \(same as Clojure).  
-Copyright &copy; 2015-2020 [Peter Taoussanis].
+Copyright &copy; 2015-2022 [Peter Taoussanis].
 
 <!--- Standard links -->
 [Taoensso.com]: https://www.taoensso.com

diff --git a/...re/appenders/3rd_party/android_logcat.clj → community/src/android_logcat.clj b/...re/appenders/3rd_party/android_logcat.clj → community/src/android_logcat.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.android-logcat
+(ns taoensso.timbre.appenders.community.android-logcat
   "Android LogCat appender. Requires Android runtime."
   {:author "Adam Clements (@AdamClements)"}
   (:require

diff --git a/...timbre/appenders/3rd_party/congomongo.clj → community/src/congomongo.clj b/...timbre/appenders/3rd_party/congomongo.clj → community/src/congomongo.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.congomongo
+(ns taoensso.timbre.appenders.community.congomongo
   "MongoDB appender. Requires https://github.com/aboekhoff/congomongo."
   {:author "Emlyn Corrin (@emlyn)"}
   (:require [somnium.congomongo :as mongo]

diff --git a/...sso/timbre/appenders/3rd_party/franzy.clj → community/src/franzy.clj b/...sso/timbre/appenders/3rd_party/franzy.clj → community/src/franzy.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.franzy
+(ns taoensso.timbre.appenders.community.franzy
   "Franzy (Kafka) appender.
   Requires Franzy (https://github.com/ymilky/franzy."
   {:author "Isaac Zeng (@gfZeng)"}

diff --git a/...ensso/timbre/appenders/3rd_party/gelf.clj → community/src/gelf.clj b/...ensso/timbre/appenders/3rd_party/gelf.clj → community/src/gelf.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.gelf
+(ns taoensso.timbre.appenders.community.gelf
   "Appender that sends GELF messages to a centralized logging server
   (e.g. Graylog). Requires https://github.com/Graylog2/gelfclient."
   {:author "Dave Owens (@davewo)"}

diff --git a/...nsso/timbre/appenders/3rd_party/irclj.clj → community/src/irclj.clj b/...nsso/timbre/appenders/3rd_party/irclj.clj → community/src/irclj.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.irclj
+(ns taoensso.timbre.appenders.community.irclj
   "IRC appender. Requires https://github.com/flatland/irclj."
   {:author "Emlyn Corrin (@emlyn)"}
   (:require

diff --git a/...o/timbre/appenders/3rd_party/logstash.clj → community/src/logstash.clj b/...o/timbre/appenders/3rd_party/logstash.clj → community/src/logstash.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.logstash
+(ns taoensso.timbre.appenders.community.logstash
   "Appender that sends output to Logstash.
    Requires Cheshire (https://github.com/dakrone/cheshire)."
   {:author "Mike Sperber (@mikesperber), David Frese (@dfrese)"}
@@ -7,7 +7,7 @@
   (:import  [java.net Socket InetAddress]
             [java.io PrintWriter]))
 
-;; Adapted from taoensso.timbre.appenders.3rd-party.server-socket
+;; Adapted from taoensso.timbre.appenders.community.server-socket
 
 (defn connect
   [host port]

diff --git a/...o/timbre/appenders/3rd_party/newrelic.clj → community/src/newrelic.clj b/...o/timbre/appenders/3rd_party/newrelic.clj → community/src/newrelic.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.newrelic
+(ns taoensso.timbre.appenders.community.newrelic
   "New Relic appender. Requires an appropriate New Relic jar,
   Ref. https://goo.gl/3Nv0QX."
   {:author "Camilo Polymeris (@polymeris)"}

diff --git a/...timbre/appenders/community/node_spit.cljs → community/src/node_spit.cljs b/...timbre/appenders/community/node_spit.cljs → community/src/node_spit.cljs
diff --git a/...timbre/appenders/3rd_party/postgresql.clj → community/src/postgresql.clj b/...timbre/appenders/3rd_party/postgresql.clj → community/src/postgresql.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.postgresql
+(ns taoensso.timbre.appenders.community.postgresql
   "JDBC PostgreSQL database appender.
   Requires https://github.com/clojure/java.jdbc,
            https://github.com/swaldman/c3p0."

diff --git a/...so/timbre/appenders/3rd_party/rolling.clj → community/src/rolling.clj b/...so/timbre/appenders/3rd_party/rolling.clj → community/src/rolling.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.rolling
+(ns taoensso.timbre.appenders.community.rolling
   "Rolling file appender."
   {:author "Unknown - please let me know?"}
   (:require

diff --git a/...nsso/timbre/appenders/3rd_party/rotor.clj → community/src/rotor.clj b/...nsso/timbre/appenders/3rd_party/rotor.clj → community/src/rotor.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.rotor
+(ns taoensso.timbre.appenders.community.rotor
   "Rotating file appender."
   {:author "Karsten Schmidt (@postspectacular)"}
   (:require

diff --git a/...sso/timbre/appenders/3rd_party/sentry.clj → community/src/sentry.clj b/...sso/timbre/appenders/3rd_party/sentry.clj → community/src/sentry.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.sentry
+(ns taoensso.timbre.appenders.community.sentry
   "Sentry appender. Requires https://github.com/sethtrain/raven-clj."
   {:author "Samuel Otter (@samuelotter)"}
   (:require

diff --git a/...bre/appenders/3rd_party/server_socket.clj → community/src/server_socket.clj b/...bre/appenders/3rd_party/server_socket.clj → community/src/server_socket.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.server-socket
+(ns taoensso.timbre.appenders.community.server-socket
   "TCP socket appender.
   Requires https://github.com/technomancy/server-socket."
   {:author "Emlyn Corrin (@emlyn)"}

diff --git a/...nsso/timbre/appenders/3rd_party/slack.clj → community/src/slack.clj b/...nsso/timbre/appenders/3rd_party/slack.clj → community/src/slack.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.slack
+(ns taoensso.timbre.appenders.community.slack
   "Slack appender. Requires https://github.com/julienXX/clj-slack."
   {:author "Simon Belak (@sbelak)"}
   (:require

diff --git a/...e/appenders/3rd_party/syslog_appender.clj → community/src/syslog_appender.clj b/...e/appenders/3rd_party/syslog_appender.clj → community/src/syslog_appender.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.syslog-appender
+(ns taoensso.timbre.appenders.community.syslog-appender
   "Requires https://github.com/java-native-access/jna"
   {:author "Audrius Molis @audriu"
    :inspired-by "https://github.com/joshrotenberg/brolog"}
@@ -90,7 +90,7 @@
   (timbre/merge-config!
    {:appenders
     {:syslog-appender
-     (taoensso.timbre.appenders.3rd-party.syslog-appender/syslog-appender
+     (taoensso.timbre.appenders.community.syslog-appender/syslog-appender
       {:ident "my-app"
        :syslog-options (byte 0x03)
        :facility :log-user})}}))
diff --git a/...timbre/appenders/3rd_party/udp_socket.clj → community/src/udp_socket.clj b/...timbre/appenders/3rd_party/udp_socket.clj → community/src/udp_socket.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.udp-socket
+(ns taoensso.timbre.appenders.community.udp-socket
   {:author "Leo Zovic (@inaimathi)"}
   (:import [java.net DatagramSocket DatagramPacket InetSocketAddress]))
 

diff --git a/...oensso/timbre/appenders/3rd_party/zmq.clj → community/src/zmq.clj b/...oensso/timbre/appenders/3rd_party/zmq.clj → community/src/zmq.clj
@@ -1,4 +1,4 @@
-(ns taoensso.timbre.appenders.3rd-party.zmq
+(ns taoensso.timbre.appenders.community.zmq
   "ØMQ appender. Requires https://github.com/zeromq/cljzmq."
   {:author "Angus Fletcher (@angusiguess)"}
   (:require

diff --git a/...mbre/appenders/3rd_party/rolling_test.clj → ...mbre/appenders/community/rolling_test.clj b/...mbre/appenders/3rd_party/rolling_test.clj → ...mbre/appenders/community/rolling_test.clj
@@ -1,7 +1,7 @@
-(ns taoensso.timbre.appenders.3rd-party.rolling-test
+(ns taoensso.timbre.appenders.community.rolling-test
   (:require
     [clojure.test :refer [deftest is use-fixtures]]
-    [taoensso.timbre.appenders.3rd-party.rolling :as rolling])
+    [taoensso.timbre.appenders.community.rolling :as rolling])
   (:import
    (java.io File)
    (java.nio.file Files)

diff --git a/...timbre/appenders/3rd_party/rotor_test.clj → ...timbre/appenders/community/rotor_test.clj b/...timbre/appenders/3rd_party/rotor_test.clj → ...timbre/appenders/community/rotor_test.clj
@@ -1,10 +1,10 @@
-(ns taoensso.timbre.appenders.3rd-party.rotor-test
+(ns taoensso.timbre.appenders.community.rotor-test
   (:require
     [clojure.test :refer :all]
     [clojure.java.io :as io]
     [clojure.set :as set]
     [taoensso.timbre :as timbre]
-    [taoensso.timbre.appenders.3rd-party.rotor :as rotor]))
+    [taoensso.timbre.appenders.community.rotor :as rotor]))
 
 (def logfile "rotor-test.log")
 

diff --git a/project.clj b/project.clj
@@ -31,10 +31,12 @@
    :1.10     {:dependencies [[org.clojure/clojure "1.10.3"]]}
    :1.11     {:dependencies [[org.clojure/clojure "1.11.1"]]}
    :depr     {:jvm-opts ["-Dtaoensso.elide-deprecated=true"]}
-   :dev      [:1.11 :test :server-jvm #_:depr :3pa] ; TODO :depr
+   :dev      [:1.11 :test :server-jvm #_:depr #_:community] ; TODO :depr
 
-   :3pa ; 3rd-party appenders
-   {:dependencies
+   :community
+   {:source-paths [       "src"                  "community/src"]
+    :test-paths   ["test" "src" "community/test" "community/src"]
+    :dependencies
     [[irclj                   "0.5.0-alpha4"]
      [org.graylog2/gelfclient "1.5.1"
       :exclusions [com.fasterxml.jackson.core/jackson-core]]
@@ -76,7 +78,8 @@
 
   :aliases
   {"build-once" ["cljsbuild" "once"]
-   "deploy-lib" ["do" "build-once," "deploy" "clojars," "install"]
+   "deploy-lib" ["with-profile" "+community"
+                 "do" "build-once," "deploy" "clojars," "install"]
    "start-dev"  ["with-profile" "+dev" "repl" ":headless"]
    "test-all"   ["do" "clean,"
                  "with-profile" "+1.11:+1.10:+1.9:+1.8:+1.7" "test,"