Rename to sobek

See grafana/k6#3772 Apart from renaming: 1. Drop the goja package as it depends on goja_nodejs and we are not forking this ... yet. 2. Drop references to goja_nodejs for the same reason. 3. Point out this is a fork of goja. Some links to goja are left as they link to issues that are still relevant for the point being made.
grafana · Jun 11, 2024 · 1a77bda · 1a77bda
1 parent ccbae20
commit 1a77bda
Show file tree

Hide file tree

Showing 107 changed files with 226 additions and 389 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,15 @@
-goja
+sobek
 ====
 
 ECMAScript 5.1(+) implementation in Go.
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/dop251/goja.svg)](https://pkg.go.dev/github.com/dop251/goja)
+[![Go Reference](https://pkg.go.dev/badge/github.com/grafana/sobek.svg)](https://pkg.go.dev/github.com/grafana/sobek)
 
-Goja is an implementation of ECMAScript 5.1 in pure Go with emphasis on standard compliance and
+Sobek is an implementation of ECMAScript 5.1 in pure Go with emphasis on standard compliance and
 performance.
 
+This project is a fork of [goja](https://github.com/dop251/goja).
+
 This project was largely inspired by [otto](https://github.com/robertkrimen/otto).
 
 The minimum required Go version is 1.20.
@@ -20,7 +22,7 @@ Features
    pass all of them. See .tc39_test262_checkout.sh for the latest working commit id.
  * Capable of running Babel, Typescript compiler and pretty much anything written in ES5.
  * Sourcemaps.
- * Most of ES6 functionality, still work in progress, see https://github.com/dop251/goja/milestone/1?closed=1
+ * Most of ES6 functionality, still work in progress, see https://github.com/grafana/sobek/milestone/1?closed=1
 
 Known incompatibilities and caveats
 -----------------------------------
@@ -98,21 +100,19 @@ It gives you a much better control over execution environment so can be useful f
 
 ### Is it goroutine-safe?
 
-No. An instance of goja.Runtime can only be used by a single goroutine
+No. An instance of sobek.Runtime can only be used by a single goroutine
 at a time. You can create as many instances of Runtime as you like but
 it's not possible to pass object values between runtimes.
 
 ### Where is setTimeout()?
 
 setTimeout() assumes concurrent execution of code which requires an execution
 environment, for example an event loop similar to nodejs or a browser.
-There is a [separate project](https://github.com/dop251/goja_nodejs) aimed at providing some NodeJS functionality,
-and it includes an event loop.
 
 ### Can you implement (feature X from ES6 or higher)?
 
 I will be adding features in their dependency order and as quickly as time permits. Please do not ask
-for ETAs. Features that are open in the [milestone](https://github.com/dop251/goja/milestone/1) are either in progress
+for ETAs. Features that are open in the [milestone](https://github.com/grafana/sobek/milestone/1) are either in progress
 or will be worked on next.
 
 The ongoing work is done in separate feature branches which are merged into master when appropriate.
@@ -141,7 +141,7 @@ Basic Example
 Run JavaScript and get the result value.
 
 ```go
-vm := goja.New()
+vm := sobek.New()
 v, err := vm.RunString("2 + 2")
 if err != nil {
     panic(err)
@@ -153,13 +153,13 @@ if num := v.Export().(int64); num != 4 {
 
 Passing Values to JS
 --------------------
-Any Go value can be passed to JS using Runtime.ToValue() method. See the method's [documentation](https://pkg.go.dev/github.com/dop251/goja#Runtime.ToValue) for more details.
+Any Go value can be passed to JS using Runtime.ToValue() method. See the method's [documentation](https://pkg.go.dev/github.com/grafana/sobek#Runtime.ToValue) for more details.
 
 Exporting Values from JS
 ------------------------
 A JS value can be exported into its default Go representation using Value.Export() method.
 
-Alternatively it can be exported into a specific Go variable using [Runtime.ExportTo()](https://pkg.go.dev/github.com/dop251/goja#Runtime.ExportTo) method.
+Alternatively it can be exported into a specific Go variable using [Runtime.ExportTo()](https://pkg.go.dev/github.com/grafana/sobek#Runtime.ExportTo) method.
 
 Within a single export operation the same Object will be represented by the same Go value (either the same map, slice or
 a pointer to the same struct). This includes circular objects and makes it possible to export them.
@@ -168,40 +168,40 @@ Calling JS functions from Go
 ----------------------------
 There are 2 approaches:
 
-- Using [AssertFunction()](https://pkg.go.dev/github.com/dop251/goja#AssertFunction):
+- Using [AssertFunction()](https://pkg.go.dev/github.com/grafana/sobek#AssertFunction):
 ```go
 const SCRIPT = `
 function sum(a, b) {
     return +a + b;
 }
 `
 
-vm := goja.New()
+vm := sobek.New()
 _, err := vm.RunString(SCRIPT)
 if err != nil {
     panic(err)
 }
-sum, ok := goja.AssertFunction(vm.Get("sum"))
+sum, ok := sobek.AssertFunction(vm.Get("sum"))
 if !ok {
     panic("Not a function")
 }
 
-res, err := sum(goja.Undefined(), vm.ToValue(40), vm.ToValue(2))
+res, err := sum(sobek.Undefined(), vm.ToValue(40), vm.ToValue(2))
 if err != nil {
     panic(err)
 }
 fmt.Println(res)
 // Output: 42
 ```
-- Using [Runtime.ExportTo()](https://pkg.go.dev/github.com/dop251/goja#Runtime.ExportTo):
+- Using [Runtime.ExportTo()](https://pkg.go.dev/github.com/grafana/sobek#Runtime.ExportTo):
 ```go
 const SCRIPT = `
 function sum(a, b) {
     return +a + b;
 }
 `
 
-vm := goja.New()
+vm := sobek.New()
 _, err := vm.RunString(SCRIPT)
 if err != nil {
     panic(err)
@@ -224,10 +224,10 @@ Mapping struct field and method names
 -------------------------------------
 By default, the names are passed through as is which means they are capitalised. This does not match
 the standard JavaScript naming convention, so if you need to make your JS code look more natural or if you are
-dealing with a 3rd party library, you can use a [FieldNameMapper](https://pkg.go.dev/github.com/dop251/goja#FieldNameMapper):
+dealing with a 3rd party library, you can use a [FieldNameMapper](https://pkg.go.dev/github.com/grafana/sobek#FieldNameMapper):
 
 ```go
-vm := goja.New()
+vm := sobek.New()
 vm.SetFieldNameMapper(TagFieldNameMapper("json", true))
 type S struct {
     Field int `json:"field"`
@@ -238,19 +238,19 @@ fmt.Println(res.Export())
 // Output: 42
 ```
 
-There are two standard mappers: [TagFieldNameMapper](https://pkg.go.dev/github.com/dop251/goja#TagFieldNameMapper) and
-[UncapFieldNameMapper](https://pkg.go.dev/github.com/dop251/goja#UncapFieldNameMapper), or you can use your own implementation.
+There are two standard mappers: [TagFieldNameMapper](https://pkg.go.dev/github.com/grafana/sobek#TagFieldNameMapper) and
+[UncapFieldNameMapper](https://pkg.go.dev/github.com/grafana/sobek#UncapFieldNameMapper), or you can use your own implementation.
 
 Native Constructors
 -------------------
 
-In order to implement a constructor function in Go use `func (goja.ConstructorCall) *goja.Object`.
-See [Runtime.ToValue()](https://pkg.go.dev/github.com/dop251/goja#Runtime.ToValue) documentation for more details.
+In order to implement a constructor function in Go use `func (sobek.ConstructorCall) *sobek.Object`.
+See [Runtime.ToValue()](https://pkg.go.dev/github.com/grafana/sobek#Runtime.ToValue) documentation for more details.
 
 Regular Expressions
 -------------------
 
-Goja uses the embedded Go regexp library where possible, otherwise it falls back to [regexp2](https://github.com/dlclark/regexp2).
+Sobek uses the embedded Go regexp library where possible, otherwise it falls back to [regexp2](https://github.com/dlclark/regexp2).
 
 Exceptions
 ----------
@@ -259,7 +259,7 @@ Any exception thrown in JavaScript is returned as an error of type *Exception. I
 by using the Value() method:
 
 ```go
-vm := goja.New()
+vm := sobek.New()
 _, err := vm.RunString(`
 
 throw("Test");
@@ -284,7 +284,7 @@ func Test() {
     panic(vm.ToValue("Error"))
 }
 
-vm = goja.New()
+vm = sobek.New()
 vm.Set("Test", Test)
 _, err := vm.RunString(`
 
@@ -315,7 +315,7 @@ func TestInterrupt(t *testing.T) {
     }
     `
 
-    vm := goja.New()
+    vm := sobek.New()
     time.AfterFunc(200 * time.Millisecond, func() {
         vm.Interrupt("halt")
     })
@@ -327,8 +327,3 @@ func TestInterrupt(t *testing.T) {
     // err is of type *InterruptError and its Value() method returns whatever has been passed to vm.Interrupt()
 }
 ```
-
-NodeJS Compatibility
---------------------
-
-There is a [separate project](https://github.com/dop251/goja_nodejs) aimed at providing some of the NodeJS functionality.
diff --git a/array.go b/array.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"fmt"
@@ -7,7 +7,7 @@ import (
 	"reflect"
 	"strconv"
 
-	"github.com/dop251/goja/unistring"
+	"github.com/grafana/sobek/unistring"
 )
 
 type arrayIterObject struct {

diff --git a/array_sparse.go b/array_sparse.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"fmt"
@@ -8,7 +8,7 @@ import (
 	"sort"
 	"strconv"
 
-	"github.com/dop251/goja/unistring"
+	"github.com/grafana/sobek/unistring"
 )
 
 type sparseArrayItem struct {

diff --git a/array_sparse_test.go b/array_sparse_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"testing"

diff --git a/array_test.go b/array_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"reflect"

diff --git a/ast/README.markdown b/ast/README.markdown
@@ -1,6 +1,6 @@
 # ast
 --
-    import "github.com/dop251/goja/ast"
+    import "github.com/grafana/sobek/ast"
 
 Package ast declares types representing a JavaScript AST.
 

diff --git a/ast/node.go b/ast/node.go
@@ -9,9 +9,9 @@ node types are concerned) and may change in the future.
 package ast
 
 import (
-	"github.com/dop251/goja/file"
-	"github.com/dop251/goja/token"
-	"github.com/dop251/goja/unistring"
+	"github.com/grafana/sobek/file"
+	"github.com/grafana/sobek/token"
+	"github.com/grafana/sobek/unistring"
 )
 
 type PropertyKind string

diff --git a/builtin_array.go b/builtin_array.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"math"

diff --git a/builtin_arrray_test.go b/builtin_arrray_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import "testing"
 

diff --git a/builtin_boolean.go b/builtin_boolean.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 func (r *Runtime) booleanproto_toString(call FunctionCall) Value {
 	var b bool

diff --git a/builtin_date.go b/builtin_date.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"fmt"

diff --git a/builtin_error.go b/builtin_error.go
@@ -1,6 +1,6 @@
-package goja
+package sobek
 
-import "github.com/dop251/goja/unistring"
+import "github.com/grafana/sobek/unistring"
 
 const propNameStack = "stack"
 

diff --git a/builtin_function.go b/builtin_function.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"math"

diff --git a/builtin_function_test.go b/builtin_function_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"testing"

diff --git a/builtin_global.go b/builtin_global.go
@@ -1,8 +1,8 @@
-package goja
+package sobek
 
 import (
 	"errors"
-	"github.com/dop251/goja/unistring"
+	"github.com/grafana/sobek/unistring"
 	"io"
 	"math"
 	"regexp"

diff --git a/builtin_global_test.go b/builtin_global_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"testing"

diff --git a/builtin_json.go b/builtin_json.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"bytes"
@@ -12,7 +12,7 @@ import (
 	"unicode/utf16"
 	"unicode/utf8"
 
-	"github.com/dop251/goja/unistring"
+	"github.com/grafana/sobek/unistring"
 )
 
 const hex = "0123456789abcdef"

diff --git a/builtin_json_test.go b/builtin_json_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"encoding/json"

diff --git a/builtin_map.go b/builtin_map.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"reflect"

diff --git a/builtin_map_test.go b/builtin_map_test.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"fmt"

diff --git a/builtin_math.go b/builtin_math.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"math"

diff --git a/builtin_number.go b/builtin_number.go
@@ -1,10 +1,10 @@
-package goja
+package sobek
 
 import (
 	"math"
 	"sync"
 
-	"github.com/dop251/goja/ftoa"
+	"github.com/grafana/sobek/ftoa"
 )
 
 func (r *Runtime) toNumber(v Value) Value {

diff --git a/builtin_object.go b/builtin_object.go
@@ -1,4 +1,4 @@
-package goja
+package sobek
 
 import (
 	"fmt"