Merge pull request #4212 from BuckleScript/fix_editor_tooling

bobzhang · web-flow · commit d0b0cbb5bd40 · 2020-03-06T14:49:53.000+08:00
fix editor tooling
diff --git a/jscomp/bsb/bsb_merlin_gen.ml b/jscomp/bsb/bsb_merlin_gen.ml
@@ -87,11 +87,20 @@ let output_merlin_namespace buffer ns=
     Buffer.add_string buffer "-open ";
     Buffer.add_string buffer x 
 
+(* Literals.dash_nostdlib::
+   FIX editor tooling, note merlin does not need -nostdlib since we added S and B
+   RLS will add -I for those cmi files,  
+   Some consistency check is needed
+   Unless we tell the editor to peek those cmi for auto-complete and others for building which is too
+   complicated
+*)      
 let bsc_flg_to_merlin_ocamlc_flg bsc_flags  =
-  merlin_flg ^ 
-  String.concat Ext_string.single_space 
-    (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
-     Literals.dash_nostdlib::bsc_flags)) 
+  let flags = (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
+     bsc_flags)) in 
+  if flags <> [] then    
+    merlin_flg ^ 
+    String.concat Ext_string.single_space flags
+  else ""
 
 (* No need for [-warn-error] in merlin  *)     
 let warning_to_merlin_flg (warning: Bsb_warning.t ) : string=     
diff --git a/jscomp/bsb/bsb_theme_init.ml b/jscomp/bsb/bsb_theme_init.ml
@@ -76,7 +76,7 @@ let run_npm_link cwd dirname  =
         exit 2
       end 
   else 
-  if Ext_sys.is_windows_or_cygwin then
+  (* if Ext_sys.is_windows_or_cygwin then *)
     begin
       let npm_link = "npm link bs-platform" in
       let exit_code = Sys.command npm_link in
@@ -86,7 +86,7 @@ let run_npm_link cwd dirname  =
           exit exit_code
         end
     end
-  else
+  (* else
     begin
       (* symlink bs-platform and bsb,bsc,bsrefmt to .bin directory
         we did not run npm link bs-platform for efficiency reasons
@@ -104,7 +104,7 @@ let run_npm_link cwd dirname  =
       Unix.symlink
         (Filename.dirname (Filename.dirname Sys.executable_name))
         (Filename.concat "node_modules" Bs_version.package_name)
-    end
+    end *)
 
 let enter_dir cwd x action =
   Unix.chdir x ;
diff --git a/jscomp/main/cmij_main.ml b/jscomp/main/cmij_main.ml
@@ -104,13 +104,6 @@ let from_cmi (files : string list) (output_file : string) =
       let content = 
         Marshal.to_string 
           cmi
-          (* cmi_name, crcs can be saved, but only a tiny bit *)
-          (* (cmi.cmi_sign) *)
-          (* (Array.of_list cmi.cmi_sign) *)
-          (* ({ with 
-             (* cmi_crcs = [] *)
-             cmi_flags = []
-             }) *)
           [] in 
       Printf.sprintf {|%S (* %d *)|} module_name (String.length content) ,                              
       Printf.sprintf {|(* %s *) %S|} module_name content) in 
