Skip to content

Commit dc814e4

Browse files
joan38joan38
committed
Massively simplify getting started with Scala
1 parent 7ec2ca6 commit dc814e4

File tree

2 files changed

+77
-98
lines changed

2 files changed

+77
-98
lines changed

‎_data/setup-scala.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
linux-x86-64: curl -fL https://github.com/coursier/coursier/releases/latest/download/cs-x86_64-pc-linux.gz | gzip -d > cs && chmod +x cs && ./cs setup
2-
linux-arm64: curl -fL https://github.com/VirtusLab/coursier-m1/releases/latest/download/cs-aarch64-pc-linux.gz | gzip -d > cs && chmod +x cs && ./cs setup
3-
macOS-x86-64: curl -fL https://github.com/coursier/coursier/releases/latest/download/cs-x86_64-apple-darwin.gz | gzip -d > cs && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup
4-
macOS-arm64: curl -fL https://github.com/VirtusLab/coursier-m1/releases/latest/download/cs-aarch64-apple-darwin.gz | gzip -d > cs && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup
5-
macOS-brew: brew install coursier && coursier setup
6-
windows-link: https://github.com/coursier/coursier/releases/latest/download/cs-x86_64-pc-win32.zip
1+
macos-install-cli: brew install Virtuslab/scala-cli/scala-cli
2+
linux-install-cli: curl -sSLf https://scala-cli.virtuslab.org/get | sh
3+
windows-install-cli: winget install virtuslab.scalacli
4+
5+
macos-linux-launcher-cli: curl https://raw.githubusercontent.com/VirtusLab/scala-cli/refs/heads/main/scala-cli.sh > scala && chmod +x scala
6+
windows-launcher-cli: Invoke-WebRequest "https://raw.githubusercontent.com/VirtusLab/scala-cli/refs/heads/main/scala-cli.bat" -OutFile "scala.bat"

‎_overviews/getting-started/install-scala.md

+71-92
Original file line numberDiff line numberDiff line change
@@ -33,121 +33,100 @@ The instructions below cover both Scala 2 and Scala 3.
3333

3434
{% include inner-documentation-sections.html links=page.newcomer_resources %}
3535

36-
## Install Scala on your computer
36+
## Install the Scala CLI
3737

