shapeless is a type class and dependent type based generic programming library for Scala. It had its origins in several talks by Miles Sabin (@milessabin), given over the course of 2011, on implementing scrap your boilerplate and higher rank polymorphism in Scala. Since then it has evolved from being a resolutely experimental project into library which, while still testing the limits of what's possible in Scala, is being used widely in production systems wherever there are arities to be abstracted over and boilerplate to be scrapped.
There is a wide variety of projects which use shapeless in one way or another ... see the incomplete list of projects for ideas and inspiration. If you are using shapeless and your project isn't listed yet, please add it.
A full feature overview of shapeless-2.2.0+ is in preparation. In the meantime, please refer to the release notes and the feature overview for shapeless-2.0.0 which can be found here. If you are upgrading from shapeless-2.0.0 you will find the migration guide useful.
shapeless is part of the Typelevel family of projects. It is an Open Source project under the Apache License v2, hosted on github. Binary artefacts are published to the Sonatype OSS Repository Hosting service and synced to Maven Central.
Most discussion of shapeless and generic programming in Scala happens on the shapeless Gitter channel. There is also a mailing list and IRC channel, but these are largely dormant now that most activity has moved to Gitter. Questions about shapeless are often asked and answered under the shapeless tag on StackOverflow. Some articles on the implementation techniques can be found on Miles's blog, and Olivera, Moors and Odersky, Type Classes as Object and Implicits is useful background material.
The shapeless project supports the Typelevel code of conduct and wants all of its channels (mailing list, Gitter, IRC, github, etc.) to be welcoming environments for everyone.
Whilst shapeless is a somewhat "advanced" Scala library, it is a lot more approachable than many people think. Contributors are usually available to field questions, give advice and discuss ideas on the Gitter channel, and for people wanting to take their first steps at contributing we have a selection of open issues flagged up as being good candidates to take on. No contribution is too small, and guidance is always available.
Binary release artefacts are published to the Sonatype OSS Repository Hosting service and synced to Maven Central. Snapshots of the master and scala-2.10.x branches are built using Travis CI and automatically published to the Sonatype OSS Snapshot repository. To include the Sonatype repositories in your SBT build you should add,
resolvers ++= Seq(
Resolver.sonatypeRepo("releases"),
Resolver.sonatypeRepo("snapshots")
)Please be aware that SBT 0.13.6 has an issue related to its new name hashing feature which when compiling with shapeless might cause SBT to loop indefinitely consuming all heap. Workarounds are to move to an earlier (0.13.5) or later (0.13.7, 0.13.8) SBT version or disable name hashing by adding,
incOptions := incOptions.value.withNameHashing(false)to your settings.
Builds are available for Scala 2.11.x and for Scala 2.10.x. The main line of development for shapeless 2.2.5 is Scala 2.11.7 with Scala 2.10.x supported via the macro paradise compiler plugin.
scalaVersion := "2.11.7"
libraryDependencies ++= Seq(
"com.chuusai" %% "shapeless" % "2.2.5"
)If you are using Scala 2.10.x, note that unlike earlier versions, it is no longer necessary to provide an explicit Scala version suffix for your shapeless dependency. You must however ensure that you are using Scala version 2.10.2 or greater, with Scala 2.10.6 (or switching to 2.11.x) strongly recommended. You should also add the macro paradise plugin to your build,
scalaVersion := "2.10.6"
libraryDependencies ++= Seq(
"com.chuusai" %% "shapeless" % "2.2.5",
compilerPlugin("org.scalamacros" % "paradise" % "2.0.1" cross CrossVersion.full)
)The shapeless-2.2.1 release accidentally broke binary compatability with shapeless-2.2.0 and has been deprecated. Please use shapeless-2.2.5 instead.
Please use a current release if possible. If unavoidable, you can find usage information for older releases on the shapeless wiki.
shapeless is built with SBT 0.13.8 or later, and its master branch is built with Scala 2.11.7 by default. To build with Scala 2.10.x you should check out the scala-2.10.x branch. As a general rule all new features and bugfixes are made against master and Scala 2.11.7 and merged into the scala-2.10.x branch with only the minimal changes needed for forwards compatibility.
- Alessandro Lacava [email protected] @lambdista
- Alexander Konovalov [email protected] @alexknvl
- Alexandre Archambault [email protected] @alxarchambault
- Alistair Johnson [email protected]
- Alois Cochard [email protected] @aloiscochard
- Andreas Koestler [email protected] @AndreasKostler
- Andrew Brett [email protected] @Ephemerix
- Ben Hutchison [email protected] @ben_hutchison
- Ben James [email protected] @bmjames
- Brian McKenna [email protected] @puffnfresh
- Bryn Keller [email protected] @brynkeller
- Chris Hodapp [email protected] @clhodapp
- Cody Allen [email protected] @fourierstrick
- Dale Wijnand [email protected] @dwijnand
- Dario Rexin [email protected] @evonox
- David Barri [email protected] @japgolly
- Denis Mikhaylov [email protected] @notxcain
- Eugene Burmako [email protected] @xeno_by
- Filipe Nepomuceno [email protected]
- Frank S. Thomas [email protected] @fst9000
- George Leontiev [email protected] @folone
- Howard Branch [email protected] @purestgreen
- Huw Giddens [email protected]
- Jason Zaugg [email protected] @retronym
- Jean-Remi Desjardins [email protected] @jrdesjardins
- Johannes Rudolph [email protected] @virtualvoid
- Johnny Everson [email protected] @johnny_everson
- Joni Freeman [email protected] @jonifreeman
- Julien Tournay [email protected] @skaalf
- Jules Gosnell [email protected]
- Kevin Wright [email protected] @thecoda
- Lars Hupel [email protected] @larsr_h
- Mario Pastorelli [email protected] @mapastr
- Mathias Doenitz [email protected] @sirthias
- Michael Donaghy [email protected]
- Michael Pilquist [email protected] @mpilquist
- Miles Sabin [email protected] @milessabin
- Nikolas Evangelopoulos [email protected]
- Oleg Aleshko [email protected] @OlegYch
- Owein Reese [email protected] @OweinReese
- Paolo G. Giarrusso [email protected] @blaisorblade
- Pascal Voitot [email protected] @mandubian
- Peter Schmitz [email protected] @peterschmitz_
- Renato Cavalcanti [email protected] @renatocaval
- Sam Halliday [email protected] @fommil
- Sarah Gerweck [email protected] @SGerweck
- Sébastien Doeraene [email protected] @sjrdoeraene
- Simon Hafner [email protected] @reactormonk
- Stacy Curl [email protected] @stacycurl
- Stephen Compall [email protected] @S11001001
- Tom Switzer [email protected] @tixxit
- Travis Brown [email protected] @travisbrown
- Vladimir Matveev [email protected] @netvlm