Merge pull request #565 from scala-js/topic/defaultArgs

Default args for facades should be `js.native`

Author: armanbilge

.scalafix.conf

@@ -1,4 +1,5 @@
 rules = [
+  DefaultFacadeArgs,
   ExplicitResultTypes,
   OrganizeImports,
   RemoveUnused,

api-reports/2_12.txt

@@ -1,7 +1,10 @@
 import Build._
+import Dependencies.Ver._
 
 addCommandAlias("prePR", "+prePR_nonCross")
 
+addCommandAlias("quickPrePR", s"++$scala212; prePR_nonCross; ++$scala213; prePR_nonCross")
+
 val prePR_nonCross = taskKey[Unit]("Performs all necessary work required before submitting a PR, for a single version of Scala.")
 
 // Unfortunately we can't just call `root/Test/compile` because it doesn't take aggregation into account :(

api-reports/2_13.txt

@@ -1 +1,2 @@
+org.scalajs.dom.scalafix.DefaultFacadeArgs
 org.scalajs.dom.scalafix.GenerateApiReport

prePR.sbt

@@ -0,0 +1,31 @@
+package org.scalajs.dom.scalafix
+
+import scala.meta._
+import scalafix.v1._
+
+class DefaultFacadeArgs extends SemanticRule("DefaultFacadeArgs") {
+
+  override def fix(implicit doc: SemanticDocument): Patch =
+    doc.tree.collect {
+
+      case Defn.Def(mods, _, _, paramss, _, body) if Util.isJsNative(body) =>
+
+        // https://github.com/scala-js/scala-js/issues/4553
+        // `js.native` as default arg doesn't compile for top-level method facades.
+        if (Util.isJSGlobal(mods)) {
+          // Ignore for now
+          Patch.empty
+
+        } else {
+          // Replace default argument with js.native
+          lazy val jsNative = body.toString
+          paramss.iterator.flatten.foldLeft(Patch.empty) { (patch, param) =>
+            param.default match {
+              case Some(d) if d.toString != jsNative => patch + Patch.replaceTree(d, jsNative)
+              case _                                 => patch
+            }
+          }
+        }
+    }.asPatch
+
+}

scalafix/src/main/resources/META-INF/services/scalafix.v1.Rule

@@ -95,7 +95,7 @@ class GenerateApiReport extends SemanticRule("GenerateApiReport") {
           .replaceAll(" {2,}", " ")
           .trim
           .stripSuffix(" = js.native")
-          .replaceAll(" = js.native(?=[^\n])", "?")
+          .replaceAll(" = js\\.(native|undefined)(?=[^\n])", "?")
 
       // "?" means that type aliases come before everything else
       val name = Util.termName(t2).fold("?")(_.value)

scalafix/src/main/scala/org/scalajs/dom/scalafix/DefaultFacadeArgs.scala

@@ -24,6 +24,19 @@ object Util {
 
   // ===================================================================================================================
 
+  def isJSGlobal(mods: List[Mod]): Boolean =
+    mods.exists {
+      case Mod.Annot(Init(Type.Name("JSGlobal"), _, _)) => true
+      case _ => false
+    }
+
+  def isJsNative(t: Term): Boolean = {
+    val s = t.toString
+    s == "js.native" || s == "native"
+  }
+
+  // ===================================================================================================================
+
   def parents(sym: Symbol)(implicit doc: SemanticDocument): List[SemanticType] =
     dealias(sym).info match {
       case Some(i) => parents(i.signature)

scalafix/src/main/scala/org/scalajs/dom/scalafix/GenerateApiReport.scala

@@ -81,7 +81,7 @@ class AudioContext extends EventTarget {
     *   The number of channels in the input audio streams, which the output stream will contain; the default is 6 is
     *   this parameter is not specified.
     */
-  def createChannelMerger(numberOfInputs: Int = 6): ChannelMergerNode = js.native
+  def createChannelMerger(numberOfInputs: Int = js.native): ChannelMergerNode = js.native
 
   /** Creates a ChannelSplitterNode, which is used to access the individual channels of an audio stream and process them
     * separately.
@@ -90,7 +90,7 @@ class AudioContext extends EventTarget {
     *   The number of channels in the input audio stream that you want to output separately; the default is 6 is this
     *   parameter is not specified.
     */
-  def createChannelSplitter(numberOfOutputs: Int = 6): ChannelSplitterNode = js.native
+  def createChannelSplitter(numberOfOutputs: Int = js.native): ChannelSplitterNode = js.native
 
   /** Creates a ConvolverNode, which can be used to apply convolution effects to your audio graph, for example a
     * reverberation effect.
@@ -414,15 +414,15 @@ trait AudioBufferSourceNode extends AudioNode {
     *   The duration parameter, which defaults to the length of the asset minus the value of offset, defines the length
     *   of the portion of the asset to be played.
     */
-  def start(when: Double = 0.0, offset: Double = 0.0, duration: Double = js.native): Unit = js.native
+  def start(when: Double = js.native, offset: Double = js.native, duration: Double = js.native): Unit = js.native
 
   /** Schedules the end of the playback of an audio asset.
     *
     * @param when
     *   The when parameter defines when the playback will stop. If it represents a time in the past, the playback will
     *   end immediately. If this method is called twice or more, an exception is raised.
     */
-  def stop(when: Double = 0.0): Unit = js.native
+  def stop(when: Double = js.native): Unit = js.native
 
   /** Is an EventHandler containing the callback associated with the ended event. */
   var onended: js.Function1[Event, _] = js.native
@@ -481,7 +481,7 @@ trait AudioListener extends AudioNode {
     * @param z
     *   The z position of the listener in 3D space.
     */
-  def setPosition(x: Double = 0.0, y: Double = 0.0, z: Double = 0.0): Unit = js.native
+  def setPosition(x: Double = js.native, y: Double = js.native, z: Double = js.native): Unit = js.native
 
   /** Defines the orientation of the listener.
     *
@@ -508,8 +508,8 @@ trait AudioListener extends AudioNode {
     * @param zUp
     *   The z value of the up vector of the listener.
     */
-  def setOrientation(x: Double = 0.0, y: Double = 0.0, z: Double = -1.0, xUp: Double = 0.0, yUp: Double = 1.0,
-      zUp: Double = 0.0): Unit = js.native
+  def setOrientation(x: Double = js.native, y: Double = js.native, z: Double = js.native, xUp: Double = js.native,
+      yUp: Double = js.native, zUp: Double = js.native): Unit = js.native
 }
 
 /** The AudioParam interface represents an audio-related parameter, usually a parameter of an AudioNode (such as
@@ -891,10 +891,10 @@ trait OscillatorNode extends AudioNode {
   var `type`: String = js.native // Not sure if this is correct ...
 
   /** This method specifies the exact time to start playing the tone. */
-  def start(when: Double = 0.0): Unit = js.native
+  def start(when: Double = js.native): Unit = js.native
 
   /** This method specifies the exact time to stop playing the tone. */
-  def stop(when: Double = 0.0): Unit = js.native
+  def stop(when: Double = js.native): Unit = js.native
 
   /** Used to point to a PeriodicWave defining a periodic waveform that can be used to shape the oscillator's output,
     * when type = "custom" is used.
@@ -977,7 +977,7 @@ trait PannerNode extends AudioNode {
     * @param z
     *   The z position of the panner in 3D space.
     */
-  def setPosition(x: Double = 0.0, y: Double = 0.0, z: Double = 0.0): Unit = js.native
+  def setPosition(x: Double = js.native, y: Double = js.native, z: Double = js.native): Unit = js.native
 
   /** Defines the direction the audio source is playing in. This can have a big effect if the sound is very directional
     * — controlled by the three cone-related attributes PannerNode.coneInnerAngle, PannerNode.coneOuterAngle, and
@@ -996,7 +996,7 @@ trait PannerNode extends AudioNode {
     * @param z
     *   The z value of the panner's direction vector in 3D space.
     */
-  def setOrientation(x: Double = 1.0, y: Double = 0.0, z: Double = 0.0): Unit = js.native
+  def setOrientation(x: Double = js.native, y: Double = js.native, z: Double = js.native): Unit = js.native
 
   /** Defines the velocity vector of the audio source — how fast it is moving and in what direction.
     *
@@ -1015,7 +1015,7 @@ trait PannerNode extends AudioNode {
     * @param z
     *   The z value of the panner's velocity vector.
     */
-  def setVelocity(x: Double = 0.0, y: Double = 0.0, z: Double = 0.0): Unit = js.native
+  def setVelocity(x: Double = js.native, y: Double = js.native, z: Double = js.native): Unit = js.native
 }
 
 /** The StereoPannerNode interface of the Web Audio API represents a simple stereo panner node that can be used to pan

scalafix/src/main/scala/org/scalajs/dom/scalafix/Util.scala

@@ -14,7 +14,7 @@ object Fetch extends js.Object {
     * @param init
     * @return
     */
-  def fetch(info: RequestInfo, init: RequestInit = null): js.Promise[Response] = js.native
+  def fetch(info: RequestInfo, init: RequestInit = js.native): js.Promise[Response] = js.native
 }
 
 /** The Request interface of the Fetch API represents a resource request.
@@ -151,7 +151,7 @@ object Response extends js.Object {
     * @return
     *   a new Response
     */
-  def redirect(url: String, status: Int = 302): Response = js.native
+  def redirect(url: String, status: Int = js.native): Response = js.native
 }
 
 /** See [[https://fetch.spec.whatwg.org/#response-class ¶6.4 Response class]] definition in whatwg Fetch spec. */