Switch to jsonv2 wholesale (#1486)

Author: jakebailey

.golangci.yml

@@ -15,6 +15,7 @@ linters:
     - canonicalheader
     - copyloopvar
     - customlint
+    - depguard
     - durationcheck
     - errcheck
     - errchkjson
@@ -62,10 +63,18 @@ linters:
       customlint:
         type: module
 
+    depguard:
+      rules:
+        main:
+          deny:
+            - pkg: 'encoding/json$'
+              desc: 'Use "github.com/microsoft/typescript-go/internal/json" instead.'
+
   exclusions:
     rules:
       - path: internal/fourslash/tests/gen/
-        linters: misspell
+        linters:
+          - misspell
 
     presets:
       - comments

NOTICE.txt

@@ -230,7 +230,7 @@ SOFTWARE.
 
 ---------------------------------------------------------
 
-github.com/go-json-experiment/json v0.0.0-20250714165856-be8212f5270d - BSD-3-Clause
+github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2 - BSD-3-Clause
 
 Copyright (c) 2020 The Go Authors. All rights reserved.
 

go.mod

@@ -1,10 +1,10 @@
 module github.com/microsoft/typescript-go
 
-go 1.24.0
+go 1.24.2
 
 require (
 	github.com/dlclark/regexp2 v1.11.5
-	github.com/go-json-experiment/json v0.0.0-20250714165856-be8212f5270d
+	github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2
 	github.com/google/go-cmp v0.7.0
 	github.com/peter-evans/patience v0.3.0
 	golang.org/x/sync v0.16.0

go.sum

@@ -1,7 +1,7 @@
 github.com/dlclark/regexp2 v1.11.5 h1:Q/sSnsKerHeCkc/jSTNq1oCm7KiVgUMZRDUoRu0JQZQ=
 github.com/dlclark/regexp2 v1.11.5/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
-github.com/go-json-experiment/json v0.0.0-20250714165856-be8212f5270d h1:+d6m5Bjvv0/RJct1VcOw2P5bvBOGjENmxORJYnSYDow=
-github.com/go-json-experiment/json v0.0.0-20250714165856-be8212f5270d/go.mod h1:TiCD2a1pcmjd7YnhGH0f/zKNcCD06B029pHhzV23c2M=
+github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2 h1:iizUGZ9pEquQS5jTGkh4AqeeHCMbfbjeb0zMt0aEFzs=
+github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2/go.mod h1:TiCD2a1pcmjd7YnhGH0f/zKNcCD06B029pHhzV23c2M=
 github.com/go-quicktest/qt v1.101.0 h1:O1K29Txy5P2OK0dGo59b7b0LR6wKfIhttaAhHUyn7eI=
 github.com/go-quicktest/qt v1.101.0/go.mod h1:14Bz/f7NwaXPtdYEgzsx46kqSxVwTbzVZsDC26tQJow=
 github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=

internal/api/api.go

@@ -2,7 +2,6 @@ package api
 
 import (
 	"context"
-	"encoding/json"
 	"errors"
 	"fmt"
 	"sync"
@@ -12,6 +11,7 @@ import (
 	"github.com/microsoft/typescript-go/internal/astnav"
 	"github.com/microsoft/typescript-go/internal/checker"
 	"github.com/microsoft/typescript-go/internal/core"
+	"github.com/microsoft/typescript-go/internal/json"
 	"github.com/microsoft/typescript-go/internal/lsp/lsproto"
 	"github.com/microsoft/typescript-go/internal/project"
 	"github.com/microsoft/typescript-go/internal/tsoptions"

internal/api/proto.go

@@ -1,7 +1,6 @@
 package api
 
 import (
-	"encoding/json"
 	"errors"
 	"fmt"
 	"strconv"
@@ -10,6 +9,7 @@ import (
 	"github.com/microsoft/typescript-go/internal/ast"
 	"github.com/microsoft/typescript-go/internal/checker"
 	"github.com/microsoft/typescript-go/internal/core"
+	"github.com/microsoft/typescript-go/internal/json"
 	"github.com/microsoft/typescript-go/internal/project"
 )
 

internal/api/server.go

@@ -4,14 +4,14 @@ import (
 	"bufio"
 	"context"
 	"encoding/binary"
-	"encoding/json"
 	"fmt"
 	"io"
 	"strconv"
 	"sync"
 
 	"github.com/microsoft/typescript-go/internal/bundled"
 	"github.com/microsoft/typescript-go/internal/core"
+	"github.com/microsoft/typescript-go/internal/json"
 	"github.com/microsoft/typescript-go/internal/project"
 	"github.com/microsoft/typescript-go/internal/vfs"
 	"github.com/microsoft/typescript-go/internal/vfs/osvfs"

internal/collections/ordered_map.go

@@ -1,19 +1,16 @@
 package collections
 
 import (
-	"bytes"
 	"encoding"
-	"encoding/json"
 	"errors"
-	"fmt"
 	"iter"
 	"maps"
 	"reflect"
 	"slices"
 	"strconv"
 
-	json2 "github.com/go-json-experiment/json"
 	"github.com/go-json-experiment/json/jsontext"
+	"github.com/microsoft/typescript-go/internal/json"
 )
 
 // OrderedMap is an insertion ordered map.
@@ -203,37 +200,30 @@ func (m *OrderedMap[K, V]) clone() OrderedMap[K, V] {
 	}
 }
 
-func (m *OrderedMap[K, V]) MarshalJSON() ([]byte, error) {
-	if len(m.mp) == 0 {
-		return []byte("{}"), nil
+var _ json.MarshalerTo = (*OrderedMap[string, string])(nil)
+
+func (m *OrderedMap[K, V]) MarshalJSONTo(enc *jsontext.Encoder) error {
+	if err := enc.WriteToken(jsontext.BeginObject); err != nil {
+		return err
 	}
-	var buf bytes.Buffer
-	buf.WriteByte('{')
-	enc := json.NewEncoder(&buf)
-	enc.SetEscapeHTML(false)
-
-	for i, k := range m.keys {
-		if i > 0 {
-			buf.WriteByte(',')
-		}
 
+	for _, k := range m.keys {
+		// TODO: is this needed? Can we just MarshalEncode k directly?
 		keyString, err := resolveKeyName(reflect.ValueOf(k))
 		if err != nil {
-			return nil, err
+			return err
 		}
 
-		if err := enc.Encode(keyString); err != nil {
-			return nil, err
+		if err := json.MarshalEncode(enc, keyString); err != nil {
+			return err
 		}
 
-		buf.WriteByte(':')
-
-		if err := enc.Encode(m.mp[k]); err != nil {
-			return nil, err
+		if err := json.MarshalEncode(enc, m.mp[k]); err != nil {
+			return err
 		}
 	}
-	buf.WriteByte('}')
-	return buf.Bytes(), nil
+
+	return enc.WriteToken(jsontext.EndObject)
 }
 
 func resolveKeyName(k reflect.Value) (string, error) {
@@ -256,50 +246,7 @@ func resolveKeyName(k reflect.Value) (string, error) {
 	panic("unexpected map key type")
 }
 
-var (
-	_ json.Unmarshaler      = (*OrderedMap[string, string])(nil)
-	_ json2.UnmarshalerFrom = (*OrderedMap[string, string])(nil)
-)
-
-func (m *OrderedMap[K, V]) UnmarshalJSON(data []byte) error {
-	if string(data) == "null" {
-		// By convention, to approximate the behavior of Unmarshal itself,
-		// Unmarshalers implement UnmarshalJSON([]byte("null")) as a no-op.
-		// https://pkg.go.dev/encoding/json#Unmarshaler
-		return nil
-	}
-	dec := json.NewDecoder(bytes.NewReader(data))
-	token, err := dec.Token()
-	if err != nil {
-		return err
-	}
-	if token != json.Delim('{') {
-		return errors.New("cannot unmarshal non-object JSON value into Map")
-	}
-	for dec.More() {
-		nameToken, err := dec.Token()
-		if err != nil {
-			return err
-		}
-		if nameToken == json.Delim('}') {
-			break
-		}
-		if key, ok := nameToken.(K); ok {
-			var valueBytes json.RawMessage
-			if err := dec.Decode(&valueBytes); err != nil {
-				return err
-			}
-			var value V
-			if err := json.Unmarshal(valueBytes, &value); err != nil {
-				return err
-			}
-			m.Set(key, value)
-		} else {
-			return fmt.Errorf("cannot unmarshal key into Map[%v, ...]", reflect.TypeFor[K]())
-		}
-	}
-	return nil
-}
+var _ json.UnmarshalerFrom = (*OrderedMap[string, string])(nil)
 
 func (m *OrderedMap[K, V]) UnmarshalJSONFrom(dec *jsontext.Decoder) error {
 	token, err := dec.ReadToken()
@@ -310,6 +257,7 @@ func (m *OrderedMap[K, V]) UnmarshalJSONFrom(dec *jsontext.Decoder) error {
 		// By convention, to approximate the behavior of Unmarshal itself,
 		// Unmarshalers implement UnmarshalJSON([]byte("null")) as a no-op.
 		// https://pkg.go.dev/encoding/json#Unmarshaler
+		// TODO: reconsider
 		return nil
 	}
 	if token.Kind() != '{' { // jsontext.ObjectStart.Kind()
@@ -318,10 +266,10 @@ func (m *OrderedMap[K, V]) UnmarshalJSONFrom(dec *jsontext.Decoder) error {
 	for dec.PeekKind() != '}' { // jsontext.ObjectEnd.Kind()
 		var key K
 		var value V
-		if err := json2.UnmarshalDecode(dec, &key); err != nil {
+		if err := json.UnmarshalDecode(dec, &key); err != nil {
 			return err
 		}
-		if err := json2.UnmarshalDecode(dec, &value); err != nil {
+		if err := json.UnmarshalDecode(dec, &value); err != nil {
 			return err
 		}
 		m.Set(key, value)

internal/collections/ordered_map_test.go

@@ -1,13 +1,12 @@
 package collections_test
 
 import (
-	"encoding/json"
 	"fmt"
 	"slices"
 	"testing"
 
-	json2 "github.com/go-json-experiment/json"
 	"github.com/microsoft/typescript-go/internal/collections"
+	"github.com/microsoft/typescript-go/internal/json"
 	"gotest.tools/v3/assert"
 )
 
@@ -162,13 +161,9 @@ func TestOrderedMapWithSizeHint(t *testing.T) { //nolint:paralleltest
 func TestOrderedMapUnmarshalJSON(t *testing.T) {
 	t.Parallel()
 
-	t.Run("UnmarshalJSON", func(t *testing.T) {
-		t.Parallel()
-		testOrderedMapUnmarshalJSON(t, json.Unmarshal)
-	})
 	t.Run("UnmarshalJSONV2", func(t *testing.T) {
 		t.Parallel()
-		testOrderedMapUnmarshalJSON(t, func(in []byte, out any) error { return json2.Unmarshal(in, out) })
+		testOrderedMapUnmarshalJSON(t, func(in []byte, out any) error { return json.Unmarshal(in, out) })
 	})
 }
 

internal/compiler/program.go

@@ -2,7 +2,6 @@ package compiler
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"maps"
 	"slices"
@@ -15,6 +14,7 @@ import (
 	"github.com/microsoft/typescript-go/internal/collections"
 	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/diagnostics"
+	"github.com/microsoft/typescript-go/internal/json"
 	"github.com/microsoft/typescript-go/internal/module"
 	"github.com/microsoft/typescript-go/internal/modulespecifiers"
 	"github.com/microsoft/typescript-go/internal/outputpaths"