Merge pull request #2 from clarkmcc/release-0.2

Release v0.2.0 - Added more Typescript tags, optimized version registry

README.md

@@ -26,11 +26,33 @@ output, err = typescript.TranspileString(script, nil, typescript.WithCompileOpti
 ```
 
 ### Custom Typescript Version
-You can optionally specify which typescript version you want to compile using. These versions are based on the Git tags from the Typescript repository.
+#### Default Registry
+You can optionally specify which typescript version you want to compile using. These versions are based on the Git tags from the Typescript repository. If you're using a version that is supported in this package, you'll need to import the version package as a side-effect and will automatically be registered to the default registry.
 ```go
-output, err := typescript.Transpile(reader, nil, typescript.WithVersion("v4.2.2"))
+import _ "github.com/clarkmcc/go-typescript/versions/v4.2.2"
+
+func main() {
+    output, err := typescript.Transpile(reader, nil, typescript.WithVersion("v4.2.2"))
+}
+```
+
+#### Custom Registry
+You may want to use a custom version registry rather than the default registry.
+
+```go
+import version "github.com/clarkmcc/go-typescript/versions/v4.2.2"
+
+func main() {
+    registry := versions.NewRegistry()
+    registry.MustRegister("v4.2.3", version.Source)
+
+    output, err := typescript.TranspileString("let a:number = 10;", &typescript.Config{
+        TypescriptSource: program,
+    })
+}
 ```
 
+#### Custom Version
 Need a different typescript version than the tags we support in this repo? No problem, you can load your own:
 
 ```go

config.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"github.com/clarkmcc/go-typescript/utils"
 	"github.com/clarkmcc/go-typescript/versions"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.2.3"
 	"github.com/dop251/goja"
 )
 

config_test.go

@@ -2,6 +2,15 @@ package typescript
 
 import (
 	"fmt"
+	"github.com/clarkmcc/go-typescript/versions"
+	_ "github.com/clarkmcc/go-typescript/versions/v3.8.3"
+	_ "github.com/clarkmcc/go-typescript/versions/v3.9.9"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.1.2"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.1.3"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.1.4"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.1.5"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.2.2"
+	v423 "github.com/clarkmcc/go-typescript/versions/v4.2.3"
 	"github.com/stretchr/testify/require"
 	"testing"
 )
@@ -13,3 +22,73 @@ func TestConfig_Initialize(t *testing.T) {
 	_, err = cfg.Runtime.RunString(fmt.Sprintf("%v('not a valid base64 string')", cfg.decoderName))
 	require.Error(t, err)
 }
+
+func TestVersionLoading(t *testing.T) {
+	t.Run("v3.8.3", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v3.8.3"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v3.9.9", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v3.9.9"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.1.2", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.1.2"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.1.3", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.1.3"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.1.4", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.1.4"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.1.5", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.1.5"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.2.2", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.2.2"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+	t.Run("v4.2.3", func(t *testing.T) {
+		output, err := TranspileString("let a: number = 10;", &Config{
+			TypescriptSource: versions.DefaultRegistry.MustGet("v4.2.3"),
+		})
+		require.NoError(t, err)
+		require.Equal(t, "var a = 10;", output)
+	})
+}
+
+func TestCustomRegistry(t *testing.T) {
+	registry := versions.NewRegistry()
+	registry.MustRegister("v4.2.3", v423.Source)
+
+	output, err := TranspileString("let a: number = 10;", &Config{
+		TypescriptSource: registry.MustGet("v4.2.3"),
+	})
+	require.NoError(t, err)
+	require.Equal(t, "var a = 10;", output)
+}

examples/main.go

@@ -3,6 +3,7 @@ package main
 import (
 	_ "embed"
 	typescript "github.com/clarkmcc/go-typescript"
+	_ "github.com/clarkmcc/go-typescript/versions/v4.2.2"
 	"log"
 )
 

transpiler.go

@@ -5,6 +5,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
+	"github.com/dop251/goja"
 	"io"
 	"io/ioutil"
 	"strings"
@@ -26,6 +27,9 @@ func TranspileCtx(ctx context.Context, script io.Reader, cfg *Config, opts ...Op
 	if cfg == nil {
 		cfg = NewDefaultConfig()
 	}
+	if cfg.Runtime == nil {
+		cfg.Runtime = goja.New()
+	}
 	for _, fn := range opts {
 		fn(cfg)
 	}

versions/registry.go

@@ -27,6 +27,14 @@ func (r *Registry) Register(tag string, source string) error {
 	return nil
 }
 
+// MustRegister calls Register and panics if we're unable to register the version.
+func (r *Registry) MustRegister(tag string, source string) {
+	err := r.Register(tag, source)
+	if err != nil {
+		panic(err)
+	}
+}
+
 // Get attempts to return the typescript source for the specified tag if it exists, otherwise
 // it returns an error with a list of typescript versions that are supported by this registry.
 func (r *Registry) Get(tag string) (*goja.Program, error) {

versions/registry_test.go

@@ -7,6 +7,7 @@ import (
 
 func TestRegistry_Get(t *testing.T) {
 	t.Run("KnownTag", func(t *testing.T) {
+		DefaultRegistry.MustRegister("v4.2.3", "")
 		_, err := DefaultRegistry.Get("v4.2.3")
 		require.NoError(t, err)
 	})

versions/v3.8.3/loader.go

@@ -0,0 +1,13 @@
+package v3_8_3
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v3.8.3.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v3.8.3", Source)
+}

versions/v3.9.9/loader.go

@@ -0,0 +1,13 @@
+package v3_9_9
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v3.9.9.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v3.9.9", Source)
+}

versions/v4.1.2/loader.go

@@ -0,0 +1,13 @@
+package v4_1_2
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.1.2.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.1.2", Source)
+}

versions/v4.1.3/loader.go

@@ -0,0 +1,13 @@
+package v4_1_3
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.1.3.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.1.3", Source)
+}

versions/v4.1.4/loader.go

@@ -0,0 +1,13 @@
+package v4_1_4
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.1.4.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.1.4", Source)
+}

versions/v4.1.5/loader.go

@@ -0,0 +1,13 @@
+package v4_1_5
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.1.5.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.1.5", Source)
+}

versions/v4.2.2/loader.go

@@ -0,0 +1,13 @@
+package v4_2_2
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.2.2.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.2.2", Source)
+}

versions/v4.2.3/loader.go

@@ -0,0 +1,13 @@
+package v4_2_3
+
+import (
+	_ "embed"
+	"github.com/clarkmcc/go-typescript/versions"
+)
+
+//go:embed v4.2.3.js
+var Source string
+
+func init() {
+	versions.DefaultRegistry.MustRegister("v4.2.3", Source)
+}