Merge branch 'topic/mima' into issue/445

armanbilge · armanbilge · commit 2d415e1d0f1f · 2021-08-12T23:36:09.000Z
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+Hi there!
+
+Before submitting a PR containing any Scala changes, please make sure you...
+
+* run `sbt prePR`
+* commit changes to `api-reports`
+
+Thanks for contributing!
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,16 @@
+name-template: 'v$NEXT_PATCH_VERSION'
+tag-template: 'v$NEXT_PATCH_VERSION'
+template: |
+  # What's Changed
+  $CHANGES
+categories:
+  - title: 'New'
+    label: 'type: feature'
+  - title: 'Bug Fixes'
+    label: 'type: bug'
+  - title: 'Maintenance'
+    label: 'type: maintenance'
+  - title: 'Documentation'
+    label: 'type: docs'
+  - title: 'Dependency Updates'
+    label: 'type: dependencies'
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,20 +21,33 @@ jobs:
     env:
       SCALAJS_VERSION: "${{ matrix.scalajsversion == '0.6.x' && '0.6.28' || '' }}"
     steps:
+
       - uses: actions/checkout@v2
       - uses: olafurpg/setup-scala@v13
         with:
           java-version: "adopt@1.8"
       - uses: coursier/cache-action@v6
+
+      - name: Hacks for Scala 2.10
+        if: matrix.scalaversion == '2.10.7'
+        run: ./prepareForScala210.sh
+
       - name: Build
         run: sbt "++${{ matrix.scalaversion }}" package
+
       - name: Test generate documentation
         run: sbt "++${{ matrix.scalaversion }}" doc
+
       - name: Build examples
         run: sbt "++${{ matrix.scalaversion }}" example/compile
-      - name: scalafmt
+
+      - name: Validate formatting
         run: sbt "++${{ matrix.scalaversion }}" scalafmtCheck
 
+      - name: Validate api report
+        if: matrix.scalajsversion == '1.x' && matrix.scalaversion != '2.11.12'
+        run: ./api-reports/validate "${{ matrix.scalaversion }}"
+
   readme:
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,17 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+      - series/1.x
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,24 @@
+name: Release
+on:
+  push:
+    branches: ["master", "series/1.x"]
+    tags: ["v*"]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        scalajsversion: ["1.x", "0.6.x"]
+    env:
+      SCALAJS_VERSION: "${{ matrix.scalajsversion == '0.6.x' && '0.6.28' || '' }}"
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: olafurpg/setup-scala@v13
+      - run: sbt ci-release
+        env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@
 .idea_modules
 .metals
 .project
+.sbtboot
 .settings/
 .vscode
 metals.sbt
