Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcuadros/go-candyjs
fully transparent bridge between Go and the JavaScript
https://github.com/mcuadros/go-candyjs
Last synced: 27 days ago
JSON representation
fully transparent bridge between Go and the JavaScript
- Host: GitHub
- URL: https://github.com/mcuadros/go-candyjs
- Owner: mcuadros
- License: mit
- Archived: true
- Created: 2015-06-03T16:36:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-05T05:18:55.000Z (about 7 years ago)
- Last Synced: 2024-02-14T23:34:40.098Z (10 months ago)
- Language: Go
- Homepage:
- Size: 1.05 MB
- Stars: 455
- Watchers: 21
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - go-candyjs - fully transparent bridge between Go and the JavaScript (Go)
README
go-candyjs [](https://travis-ci.org/mcuadros/go-candyjs) [](https://coveralls.io/r/mcuadros/go-candyjs?branch=master) [](http://godoc.org/github.com/mcuadros/go-candyjs) [](https://github.com/mcuadros/go-candyjs/releases)
==========
*CandyJS* is an intent of create a fully **transparent bridge between Go and the
JavaScript** engine [duktape](http://duktape.org/). Basicly is a syntax-sugar
library built it on top of [go-duktape](https://github.com/olebedev/go-duktape)
using reflection techniques.
#### ok but what for ...
build extensible applications that allow to the user **execute** arbitrary
**code** (let's say plugins) **without** the requirement of **compile** it.
Demo
----
[](https://asciinema.org/a/21430)
Features
--------
Embeddable **Ecmascript E5/E5.1 compliant** engine ([duktape](http://duktape.org/)).
```go
ctx := candyjs.NewContext()
ctx.EvalString(`
function factorial(n) {
if (n === 0) return 1;
return n * factorial(n - 1);
}
print(factorial(10));
`) //3628800
```
Call **Go functions** from JavaScript and vice versa.
```go
ctx := candyjs.NewContext()
ctx.PushGlobalGoFunction("golangMultiply", func(a, b int) int {
return a * b
})
ctx.EvalString(`print(golangMultiply(5, 10));`) //50
```
Transparent interface between **Go structs** and JavaScript.
```go
type MyStruct struct {
Number int
}
func (m *MyStruct) Multiply(x int) int {
return m.Number * x
}
...
ctx := candyjs.NewContext()
ctx.PushGlobalStruct("golangStruct", &MyStruct{10})
ctx.EvalString(`print(golangStruct.number);`) //10
ctx.EvalString(`print(golangStruct.multiply(5));`) //50
```
Import of **Go packages** into the JavaScript context.
```go
//go:generate candyjs import fmt
...
ctx := candyjs.NewContext()
ctx.EvalString(`
var fmt = CandyJS.require('fmt');
fmt.printf('candyjs is %s', 'awesome')
`) // 'candyjs is awesome'
```
Installation
------------
The recommended way to install go-candyjs is:
```
go get -u github.com/mcuadros/go-candyjs/...
```
> *CandyJS* includes a binary tool used by [go generate](http://blog.golang.org/generate),
please be sure that `$GOPATH/bin` is on your `$PATH`
Examples
--------
### JavaScript running a HTTP server
In this example a [`gin`](https://github.com/gin-gonic/gin) server is executed
and a small JSON is server. In CandyJS you can import Go packages directly if
they are [defined](https://github.com/mcuadros/go-candyjs/blob/master/examples/complex/main.go#L10:L13)
previously on the Go code.
**Interpreter code** (`main.go`)
```go
...
//go:generate candyjs import time
//go:generate candyjs import github.com/gin-gonic/gin
func main() {
ctx := candyjs.NewContext()
ctx.PevalFile("example.js")
}
```
**Program code** (`example.js`)
```js
var time = CandyJS.require('time');
var gin = CandyJS.require('github.com/gin-gonic/gin');
var engine = gin.default();
engine.get("/back", CandyJS.proxy(function(ctx) {
var future = time.date(2015, 10, 21, 4, 29 ,0, 0, time.UTC);
var now = time.now();
ctx.json(200, {
future: future.string(),
now: now.string(),
nsecs: future.sub(now)
});
}));
engine.run(':8080');
```
Caveats
-------
Due to an [incompatibility](https://github.com/svaarala/duktape/issues/154#issuecomment-87077208) with Duktape's error handling system and Go, you can't throw errors from Go. All errors generated from Go functions are generic ones `error error (rc -100)`
License
-------
MIT, see [LICENSE](LICENSE)