just deprecate %external

Author: cometkim

CHANGELOG.md

@@ -86,6 +86,7 @@
 - Turn off transformation for closures inside loops when capturing loop variables, now that `let` is emitted instead of `var`. https://github.com/rescript-lang/rescript-compiler/pull/6480
 - Improve unused attribute warning message. https://github.com/rescript-lang/rescript-compiler/pull/6787
 - Remove internal option `use-stdlib` from build schema. https://github.com/rescript-lang/rescript-compiler/pull/6778
+- Deprecate `%external` extension, which has never officially introduced. https://github.com/rescript-lang/rescript-compiler/pull/6906
 
 # 11.1.2
 

jscomp/frontend/ast_exp_extension.ml

@@ -61,19 +61,11 @@ let handle_extension e (self : Bs_ast_mapper.mapper)
     Exp.constraint_ ~loc
       (Ast_exp_handle_external.handle_raw ~kind:Raw_re loc payload)
       (Ast_comb.to_js_re_type loc)
-  | "global" | "external" -> (
-    if txt = "external" then
-      Location.deprecated loc
-        "%external is deprecated, use %global or %define instead.";
+  | "external" -> (
+    Location.deprecated loc
+      "%external is deprecated, use %raw or regular FFI syntax instead.";
     match Ast_payload.as_ident payload with
-    | Some {txt = Lident x} -> Ast_exp_handle_external.handle_global loc x
-    | None | Some _ ->
-      Location.raise_errorf ~loc "external expects a single identifier")
-  | "define" -> (
-    match Ast_payload.as_ident payload with
-    | Some {txt = Lident x} ->
-      Ast_exp_handle_external.handle_define loc x
-      (* TODO: we need to support %define(gg.xx) *)
+    | Some {txt = Lident x} -> Ast_exp_handle_external.handle_external loc x
     | None | Some _ ->
       Location.raise_errorf ~loc "external expects a single identifier")
   | "time" -> (

jscomp/frontend/ast_exp_handle_external.ml

@@ -25,33 +25,16 @@
 open Ast_helper
 
 (**
-   {[ Js.undefinedToOption (Js.globalThis["x"]) ]}
-*)
-let handle_global loc (x : string) : Parsetree.expression =
-  let global_reference : Parsetree.expression =
-    {
-      pexp_loc = loc;
-      pexp_attributes = [];
-      pexp_desc =
-        Ast_util.js_property loc
-          (Exp.ident {loc; txt = Ldot (Lident "Js", "globalThis")})
-          x;
-    }
-  in
-  let undefined_typeof =
-    Exp.ident {loc; txt = Ldot (Lident "Js", "undefinedToOption")}
-  in
-  Ast_compatible.app1 ~loc undefined_typeof global_reference
-
-(*
    {[
      Js.undefinedToOption 
        (if Js.typeof x = "undefined" then undefined 
         else x  )
 
    ]}
+
+   @deprecated
 *)
-let handle_define loc (x : string) : Parsetree.expression =
+let handle_external loc (x : string) : Parsetree.expression =
   let raw_exp : Ast_exp.t =
     let str_exp =
       Ast_compatible.const_exp_string ~loc x ~delimiter:Ext_string.empty

jscomp/frontend/ast_exp_handle_external.mli

@@ -22,9 +22,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
-val handle_global : Location.t -> string -> Parsetree.expression
-
-val handle_define : Location.t -> string -> Parsetree.expression
+val handle_external : Location.t -> string -> Parsetree.expression
 
 val handle_debugger : Location.t -> Ast_payload.t -> Parsetree.expression_desc
 

jscomp/others/js.res

@@ -77,9 +77,6 @@ Prefer `Js.Array2` over `Js.Array`, `Js.String2` over `Js.String`, etc. The latt
 /** JS object type */
 type t<'a> = {..} as 'a
 
-/** JS global object reference */
-@val external globalThis: t<'a> = "globalThis"
-
 module Internal = {
   external opaqueFullApply: 'a => 'a = "%uncurried_apply"
 

jscomp/runtime/js.res

@@ -77,9 +77,6 @@ Prefer `Js.Array2` over `Js.Array`, `Js.String2` over `Js.String`, etc. The latt
 /** JS object type */
 type t<'a> = {..} as 'a
 
-/** JS global object reference */
-@val external globalThis: t<'a> = "globalThis"
-
 module Internal = {
   external opaqueFullApply: 'a => 'a = "%uncurried_apply"
 

jscomp/test/build.ninja

@@ -33,6 +33,12 @@ external createEventNonIEBrowsers: string => Dom.event = "createEvent"
 @send
 external initEventNonIEBrowsers: (Dom.event, string, bool, bool) => unit = "initEvent"
 
+@val @scope("globalThis")
+external window: option<Dom.window> = "window"
+
+@val @scope("globalThis")
+external history: option<Dom.history> = "history"
+
 let safeMakeEvent = eventName =>
   if Js.typeof(event) == "function" {
     makeEventIE11Compatible(eventName)
@@ -60,9 +66,9 @@ let arrayToList = a => {
 /* actually you know what, not gonna provide search for now. It's a mess.
  We'll let users roll their own solution/data structure for now */
 let path = () =>
-  switch %global(window) {
+  switch window {
   | None => list{}
-  | Some(window: Dom.window) =>
+  | Some(window) =>
     switch window |> location |> pathname {
     | ""
     | "/" => list{}
@@ -78,9 +84,9 @@ let path = () =>
     }
   }
 let hash = () =>
-  switch %global(window) {
+  switch window {
   | None => ""
-  | Some(window: Dom.window) =>
+  | Some(window) =>
     switch window |> location |> hash {
     | ""
     | "#" => ""
@@ -91,9 +97,9 @@ let hash = () =>
     }
   }
 let search = () =>
-  switch %global(window) {
+  switch window {
   | None => ""
-  | Some(window: Dom.window) =>
+  | Some(window) =>
     switch window |> location |> search {
     | ""
     | "?" => ""
@@ -103,18 +109,18 @@ let search = () =>
     }
   }
 let push = path =>
-  switch (%global(history), %global(window)) {
+  switch (history, window) {
   | (None, _)
   | (_, None) => ()
-  | (Some(history: Dom.history), Some(window: Dom.window)) =>
+  | (Some(history), Some(window)) =>
     pushState(history, ~href=path)
     dispatchEvent(window, safeMakeEvent("popstate"))
   }
 let replace = path =>
-  switch (%global(history), %global(window)) {
+  switch (history, window) {
   | (None, _)
   | (_, None) => ()
-  | (Some(history: Dom.history), Some(window: Dom.window)) =>
+  | (Some(history), Some(window)) =>
     replaceState(history, ~href=path)
     dispatchEvent(window, safeMakeEvent("popstate"))
   }
@@ -143,17 +149,17 @@ let url = () => {path: path(), hash: hash(), search: search()}
 /* alias exposed publicly */
 let dangerouslyGetInitialUrl = url
 let watchUrl = callback =>
-  switch %global(window) {
+  switch window {
   | None => () => ()
-  | Some(window: Dom.window) =>
+  | Some(window) =>
     let watcherID = () => callback(url())
     addEventListener(window, "popstate", watcherID)
     watcherID
   }
 let unwatchUrl = watcherID =>
-  switch %global(window) {
+  switch window {
   | None => ()
-  | Some(window: Dom.window) => removeEventListener(window, "popstate", watcherID)
+  | Some(window) => removeEventListener(window, "popstate", watcherID)
   }
 
 let useUrl = (~serverUrl=?, ()) => {