![Gitter](https://badges.gitter.im/Join Chat.svg)

Golo, a lightweight dynamic language for the JVM.

The world didn't need another JVM language. So we built yet another one. A simple one.

Golo is a simple dynamic, weakly-typed language for the JVM.

Built from day 1 with invokedynamic, Golo takes advantage of the latest advances of the JVM. It is also a showcase on how to build a language runtime with invokedynamic.

Eclipse Golo was originally being developed as part of the research activities of the DynaMid group of the CITI Laboratory at INSA-Lyon.

Golo is a mature Eclipse Technology Project.

Getting Golo

Golo follows the semantic versioning scheme.

Go to the Golo downloads page for general download instructions.

You can fetch Golo from Maven central under the org.eclipse.golo group.

We also provide Docker images based on Ubuntu 14.04 and Java SE 8: docker pull jponge/golo-lang (https://registry.hub.docker.com/u/jponge/golo-lang/)

Building Golo

Dependencies

Golo is built with Gradle. Since the source code contains the Gradle wrapper scripts, the build can bootstrap itself by downloading the qualified Gradle version from the Internet.

Golo needs Java SE 8 or more to build and run.

Building

Common tasks:

build: ./gradlew build
test: ./gradlew test
clean: ./gradlew clean
documentation: ./gradlew asciidoctor golodoc javadoc
assemble a working distribution in build/install: ./gradlew installDist
generate a nice JaCoCo tests coverage report: ./gradlew jacocoTestReport

The complete list of tasks is available by running ./gradlew tasks.

IDE support

Eclipse

You should use the buildship plugin.

Note that you may have to manually adjust the Java source paths to include build/generated/javacc and build/generated/jjtree.

Netbeans

Netbeans has a recommended community-suppprted Gradle plugin.

It works with no required manual adjustment on the Golo code base in our tests.

IntelliJ IDEA

Gradle support is native in IntelliJ IDEA.

Note that you may have to adjust the module settings to:

remove build from the excluded folders, and
add both build/generated/javacc and build/generated/jjtree as source folders, and
exclude other folders in build to reduce completion scopes.

Special build profiles

Bootstrap mode

Working on the compiler may cause your build to fail because proper compilation and bytecode generation doesn't work. In such cases the goloc task is likely to fail, and a wide range of unit tests will break because some Golo source files won't have been compiled.

You can activate the bootstrap mode for that, and focus solely on the Java parts:

./gradlew test -P bootstrap

Tests console output

By default Gradle redirects all tests console outputs, and makes them available from the HTML report found in build/reports/tests/index.html.

You can instead opt to have all console outputs:

./gradlew test -P consoleTraceTests

Verbose tests

It is often desirable to get more outputs from tests, like dumps of intermediate representation trees or generated JVM bytecode.

Such verbosity can be activated using:

./gradlew test -P traceTests

Of course you can combine profiles, like:

./gradlew test -P traceTests -P consoleTraceTests -P bootstrap

License

Copyright (c) 2012-2016 Institut National des Sciences Appliquées de Lyon (INSA-Lyon) and contributors

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html

Contributing

We welcome contributions from the community!

Check the CONTRIBUTING.md file for instructions.

sunbinbin1991/golo-lang