Document formatter

Author: NoahTheDuke

CHANGELOG.md

@@ -2,10 +2,11 @@
 
 ## Unreleased
 
-- Revert swallowing cljs reference errors. (See [official forums](https://discourse.mozilla.org/t/which-tools-are-available-for-finding-errors-in-ftl-files/70313/2) for reasoning.)
+- Add an opinionated, no options formatter.
+- Clean up build.clj.
+- Bump net.xyzsd.fluent/fluent-base to 0.72.
 - Bump @fluent/bundle to 0.19.
-- Add Clojure and Java formatters. Clojure is more idiomatic, Java is twice as fast. 500us vs 250us for a 2k file.
-- Clean up build.clj, add prep task.
+- Revert swallowing cljs reference errors. (See [official forums](https://discourse.mozilla.org/t/which-tools-are-available-for-finding-errors-in-ftl-files/70313/2) for reasoning.)
 
 ## 0.0.2
 

README.md

@@ -10,6 +10,17 @@ This library aims to smooth over those differences, making it easy to build your
 > [!NOTE]
 > Requires Clojure 1.12 because new interop syntax is really nice. I'm not looking to support earlier Clojures at this time.
 
+## Table of Contents
+
+<!-- toc -->
+
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+- [Formatter](#formatter)
+- [Extended example](#extended-example)
+
+<!-- tocstop -->
+
 ## Getting Started
 
 Add it to your deps.edn or project.clj:
@@ -18,7 +29,7 @@ Add it to your deps.edn or project.clj:
 {:deps {io.github.noahtheduke/fluent-clj {:mvn/version "0.0.2"}}}
 ```
 
-## Example
+## Usage
 
 ```clojure
 (require '[noahtheduke.fluent :as i18n])
@@ -54,7 +65,11 @@ email-cnt = {$cnt ->
 => "2 emails"
 ```
 
-## Usage in an actual application
+## Formatter
+
+A no-options formatter for Fluent Files is included, available as a `-X` function. To use it, call `clojure -X noahtheduke.fluent.utils/fmt :file "corpus/example.ftl"` to format a single file or `clojure -X noahtheduke.fluent.utils/fmt :dir "corpus"` to format all `.ftl` files in the given directory.
+
+## Extended example
 
 I built this library for a website that uses [Reagent](https://reagent-project.github.io), so I'll share how we do it there.
 

build.clj

@@ -7,9 +7,7 @@
    [clojure.java.io :as io]
    [clojure.string :as str]
    [clojure.tools.build.api :as b]
-   [deps-deploy.deps-deploy :as dd]) 
-  (:import
-    [java.io File]))
+   [deps-deploy.deps-deploy :as dd]))
 
 (defn make-version []
   (str/trim (slurp "./resources/FLUENTCLJ_VERSION")))
@@ -29,7 +27,6 @@
             :src-dirs ["src"]
             :java-src-dirs ["src"]
             :resource-dirs ["resources"]
-            :javac-opts ["--release" "17"]
             :pom-data [[:licenses
                         [:license [:name "MPL-2.0"] [:url "https://mozilla.org/MPL/2.0"]]]]}
            opts)))
@@ -43,23 +40,9 @@
     (b/copy-dir {:src-dirs (concat (:src-dirs opts) (:resource-dirs opts))
                  :target-dir (:class-dir opts)})))
 
-(defn javac [opts]
-  (let [opts (make-opts opts)]
-    (when (->> (map io/file (:java-src-dirs opts))
-               (mapcat file-seq)
-               (filter #(and (.isFile ^File %)
-                             (str/ends-with? (str %) ".java")))
-               (seq))
-      (println "Compiling" (str/join ", " (:java-src-dirs opts)))
-      (b/javac {:src-dirs (:java-src-dirs opts)
-                :class-dir (:class-dir opts)
-                :basis (:basis opts)
-                :javac-opts (:javac-opts opts)}))))
-
 (defn jar [opts]
   (let [opts (make-opts opts)]
     (copy-src opts)
-    (javac opts)
     (b/jar opts)
     (println "Created" (str (b/resolve-path (:jar-file opts))))))
 
@@ -71,7 +54,6 @@
 (defn uberjar [opts]
   (let [opts (make-opts opts)]
     (copy-src opts)
-    (javac opts)
     (b/write-pom opts)
     (b/compile-clj opts)
     (b/uber opts)
@@ -81,7 +63,6 @@
   (let [opts (make-opts opts)]
     (clean opts)
     (copy-src opts)
-    (javac opts)
     (b/write-pom opts)
     (b/jar opts)
     (dd/deploy {:installer :remote

deps.edn

@@ -1,10 +1,7 @@
 {:paths ["src" "resources" "target/classes"]
  :deps {org.clojure/clojure {:mvn/version "1.12.0"}
-        net.xyzsd.fluent/fluent-base {:mvn/version "0.70"}
-        net.xyzsd.fluent/fluent-functions-cldr {:mvn/version "0.70"}}
- :deps/prep-lib {:ensure "target/classes"
-                 :alias :build
-                 :fn javac}
+        net.xyzsd.fluent/fluent-base {:mvn/version "0.72"}
+        net.xyzsd.fluent/fluent-functions-cldr {:mvn/version "0.72"}}
  :aliases
  {:dev {:extra-paths ["dev"]
         :extra-deps {criterium/criterium {:mvn/version "0.4.6"}

justfile

@@ -1,15 +1,13 @@
 default:
     @just --list
 
-@compile:
-    clojure -T:build javac
+@gen-docs:
+    markdown-toc -i --maxdepth 2 README.md
 
 @repl arg="":
-    just compile
     clojure -M{{arg}}:dev:test:repl
 
 @run *args:
-    just compile
     clojure -M:run {{args}}
 
 splint:
@@ -23,7 +21,6 @@ lint:
     just lsp
 
 test-clj:
-    just compile
     clojure -M:dev:test:runner
 
 test-cljs:
@@ -53,7 +50,7 @@ current_version := `cat resources/FLUENTCLJ_VERSION | xargs`
 # Builds the uberjar, builds the jar, sends the jar to clojars
 @release version:
     echo 'Running tests'
-    just test-all
+    just test
     echo 'Setting new version {{version}}'
     just set-version {{version}}
     echo 'Commit and tag'

src/noahtheduke/fluent/utils.clj

@@ -13,29 +13,27 @@
    [java.io File]))
 
 (defn safe-read-and-fmt
-  ^String [s]
-  (let [contents (-> s
-                     (str/replace #"\\u([0-9A-F]{4})" "__FLUENT_CLJ__u$1")
-                     (str/replace #"\\U([0-9A-F]{4})" "__FLUENT_CLJ__U$1"))
-        ast (parse contents)
-        _ (when-let [errors (seq (FluentResource/.errors ast))]
-            (throw (ex-info (str "found errors: " (ex-message (last errors))) {:errors errors})))
-        formatted-contents (-> (pprint-str ast)
-                               (str/replace #"__FLUENT_CLJ__u([0-9A-F]{4})" "\\\\u$1")
-                               (str/replace #"__FLUENT_CLJ__U([0-9A-F]{4})" "\\\\U$1")
-                               (str/trim)
-                               (str "\n"))]
-    formatted-contents))
+  ^String [contents]
+  (let [ast (parse contents)]
+    (when-let [errors (seq (FluentResource/.errors ast))]
+      (throw (ex-info (str "found errors: " (ex-message (last errors))) {:errors errors})))
+    (-> (pprint-str ast)
+        (str/trim)
+        (str "\n"))))
 
-(defn fmt-dir
-  "Format all files in a directory"
-  [{:keys [dir]}]
-  (doseq [f (->> (io/file (name dir))
-                 (file-seq)
-                 (filter #(File/.isFile %))
-                 (filter #(str/ends-with? (str %) ".ftl")))
-          :let [formatted-file (safe-read-and-fmt (slurp f))]]
-    (spit f formatted-file)))
+(defn fmt
+  "Format files in :dir or single file at :file. No-op if given neither."
+  [{:keys [dir file]}]
+  (cond
+    dir (doseq [f (->> (io/file (name dir))
+                       (file-seq)
+                       (filter #(File/.isFile %))
+                       (filter #(str/ends-with? (str %) ".ftl")))
+                :let [formatted-file (safe-read-and-fmt (slurp f))]]
+          (spit f formatted-file))
+    file (as-> (slurp file) $
+           (safe-read-and-fmt $)
+           (spit file $))))
 
 (comment
-  (fmt-dir {:dir "corpus"}))
+  (fmt {:dir "corpus"}))