Final documentation tweaks and such

Author: hlship

VERSION.txt

@@ -0,0 +1 @@
+1.3

build.clj

@@ -2,10 +2,11 @@
 
 (ns build
   (:require [clojure.tools.build.api :as build]
-            [net.lewisship.build :as b]))
+            [net.lewisship.build :as b]
+            [clojure.string :as str]))
 
 (def lib 'io.aviso/pretty)
-(def version "1.3")
+(def version (-> "VERSION.txt" slurp str/trim))
 
 (def jar-params {:project-name lib
                  :version version})
@@ -35,7 +36,7 @@
 (defn publish
   "Generate Codox documentation and publish via a GitHub push."
   [_params]
-  (println "Generating Codox documentation")
+  (println "Generating Codox documentation ...")
   (codox nil)
   (println "Copying documentation to" publish-dir "...")
   (build/copy-dir {:target-dir publish-dir

deps.edn

@@ -8,7 +8,8 @@
                 criterium/criterium {:mvn/version "0.4.6"}
                 com.stuartsierra/component {:mvn/version "1.1.0"}
                 com.walmartlabs/test-reporting {:mvn/version "1.2"}
-                org.clojure/core.async {:mvn/version "1.5.648"}}}
+                org.clojure/core.async {:mvn/version "1.5.648"}
+                leiningen/leiningen {:mvn/version "2.9.8"}}}
 
   ;; clj -X:dev:test
   :test

docs/conf.py

@@ -48,7 +48,7 @@
 
 # General information about the project.
 project = u'io.aviso/pretty'
-copyright = u'2013-2019, Aviso'
+copyright = u'2013-2022, Aviso'
 author = u'Howard M. Lewis Ship and others'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -57,12 +57,11 @@
 #
 
 def read_project_version():
-    f = open("../project.clj")
-    line = f.readline()
-    terms = line.split('"')
+    f = open("VERSION.txt")
+    version = f.readline().strip()
     f.close()
 
-    return terms[1]
+    return version
 
 
 # The full version, including alpha/beta/rc tags.

docs/lein-plugin.rst

@@ -11,10 +11,10 @@ of your :file:`project.clj`.
 .. code-block:: clojure
 
   (defproject ...
-   :plugins [[io.aviso/pretty "1.0"]]
+   :plugins [[io.aviso/pretty "1.3"]]
    :middleware [io.aviso.lein-pretty/inject]
    :dependencies [...
-                  [io.aviso/pretty "1.0"]]
+                  [io.aviso/pretty "1.3"]]
    ...)
 
 Adjust the version number for the current version, "|release|".
@@ -31,8 +31,8 @@ Another option is to add the following to your :file:`~/.lein/profiles.clj`:
 .. code-block:: clojure
 
    :pretty {
-     :plugins [[io.aviso/pretty "X.Y.Z"]]
-     :dependencies [[io.aviso/pretty "X.Y.Z"]]
+     :plugins [[io.aviso/pretty "1.3"]]
+     :dependencies [[io.aviso/pretty "1.3"]]
      :middleware [io.aviso.lein-pretty/inject]
    }
 
@@ -54,4 +54,3 @@ You may also want to add the following to your :file:`~/.bash_profile`::
     alias pretty="lein with-profile +pretty"
 
 At which point, you can use the command ``pretty`` instead of ``lein``.
-

docs/repl.rst

@@ -52,3 +52,8 @@ another window.
 
     (-> (copy) format-exception paste)
 
+-main
+-----
+
+Sets up pretty exceptions before passing arguments to `clojure.main/main`; this is used when starting a REPL
+to ensure that pretty exception are enabled before starting to interact.

src/io/aviso/ansi.clj

@@ -8,7 +8,7 @@
     true
     (catch Throwable _ false)))
 
-(def ^:const ansi-output-enabled?
+(def ^:const ^{:added "1.3"} ansi-output-enabled?
   "Determine if ANSI output is enabled.  If the environment variable ENABLE_ANSI_COLORS is non-null,
   then it sets the value:  the value `false` (matched caselessly) disables ANSI colors and fonts,
   otherwise they are enabled.

src/io/aviso/exception.clj

@@ -32,9 +32,9 @@
   "Current set of fonts used in exception formatting. This can be overridden to change colors, or bound to nil
    to disable fonts.
 
-   ~Further, the environment variable DISABLE_DEFAULT_PRETTY_FONTS, if non-nil, will default this to nil.~
+   Further, the environment variable DISABLE_DEFAULT_PRETTY_FONTS, if non-nil, will default this to nil.
 
-   Starting in 1.3, ANSI fonts may be disabled; see [[ansi-output-enabled?]]"
+   Starting in 1.3, ANSI fonts may be disabled at a lower level; see [[ansi-output-enabled?]]"
   (when-not (System/getenv "DISABLE_DEFAULT_PRETTY_FONTS")
     default-fonts))