@@ -141,6 +134,14 @@ let stdlib = "stdlib-406"
 let (//) = Filename.concat 
 let (|~) = Ext_string.contain_substring
 
+let cmi_target_file = (Filename.concat "main" "builtin_cmi_datasets.ml")
+let release_cmi = Array.exists ((=) "-release") Sys.argv
+let () = 
+  if release_cmi then begin  
+    print_endline "collecting cmi from ../lib/ocaml in release mode" ;
+    try Sys.remove cmi_target_file with _ -> 
+      Format.fprintf Format.err_formatter "failed to remove %s@." cmi_target_file
+  end 
 let () = 
   let cmj_files = 
     ( 
@@ -150,14 +151,18 @@ let () =
   from_cmj cmj_files
     (Filename.concat "main" "builtin_cmj_datasets.ml");
   let cmi_files = 
-    "runtime" // "js.cmi" ::       
-    (get_files Literals.suffix_cmi stdlib @
-    get_files Literals.suffix_cmi "others" )
-    |> List.filter (fun x -> 
-       x|~ "js_internalOO" ||
-       x|~  "camlinternal" ||
-       not (x |~ "internal"))
+    if release_cmi then   
+      get_files Literals.suffix_cmi (".."//"lib"//"ocaml")  
+   else    
+     "runtime" // "js.cmi" ::       
+     (get_files Literals.suffix_cmi stdlib @
+      get_files Literals.suffix_cmi "others" )
+     |> List.filter (fun x -> 
+         x|~ "js_internalOO" ||
+         x|~  "camlinternal" ||
+         not (x |~ "internal")) 
   in     
-  from_cmi cmi_files
-    (Filename.concat "main" "builtin_cmi_datasets.ml")
+  from_cmi 
+  cmi_files
+  cmi_target_file
 
diff --git a/lib/4.06.1/bsb.ml b/lib/4.06.1/bsb.ml
@@ -11905,11 +11905,20 @@ let output_merlin_namespace buffer ns=
     Buffer.add_string buffer "-open ";
     Buffer.add_string buffer x 
 
+(* Literals.dash_nostdlib::
+   FIX editor tooling, note merlin does not need -nostdlib since we added S and B
+   RLS will add -I for those cmi files,  
+   Some consistency check is needed
+   Unless we tell the editor to peek those cmi for auto-complete and others for building which is too
+   complicated
+*)      
 let bsc_flg_to_merlin_ocamlc_flg bsc_flags  =
-  merlin_flg ^ 
-  String.concat Ext_string.single_space 
-    (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
-     Literals.dash_nostdlib::bsc_flags)) 
+  let flags = (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
+     bsc_flags)) in 
+  if flags <> [] then    
+    merlin_flg ^ 
+    String.concat Ext_string.single_space flags
+  else ""
 
 (* No need for [-warn-error] in merlin  *)     
 let warning_to_merlin_flg (warning: Bsb_warning.t ) : string=     
@@ -16270,7 +16279,7 @@ let run_npm_link cwd dirname  =
         exit 2
       end 
   else 
-  if Ext_sys.is_windows_or_cygwin then
+  (* if Ext_sys.is_windows_or_cygwin then *)
     begin
       let npm_link = "npm link bs-platform" in
       let exit_code = Sys.command npm_link in
@@ -16280,7 +16289,7 @@ let run_npm_link cwd dirname  =
           exit exit_code
         end
     end
-  else
+  (* else
     begin
       (* symlink bs-platform and bsb,bsc,bsrefmt to .bin directory
         we did not run npm link bs-platform for efficiency reasons
@@ -16298,7 +16307,7 @@ let run_npm_link cwd dirname  =
       Unix.symlink
         (Filename.dirname (Filename.dirname Sys.executable_name))
         (Filename.concat "node_modules" Bs_version.package_name)
-    end
+    end *)
 
 let enter_dir cwd x action =
   Unix.chdir x ;
diff --git a/lib/4.06.1/unstable/bsb_native.ml b/lib/4.06.1/unstable/bsb_native.ml
@@ -12027,11 +12027,20 @@ let output_merlin_namespace buffer ns=
     Buffer.add_string buffer "-open ";
     Buffer.add_string buffer x 
 
+(* Literals.dash_nostdlib::
+   FIX editor tooling, note merlin does not need -nostdlib since we added S and B
+   RLS will add -I for those cmi files,  
+   Some consistency check is needed
+   Unless we tell the editor to peek those cmi for auto-complete and others for building which is too
+   complicated
+*)      
 let bsc_flg_to_merlin_ocamlc_flg bsc_flags  =
-  merlin_flg ^ 
-  String.concat Ext_string.single_space 
-    (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
-     Literals.dash_nostdlib::bsc_flags)) 
+  let flags = (List.filter (fun x -> not (Ext_string.starts_with x bs_flg_prefix )) ( 
+     bsc_flags)) in 
+  if flags <> [] then    
+    merlin_flg ^ 
+    String.concat Ext_string.single_space flags
+  else ""
 
 (* No need for [-warn-error] in merlin  *)     
 let warning_to_merlin_flg (warning: Bsb_warning.t ) : string=     
@@ -16392,7 +16401,7 @@ let run_npm_link cwd dirname  =
         exit 2
       end 
   else 
-  if Ext_sys.is_windows_or_cygwin then
+  (* if Ext_sys.is_windows_or_cygwin then *)
     begin
       let npm_link = "npm link bs-platform" in
       let exit_code = Sys.command npm_link in
@@ -16402,7 +16411,7 @@ let run_npm_link cwd dirname  =
           exit exit_code
         end
     end
-  else
+  (* else
     begin
       (* symlink bs-platform and bsb,bsc,bsrefmt to .bin directory
         we did not run npm link bs-platform for efficiency reasons
@@ -16420,7 +16429,7 @@ let run_npm_link cwd dirname  =
       Unix.symlink
         (Filename.dirname (Filename.dirname Sys.executable_name))
         (Filename.concat "node_modules" Bs_version.package_name)
-    end
+    end *)
 
 let enter_dir cwd x action =
   Unix.chdir x ;
diff --git a/scripts/install.js b/scripts/install.js
@@ -224,4 +224,5 @@ var stdlib = ocamlVersion.includes("4.02") ? "stdlib-402" : "stdlib-406";
 
 if (process.env.BS_TRAVIS_CI) {
   buildLibs(stdlib);
+  require('./installUtils.js').install()
 }
diff --git a/scripts/installUtils.js b/scripts/installUtils.js
@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+//@ts-check
+var fs = require("fs");
+var path = require("path");
+var assert = require("assert");
+/**
+ *
+ * @param {string} src
+ * @param {(file:string)=>boolean} filter
+ * @param {string} dest
+ */
+function installDirBy(src, dest, filter) {
+  fs.readdir(src, function(err, files) {
+    if (err === null) {
+      files.forEach(function(file) {
+        if (filter(file)) {
+          var x = path.join(src, file);
+          var y = path.join(dest, file);
+          // console.log(x, '----->', y )
+          fs.copyFile(x, y, err => assert.equal(err, null));
+        }
+      });
+    } else {
+      throw err;
+    }
+  });
+}
+
+function install() {
+  var root_dir = path.join(__dirname, "..");
+  var lib_dir = path.join(root_dir, "lib");
+  var jscomp_dir = path.join(root_dir, "jscomp");
+  var runtime_dir = path.join(jscomp_dir, "runtime");
+  var others_dir = path.join(jscomp_dir, "others");
+  var ocaml_dir = path.join(lib_dir, "ocaml");
+  var stdlib_dir = path.join(jscomp_dir, "stdlib-406");
+  if (!fs.existsSync(ocaml_dir)) {
+    fs.mkdirSync(ocaml_dir);
+  }
+  // sync up with cmij_main.ml
+  installDirBy(runtime_dir, ocaml_dir, function(file) {
+    var y = path.parse(file);
+    return y.name === "js" && y.ext !== ".cmj";
+    // install js.cmi, js.mli
+  });
+
+  // for merlin or other IDE
+  var installed_suffixes = [".ml", ".mli", ".cmi", ".cmt", ".cmti"];
+  installDirBy(others_dir, ocaml_dir, function(file) {
+    var y = path.parse(file);
+    if (y.ext === ".cmi") {
+      return !y.base.includes("Belt_internal");
+    }
+    return installed_suffixes.includes(y.ext);
+  });
+  installDirBy(stdlib_dir, ocaml_dir, function(file) {
+    var y = path.parse(file);
+    return installed_suffixes.includes(y.ext);
+  });
+}
+exports.install = install;
diff --git a/scripts/prebuilt.js b/scripts/prebuilt.js
@@ -17,59 +17,6 @@ function rebuild() {
     stdio: [0, 1, 2]
   });
 }
