Merge pull request #22 from scala-exercises/updates-project

Updates Project

Author: juanpedromoreno

.scalafmt.conf

@@ -0,0 +1,23 @@
+version=2.4.2
+style = defaultWithAlign
+maxColumn = 100
+
+continuationIndent.callSite = 2
+
+newlines {
+  sometimesBeforeColonInMethodReturnType = false
+}
+
+align {
+  arrowEnumeratorGenerator = false
+  ifWhileOpenParen = false
+  openParenCallSite = false
+  openParenDefnSite = false
+}
+
+docstrings = JavaDoc
+
+rewrite {
+  rules = [SortImports, RedundantBraces]
+  redundantBraces.maxLines = 1
+}

.travis.yml

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
+      boilerplate notice, with the fields enclosed by brackets "[]"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright (C)  2016-2020 47 Degrees <https://47deg.com>
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

LICENSE renamed to LICENSE.md

@@ -1,6 +1,5 @@
 # Scala Exercises - template library
 
-------------------------
 
 This repository hosts a template content library for the [Scala Exercises](https://www.scala-exercises.org/) platform, in order to make the creation process of content libraries easier.
 

README.md

@@ -1,26 +1,15 @@
-val scalaExercisesV = "0.5.0-SNAPSHOT"
+addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; test")
+addCommandAlias("ci-docs", "github; project-docs/mdoc; headerCreateAll")
 
-def dep(artifactId: String) = "org.scala-exercises" %% artifactId % scalaExercisesV
-
-lazy val template = (project in file("."))
+lazy val exercises = (project in file("."))
+  .settings(moduleName := "exercises-template")
+  .settings(exercisesSettings)
   .enablePlugins(ExerciseCompilerPlugin)
-  .settings(
-    organization := "org.scala-exercises",
-    name := "exercises-template",
-    scalaVersion := "2.12.10",
-    version := "0.5.0-SNAPSHOT",
-    resolvers ++= Seq(
-      Resolver.sonatypeRepo("snapshots"),
-      Resolver.sonatypeRepo("releases")
-    ),
-    libraryDependencies ++= Seq(
-      dep("exercise-compiler"),
-      dep("definitions"),
-      %%("shapeless", "2.3.3"),
-      %%("scalatest", "3.1.1"),
-      %%("scalacheck", "1.14.3"),
-      "com.github.alexarchambault" %% "scalacheck-shapeless_1.14" % "1.2.5",
-      "org.scalatestplus" %% "scalatestplus-scalacheck" % "3.1.0.0-RC2"
-    ),
-    addCompilerPlugin("org.typelevel" %% "kind-projector" % "0.11.0" cross CrossVersion.full)
-  )
+
+lazy val `project-docs` = (project in file(".docs"))
+  .aggregate(exercises)
+  .settings(moduleName := "exercises-project-docs")
+  .settings(mdocIn := file(".docs"))
+  .settings(mdocOut := file("."))
+  .settings(skip in publish := true)
+  .enablePlugins(MdocPlugin)

build.sbt

@@ -0,0 +1,49 @@
+import sbt.Keys._
+import sbt._
+import com.alejandrohdezma.sbt.github.SbtGithubPlugin
+
+object ProjectPlugin extends AutoPlugin {
+
+  override def trigger: PluginTrigger = allRequirements
+
+  override def requires: Plugins = plugins.JvmPlugin && SbtGithubPlugin
+
+  object autoImport {
+
+    lazy val V = new {
+      val shapeless: String           = "2.3.3"
+      val scala: String               = "2.13.2"
+      val scalaExercises: String      = "0.6.0-SNAPSHOT"
+      val scalacheck: String          = "1.14.3"
+      val scalacheckShapeless: String = "1.2.5"
+      val scalatest: String           = "3.1.1"
+      val scalatestplusScheck: String = "3.1.1.1"
+    }
+
+    def dep(artifactId: String) = "org.scala-exercises" %% artifactId % V.scalaExercises
+
+    lazy val exercisesSettings = Seq(
+      libraryDependencies ++= Seq(
+        dep("exercise-compiler"),
+        dep("definitions"),
+        "com.chuusai"                %% "shapeless"                 % V.shapeless,
+        "org.scalatest"              %% "scalatest"                 % V.scalatest,
+        "org.scalacheck"             %% "scalacheck"                % V.scalacheck,
+        "org.scalatestplus"          %% "scalacheck-1-14"           % V.scalatestplusScheck,
+        "com.github.alexarchambault" %% "scalacheck-shapeless_1.14" % V.scalacheckShapeless
+      )
+    )
+  }
+
+  override def projectSettings: Seq[Def.Setting[_]] =
+    Seq(
+      organization := "org.scala-exercises",
+      organizationName := "47 Degrees",
+      organizationHomepage := Some(url("https://47deg.com")),
+      scalaVersion := autoImport.V.scala,
+      resolvers ++= Seq(
+        Resolver.sonatypeRepo("snapshots"),
+        Resolver.sonatypeRepo("releases")
+      )
+    )
+}

project/ProjectPlugin.scala

@@ -1 +1 @@
-sbt.version = 1.3.8
+sbt.version = 1.3.10

project/build.properties

@@ -1,3 +1,10 @@
 resolvers += Resolver.sonatypeRepo("snapshots")
-addSbtPlugin("com.47deg"         % "sbt-org-policies" % "0.13.3")
-addSbtPlugin("org.scala-exercises" % "sbt-exercise" % "0.5.0-SNAPSHOT")
+addSbtPlugin("org.scala-exercises" % "sbt-exercise"      % "0.6.0-SNAPSHOT")
+addSbtPlugin("com.geirsson"        % "sbt-ci-release"    % "1.5.3")
+addSbtPlugin("org.scalameta"       % "sbt-mdoc"          % "2.1.5")
+addSbtPlugin("org.scalameta"       % "sbt-scalafmt"      % "2.3.4")
+addSbtPlugin("de.heikoseeberger"   % "sbt-header"        % "5.6.0")
+addSbtPlugin("com.alejandrohdezma" %% "sbt-github"       % "0.8.0")
+addSbtPlugin("com.alejandrohdezma" % "sbt-github-header" % "0.8.0")
+addSbtPlugin("com.alejandrohdezma" % "sbt-github-mdoc"   % "0.8.0")
+addSbtPlugin("com.alejandrohdezma" % "sbt-mdoc-toc"      % "0.2")

project/plugins.sbt

@@ -18,13 +18,13 @@ package templatelib
 import org.scalaexercises.definitions._
 
 /** This is the description of the library as it will appear in the Scala Exercises website.
-  *
-  * @param name template
-  */
+ *
+ * @param name template
+ */
 object MyLibrary extends Library {
-  override def owner = "scala-exercises"
+  override def owner      = "scala-exercises"
   override def repository = "scala-exercises"
-  override def color = Some("#323232")
+  override def color      = Some("#323232")
 
   override def sections = List(
     SectionA

src/main/scala/templatelib/MyLibrary.scala

@@ -21,27 +21,25 @@ import org.scalaexercises.definitions._
 import org.scalatest.flatspec.AnyFlatSpec
 
 /** @param name section_title
-  */
+ */
 object SectionA extends AnyFlatSpec with Matchers with Section {
 
   /** = Exercise block title =
-    *
-    * Text describing background about the exercise, can be as long as needed.
-    *
-    * {{{
-    *   // Scala code blocks can also be added to enhance your documentation.
-    * }}}
-    *
-    * Also, documentation can be broken in as many paragraphs as necessary.
-    */
-  def functionAssert(res0: Boolean): Unit = {
+   *
+   * Text describing background about the exercise, can be as long as needed.
+   *
+   * {{{
+   *   // Scala code blocks can also be added to enhance your documentation.
+   * }}}
+   *
+   * Also, documentation can be broken in as many paragraphs as necessary.
+   */
+  def functionAssert(res0: Boolean): Unit =
     true shouldBe res0
-  }
 
   /** And obviously you can add as many documentation and exercises as you need
-    * to make your point ;-).
-    */
-  def functionFalseAssert(res0: Boolean): Unit = {
+   * to make your point ;-).
+   */
+  def functionFalseAssert(res0: Boolean): Unit =
     false shouldBe res0
-  }
 }