The code examples used in Programming Scala, 2nd and 3rd (forthcoming) Editions (O'Reilly)
| Key Dates | Description | | :---------------- | :---------- | | August 11, 2014 | 2nd edition examples | | May 27, 2019 | Updated for Scala 2.12 and 2.13 | | June 18, 2019 | New support for Maven builds, courtesy of oldbig | | October 12, 2019 | Updated for Scala 2.13.1, sbt 1.3.2, and other dependencies. Also now compiles with JDK 11 | | October 13, 2019 | Renamed the repo from
programming-scala-book-code-examples| | December 31, 2019 | Renamed the
progscala3and reworked most of the
*.scscripts for better testability and other improvements | | March 1, 2020 | Completed conversion to Scala 3 | | March 20, 2020 | Started incorporating new Scala 3 syntax, idioms | | November 11, 2020 | First Scala
3.0.0-M1milestone changes | | November 25, 2020 | First Scala
3.0.0-M2milestone changes | | December 19, 2020 | First Scala
3.0.0-M3milestone changes | | February 21, 2021 | Scala
3.0.0-RC1updates | | April 3, 2021 | Scala
3.0.0-RC2updates | | April 24, 2021 | Scala
This repo contains all the code examples to be included in Programming Scala, Third Edition. (The second edition is available here.) There are also many code files in this distribution that aren't included in the book.
When the second edition was published, the examples used Scala 2.11. The code has since been updated to also compile with Scala 2.12 and 2.13. Many examples are being improved, in part so they compile with newer library versions and with the stricter compiler flags now used. (ScalaTest, in particular, has changed a lot since the second edition.)
If you want the example code for the second edition (with some bug fixes and Scala 2.12-2.13 support), download the tagged 2.1.0 build or check out the
release-2.1.0branch. The latest
release-2.X.Ybranch include all the updates for 2.12 and 2.13. (No more
release-2.X.Yreleases are planned.) The third edition code for Scala 3 will be tagged with
001until the edition is published. Afterwards,
release-3.X.Ywill be used. These releases will be based off of
In the book's text, when an example corresponds to a file in this distribution, the listing begins with a path in a comment with the following format:
Following the usual conventions, tests are in
Use these comments to find the corresponding source file. This archive also contains MUnit and ScalaCheck unit tests to validate some of the code. Most of these tests are not reproduced in the text of the book.
The examples include "scripts" that are run with the
scalacommand-line "REPL" (read, eval, print loop) or using
sbt console. Other files are compiled.
To keep these different kinds of files straight and to support building with SBT, the following conventions are used for the files:
src/main/scala/.../*.scala- All Scala 3 source files built with SBT.
src/test/.../*.scala- All Scala 3 test source files built and executed with SBT.
src/script/.../*.scala- "Script" files that won't compile with
scalac, but can be interpreted with the
scalaREPL or used as a worksheet (see below).
src/*/scala-2/.../*.scala- Some Scala 2 source files that won't compile with Scala 3. They are not built with SBT.
You won't find many comments in the code, except of the form
// <1>, which get converted into markers corresponding to notes in the book. All the descriptions of the code are in the book, so they aren't repeated as code comments.
Some files have sections marked like this:
// tag::section1 // end::section1
These are used to mark sections that are selectively included in the book. Sometimes the whole file is included in sections, while other times the file has content that isn't included ("Bonus!!").
To build and run the examples, all you need is a recent version of the the JDK and SBT, the de-facto standard build tool for Scala. When you run SBT, it will bootstrap itself with the correct version of its jar file, Scala, and project dependencies, which are specified in the
build.sbtfile in the root directory and other build files in the
Follow these installation instructions.
If you want to install Scala separately and Scala's Scaladocs, go to scala-lang.org for details. However, this isn't required.
If you want to play with the Spark example,
src/script/scala-2/progscala3/bigdata/SparkWordCount.scala, you'll need to download a Spark distribution from https://spark.apache.org and use a compatible version of Scala, 2.12 (at the time of this writing). With that version of Scala on your path and assuming that
$SPARK_HOMErefers to the root directory of your Spark installations, run the following command in the root directory of this project:
$ $SPARK_HOME/bin/spark-shell ... scala>
Then paste the content of
SparkWordCount.scalaat the prompt. After it runs, there will be a new directory,
README.md.wordcountwith the partition files of the output.
Tip: For more on Spark, see my free tutorial on GitHub, spark-scala-tutorial.
NOTE: Support for Scala 3 may be limited for a while in the following tools.
Most editors and IDEs now have some sort of Scala support:
For other IDEs and text editors, try Scala Metals first (I've used it with Sublime Text, for example) or the older ENSIME project. You may also need additional, third-party tools for syntax highlighting, etc.
After installing the required plugins, load this project in your IDE, which should detect and use the SBT project automatically. For eclipse, run the
sbt eclipsetask to generate project files, then import them.
If you like working with Scala worksheets in your IDE or editor, you may be able to load any of the REPL "script" files under
src/scriptas a worksheet. If your environment is more restrictive, for example about the extension used, then run the included
./make-worksheets.shto copy all the REPL "script" examples to worksheet files. This command copies the tree
src/worksheetand changes the
.scalaextension for all the files to
.worksheet.sc, the VSCode convention. These behaviors are configurable. Use the
--helpoption to see the details. If you are using Windows and you don't have
bashavailable, e.g., through the Linux subsystem, then modify individual files as you see fit.
See this Dotty documentation page for more information about worksheets.
After installing SBT, open a command/terminal window and run the
You'll see lots of output as it downloads all the dependencies, compiles the code and runs the tests. You should see
[success]messages at the end.
SBT is discussed in more detail in the book and the SBT website, but a few useful commands are worth mentioning here.
If you start
sbtwithout any arguments, it puts you into an interactive mode where you can type commands. Use control-D to exit this mode. Once at the SBT prompt (
sbt:programming-scala-3rd-ed-code-examples>), try the following commands, where each
#starts a comment; don't type those!
help # help on tasks and settings clean # delete all build outputs compile # compile the source, but not test code test # compile source and test code, if necessary and run the tests. ~test # continuously compile and test when source changes are saved. console # run the Scala REPL; dependencies and code are on the CLASSPATH tasks # show the most common tasks (commands). tasks -V # REALLY show ALL tasks
~prefix causes the task to be run continuously each time source code changes are saved. This promotes continuous TDD (test-driven development) and is one of my favorite features!
Outside of SBT, you could, in principle, run the script files manually at the console/terminal prompt.
However, at the time of this writing, the
scalaREPL for the preview versions of Scala 3 do not support loading script files like this. Hopefully the final version of Scala 3 will restore this ability. Actually, it's easier to run many of the scripts using the SBT
consoletask, at least those that use libraries or other compiled code that SBT has on the
CLASSPATHalready. Use the REPL's
:load src/script/scala/.../Foo.scalafeature to load and run a script file. You can also work with these files as Scala worksheets, as discussed above.
I welcome feedback on the Book and these examples. Please post comments, corrections, etc. to one of the following places:
There is also a dedicated site for the book where occasional updates, clarifications, corrections, and lame excuses will be posted: programming-scala.org.