Reorganize build.sbt. Add coverage tool.

.github/workflows/scala.yml

@@ -18,8 +18,11 @@ jobs:
       with:
         java-version: '11'
         distribution: 'adopt'
-    - name: Run tests
+    - name: Run tests for all versions
       run: sbt +test
-
+    - name: Run code coverage
+      run: sbt clean coverage test coverageReport
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,16 +1,66 @@
-out/
-target/
-project/target
-project/project
-docs/generated
-.addons-dont-touch
-/lib/
-/test_lib/
-/testbuild/
-obj_dir
-test_run_dir
-generated
+# Scala .gitignore
+#
+# JARs aren't checked in, they are fetched by sbt
+#
+/lib/*.jar
+/test/files/codelib/*.jar
+/test/files/lib/*.jar
+/test/files/speclib/instrumented.jar
+/tools/*.jar
+
+# Developer specific properties
+/build.properties
+/buildcharacter.properties
+
+# might get generated when testing Jenkins scripts locally
+/jenkins.properties
+
+# target directory for build
+/build/
+
+# other
+/out/
+/bin/
+/sandbox/
+
+# intellij
+/src/intellij*/*.iml
+/src/intellij*/*.ipr
+/src/intellij*/*.iws
+**/.cache
+/.idea
+/.settings
+
+# vscode
+/.vscode
+
+# Standard symbolic link to build/quick/bin
+/qbin
+
+# sbt's target directories
+/target/
+/project/**/target/
+/test/macro-annot/target/
+/test/files/target/
+/test/target/
+/build-sbt/
+local.sbt
+jitwatch.out
+
+# Used by the restarr/restarrFull commands as target directories
+/build-restarr/
+/target-restarr/
+
+# metals
 .metals
 .bloop
+project/**/metals.sbt
+project/metals.sbt
+
+# custom
 .bsp
-.vscode
+.addons-dont-touch
+.DS_Store
+generated
+docs/generated
+test_run_dir

Readme.md

@@ -2,6 +2,9 @@
 
 A generic library adding some frequently used methods in Scala and Chisel development.
 
+[![codecov.io](https://codecov.io/github/carlosedp/scalautils/coverage.svg?branch=master)]
+(https://codecov.io/github/carlosedp/scalautils?branch=master)
+
 ## Adding to your project
 
 ### SBT

build.sbt

@@ -1,39 +1,49 @@
-name := "scalautils"
-organization := "com.carlosedp"
-version := "0.4.0"
-scalaVersion := "2.13.6"
-
-homepage := Some(url("https://carlosedp.com"))
+ThisBuild / organization := "com.carlosedp"
+ThisBuild / version := "0.4.0"
+ThisBuild / scalaVersion := "2.13.6"
+ThisBuild / homepage := Some(url("https://carlosedp.com"))
 ThisBuild / licenses := Seq("MIT" -> url("https://opensource.org/licenses/MIT"))
-scmInfo := Some(ScmInfo(url("https://github.com/carlosedp/scalautils"), "git@github.com:carlosedp/scalautils.git"))
-developers := List(Developer("carlosedp", "carlosedp", "carlosedp@gmail.com", url("https://github.com/carlosedp")))
+ThisBuild / scmInfo := Some(
+  ScmInfo(url("https://github.com/carlosedp/scalautils"), "git@github.com:carlosedp/scalautils.git")
+)
+ThisBuild / developers := List(
+  Developer("carlosedp", "carlosedp", "carlosedp@gmail.com", url("https://github.com/carlosedp"))
+)
 semanticdbEnabled := true
-semanticdbVersion := "4.4.27"
+semanticdbVersion := "4.4.27" //scalafixSemanticdb.revision // Force version due to compatibility issues
+ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % "0.5.0"
 
-crossScalaVersions := Seq("2.11.12", "2.12.13", "2.13.6")
-publishConfiguration := publishConfiguration.value.withOverwrite(true)
-publishLocalConfiguration := publishLocalConfiguration.value.withOverwrite(true)
-publishMavenStyle := true
+lazy val root = (project in file("."))
+  .settings(
+    name := "scalautils",
+    crossScalaVersions := Seq("2.11.12", "2.12.13", "2.13.6", "3.0.2"),
+    libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.9",
+    sonatypeRepository := "https://s01.oss.sonatype.org/service/local",
+    sonatypeCredentialHost := "s01.oss.sonatype.org",
+    publishConfiguration := publishConfiguration.value.withOverwrite(true),
+    publishLocalConfiguration := publishLocalConfiguration.value.withOverwrite(true),
+    publishMavenStyle := true
+  )
 
-libraryDependencies += "org.scalatest"                     %% "scalatest"        % "3.2.9"
-ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % "0.5.0"
+ThisBuild / publishTo := {
+  val nexus = "https://s01.oss.sonatype.org/"
+  if (isSnapshot.value) Some("snapshots" at nexus + "content/repositories/snapshots")
+  else Some("releases" at nexus + "service/local/staging/deploy/maven2")
+}
 
-addCommandAlias("fix", "all compile:scalafix test:scalafix")
-addCommandAlias("fmt", "all scalafmtSbt scalafmtAll;all compile:scalafix test:scalafix")
+addCommandAlias("fix", "all Compile / scalafix Test / scalafix")
+addCommandAlias("fmt", "all scalafmtSbt scalafmtAll")
+addCommandAlias("lint", "fmt;fix")
 addCommandAlias("deps", "dependencyUpdates")
 addCommandAlias("xtest", "+test")
 addCommandAlias("release", "+publishSigned;sonatypeBundleRelease")
 
 scalacOptions ++= Seq(
+  "-deprecation",
+  "-explaintypes",
+  "-unchecked",
+  "-feature",
   "-Ywarn-value-discard",
   "-Ywarn-dead-code",
   "-Ywarn-unused"
 )
-
-sonatypeRepository := "https://s01.oss.sonatype.org/service/local"
-sonatypeCredentialHost := "s01.oss.sonatype.org"
-ThisBuild / publishTo := {
-  val nexus = "https://s01.oss.sonatype.org/"
-  if (isSnapshot.value) Some("snapshots" at nexus + "content/repositories/snapshots")
-  else Some("releases" at nexus + "service/local/staging/deploy/maven2")
-}

project/plugins.sbt

@@ -1,5 +1,6 @@
-addSbtPlugin("org.xerial.sbt"   % "sbt-sonatype" % "3.9.7")
-addSbtPlugin("com.jsuereth"     % "sbt-pgp"      % "2.0.1")
-addSbtPlugin("org.scalameta"    % "sbt-scalafmt" % "2.4.0")
-addSbtPlugin("ch.epfl.scala"    % "sbt-scalafix" % "0.9.27")
-addSbtPlugin("com.timushev.sbt" % "sbt-updates"  % "0.5.3")
+addSbtPlugin("org.xerial.sbt"   % "sbt-sonatype"  % "3.9.7")
+addSbtPlugin("com.jsuereth"     % "sbt-pgp"       % "2.0.1")
+addSbtPlugin("org.scalameta"    % "sbt-scalafmt"  % "2.4.0")
+addSbtPlugin("ch.epfl.scala"    % "sbt-scalafix"  % "0.9.27")
+addSbtPlugin("com.timushev.sbt" % "sbt-updates"   % "0.5.3")
+addSbtPlugin("org.scoverage"    % "sbt-scoverage" % "1.9.0")