Merge pull request #3854 from ulrikstrid/develop-with-esy

Minimal changes to allow developing with esy

Author: bobzhang

4061.json

@@ -0,0 +1,8 @@
+{
+  "source": "./esy.json",
+  "override": {
+    "resolutions": {
+      "ocaml": "bucklescript/ocaml:package.json#4582c3fcce632aaa0f9794f5518bf5d9ad4a6385"
+    }
+  }
+}

CONTRIBUTING.md

@@ -34,6 +34,7 @@ The extension requires using an opam switch for ocaml 4.02.3, where `merlin` and
 ```
 ./script/ninja.js docs
 ```
+
 #### Edit file and test changes
 
 In general, you'd edit files and rerun `./scripts/ninja.js build`.
@@ -70,6 +71,30 @@ git -C ocaml checkout 4.06.1+BS && node ./scripts/buildocaml.js
 
 Note: clean up is necessary since the binary artifacts between versions of compiler may be incompatible.
 
+### Using esy in development (experimental)
+
+You can use [esy](https://esy.sh) to develop bucklescript. By default esy will do "out of source builds" which means that all the changes will happen outside the current directory. To be able to bspack the needed files and get sources that you can commit you will have to change the following in the `esy.json`.
+
+```diff
+-"buildsInSource": true,
++"buildsInSource": "unsafe",
+```
+
+When that is changed you just run the following command it will build everything you need.
+
+    esy
+
+By default we depend on the 4.02.3+BS OCaml compiler. To be able to build with the 4.06.1+BS compiler we have a `4061.json` file that just extends the `esy.json` and overrides the OCaml dependency. To use this file instead you simply run this command instead.
+
+    esy @4061
+
+If there are problems building try to run one of the following depending on what you're building
+
+```
+esy clean
+esy @4061 clean
+```
+
 ## Test on a Dummy Project
 
 Go somewhere else and do this:
@@ -86,7 +111,6 @@ And whenever you modify a file in bucklescript, run this:
 npm install -g .
 ```
 
-
 ## Change the Vendored OCaml Compiler
 
 This section is reserved for when you're making a change to the vendored ocaml compiler itself, in `ocaml`, and then testing on super-errors changes at the same time. If you're doing this for whatever reason, then the previous quick iteration workflow wouldn't work. Here's what you have to do after each change:
@@ -109,6 +133,7 @@ Currently all tests are in `jscomp/test` directory and you should either add/mod
 
 - Add the filename in `jscomp/test/test.mllib`
 - Add a test suite. The specification is in `jscomp/test/mt.ml`. For example some simple tests would be like:
+
   ```ocaml
   let suites : _ Mt.pair_suites =
      ["hey", (fun _ -> Eq(true, 3 > 2));

esy.json

@@ -10,6 +10,9 @@
   "resolutions": {
     "ocaml": "bucklescript/ocaml:package.json#698e60f3cd2f442f2013e79860ce2f7b0a9624cb"
   },
+  "scripts": {
+    "clean": "node ./scripts/ninja.js clean"
+  },
   "esy": {
     "buildsInSource": true,
     "build": [
@@ -18,10 +21,17 @@
       ["cp", "-r", "-f", "#{self.root / 'esy.json'}", "#{self.install}"],
       ["cp", "-r", "-f", "#{self.root / 'package.json'}", "#{self.install}"],
       ["cp", "-r", "-f", "#{self.root / 'jscomp'}", "#{self.install}"],
+      ["cp", "-r", "-f", "#{self.root / 'jscomp' / 'bin'}", "#{self.install}"],
       ["cp", "-r", "-f", "#{self.root / 'lib'}", "#{self.install}"],
       ["cp", "-r", "-f", "#{self.root / 'scripts'}", "#{self.install}"],
       ["cp", "-r", "-f", "#{self.root / 'vendor'}", "#{self.install}"]
     ],
+    "buildDev": [
+      ["echo", "config"],
+      ["node", "./scripts/ninja.js", "config"],
+      ["echo", "build"],
+      ["node", "./scripts/ninja.js", "build"]
+    ],
     "buildEnv": {
       "ESY": "true"
     },

scripts/ninja.js

@@ -28,6 +28,7 @@ var othersTarget = pseudoTarget("others");
 var stdlibTarget = pseudoTarget("$stdlib");
 
 var vendorNinjaPath = path.join(
+  __dirname,
   "..",
   "vendor",
   "ninja",
@@ -115,7 +116,7 @@ var useEnv = false;
  * Note ocamldep.opt has built-in macro handling OCAML_VERSION
  */
 var getOcamldepFile = () => {
-  if (useEnv) {
+  if (useEnv || process.env.ESY === "true") {
     return `ocamldep.opt`;
   } else {
     return path.join(
@@ -1479,6 +1480,7 @@ function setSortedToString(xs) {
  * @returns {string}
  */
 function getVendorConfigNinja() {
+  if (process.env.ESY === "true") return getEnnvConfigNinja();
   var prefix = `../native/${require("./buildocaml.js").getVersionPrefix()}/bin`;
   return `
 ocamlopt = ${prefix}/ocamlopt.opt
@@ -1492,6 +1494,7 @@ function getEnnvConfigNinja() {
 ocamlopt = ocamlopt.opt    
 ocamllex = ocamllex.opt
 ocamlmklib = ocamlmklib
+ocaml = ocaml
 `;
 }
 
@@ -1782,10 +1785,19 @@ function main() {
 
         break;
       case "cleanbuild":
-        console.log(`run cleaning first`)
-        cp.execSync(`node ${__filename} clean`,{cwd:__dirname,stdio:[0,1,2]})
-        cp.execSync(`node ${__filename} config`,{cwd:__dirname,stdio:[0,1,2]})
-        cp.execSync(`node ${__filename} build`,{cwd:__dirname,stdio:[0,1,2]})
+        console.log(`run cleaning first`);
+        cp.execSync(`node ${__filename} clean`, {
+          cwd: __dirname,
+          stdio: [0, 1, 2]
+        });
+        cp.execSync(`node ${__filename} config`, {
+          cwd: __dirname,
+          stdio: [0, 1, 2]
+        });
+        cp.execSync(`node ${__filename} build`, {
+          cwd: __dirname,
+          stdio: [0, 1, 2]
+        });
         break;
       case "docs":
         console.log(`building docs`);