Add ppx as a dependency for building source

Author: bobzhang

jscomp/bsb/bsb_build_util.ml

@@ -67,33 +67,35 @@ let convert_and_resolve_path : string -> string -> string =
    ./foo/bar => /absolute/path/to/projectRoot/./foo/bar
    Input is node path, output is OS dependent (normalized) path
 *)
-let resolve_bsb_magic_file ~cwd ~desc p =
+let resolve_bsb_magic_file ~cwd ~desc p : string * bool =
+
   let no_slash = Ext_string.no_slash_idx p in
   if no_slash < 0 then
-    p (*FIXME: better error message for "" input *)
+    (* Single file FIXME: better error message for "" input *)
+    p, false  
   else 
-  let first_char = String.unsafe_get p 0 in 
-  if Filename.is_relative p &&  
-     first_char  <> '.' then
-    let package_name, rest = 
-      Bsb_pkg_types.extract_pkg_name_and_file p 
-    in 
-    let relative_path = 
+    let first_char = String.unsafe_get p 0 in 
+    if Filename.is_relative p &&  
+       first_char  <> '.' then
+      let package_name, rest = 
+        Bsb_pkg_types.extract_pkg_name_and_file p 
+      in 
+      let relative_path = 
         if Ext_sys.is_windows_or_cygwin then Ext_string.replace_slash_backward rest 
         else rest in       
-    (* let p = if Ext_sys.is_windows_or_cygwin then Ext_string.replace_slash_backward p else p in *)
-    let package_dir = Bsb_pkg.resolve_bs_package ~cwd package_name in
-    let path = package_dir // relative_path in 
-    if Sys.file_exists path then path
-    else 
-      begin 
-        Bsb_log.error "@{<error>Could not resolve @} %s in %s@." p cwd ; 
-        failwith (p ^ " not found when resolving " ^ desc)
-      end
+      (* let p = if Ext_sys.is_windows_or_cygwin then Ext_string.replace_slash_backward p else p in *)
+      let package_dir = Bsb_pkg.resolve_bs_package ~cwd package_name in
+      let path = package_dir // relative_path in 
+      if Sys.file_exists path then path, true
+      else 
+        begin 
+          Bsb_log.error "@{<error>Could not resolve @} %s in %s@." p cwd ; 
+          failwith (p ^ " not found when resolving " ^ desc)
+        end
 
-  else
-    (* relative path [./x/y]*)
-    convert_and_resolve_path cwd p
+    else
+      (* relative path [./x/y]*)
+      convert_and_resolve_path cwd p, true
 
 
 

jscomp/bsb/bsb_build_util.mli

@@ -85,8 +85,15 @@ val get_list_string :
     Ext_json_types.t array -> 
     string list
 
-
-val resolve_bsb_magic_file : cwd:string -> desc:string -> string -> string
+(* [resolve_bsb_magic_file]
+   returns a tuple (path,checked)
+   when checked is true, it means such file should exist without depending on env
+*)
+val resolve_bsb_magic_file : 
+  cwd:string -> 
+  desc:string ->
+  string -> 
+  string * bool
 
 type package_context = {
   cwd : string ; 

jscomp/bsb/bsb_config_parse.ml

@@ -138,7 +138,8 @@ let interpret_json
       since it is external configuration, no {!Bsb_build_util.convert_and_resolve_path}
   *)
   let bsc_flags = ref Bsb_default.bsc_flags in  
-  let ppx_flags = ref [] in 
+  let ppx_files : string list ref = ref [] in 
+  let ppx_checked_files : string list ref = ref [] in 
   let js_post_build_cmd = ref None in 
   let built_in_package = ref None in
   let generate_merlin = ref true in 
@@ -175,8 +176,8 @@ let interpret_json
       | Some (Str {str}) 
         -> 
         Refmt_custom
-        (Bsb_build_util.resolve_bsb_magic_file 
-          ~cwd ~desc:Bsb_build_schemas.refmt str)
+        (fst (Bsb_build_util.resolve_bsb_magic_file 
+          ~cwd ~desc:Bsb_build_schemas.refmt str))
       | Some config  -> 
         Bsb_exception.config_error config "expect version 2 or 3"
       | None ->
