Use Text instead of ShortText. Release 0.3.0.0.

Author: andrewthad

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Revision history for json-syntax
 
+## 0.3.0.0 -- 2025-07-14
+
+* Switch from ShortText to Text. In many cases, this makes it possible for the
+  resulting Value to share the input byte array instead of allocating additional
+  memory.
+* Get rid of word-compat. Require new GHC instead.
+* Optimize decoding. Time for `json/twitter/100/decode` drops from 190us to 150us.
+
 ## 0.2.7.2 -- 2024-02-07
 
 * Fix build with GHC 9.8.

bench/Main.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
@@ -6,6 +7,7 @@ import Gauge.Main (bench, bgroup, defaultMain, whnf)
 import Metrics1024 (encodedMetrics1024)
 import Twitter100 (byteStringTwitter100, encodedTwitter100)
 import Url100 (byteStringUrl100, encodedUrl100)
+import Data.Bytes (Bytes)
 
 import qualified Data.Aeson as Aeson
 import qualified Data.ByteString.Lazy as LBS
@@ -29,6 +31,7 @@ main = do
   aesonValueTwitter100 <- case Aeson.decodeStrict' byteStringTwitter100 of
     Nothing -> fail "aeson failed to decode twitter-100"
     Just (v :: Aeson.Value) -> pure v
+  let !encodedCompactTwitter100 = Chunks.concat (BLDR.run 128 (J.encode valueTwitter100)) :: Bytes
   defaultMain
     [ bgroup
         "json"
@@ -50,6 +53,14 @@ main = do
                       valueTwitter100
                 ]
             ]
+        , bgroup
+            "twitter-compact"
+            [ bgroup
+                "100"
+                [ bench "decode" $
+                    whnf J.decode encodedCompactTwitter100
+                ]
+            ]
         , bgroup
             "url"
             [ bgroup

json-syntax.cabal

@@ -45,19 +45,18 @@ library
     , array-builder        >=0.1    && <0.2
     , array-chunks         >=0.1.3  && <0.2
     , base                 >=4.15   && <5
-    , bytebuild            >=0.3.10 && <0.4
+    , bytebuild            >=0.3.12 && <0.4
     , byteslice            >=0.2.9  && <0.3
-    , bytesmith            >=0.3.8  && <0.4
+    , bytesmith            >=0.3.13 && <0.4
     , bytestring           >=0.10.8 && <0.12
     , contiguous           >=0.6    && <0.7
     , natural-arithmetic   >=0.1.2  && <0.3
     , primitive            >=0.7    && <0.10
     , run-st               >=0.1.1  && <0.2
     , scientific-notation  >=0.1.6  && <0.2
-    , text                 >=2.0.2  && <2.2
+    , text                 >=2.1.2  && <2.2
     , text-short           >=0.1.3  && <0.2
     , transformers         >=0.5.6  && <0.7
-    , word-compat          >=0.0.6  && <0.1
     , zigzag               >=0.0.1  && <0.1
 
   hs-source-dirs:  src