Support rescript.json (#6382)

* add support rescript.json

* migrate to rescript.json

* add warning message and its test

* add CHANGELOG

Author: cometkim

CHANGELOG.md

@@ -17,7 +17,7 @@
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Lesser General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
@@ -101,7 +101,7 @@ let resolve_bsb_magic_file ~cwd ~desc p : result =
 
 (** converting a file from Linux path format to Windows *)
 
-(** 
+(**
    {[
      mkp "a/b/c/d";;
      mkp "/a/b/c/d"
@@ -155,9 +155,8 @@ let extract_pinned_dependencies (map : Ext_json_types.t Map_string.t) : Set_stri
 
 let rec walk_all_deps_aux (visited : string Hash_string.t) (paths : string list)
     ~(top : top) (dir : string) (queue : _ Queue.t) ~pinned_dependencies =
-  let bsconfig_json = dir // Literals.bsconfig_json in
-  match Ext_json_parse.parse_json_from_file bsconfig_json with
-  | Obj { map; loc } ->
+  match Bsb_config_load.load_json ~per_proj_dir:dir ~warn_legacy_config:false with
+  | _, Obj { map; loc } ->
       let cur_package_name =
         match Map_string.find_opt map Bsb_build_schemas.name with
         | Some (Str { str; loc }) ->
@@ -183,7 +182,7 @@ let rec walk_all_deps_aux (visited : string Hash_string.t) (paths : string list)
       else
         let explore_deps (deps : string) pinned_dependencies =
           map
-          |? ( deps,                
+          |? ( deps,
                `Arr
                  (fun (new_packages : Ext_json_types.t array) ->
                    Ext_array.iter new_packages (fun js ->
@@ -205,8 +204,8 @@ let rec walk_all_deps_aux (visited : string Hash_string.t) (paths : string list)
         | Expect_name n when Set_string.mem pinned_dependencies n -> true
         | _ -> false
         in
-        let pinned_dependencies = match is_pinned with 
-        | true -> 
+        let pinned_dependencies = match is_pinned with
+        | true ->
           let transitive_pinned_dependencies = extract_pinned_dependencies map
           in
           Set_string.union transitive_pinned_dependencies pinned_dependencies

jscomp/bsb/bsb_build_util.ml

@@ -0,0 +1,24 @@
+let ( // ) = Ext_path.combine
+
+let load_json ~(per_proj_dir : string) ~(warn_legacy_config : bool)
+    : string * Ext_json_types.t =
+  let filename, abs, in_chan =
+    let filename = Literals.rescript_json in
+    let abs = (per_proj_dir // filename) in
+    match open_in abs
+    with
+    | in_chan -> (filename, abs, in_chan)
+    | exception e ->
+      let filename = Literals.bsconfig_json in
+      let abs = (per_proj_dir // filename) in
+      match open_in abs
+      with
+      | in_chan -> (filename, abs, in_chan)
+      | exception _ -> raise e (* forward error from rescript.json *)
+  in
+  if warn_legacy_config && filename = Literals.bsconfig_json then
+    print_endline "Warning: bsconfig.json is deprecated. Migrate it to rescript.json\n";
+  match Ext_json_parse.parse_json_from_chan abs in_chan
+  with
+  | v -> close_in in_chan ; (filename, v)
+  | exception e -> close_in in_chan ; raise e

jscomp/bsb/bsb_config_load.ml

@@ -0,0 +1,2 @@
+val load_json :
+  per_proj_dir:string -> warn_legacy_config:bool -> string * Ext_json_types.t

jscomp/bsb/bsb_config_load.mli

@@ -70,10 +70,10 @@ let extract_package_name_and_namespace (map : json_map) : string * string option
    - the running bsb need delete stale build artifacts
       (kinda check npm upgrade)
 
-      Note if the setup is correct: 
+      Note if the setup is correct:
       the running compiler and node_modules/rescript
-      should be the same version, 
-      The exact check is that the running compiler should have a 
+      should be the same version,
+      The exact check is that the running compiler should have a
       compatible runtime version installed, the location of the
       compiler is actually not relevant.
       We disable the check temporarily
@@ -235,9 +235,13 @@ let extract_js_post_build (map : json_map) cwd : string option =
   |> ignore;
   !js_post_build_cmd
 
-(** ATT: make sure such function is re-entrant. 
+(** ATT: make sure such function is re-entrant.
     With a given [cwd] it works anywhere*)
-let interpret_json ~(package_kind : Bsb_package_kind.t) ~(per_proj_dir : string)
+let interpret_json
+  ~(filename : string)
+  ~(json : Ext_json_types.t)
+  ~(package_kind : Bsb_package_kind.t)
+  ~(per_proj_dir : string)
     : Bsb_config_types.t =
   (* we should not resolve it too early,
       since it is external configuration, no {!Bsb_build_util.convert_and_resolve_path}
@@ -253,8 +257,7 @@ let interpret_json ~(package_kind : Bsb_package_kind.t) ~(per_proj_dir : string)
      1. if [build.ninja] does use [ninja] we need set a variable
      2. we need store it so that we can call ninja correctly
   *)
-  match
-    Ext_json_parse.parse_json_from_file (per_proj_dir // Literals.bsconfig_json)
+  match json
   with
   | Obj { map } -> (
       let package_name, namespace = extract_package_name_and_namespace map in
@@ -349,17 +352,19 @@ let interpret_json ~(package_kind : Bsb_package_kind.t) ~(per_proj_dir : string)
             (match package_kind with
             | Toplevel -> extract_uncurried map
             | Pinned_dependency x | Dependency x -> x.uncurried);
+            filename;
           }
       | None ->
-          Bsb_exception.invalid_spec "no sources specified in bsconfig.json")
-  | _ -> Bsb_exception.invalid_spec "bsconfig.json expect a json object {}"
+          Bsb_exception.invalid_spec ("no sources specified in " ^ filename))
+  | _ -> Bsb_exception.invalid_spec (filename ^ " expect a json object {}")
 
 let deps_from_bsconfig () =
-  let json = Ext_json_parse.parse_json_from_file Literals.bsconfig_json in
-  match json with
-  | Obj { map } ->
-      ( Bsb_package_specs.from_map ~cwd:Bsb_global_paths.cwd map,
+  let cwd = Bsb_global_paths.cwd in
+  match Bsb_config_load.load_json ~per_proj_dir:cwd ~warn_legacy_config:false
+  with
+  | _, Obj { map } ->
+      ( Bsb_package_specs.from_map ~cwd map,
         Bsb_jsx.from_map map,
         extract_uncurried map,
         Bsb_build_util.extract_pinned_dependencies map )
-  | _ -> assert false
+  | _, _ -> assert false

jscomp/bsb/bsb_config_parse.ml

@@ -25,4 +25,8 @@
 val deps_from_bsconfig : unit -> Bsb_package_specs.t * Bsb_jsx.t * bool *  Set_string.t
 
 val interpret_json :
-  package_kind:Bsb_package_kind.t -> per_proj_dir:string -> Bsb_config_types.t
+  filename:string ->
+  json:Ext_json_types.t ->
+  package_kind:Bsb_package_kind.t ->
+  per_proj_dir:string ->
+  Bsb_config_types.t

jscomp/bsb/bsb_config_parse.mli

@@ -65,4 +65,6 @@ type t = {
   (* note when used as a dev mode, we will always ignore it *)
   gentype_config : gentype_config;
   uncurried: bool;
+
+  filename: string;
 }

jscomp/bsb/bsb_config_types.ml

@@ -30,14 +30,17 @@ let ( // ) = Ext_path.combine
     return None if we dont need regenerate
     otherwise return Some info
 *)
-let regenerate_ninja ~(package_kind : Bsb_package_kind.t) ~forced ~per_proj_dir
+let regenerate_ninja ~(package_kind : Bsb_package_kind.t) ~forced ~per_proj_dir ~warn_legacy_config
     : Bsb_config_types.t option =
   let lib_artifacts_dir = Bsb_config.lib_bs in
   let lib_bs_dir = per_proj_dir // lib_artifacts_dir in
   let output_deps = lib_bs_dir // bsdeps in
   let check_result =
     Bsb_ninja_check.check ~package_kind ~per_proj_dir ~forced ~file:output_deps
   in
+  let config_filename, config_json =
+    Bsb_config_load.load_json ~per_proj_dir ~warn_legacy_config
+  in
   match check_result with
   | Good -> None (* Fast path, no need regenerate ninja *)
   | Bsb_forced | Bsb_bsc_version_mismatch | Bsb_package_kind_inconsistent
@@ -52,7 +55,8 @@ let regenerate_ninja ~(package_kind : Bsb_package_kind.t) ~forced ~per_proj_dir
         Bsb_clean.clean_self per_proj_dir);
 
       let config : Bsb_config_types.t =
-        Bsb_config_parse.interpret_json ~package_kind ~per_proj_dir
+        Bsb_config_parse.interpret_json
+          ~filename:config_filename ~json:config_json ~package_kind ~per_proj_dir
       in
       (* create directory, lib/bs, lib/js, lib/es6 etc *)
       Bsb_build_util.mkp lib_bs_dir;
@@ -75,5 +79,5 @@ let regenerate_ninja ~(package_kind : Bsb_package_kind.t) ~forced ~per_proj_dir
           since it may add files in the future *)
       Bsb_ninja_check.record ~package_kind ~per_proj_dir ~config
         ~file:output_deps
-        (Literals.bsconfig_json :: config.file_groups.globbed_dirs);
+        (config.filename :: config.file_groups.globbed_dirs);
       Some config

jscomp/bsb/bsb_ninja_regen.ml

@@ -26,6 +26,7 @@ val regenerate_ninja :
   package_kind:Bsb_package_kind.t ->
   forced:bool ->
   per_proj_dir:string ->
+  warn_legacy_config:bool ->
   Bsb_config_types.t option
 (** Regenerate ninja file by need based on [.bsdeps]
     return None if we dont need regenerate

jscomp/bsb/bsb_ninja_regen.mli

@@ -30,7 +30,7 @@ let make_world_deps cwd (config : Bsb_config_types.t option)
   let package_specs, jsx, uncurried, pinned_dependencies =
     match config with
     | None ->
-        (* When this running bsb does not read bsconfig.json,
+        (* When this running bsb does not read rescript.json,
            we will read such json file to know which [package-specs]
            it wants
         *)
@@ -70,6 +70,7 @@ let make_world_deps cwd (config : Bsb_config_types.t option)
                    (if is_pinned then Pinned_dependency { package_specs; jsx; uncurried }
                    else Dependency { package_specs; jsx; uncurried })
                  ~per_proj_dir:proj_dir ~forced:false
+                 ~warn_legacy_config:false
              in
              let command =
                { Bsb_unix.cmd = vendor_ninja; cwd = lib_bs_dir; args }