@@ -189,11 +190,11 @@ let interpret_json
         Some { path = 
           match String_map.find_opt obj Bsb_build_schemas.path with
           | None -> 
-            Bsb_build_util.resolve_bsb_magic_file
+            fst @@ Bsb_build_util.resolve_bsb_magic_file
             ~cwd ~desc:"gentype.exe"
             "gentype/gentype.exe"
           | Some (Str {str}) ->  
-            Bsb_build_util.resolve_bsb_magic_file
+            fst @@ Bsb_build_util.resolve_bsb_magic_file
             ~cwd ~desc:"gentype.exe" str 
           | Some config -> 
             Bsb_exception.config_error config
@@ -264,7 +265,7 @@ let interpret_json
       | Some (Str {str = p }) ->
         if p = "" then failwith "invalid pp, empty string found"
         else 
-          Some (Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.pp_flags p)
+          Some (fst @@ Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.pp_flags p)
       | Some x ->    
         Bsb_exception.errorf ~loc:(Ext_json.loc_of x) "pp-flags expected a string"
       | None ->  
@@ -294,7 +295,7 @@ let interpret_json
 
     |? (Bsb_build_schemas.js_post_build, `Obj begin fun m ->
         m |? (Bsb_build_schemas.cmd , `Str (fun s -> 
-            js_post_build_cmd := Some (Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.js_post_build s)
+            js_post_build_cmd := Some (fst @@ Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.js_post_build s)
 
           )
           )
@@ -313,10 +314,18 @@ let interpret_json
     |? (Bsb_build_schemas.bs_external_includes, `Arr (fun s -> bs_external_includes := get_list_string s))
     |? (Bsb_build_schemas.bsc_flags, `Arr (fun s -> bsc_flags := Bsb_build_util.get_list_string_acc s !bsc_flags))
     |? (Bsb_build_schemas.ppx_flags, `Arr (fun s -> 
-        ppx_flags := Ext_list.map (get_list_string s) (fun p ->
+        let args = get_list_string s in 
+        let a,b = Ext_list.map_split_opt  args (fun p ->
             if p = "" then failwith "invalid ppx, empty string found"
-            else Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.ppx_flags p
-          )
+            else 
+              let file, checked = 
+                Bsb_build_util.resolve_bsb_magic_file ~cwd ~desc:Bsb_build_schemas.ppx_flags p 
+              in 
+              let some_file = Some file in 
+              some_file, if checked then some_file else None
+          ) in 
+        ppx_files := a ;  
+        ppx_checked_files := b    
       ))
 
     |? (Bsb_build_schemas.cut_generators, `Bool (fun b -> cut_generators := b))
@@ -385,8 +394,9 @@ let interpret_json
           warning = warning;
           external_includes = !bs_external_includes;
           bsc_flags = !bsc_flags ;
-          ppx_flags = !ppx_flags ;
-          pp_flags = pp_flags ;          
+          ppx_files = !ppx_files ;
+          ppx_checked_files = !ppx_checked_files;
+          pp_file = pp_flags ;          
           bs_dependencies = !bs_dependencies;
           bs_dev_dependencies = !bs_dev_dependencies;
           refmt;

jscomp/bsb/bsb_config_types.ml

@@ -51,8 +51,9 @@ type t =
     (* CapitalPackage *)
     external_includes : string list ; 
     bsc_flags : string list ;
-    ppx_flags : string list ;
-    pp_flags : string option;
+    ppx_files : string list ;
+    ppx_checked_files : string list ;
+    pp_file : string option;
     bs_dependencies : dependencies;
     bs_dev_dependencies : dependencies;
     built_in_dependency : dependency option; 

jscomp/bsb/bsb_merlin_gen.ml

@@ -105,8 +105,8 @@ let merlin_file_gen ~cwd
     built_in_ppx
     ({bs_file_groups = res_files ; 
       generate_merlin;
-      ppx_flags;
-      pp_flags ;
+      ppx_files;
+      pp_file;
       bs_dependencies;
       bs_dev_dependencies;
       bsc_flags; 
@@ -121,10 +121,10 @@ let merlin_file_gen ~cwd
   if generate_merlin then begin     
     let buffer = Buffer.create 1024 in
     output_merlin_namespace buffer namespace; 
-    Ext_list.iter ppx_flags (fun x ->
+    Ext_list.iter ppx_files (fun x ->
         Buffer.add_string buffer (merlin_flg_ppx ^ x )
       );
-    Ext_option.iter pp_flags (fun x -> 
+    Ext_option.iter pp_file (fun x -> 
       Buffer.add_string buffer (merlin_flg_pp ^ x)
     );  
     Ext_option.iter reason_react_jsx 

jscomp/bsb/bsb_ninja_file_groups.ml

@@ -99,6 +99,7 @@ let emit_impl_build
     (package_specs : Bsb_package_specs.t)
     (group_dir_index : Bsb_dir_index.t) 
     oc 
+    ~has_checked_ppx
     ~bs_suffix
     ~no_intf_file:(no_intf_file : bool) 
     js_post_build_cmd
@@ -131,6 +132,7 @@ let emit_impl_build
     Bsb_ninja_util.output_build oc
       ~output:output_mlast
       ~input
+      ~implicit_deps:(if has_checked_ppx then [ "${ppx_checked_files}" ] else [])       
       ~rule:( if is_re then 
                 Bsb_ninja_rule.build_ast_and_module_sets_from_re
               else
@@ -140,6 +142,7 @@ let emit_impl_build
       ~output:output_mlastd
       ~input:output_mlast
       ~rule:Bsb_ninja_rule.build_bin_deps
+      ~implicit_deps:(if has_checked_ppx then [ "${ppx_checked_files}" ] else [])       
       ?shadows:(if Bsb_dir_index.is_lib_dir group_dir_index then None
                 else Some [{Bsb_ninja_util.key = Bsb_build_schemas.bsb_dir_group ; 
                             op = 
@@ -174,6 +177,7 @@ let emit_intf_build
     (group_dir_index : Bsb_dir_index.t)
     oc
     ~is_re
+    ~has_checked_ppx
     namespace
     filename_sans_extension
   : info =
@@ -200,11 +204,14 @@ let emit_intf_build
               (if is_re then filename_sans_extension ^ Literals.suffix_rei 
                else filename_sans_extension ^ Literals.suffix_mli))
     ~rule:(if is_re then Bsb_ninja_rule.build_ast_and_module_sets_from_rei
-           else Bsb_ninja_rule.build_ast_and_module_sets);
+           else Bsb_ninja_rule.build_ast_and_module_sets)
+    ~implicit_deps:(if has_checked_ppx then [ "${ppx_checked_files}" ] else [])       
+    ;
   Bsb_ninja_util.output_build oc
     ~output:output_mliastd
     ~input:output_mliast
     ~rule:Bsb_ninja_rule.build_bin_deps
+    ~implicit_deps:(if has_checked_ppx then [ "${ppx_checked_files}" ] else [])       
     ?shadows:(if Bsb_dir_index.is_lib_dir group_dir_index  then None
               else Some [{
                   key = Bsb_build_schemas.bsb_dir_group; 
@@ -225,6 +232,7 @@ let handle_module_info
     (group_dir_index : Bsb_dir_index.t)
     (package_specs : Bsb_package_specs.t) 
     js_post_build_cmd
+    ~has_checked_ppx
     ~bs_suffix
     oc  module_name 
     ( {name_sans_extension = input} as module_info : Bsb_db.module_info)
@@ -233,10 +241,11 @@ let handle_module_info
   match module_info.ml_info, module_info.mli_info with
   | Ml_source (impl_is_re,_), 
     Mli_source(intf_is_re,_) ->
-    emit_impl_build 
+    emit_impl_build       
       package_specs
       group_dir_index
       oc 
+      ~has_checked_ppx
       ~bs_suffix
       ~no_intf_file:false
       ~is_re:impl_is_re
@@ -247,6 +256,7 @@ let handle_module_info
       package_specs
       group_dir_index
       oc         
+      ~has_checked_ppx
       ~is_re:intf_is_re
       namespace
       input 
@@ -255,6 +265,7 @@ let handle_module_info
       package_specs
       group_dir_index
       oc 
+      ~has_checked_ppx
       ~bs_suffix
       ~no_intf_file:true
       js_post_build_cmd      
@@ -263,6 +274,7 @@ let handle_module_info
       input 
   | Ml_empty, Mli_source(is_re,_) ->    
     emit_intf_build 
+      ~has_checked_ppx 
       package_specs
       group_dir_index
       oc         
@@ -274,6 +286,7 @@ let handle_module_info
 
 let handle_file_group 
     oc 
+    ~(has_checked_ppx : bool)
     ~bs_suffix
     ~custom_rules 
     ~package_specs 
@@ -295,6 +308,7 @@ let handle_file_group
       if installable then 
         String_hash_set.add files_to_install (Bsb_db.filename_sans_suffix_of_module_info module_info);
       (handle_module_info 
+        ~has_checked_ppx
         ~bs_suffix
          group.dir_index 
          package_specs js_post_build_cmd 
@@ -307,15 +321,19 @@ let handle_file_group
 
 
 let handle_file_groups
-    oc ~package_specs 
+    oc 
+    ~has_checked_ppx
+    ~package_specs 
     ~bs_suffix
     ~js_post_build_cmd
     ~files_to_install ~custom_rules
     (file_groups  :  Bsb_file_groups.file_groups)
     namespace (st : info) : info  =
   Ext_list.fold_left file_groups st  
     (handle_file_group 
-       oc  ~bs_suffix ~package_specs ~custom_rules ~js_post_build_cmd
+       oc  
+       ~has_checked_ppx
+       ~bs_suffix ~package_specs ~custom_rules ~js_post_build_cmd
        files_to_install 
        namespace
     ) 

jscomp/bsb/bsb_ninja_file_groups.mli

@@ -31,6 +31,7 @@ val zero : info
 
 val handle_file_groups :
   out_channel ->
+  has_checked_ppx:bool ->
   package_specs:Bsb_package_specs.t ->  
   bs_suffix:bool ->
   js_post_build_cmd:string option -> 

jscomp/bsb/bsb_ninja_gen.ml

@@ -57,8 +57,9 @@ let output_ninja_and_namespace_map
       package_name;
       external_includes;
       bsc_flags ; 
-      ppx_flags;
-      pp_flags ;
+      pp_file;
+      ppx_files ;
+      ppx_checked_files;
       bs_dependencies;
       bs_dev_dependencies;
       refmt;
@@ -79,7 +80,7 @@ let output_ninja_and_namespace_map
   let bsc = bsc_dir // bsc_exe in   (* The path to [bsc.exe] independent of config  *)
   let bsdep = bsc_dir // bsb_helper_exe in (* The path to [bsb_heler.exe] *)
   let cwd_lib_bs = cwd // Bsb_config.lib_bs in 
-  let ppx_flags = Bsb_build_util.ppx_flags ppx_flags in
+  let ppx_flags = Bsb_build_util.ppx_flags ppx_files in
   let bsc_flags =  String.concat Ext_string.single_space bsc_flags in
   let refmt_flags = String.concat Ext_string.single_space refmt_flags in
   let oc = open_out_bin (cwd_lib_bs // Literals.build_ninja) in
@@ -139,7 +140,7 @@ let output_ninja_and_namespace_map
         |] oc 
   in   
   let () = 
-    Ext_option.iter pp_flags (fun flag ->
+    Ext_option.iter pp_file (fun flag ->
       Bsb_ninja_util.output_kv Bsb_ninja_global_vars.pp_flags
       (Bsb_build_util.pp_flag flag) oc 
     );
@@ -149,6 +150,11 @@ let output_ninja_and_namespace_map
       ("-bs-gentype " ^ path) oc
     )
     ;  
+    if ppx_checked_files <> [] then 
+      Bsb_ninja_util.output_kv Bsb_ninja_global_vars.ppx_checked_files 
+      (String.concat " " ppx_files) oc
+    ;
+
     Bsb_ninja_util.output_kvs
       [|
         Bsb_ninja_global_vars.bs_package_flags, bs_package_flags ; 
@@ -236,6 +242,7 @@ let output_ninja_and_namespace_map
   (** Generate build statement for each file *)        
   let all_info =      
     Bsb_ninja_file_groups.handle_file_groups oc  
+      ~has_checked_ppx:(ppx_checked_files <> [])
       ~bs_suffix     
       ~custom_rules
       ~js_post_build_cmd 

jscomp/bsb/bsb_ninja_global_vars.ml

@@ -34,9 +34,8 @@ let bsdep = "bsdep"
 let bsc_flags = "bsc_flags"
 
 let ppx_flags = "ppx_flags"
-
+let ppx_checked_files = "ppx_checked_files"
 let pp_flags = "pp_flags"
-
 let bs_package_includes = "bs_package_includes"
 
 let bs_package_dev_includes = "bs_package_dev_includes"