deprecate %exteranl in favor of %global and %define

Author: cometkim

jscomp/frontend/ast_exp_extension.ml

@@ -61,14 +61,19 @@ 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)
-  | "external" -> (
+  | "global" | "external" -> (
+    if txt = "external" then
+      Location.deprecated loc
+        "%external is deprecated, use %global or %define 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_external loc x
-      (* do we need support [%external gg.xx ]
-
-         {[ Js.Undefined.to_opt (if Js.typeof x == "undefined" then x else Js.Undefined.empty ) ]}
-      *)
+      Ast_exp_handle_external.handle_define loc x
+      (* TODO: we need to support %define(gg.xx) *)
     | None | Some _ ->
       Location.raise_errorf ~loc "external expects a single identifier")
   | "time" -> (

jscomp/frontend/ast_exp_handle_external.ml

@@ -24,6 +24,25 @@
 
 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 
@@ -32,7 +51,7 @@ open Ast_helper
 
    ]}
 *)
-let handle_external loc (x : string) : Parsetree.expression =
+let handle_define 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,7 +22,9 @@
  * 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_external : Location.t -> string -> Parsetree.expression
+val handle_global : Location.t -> string -> Parsetree.expression
+
+val handle_define : Location.t -> string -> Parsetree.expression
 
 val handle_debugger : Location.t -> Ast_payload.t -> Parsetree.expression_desc
 

jscomp/others/js.res

@@ -77,6 +77,9 @@ 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,6 +77,9 @@ 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/reasonReactRouter.js

@@ -60,7 +60,7 @@ 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 %external(window) {
+  switch %global(window) {
   | None => list{}
   | Some(window: Dom.window) =>
     switch window |> location |> pathname {
@@ -78,7 +78,7 @@ let path = () =>
     }
   }
 let hash = () =>
-  switch %external(window) {
+  switch %global(window) {
   | None => ""
   | Some(window: Dom.window) =>
     switch window |> location |> hash {
@@ -91,7 +91,7 @@ let hash = () =>
     }
   }
 let search = () =>
-  switch %external(window) {
+  switch %global(window) {
   | None => ""
   | Some(window: Dom.window) =>
     switch window |> location |> search {
@@ -103,15 +103,15 @@ let search = () =>
     }
   }
 let push = path =>
-  switch (%external(history), %external(window)) {
+  switch (%global(history), %global(window)) {
   | (None, _)
   | (_, None) => ()
   | (Some(history: Dom.history), Some(window: Dom.window)) =>
     pushState(history, ~href=path)
     dispatchEvent(window, safeMakeEvent("popstate"))
   }
 let replace = path =>
-  switch (%external(history), %external(window)) {
+  switch (%global(history), %global(window)) {
   | (None, _)
   | (_, None) => ()
   | (Some(history: Dom.history), Some(window: Dom.window)) =>
@@ -143,15 +143,15 @@ let url = () => {path: path(), hash: hash(), search: search()}
 /* alias exposed publicly */
 let dangerouslyGetInitialUrl = url
 let watchUrl = callback =>
-  switch %external(window) {
+  switch %global(window) {
   | None => () => ()
   | Some(window: Dom.window) =>
     let watcherID = () => callback(url())
     addEventListener(window, "popstate", watcherID)
     watcherID
   }
 let unwatchUrl = watcherID =>
-  switch %external(window) {
+  switch %global(window) {
   | None => ()
   | Some(window: Dom.window) => removeEventListener(window, "popstate", watcherID)
   }

jscomp/test/reasonReactRouter.res

@@ -12,25 +12,25 @@ let ok = (loc, x) => {
     list{(loc ++ (" id " ++ string_of_int(test_id.contents)), _ => Mt.Ok(x)), ...suites.contents}
 }
 
-let a = switch %external(___undefined_value) {
+let a = switch %define(___undefined_value) {
 | None => 1
 | Some(_) => 2
 }
 
 let test = () =>
-  switch %external(__DEV__) {
+  switch %define(__DEV__) {
   | Some(_) => Js.log("dev mode")
   | None => Js.log("producton mode")
   }
 
 let test2 = () =>
-  switch %external(__filename) {
+  switch %define(__filename) {
   | Some(f) => Js.log(f)
   | None => Js.log("non node environment")
   }
 
 let test3 = () =>
-  if %external(__DEV__) == None {
+  if %define(__DEV__) == None {
     Js.log("production mode")
   }
 

jscomp/test/undef_regression2_test.res

@@ -3,19 +3,6 @@
 import * as Belt_Array from "./belt_Array.js";
 import * as Caml_option from "./caml_option.js";
 
-function copyBucket(c) {
-  if (c === undefined) {
-    return c;
-  }
-  let head = {
-    key: c.key,
-    value: c.value,
-    next: undefined
-  };
-  copyAuxCont(c.next, head);
-  return head;
-}
-
 function copyAuxCont(_c, _prec) {
   while(true) {
     let prec = _prec;
@@ -35,6 +22,19 @@ function copyAuxCont(_c, _prec) {
   };
 }
 
+function copyBucket(c) {
+  if (c === undefined) {
+    return c;
+  }
+  let head = {
+    key: c.key,
+    value: c.value,
+    next: undefined
+  };
+  copyAuxCont(c.next, head);
+  return head;
+}
+
 function copyBuckets(buckets) {
   let len = buckets.length;
   let newBuckets = new Array(len);

lib/es6/belt_internalBuckets.js

@@ -2,6 +2,18 @@
 
 import * as Belt_Array from "./belt_Array.js";
 
+function copyBucket(c) {
+  if (c === undefined) {
+    return c;
+  }
+  let head = {
+    key: c.key,
+    next: undefined
+  };
+  copyAuxCont(c.next, head);
+  return head;
+}
+
 function copyAuxCont(_c, _prec) {
   while(true) {
     let prec = _prec;
@@ -20,18 +32,6 @@ function copyAuxCont(_c, _prec) {
   };
 }
 
-function copyBucket(c) {
-  if (c === undefined) {
-    return c;
-  }
-  let head = {
-    key: c.key,
-    next: undefined
-  };
-  copyAuxCont(c.next, head);
-  return head;
-}
-
 function copyBuckets(buckets) {
   let len = buckets.length;
   let newBuckets = new Array(len);