Skip to content

Format deprecated methods more clearly in API reports #493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2021
+41 −14
Merged

Format deprecated methods more clearly in API reports #493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions api-reports/2_12.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ experimental/permissions/package[SO] val permissions: Permissions
experimental/permissions/package[SO] val `persistent-storage` = "persistent-storage".asInstanceOf[PermissionName]
experimental/permissions/package[SO] val prompt = "prompt".asInstanceOf[PermissionState]
experimental/permissions/package[SO] val push = "push".asInstanceOf[PermissionName]
experimental/permissions/package[SO] def query( permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package[SO] def query(permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package[SO] val state: PermissionState
experimental/permissions/package[SO] implicit def toPermissions(navigator: dom.raw.Navigator): PermissionsNavigator
experimental/permissions/package[SO] val userVisibleOnly = permissionUserVisibleOnly
Expand All @@ -888,7 +888,7 @@ experimental/permissions/package.PermissionStatus[JT] var onchange: js.Function1
experimental/permissions/package.PermissionStatus[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
experimental/permissions/package.PermissionStatus[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
experimental/permissions/package.PermissionStatus[JT] val state: PermissionState
experimental/permissions/package.Permissions[JT] def query( permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package.Permissions[JT] def query(permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package.PermissionsNavigator[JT] val permissions: Permissions
experimental/permissions/package.PushPermissionDescriptor[JT] val name: PermissionName
experimental/permissions/package.PushPermissionDescriptor[JT] val userVisibleOnly: Boolean
Expand Down Expand Up @@ -933,7 +933,7 @@ experimental/push/package.PushServiceWorkerRegistration[JT] val pushManager: Pus
experimental/serviceworkers/Cache[JC] def add(request: RequestInfo): js.Promise[Unit]
experimental/serviceworkers/Cache[JC] def addAll(requests: js.Array[RequestInfo]): js.Promise[Unit]
experimental/serviceworkers/Cache[JC] def delete(request: RequestInfo, options: js.UndefOr[CacheQueryOptions]?): js.Promise[Boolean]
experimental/serviceworkers/Cache[JC] def keys(request: js.UndefOr[RequestInfo]?, options: js.UndefOr[ CacheQueryOptions]?): js.Promise[js.Array[Request]]
experimental/serviceworkers/Cache[JC] def keys(request: js.UndefOr[RequestInfo]?, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.Array[Request]]
experimental/serviceworkers/Cache[JC] def `match`(request: RequestInfo, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.UndefOr[Response]]
experimental/serviceworkers/Cache[JC] def matchAll(request: RequestInfo?, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.Array[Response]]
experimental/serviceworkers/Cache[JC] def put(request: RequestInfo, response: Response): js.Promise[Unit]
Expand Down Expand Up @@ -2535,7 +2535,7 @@ raw/BiquadFilterNode[JT] def removeEventListener[T <: Event](`type`: String, lis
raw/BiquadFilterNode[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
raw/BiquadFilterNode[JT] var `type`: String
raw/Blob[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
raw/Blob[JC] @deprecated("This method seems to have been added in error and not actually exist.", "1.2.0") def close(): Unit
raw/Blob[JC] def close(): Unit (@deprecated in 1.2.0)
raw/Blob[JC] def size: Double
raw/Blob[JC] def slice(start: Double?, end: Double?, contentType: String?): Blob
raw/Blob[JC] def stream(): ReadableStream[Byte]
Expand Down Expand Up @@ -3774,7 +3774,7 @@ raw/EventTarget[JC] def removeEventListener[T <: Event](`type`: String, listener
raw/EventTarget[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
raw/External[JT]
raw/File[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
raw/File[JC] @deprecated("This method seems to have been added in error and not actually exist.", "1.2.0") def close(): Unit
raw/File[JC] def close(): Unit (@deprecated in 1.2.0)
raw/File[JC] def name: String
raw/File[JC] def size: Double
raw/File[JC] def slice(start: Double?, end: Double?, contentType: String?): Blob
Expand Down
10 changes: 5 additions & 5 deletions api-reports/2_13.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ experimental/permissions/package[SO] val permissions: Permissions
experimental/permissions/package[SO] val `persistent-storage` = "persistent-storage".asInstanceOf[PermissionName]
experimental/permissions/package[SO] val prompt = "prompt".asInstanceOf[PermissionState]
experimental/permissions/package[SO] val push = "push".asInstanceOf[PermissionName]
experimental/permissions/package[SO] def query( permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package[SO] def query(permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package[SO] val state: PermissionState
experimental/permissions/package[SO] implicit def toPermissions(navigator: dom.raw.Navigator): PermissionsNavigator
experimental/permissions/package[SO] val userVisibleOnly = permissionUserVisibleOnly
Expand All @@ -888,7 +888,7 @@ experimental/permissions/package.PermissionStatus[JT] var onchange: js.Function1
experimental/permissions/package.PermissionStatus[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
experimental/permissions/package.PermissionStatus[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
experimental/permissions/package.PermissionStatus[JT] val state: PermissionState
experimental/permissions/package.Permissions[JT] def query( permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package.Permissions[JT] def query(permissionDescriptor: PermissionDescriptor): js.Promise[PermissionStatus]
experimental/permissions/package.PermissionsNavigator[JT] val permissions: Permissions
experimental/permissions/package.PushPermissionDescriptor[JT] val name: PermissionName
experimental/permissions/package.PushPermissionDescriptor[JT] val userVisibleOnly: Boolean
Expand Down Expand Up @@ -933,7 +933,7 @@ experimental/push/package.PushServiceWorkerRegistration[JT] val pushManager: Pus
experimental/serviceworkers/Cache[JC] def add(request: RequestInfo): js.Promise[Unit]
experimental/serviceworkers/Cache[JC] def addAll(requests: js.Array[RequestInfo]): js.Promise[Unit]
experimental/serviceworkers/Cache[JC] def delete(request: RequestInfo, options: js.UndefOr[CacheQueryOptions]?): js.Promise[Boolean]
experimental/serviceworkers/Cache[JC] def keys(request: js.UndefOr[RequestInfo]?, options: js.UndefOr[ CacheQueryOptions]?): js.Promise[js.Array[Request]]
experimental/serviceworkers/Cache[JC] def keys(request: js.UndefOr[RequestInfo]?, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.Array[Request]]
experimental/serviceworkers/Cache[JC] def `match`(request: RequestInfo, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.UndefOr[Response]]
experimental/serviceworkers/Cache[JC] def matchAll(request: RequestInfo?, options: js.UndefOr[CacheQueryOptions]?): js.Promise[js.Array[Response]]
experimental/serviceworkers/Cache[JC] def put(request: RequestInfo, response: Response): js.Promise[Unit]
Expand Down Expand Up @@ -2535,7 +2535,7 @@ raw/BiquadFilterNode[JT] def removeEventListener[T <: Event](`type`: String, lis
raw/BiquadFilterNode[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
raw/BiquadFilterNode[JT] var `type`: String
raw/Blob[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
raw/Blob[JC] @deprecated("This method seems to have been added in error and not actually exist.", "1.2.0") def close(): Unit
raw/Blob[JC] def close(): Unit (@deprecated in 1.2.0)
raw/Blob[JC] def size: Double
raw/Blob[JC] def slice(start: Double?, end: Double?, contentType: String?): Blob
raw/Blob[JC] def stream(): ReadableStream[Byte]
Expand Down Expand Up @@ -3774,7 +3774,7 @@ raw/EventTarget[JC] def removeEventListener[T <: Event](`type`: String, listener
raw/EventTarget[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
raw/External[JT]
raw/File[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
raw/File[JC] @deprecated("This method seems to have been added in error and not actually exist.", "1.2.0") def close(): Unit
raw/File[JC] def close(): Unit (@deprecated in 1.2.0)
raw/File[JC] def name: String
raw/File[JC] def size: Double
raw/File[JC] def slice(start: Double?, end: Double?, contentType: String?): Blob
Expand Down
28 changes: 26 additions & 2 deletions scalafix/src/main/scala/org/scalajs/dom/scalafix/GenerateApiReport.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,38 @@ class GenerateApiReport extends SemanticRule("GenerateApiReport") {
return

// Remove definition bodies
val t2: Tree =
var 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
}

// Inspect annotations
var deprecatedVer = Option.empty[String]

def inspectAnnotations(mods: List[Mod]): List[Mod] =
mods.filter {
case Mod.Annot(Init(tpe, _, List(List(_, ver)))) if tpe.toString == "deprecated" =>
deprecatedVer = Some {
ver match {
case Lit.String(s) => s
case term => term.toString
}
}
false
case _ => true
}

t2 match {
case Decl.Def(mods, name, tparams, paramss, tpe) => t2 = Decl.Def(inspectAnnotations(mods), name, tparams, paramss, tpe)
case Decl.Val(mods, pats, tpe) => t2 = Decl.Val(inspectAnnotations(mods), pats, tpe)
case Decl.Var(mods, pats, tpe) => t2 = Decl.Var(inspectAnnotations(mods), pats, tpe)
case _ =>
}

// Generate member desc
val desc =
t2
.toString
Expand All @@ -71,7 +95,7 @@ class GenerateApiReport extends SemanticRule("GenerateApiReport") {
// "?" means that type aliases come before everything else
val name = Util.termName(t2).fold("?")(_.value)

s.add(MutableState.Member(name, desc))
s.add(MutableState.Member(name, desc, deprecatedVer))
}

body.traverse {
Expand Down
7 changes: 5 additions & 2 deletions scalafix/src/main/scala/org/scalajs/dom/scalafix/MutableState.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,10 @@ final class MutableState {
} {
membersFound = true
val key = (scopeKey, v.name, v.desc)
b += Result(key, prefix + v.desc)
var result = prefix + v.desc
for (ver <- v.deprecatedVer)
result = s"$result (@deprecated in $ver)"
b += Result(key, result)
}

if (!membersFound && !scopeName.endsWith("/package")) {
Expand Down Expand Up @@ -103,7 +106,7 @@ object MutableState {
synchronized(directMembers += v)
}

final case class Member(name: String, desc: String)
final case class Member(name: String, desc: String, deprecatedVer: Option[String])

private[MutableState] final case class Result(sortKey: Result.SortKey, value: String)

Expand Down