-var assert = require("assert");
-/**
- *
- * @param {string} src
- * @param {(file:string)=>boolean} filter
- * @param {string} dest
- */
-function installDirBy(src, dest, filter) {
-  fs.readdir(src, function(err, files) {
-    if (err === null) {
-      files.forEach(function(file) {
-        if (filter(file)) {
-          var x = path.join(src, file);
-          var y = path.join(dest, file);
-          // console.log(x, '----->', y )
-          fs.copyFile(x, y, err => assert.equal(err, null));
-        }
-      });
-    } else {
-      throw err;
-    }
-  });
-}
-
-function install() {
-  var root_dir = path.join(__dirname, "..");
-  var lib_dir = path.join(root_dir, "lib");
-  var jscomp_dir = path.join(root_dir, "jscomp");
-  var runtime_dir = path.join(jscomp_dir, "runtime");
-  var others_dir = path.join(jscomp_dir, "others");
-  var ocaml_dir = path.join(lib_dir, "ocaml");
-  var stdlib_dir = path.join(jscomp_dir, "stdlib-406");
-  if(!fs.existsSync(ocaml_dir)){
-    fs.mkdirSync(ocaml_dir)
-  }
-  // sync up with cmij_main.ml
-  installDirBy(runtime_dir, ocaml_dir, function(file) {
-    var y = path.parse(file);
-    return y.name === "js" && y.ext !== ".cmj";
-    // install js.cmi, js.mli
-  });
-
-  // for merlin or other IDE
-  var installed_suffixes = [".ml", ".mli", ".cmi",".cmt", ".cmti"];
-  installDirBy(others_dir, ocaml_dir, function(file) {
-    var y = path.parse(file);
-    return installed_suffixes.includes(y.ext);
-  });
-  installDirBy(stdlib_dir, ocaml_dir, function(file) {
-    var y = path.parse(file);
-    return installed_suffixes.includes(y.ext)
-  });
-}
 
 function buildCompiler() {
   // for 4.02.3 it relies on OCAMLLIB to find stdlib path
@@ -104,7 +51,7 @@ if (!is_windows) {
 
 function createOCamlTar() {
   if (process.platform === hostPlatform) {
-    install();
+    require("./installUtils.js").install();
     cp.execSync(`git -C ocaml status -uno`, { cwd: root, stdio: [0, 1, 2] });
     cp.execSync(
       `git  -C ocaml archive --format=tar.gz HEAD -o ../vendor/ocaml.tar.gz`,

Original file line number	Diff line number	Diff line change
`@@ -224,4 +224,5 @@ var stdlib = ocamlVersion.includes("4.02") ? "stdlib-402" : "stdlib-406";`
`224`	`224`
`225`	`225`	`if (process.env.BS_TRAVIS_CI) {`
`226`	`226`	`buildLibs(stdlib);`
	`227`	`+ require('./installUtils.js').install()`
`227`	`228`	`}`