https://github.com/scalacenter/scastie
An interactive playground for Scala
https://github.com/scalacenter/scastie
online-repl sbt
Last synced: 6 months ago
JSON representation
An interactive playground for Scala
- Host: GitHub
- URL: https://github.com/scalacenter/scastie
- Owner: scalacenter
- License: apache-2.0
- Created: 2016-11-22T15:42:38.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T09:29:07.000Z (almost 2 years ago)
- Last Synced: 2023-12-19T11:43:24.309Z (almost 2 years ago)
- Topics: online-repl, sbt
- Language: Scala
- Homepage: https://scastie.scala-lang.org
- Size: 20.3 MB
- Stars: 416
- Watchers: 20
- Forks: 100
- Open Issues: 101
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](
https://gitter.im/scalacenter/scastie
)
# [Scastie](https://scastie.scala-lang.org)
## What is Scastie?
Scastie is sbt in your browser. You can:
* Use any version of Scala
* Use alternate backends such as Scala 3, Scala.js, Scala Native, and Typelevel Scala.
* Use any publicly available library
* Share Scala programs with anybody
* Embed Scastie into your own website or library user guide.
## How does it work?
When a user evaluates their code, the browser sends all its input to our server.
We run your code in an isolated Java Virtual Machine on our servers.
We integrated a Scaladex interface to allow you to search the Scala ecosystem
and include any published Scala library in your project. You don’t need to
remember what the latest version number of a particular library is anymore!
The output is streamed back to the user. A protocol will allow
the client to interpret different events such as compiler errors,
runtime exceptions, instrumentation, console output, etc.
We also support a worksheet mode, which feels much like a worksheet in an IDE.
It lets a user write code as top-level expressions, without having to put
your code inside of a class or object with a main method. Worksheet mode gives you two ways to interleave your results; on the one hand, when an expression
is evaluated, you can see the value and type of the evaluated expression
to the right of the code that you wrote. On the other hand, worksheet mode
also makes it possible to do a kind of literate programming; that is, you
may interleave code and HTML blocks much like in notebook environments
such as iPython notebooks.
## How do I embed Scastie?
You can embed a snippet with two different ways. You can embed a resource that
was previously saved or you can convert code to a snippet.
### Embedded Resources
#### Via HTML
Any saved resource can be embedded via a script tag by appending ".js" to its URL.
```html
```
The embedding will be patched at the location of the script tag.
It's also possible to adjust the theme via the GET parameter theme. For example:
```html
```
The theme can be `dark` or `light`. The default value is `light`. It's also possible to customize the css.
Take a look at: https://codepen.io/olegych/pen/OJXVYoR
#### Via Javascript
```html
window.addEventListener('load', function() {
scastie.Embedded('#resource-1', {
base64UUID: "CJ8KTL98QAiWvoVUPI3kXg"
});
scastie.Embedded('#resource-2', {
user: "MasseGuillaume",
base64UUID: "33D4P3ysQCq2em2MRiv5sQ"
});
scastie.Embedded('#resource-3', {
user: "MasseGuillaume",
base64UUID: "33D4P3ysQCq2em2MRiv5sQ",
update: 1
});
});
```
Take a look at: https://codepen.io/MasseGuillaume/pen/aLpzvW
### Converting Code Into Snippets
It's also possible to convert code into a snippet. The preferred way is to embed
a snippet since it's output is cached. This mode will compile and run the snippet
every time it's accessed.
```html
1 + 1
import org.scalajs.dom
import org.scalajs.dom.raw.HTMLImageElement
val img = dom.document.createElement("img").asInstanceOf[HTMLImageElement]
img.alt = "such dog"
img.src = "https://goo.gl/a3Xr41"
img
window.addEventListener('load', function() {
// DOM selector without build options
scastie.Embedded('.simple');
// with some options
scastie.Embedded('.scala-js', { targetType: 'js' });
// all option
scastie.Embedded('.full', {
theme: 'light', // default: 'light'; ('dark' or 'light')
code: '1 + 1', // default: DOM node content
isWorksheetMode: true,
sbtConfig: 'libraryDependencies += "org.json4s" %% "json4s-native" % "3.5.2"',
targetType: 'jvm', // jvm, dotty, typelevel, js
scalaVersion: '2.12.4'
});
// Setting Scala-Native targetType is not yet supported: https://github.com/scalacenter/scastie/issues/50
// Setting Scala.js version is not yet supported: https://github.com/scalacenter/scastie/issues/228
});
```
Take a look at: https://codepen.io/MasseGuillaume/pen/OxbVzm
## Try library
You can pass your library to Scastie like this:
https://scastie.scala-lang.org/try?g=com.typesafe.play&a=play&v=2.8.12&t=JVM&sv=2.13&o=playframework&r=playframework
The parameters are:
* g - maven group id, required
* a - maven artifact id, required
* v - maven artifact version, required
* t - target type, one of JVM|DOTTY|JS, required
* sv - scala version, required, can be partial like 2.12
* sjsv - scala.js version, optional
* o - scaladex organization, required for proper display of your library in build settings
* r - scaladex repository, required for proper display of your library in build settings
* c - initial snippet code, optional
## Configure snippet via query params
You can also pass full inputs json like this:
https://scastie.scala-lang.org/?inputs=%7B%0A%20%20%20%20%22_isWorksheetMode%22%20%3A%20true%2C%0A%20%20%20%20%22code%22%20%3A%20%221%20%2B%201%22%2C%0A%20%20%20%20%22target%22%20%3A%20%7B%0A%20%20%20%20%20%20%22scalaVersion%22%20%3A%20%223.1.1%22%2C%0A%20%20%20%20%20%20%22tpe%22%20%3A%20%22Scala3%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22libraries%22%20%3A%20%5B%20%5D%2C%0A%20%20%20%20%22librariesFromList%22%20%3A%20%5B%20%5D%2C%0A%20%20%20%20%22sbtConfigExtra%22%20%3A%20%22scalacOptions%20%2B%2B%3D%20Seq%28%5Cn%20%20%5C%22-deprecation%5C%22%2C%5Cn%20%20%5C%22-encoding%5C%22%2C%20%5C%22UTF-8%5C%22%2C%5Cn%20%20%5C%22-feature%5C%22%2C%5Cn%20%20%5C%22-unchecked%5C%22%5Cn%29%22%2C%0A%20%20%20%20%22sbtPluginsConfigExtra%22%20%3A%20%22%22%2C%0A%20%20%20%20%22isShowingInUserProfile%22%20%3A%20true%0A%7D
See the format here:
https://github.com/scalacenter/scastie/blob/b5feb3278837cbe3393e4598f32ab84f16aa25ba/api/src/main/scala/com.olegych.scastie.api/Inputs.scala#L61
# Supports
Scastie is supported by the Scala Center
[](https://scala.epfl.ch/)
with the help of Browser Stack for end-to-end testing
[](https://browserstack.com)