Deprecated es6 and es6-global in favor of esmodule (#6709)

* deprecated es6 and es6-global in favor of esmodule

* fix gentype

* fix playground

* migrate legecy options in tests

* add changelog

* maybe..?

Author: cometkim

CHANGELOG.md

@@ -23,6 +23,10 @@
 - Fix trailing undefined for optional parameters not omitted with `@send` and `@new`. https://github.com/rescript-lang/rescript-compiler/pull/6716
 - Fix JSX4 adding the incorrect type annotation for the prop `ref` in React.forwardRef component https://github.com/rescript-lang/rescript-compiler/pull/6718
 
+#### :nail_care: Polish
+
+- Module spec `es6` and `es6-global` is deprecated in favor of `esmodule`. https://github.com/rescript-lang/rescript-compiler/pull/6709
+
 # 11.1.0-rc.7
 
 #### :bug: Bug Fix

docs/docson/build-schema.json

@@ -2,8 +2,8 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "definitions": {
     "module-format": {
-      "enum": ["commonjs", "es6", "es6-global"],
-      "description": "es6-global generate relative `require` paths instead of relying on NodeJS' module resolution. Default: commonjs."
+      "enum": ["esmodule", "commonjs", "es6", "es6-global"],
+      "description": "es6 and es6-global are deprecated. Default: commonjs."
     },
     "suffix-spec": {
       "type": "string",

jscomp/bsb/bsb_config.ml

@@ -41,16 +41,18 @@ let rev_lib_bs = ".." // ".."
 
 (* access the js directory from "lib/bs",
    it would be '../js'
+
+   TODO: should be renamed, js -> cjs, es6 -> mjs in v12
 *)
 let lib_bs_prefix_of_format (x : Ext_module_system.t) =
   ".."
-  // match x with NodeJS -> "js" | Es6 -> "es6" | Es6_global -> "es6_global"
+  // match x with Commonjs -> "js" | Esmodule -> "es6" | Es6_global -> "es6_global"
 
 (* lib/js, lib/es6, lib/es6_global *)
 let top_prefix_of_format (x : Ext_module_system.t) =
   match x with
-  | NodeJS -> lib_js
-  | Es6 -> lib_es6
+  | Commonjs -> lib_js
+  | Esmodule -> lib_es6
   | Es6_global -> lib_es6_global
 
 let rev_lib_bs_prefix p = rev_lib_bs // p

jscomp/bsb/bsb_config.mli

@@ -33,8 +33,10 @@ val lib_js : string
 val lib_bs : string
 
 val lib_es6 : string
+[@@ocaml.deprecated "will be removed in v12"]
 
 val lib_es6_global : string
+[@@ocaml.deprecated "will be removed in v12"]
 
 val lib_ocaml : string
 

jscomp/bsb/bsb_package_specs.ml

@@ -40,19 +40,29 @@ let ( .?() ) = Map_string.find_opt
 let bad_module_format_message_exn ~loc format =
   Bsb_exception.errorf ~loc
     "package-specs: `%s` isn't a valid output module format. It has to be one \
-     of:  %s, %s or %s"
-    format Literals.commonjs Literals.es6 Literals.es6_global
+     of:  %s or %s"
+    format Literals.esmodule Literals.commonjs
 
 let supported_format (x : string) loc : Ext_module_system.t =
-  if x = Literals.commonjs then NodeJS
-  else if x = Literals.es6 then Es6
+  let _ =
+    if x = Literals.es6 || x = Literals.es6_global then
+      let loc_end =
+        {loc with Lexing.pos_cnum = loc.Lexing.pos_cnum + String.length x}
+      in
+      let loc = {Warnings.loc_start = loc; loc_end; loc_ghost = false} in
+      Location.deprecated loc
+        (Printf.sprintf "Option \"%s\" is deprecated. Use \"%s\" instead." x
+           Literals.esmodule)
+  in
+  if x = Literals.es6 || x = Literals.esmodule then Esmodule
+  else if x = Literals.commonjs then Commonjs
   else if x = Literals.es6_global then Es6_global
   else bad_module_format_message_exn ~loc x
 
 let string_of_format (x : Ext_module_system.t) =
   match x with
-  | NodeJS -> Literals.commonjs
-  | Es6 -> Literals.es6
+  | Commonjs -> Literals.commonjs
+  | Esmodule -> Literals.esmodule
   | Es6_global -> Literals.es6_global
 
 let js_suffix_regexp = Str.regexp "[A-Za-z0-9-_.]*\\.[cm]?js"
@@ -158,7 +168,8 @@ let package_flag_of_package_specs (package_specs : t) ~(dirname : string) :
   | Some x -> Ext_string.inter3 res "-runtime" x
 
 let default_package_specs suffix =
-  Spec_set.singleton { format = NodeJS; in_source = false; suffix }
+  (* TODO: swap default to Esmodule in v12 *)
+  Spec_set.singleton { format = Commonjs; in_source = false; suffix }
 
 (**
     [get_list_of_output_js specs "src/hi/hello"]

jscomp/bsb/bsb_spec_set.ml

@@ -25,7 +25,7 @@
 [@@@warning "+9"]
 
 (* TODO: sync up with {!Js_packages_info.module_system}  *)
-type format = Ext_module_system.t = NodeJS | Es6 | Es6_global
+type format = Ext_module_system.t
 
 type spec = { format : format; in_source : bool; suffix : string }
 

jscomp/build_tests/cycle1/rescript.json

@@ -7,7 +7,7 @@
     "subdirs": true
   },
   "package-specs": {
-    "module": "es6",
+    "module": "esmodule",
     "in-source": true
   },
   "suffix": ".bs.js"

jscomp/build_tests/deprecated-package-specs/input.js

@@ -0,0 +1,9 @@
+const child_process = require("child_process");
+const assert = require("assert");
+const rescript_exe = require("../../../scripts/bin_path").rescript_exe;
+
+const out = child_process.spawnSync(rescript_exe, { encoding: "utf8" });
+assert.match(
+  out.stderr,
+  /deprecated: Option "es6-global" is deprecated\. Use "esmodule" instead\./
+);

jscomp/build_tests/deprecated-package-specs/rescript.json

@@ -0,0 +1,8 @@
+{
+  "name": "deprecated-package-specs",
+  "version": "0.1.0",
+  "sources": "src",
+  "package-specs": {
+    "module": "es6-global"
+  }
+}

jscomp/build_tests/deprecated-package-specs/src/Index.res

@@ -0,0 +1 @@
+let () = Js.log("Hello, ReScript")