38-
Installing Scala means installing various command-line tools such as the Scala compiler and build tools.
39-
We recommend using the Scala installer tool "Coursier" that automatically installs all the requirements, but you can still manually install each tool.
38+
The Scala CLI is a powerful tool that allows you to compile and run Scala code without needing to install anything else
39+
(not even Java!). It is a great way to get started with Scala quickly. However, it is not a full build tool like
40+
[sbt](https://www.scala-sbt.org) or [Mill](https://mill-build.org). Please refer to their websites if you want to get
41+
started with them.
4042

41-
### Using the Scala Installer (recommended way)
43+
The Scala CLI can be installed on your computer for global access, and/or in your project directory as a launcher script
44+
for anyone to build your project without the need to install anything.\
45+
Installing on both your computer and in your project will cover you and anyone else trying to build your project!
4246

43-
The Scala installer is a tool named [Coursier](https://get-coursier.io/docs/cli-overview), whose main command is named `cs`.
44-
It ensures that a JVM and standard Scala tools are installed on your system.
45-
Install it on your system with the following instructions.
47+
### On your computer
4648

4749
<!-- Display tabs for each OS -->
48-
{% tabs install-cs-setup-tabs class=platform-os-options %}
50+
{% tabs install-scala-computer-os class=platform-os-options %}
4951

5052
<!-- macOS -->
51-
{% tab macOS for=install-cs-setup-tabs %}
52-
Run the following command in your terminal, following the on-screen instructions:
53-
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macOS-brew %}
54-
{% altDetails cs-setup-macos-nobrew "Alternatively, if you don't use Homebrew:" %}
55-
On the Apple Silicon (M1, M2, …) architecture:
56-
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macOS-arm64 %}
57-
Otherwise, on the x86-64 architecture:
58-
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macOS-x86-64 %}
59-
{% endaltDetails %}
53+
{% tab macOS for=install-scala-computer-os %}
54+
Install Scala CLI with [Homebrew](https://brew.sh/) by running the following one-line command in your terminal:
55+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macos-install-cli %}
56+
Follow [the documentation on Scala CLI's website](https://scala-cli.virtuslab.org/install) for more install options.
6057
{% endtab %}
6158
<!-- end macOS -->
6259

6360
<!-- Linux -->
64-
{% tab Linux for=install-cs-setup-tabs %}
65-
Run the following command in your terminal, following the on-screen instructions.
66-
67-
On the x86-64 architecture:
68-
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.linux-x86-64 %}
69-
Otherwise, on the ARM64 architecture:
70-
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.linux-arm64 %}
61+
{% tab Linux for=install-scala-computer-os %}
62+
Run the following one-line command in your terminal:
63+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.linux-install-cli %}
64+
Follow [the documentation on Scala CLI's website](https://scala-cli.virtuslab.org/install) for more install options.
7165
{% endtab %}
7266
<!-- end Linux -->
7367

7468
<!-- Windows -->
75-
{% tab Windows for=install-cs-setup-tabs %}
76-
Download and execute [the Scala installer for Windows]({{site.data.setup-scala.windows-link}})
77-
based on Coursier, and follow the on-screen instructions.
69+
{% tab Windows for=install-scala-computer-os %}
70+
Install Scala CLI with [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/winget/#install-winget)
71+
by running the following one-line command in your terminal:
72+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.windows-install-cli %}
73+
Follow [the documentation on Scala CLI's website](https://scala-cli.virtuslab.org/install) for more install options.
7874
{% endtab %}
7975
<!-- end Windows -->
8076

8177
<!-- Other -->
82-
{% tab Other for=install-cs-setup-tabs defaultTab %}
83-
<noscript>
84-
<p><span style="font-style:italic;">JavaScript is disabled, click the tab relevant for your OS.</span></p>
85-
</noscript>
86-
Follow the documentation from Coursier on
87-
[how to install and run `cs setup`](https://get-coursier.io/docs/cli-installation).
78+
{% tab Other for=install-scala-computer-os defaultTab %}
79+
<noscript>
80+
<p><span style="font-style:italic;">JavaScript is disabled, click the tab relevant for your OS.</span></p>
81+
</noscript>
82+
Follow [the documentation on Scala CLI's website](https://scala-cli.virtuslab.org/install) for more install options.
8883
{% endtab %}
8984
<!-- end Other -->
9085

9186
{% endtabs %}
92-
<!-- End tabs -->
93-
94-
> <i class="fa fa-info"></i>&nbsp;&nbsp; You may need to restart your terminal, log out,
95-
> or reboot in order for the changes to take effect.
96-
{: .help-info}
97-
98-
<!-- Alternative Detail - test the `scala` command -->
99-
{% altDetails testing-your-setup 'Testing your setup' %}
100-
Check your setup with the command `scala -version`, which should output:
101-
```bash
102-
$ scala -version
103-
Scala code runner version: 1.4.3
104-
Scala version (default): {{site.scala-3-version}}
105-
```
106-
{% endaltDetails %}
107-
<!-- end Alternative Detail -->
108-
109-
110-
Along with managing JVMs, `cs setup` also installs useful command-line tools:
111-
112-
| Commands | Description |
113-
|----------|-------------|
114-
| `scalac` | the Scala compiler |
115-
| `scala`, `scala-cli` | [Scala CLI](https://scala-cli.virtuslab.org), interactive toolkit for Scala |
116-
| `sbt`, `sbtn` | The [sbt](https://www.scala-sbt.org/) build tool |
117-
| `amm` | [Ammonite](https://ammonite.io/) is an enhanced REPL |
118-
| `scalafmt` | [Scalafmt](https://scalameta.org/scalafmt/) is the Scala code formatter |
119-
120-
For more information about `cs`, read
121-
[coursier-cli documentation](https://get-coursier.io/docs/cli-overview).
122-
123-
> `cs setup` installs the Scala 3 compiler and runner by default (the `scalac` and
124-
> `scala` commands, respectively). Whether you intend to use Scala 2 or 3,
125-
> this is usually not an issue because most projects use a build tool that will
126-
> use the correct version of Scala irrespective of the one installed "globally".
127-
> Nevertheless, you can always launch a specific version of Scala using
128-
> ```
129-
> $ cs launch scala:{{ site.scala-version }}
130-
> $ cs launch scalac:{{ site.scala-version }}
131-
> ```
132-
> If you prefer Scala 2 to be run by default, you can force that version to be installed with:
133-
> ```
134-
> $ cs install scala:{{ site.scala-version }} scalac:{{ site.scala-version }}
135-
> ```
136-
137-
### ...or manually
138-
139-
You only need two tools to compile, run, test, and package a Scala project: Java 8 or 11,
140-
and Scala CLI.
141-
To install them manually:
142-
143-
1. if you don't have Java 8 or 11 installed, download
144-
Java from [Oracle Java 8](https://www.oracle.com/java/technologies/javase-jdk8-downloads.html), [Oracle Java 11](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html),
145-
or [AdoptOpenJDK 8/11](https://adoptopenjdk.net/). Refer to [JDK Compatibility](/overviews/jdk-compatibility/overview.html) for Scala/Java compatibility detail.
146-
1. Install [Scala CLI](https://scala-cli.virtuslab.org/install)
87+
<!-- End tabs for each OS -->
88+
89+
### In your project
90+
91+
Download the Scala CLI launcher in your project directory:
92+
93+
<!-- Display tabs for each OS -->
94+
{% tabs install-scala-project-os class=platform-os-options %}
95+
96+
<!-- macOS/Linux -->
97+
{% tab macOS/Linux for=install-scala-project-os %}
98+
Run the following command in your terminal, following the on-screen instructions:
99+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macos-linux-launcher-cli %}
100+
{% endtab %}
101+
<!-- end macOS/Linux -->
102+
103+
<!-- Windows -->
104+
{% tab Windows for=install-scala-project-os %}
105+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.windows-launcher-cli %}
106+
{% endtab %}
107+
<!-- end Windows -->
108+
109+
<!-- Other -->
110+
{% tab Other for=install-scala-project-os defaultTab %}
111+
<noscript>
112+
<p><span style="font-style:italic;">JavaScript is disabled, click the tab relevant for your OS.</span></p>
113+
</noscript>
114+
Follow [the documentation on Scala CLI's website](https://scala-cli.virtuslab.org/install) for more install options.
115+
{% endtab %}
116+
<!-- end Other -->
117+
118+
{% endtabs %}
119+
<!-- End tabs for each OS -->
120+
121+
We recommend committing a scala executable for each OS together with your code so that
122+
everyone working on your project can compile and run the code without needing to install anything (not even Java).
147123

148124
## Using the Scala CLI
149125

150-
In a directory of your choice, which we will call `<project-dir>`, create a file named `hello.scala` with the following code:
126+
This section assumes you installed the Scala CLI on your computer. If you installed the Scala CLI in your project
127+
directory only, you should run the following commands with `./scala` instead of `scala`.
128+
129+
In your project directory, which we will call `<project-dir>`, create a file named `hello.scala` with the following code:
151130
```scala
152131
//> using scala {{site.scala-3-version}}
153132

@@ -202,7 +181,7 @@ We use the [os-lib](https://github.com/com-lihaoyi/os-lib) library from the [Sca
202181
for that purpose. A dependency on the library can be added with the `//> using` directive. Put the following code in `counter.scala`.
203182
```scala
204183
//> using scala {{site.scala-3-version}}
205-
//> using dep "com.lihaoyi::os-lib:0.10.7"
184+
//> using dep "com.lihaoyi::os-lib:0.11.4"
206185

207186
@main
208187
def countFiles(): Unit =
@@ -250,7 +229,7 @@ Type in expressions for evaluation. Or try :help.
250229
scala>
251230
```
252231

253-
Write a line of code to be executed and press enter.
232+
Write a line of code to be executed and press enter:
254233
```
255234
scala> println("Hello, World!")
256235
Hello, World!
@@ -266,7 +245,7 @@ val i: Int = 1
266245
scala>
267246
```
268247

269-
A new value of type `Int` has been created. If you provide an expression that can be evaluated, its result will be stored in an automatically created value.
248+
A new value of type `Int` has been created. If you provide an expression that can be evaluated, its result will be stored in an automatically created value:
270249
```
271250
scala> i + 3
272251
val res0: Int = 4

0 commit comments

Comments
 (0)