diff --git a/.scalafix.conf b/.scalafix.conf
@@ -0,0 +1,3 @@
+rules = [
+  GenerateApiReport,
+]
diff --git a/README.md b/README.md
@@ -1 +1 @@
-[Documentation](http://scala-js.github.io/scala-js-dom)
+[Documentation](http://scala-js.github.io/scala-js-dom) / [Scaladoc](https://javadoc.io/doc/org.scala-js/scalajs-dom_sjs1_2.13)
diff --git a/api-reports/2_12.txt b/api-reports/2_12.txt
diff --git a/api-reports/2_13.txt b/api-reports/2_13.txt
diff --git a/api-reports/validate b/api-reports/validate
@@ -0,0 +1,21 @@
+#!/bin/bash
+set -euo pipefail
+cd "$(dirname "$0")"
+
+[ $# -ne 1 ] && echo "Usage: $0 <scala version>" && exit 1
+
+series="${1%.*}"
+file="${series/./_}.txt"
+echo -n "Validating $file ... "
+
+help='Run `sbt +compile` and check in the differences to the '"$(basename "$0") directory"
+
+if [ ! -e "$file" ]; then
+  echo "file not found. $help"
+  exit 2
+elif [ -n "$(git status --porcelain -- "$file")" ]; then
+  echo "out-of-date. $help"
+  exit 3
+else
+  echo "ok"
+fi
diff --git a/build.sbt b/build.sbt
@@ -1,7 +1,19 @@
+import _root_.scalafix.sbt.BuildInfo.scalafixVersion // delete if Scala 2.10
 import scalatex.ScalatexReadme
 
-lazy val root = project.in(file(".")).
-  enablePlugins(ScalaJSPlugin)
+ThisBuild / shellPrompt := ((s: State) => Project.extract(s).currentRef.project + "> ")
+
+lazy val scalafixRules = project
+  .in(file("scalafix"))
+  .settings(
+    libraryDependencies += "ch.epfl.scala" %% "scalafix-core" % scalafixVersion, // delete if Scala 2.10
+  )
+
+lazy val root = project
+  .in(file("."))
+  .enablePlugins(ScalaJSPlugin)
+  .enablePlugins(ScalafixPlugin) // delete if Scala 2.10
+  .dependsOn(scalafixRules % ScalafixConfig) // delete if Scala 2.10
 
 name := "Scala.js DOM"
 
@@ -12,11 +24,14 @@ ThisBuild / crossScalaVersions := {
 ThisBuild / scalaVersion := crossScalaVersions.value.head
 
 val commonSettings = Seq(
-  version := "1.2.0-SNAPSHOT",
   organization := "org.scala-js",
   scalacOptions ++= Seq("-deprecation", "-feature", "-Xfatal-warnings")
 )
 
+val noPublishSettings = Seq(
+  publish / skip := true
+)
+
 normalizedName := "scalajs-dom"
 
 commonSettings
@@ -58,21 +73,6 @@ scalacOptions ++= {
   else Nil
 }
 
-scmInfo := Some(ScmInfo(
-    url("https://github.com/scala-js/scala-js-dom"),
-    "scm:git:git@github.com:scala-js/scala-js-dom.git",
-    Some("scm:git:git@github.com:scala-js/scala-js-dom.git")))
-
-publishMavenStyle := true
-
-publishTo := {
-  val nexus = "https://oss.sonatype.org/"
-  if (isSnapshot.value)
-    Some("snapshots" at nexus + "content/repositories/snapshots")
-  else
-    Some("releases" at nexus + "service/local/staging/deploy/maven2")
-}
-
 pomExtra := (
     <developers>
       <developer>
@@ -115,9 +115,22 @@ lazy val readme = ScalatexReadme(
   scalaVersion := "2.12.10",
   scalacOptions ++= Seq("-deprecation", "-feature", "-Xfatal-warnings"),
   (Compile / resources) += (example / Compile / fullOptJS).value.data
-)
+).settings(noPublishSettings: _*)
 
 lazy val example = project.
   enablePlugins(ScalaJSPlugin).
   settings(commonSettings: _*).
+  settings(noPublishSettings: _*).
   dependsOn(root)
+
+addCommandAlias("prePR", "+prePR_nonCross")
+
+val prePR_nonCross = taskKey[Unit]("Performs all necessary work required before submitting a PR, for a single version of Scala.")
+
+ThisBuild / prePR_nonCross := Def.sequential(
+  root / clean,
+  root / Compile / scalafmt,
+  root / Compile / compile,
+  (root / Compile / scalafix).toTask(""), // delete if Scala 2.10
+  example / Compile / compile,
+).value
diff --git a/prepareForScala210.sh b/prepareForScala210.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+cd "$(dirname "$0")"
+
+sed -i -e '/delete if Scala 2.10/d' *.sbt project/*.sbt
+rm scalafix.sbt
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -6,3 +6,7 @@ addSbtPlugin("org.scala-js" % "sbt-scalajs" % scalaJSVersion)
 addSbtPlugin("com.lihaoyi" % "scalatex-sbt-plugin" % "0.3.11")
 
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.0.0")
+
+addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.5.7")
+
+addSbtPlugin("ch.epfl.scala"  % "sbt-scalafix" % "0.9.29") // delete if Scala 2.10
diff --git a/scalafix.sbt b/scalafix.sbt
@@ -0,0 +1,10 @@
+ThisBuild / semanticdbEnabled          := true
+ThisBuild / semanticdbVersion          := "4.4.27"
+ThisBuild / scalafixScalaBinaryVersion := CrossVersion.binaryScalaVersion(scalaVersion.value)
+
+ThisBuild / scalacOptions ++= {
+  if (scalaVersion.value startsWith "2")
+    "-Yrangepos" :: Nil
+  else
+    Nil
+}
diff --git a/scalafix/src/main/resources/META-INF/services/scalafix.v1.Rule b/scalafix/src/main/resources/META-INF/services/scalafix.v1.Rule
@@ -0,0 +1 @@
+org.scalajs.dom.scalafix.GenerateApiReport
diff --git a/scalafix/src/main/scala/org/scalajs/dom/scalafix/GenerateApiReport.scala b/scalafix/src/main/scala/org/scalajs/dom/scalafix/GenerateApiReport.scala
@@ -0,0 +1,127 @@
+package org.scalajs.dom.scalafix
+
+import java.nio.charset.StandardCharsets
+import java.nio.file.{Paths, Files}
+import scala.meta._
+import scalafix.v1._
+
+class GenerateApiReport extends SemanticRule("GenerateApiReport") {
+  import MutableState.{global => state, ScopeType}
+
+  private[this] def enabled = state ne null
+
+  override def beforeStart(): Unit = {
+    Util.scalaSeriesVer match {
+      case "2.11" => // disabled - can't read classfiles
+      case _      => MutableState.global = new MutableState // can't set state= in early Scala versions
+    }
+  }
+
+  override def fix(implicit doc: SemanticDocument): Patch = {
+
+    if (enabled)
+      doc.tree.traverse {
+        case a: Defn.Class  => process(a.symbol, a.templ, ScopeType.Class)
+        case a: Defn.Object => process(a.symbol, a.templ, ScopeType.Object)
+        case a: Defn.Trait  => process(a.symbol, a.templ, ScopeType.Trait)
+        case a: Pkg.Object  => process(a.symbol, a.templ, ScopeType.Object)
+        case _ =>
+      }
+
+    Patch.empty
+  }
+
+  private def process(sym: Symbol, body: Template, typ: ScopeType)(implicit doc: SemanticDocument): Unit = {
+    // Skip non-public scopes
+    val info = sym.info.get
+    if (!info.isPublic && !info.isPackageObject)
+      return
+
+    val parents    = Util.parents(sym).iterator.map(Util.typeSymbol).toList
+    val domParents = parents.iterator.filter(isScalaJsDom).toSet
+    val isJsType   = parents.exists(isScalaJs)
+    val s          = state.register(sym, isJsType, typ, domParents)
+
+    def letsSeeHowLazyWeCanBeLol(t: Tree): Unit = {
+      // Skip non-public members
+      if (!t.symbol.info.get.isPublic)
+        return
+
+      // Remove definition bodies
+      val t2: Tree =
+        t match {
+          case Defn.Def(mods, name, tparams, paramss, Some(tpe), _) => Decl.Def(mods, name, tparams, paramss, tpe)
+          case Defn.Val(mods, pats, Some(tpe), _)                   => Decl.Val(mods, pats, tpe)
+          case Defn.Var(mods, pats, Some(tpe), _)                   => Decl.Var(mods, pats, tpe)
+          case _                                                    => t
+        }
+
+      val desc =
+        t2
+          .toString
+          .replace('\n', ' ')
+          .replace("=", " = ")
+          .replace("@inline ", "")
+          .replaceAll(", *", ", ")
+          .replaceAll(" {2,}", " ")
+          .trim
+          .stripSuffix(" = js.native")
+          .replaceAll(" = js.native(?=[^\n])", "?")
+
+      s.add(desc)
+    }
+
+    body.traverse {
+
+      // Skip inner members that we collect at the outer scope
+      case _: Defn.Class  =>
+      case _: Defn.Object =>
+      case _: Defn.Trait  =>
+      case _: Pkg.Object  =>
+
+      case d: Decl => letsSeeHowLazyWeCanBeLol(d)
+      case d: Defn => letsSeeHowLazyWeCanBeLol(d)
+
+      case _ =>
+    }
+  }
+
+  private def isScalaJs(sym: Symbol): Boolean =
+    sym.toString startsWith "scala/scalajs/js/"
+
+  private def isScalaJsDom(sym: Symbol): Boolean =
+    sym.toString startsWith "org/scalajs/dom/"
+
+  override def afterComplete(): Unit =
+    if (enabled) {
+      saveReport()
+      MutableState.global = null // can't set state= in early Scala versions
+    }
+
+  private def saveReport(): Unit = {
+    val scalaVer    = Util.scalaSeriesVer.replace('.', '_')
+    val projectRoot = System.getProperty("user.dir")
+    val reportFile  = Paths.get(s"$projectRoot/api-reports/$scalaVer.txt")
+    val api         = state.result().iterator.map(_.stripPrefix("org/scalajs/dom/")).mkString("\n")
+
+    val content =
+      s"""|scala-js-dom API
+          |================
+          |
+          |This is generated automatically on compile via custom Scalafix rule '${name.value}'.
+          |
+          |Flags:
+          |  [J-] = JavaScript type
+          |  [S-] = Scala type
+          |  [-${ScopeType.Class.id}] = Class
+          |  [-${ScopeType.Trait.id}] = Trait
+          |  [-${ScopeType.Object.id}] = Object
+          |
+          |
+          |$api
+          |""".stripMargin
+
+    println(s"[info] Generating $reportFile")
+    Files.write(reportFile, content.getBytes(StandardCharsets.UTF_8))
+  }
+}
diff --git a/scalafix/src/main/scala/org/scalajs/dom/scalafix/MutableState.scala b/scalafix/src/main/scala/org/scalajs/dom/scalafix/MutableState.scala
diff --git a/scalafix/src/main/scala/org/scalajs/dom/scalafix/Util.scala b/scalafix/src/main/scala/org/scalajs/dom/scalafix/Util.scala

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+rules = [`
	`2`	`+ GenerateApiReport,`
	`3`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[Documentation](http://scala-js.github.io/scala-js-dom)`
	`1`	`+[Documentation](http://scala-js.github.io/scala-js-dom) / [Scaladoc](https://javadoc.io/doc/org.scala-js/scalajs-dom_sjs1_2.13)`