Monorepo support (e.g. yarn workspaces)

.gitignore

@@ -37,3 +37,8 @@ doc/tags
 !rescript-vscode/extension/server/win32/rescript-editor-support.exe
 
 rescript-vscode/extension/server/node_modules/.bin/
+
+examples/**/node_modules
+examples/**/lib
+examples/**/src/*.js
+examples/**/.merlin

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## master
 
+- Improves tooling detection (`bsc`, `bsb`) in a monorepo like setup (`yarn workspaces`)
 - Fixes issue with long template strings breaking the syntax highlighting
 
 ## 1.1.0

README.md

@@ -15,6 +15,7 @@
 - Filetype detection for `.res`, `.resi`
 - Basic automatic indentation
 - Includes LSP for coc-vim usage
+- Proper tooling detection for monorepo like setups (yarn workspaces)
 
 **Provided by vim-rescript commands:**
 - Formatting `.res` files w/ syntax error diagnostics in VIM quickfix

autoload/rescript.vim

@@ -32,7 +32,7 @@ function! rescript#Init()
   endif
 
   " Looks for the nearest node_modules directory
-  let l:res_bin_dir = finddir('node_modules', ".;") . "/bs-platform/" . b:rescript_arch
+  let l:res_bin_dir = finddir('node_modules/bs-platform/', ".;") . b:rescript_arch
 
   "if !exists("g:rescript_compile_exe")
   let g:rescript_compile_exe = l:res_bin_dir . "/bsc.exe"

examples/monorepo-yarn-workspaces/README.md

@@ -0,0 +1,23 @@
+# yarn workspaces monorepo example
+
+This example setup is using the `yarn workspace` feature in combination with ReScript's `pinned-dependencies`.
+
+**Expected IDE plugin behavior:**
+
+When the editor is opened in one of the subprojects `app` or `common`, the editor extension should correctly detect the `bsc` and `bsb` binary in the monorepo root's `node_modules` directory.
+
+```
+cd app
+nvim .
+```
+
+## Setup
+
+```
+cd examples/monorepo-yarn-workspaces
+yarn
+
+# Build the full project
+cd app
+yarn run build
+```

examples/monorepo-yarn-workspaces/app/bsconfig.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://raw.githubusercontent.com/rescript-lang/rescript-compiler/master/docs/docson/build-schema.json",
+  "name": "app",
+  "version": "1.0.0",
+  "sources": {
+    "dir" : "src",
+    "subdirs" : true
+  },
+  "package-specs": {
+    "module": "commonjs",
+    "in-source": true
+  },
+  "suffix": ".js",
+  "bs-dependencies": [
+    "reason-react",
+    "common"
+  ],
+  "pinned-dependencies": ["common"],
+  "ppx-flags": [],
+  "bsc-flags": ["-bs-super-errors", "-bs-no-version-header"],
+  "warnings": {
+    "number": "-44",
+    "error": "+8+26+27+101"
+  },
+  "reason": {"react-jsx": 3}
+}

examples/monorepo-yarn-workspaces/app/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "app",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "common": "1.0.0"
+  },
+  "scripts": {
+    "clean": "bsb -clean-world",
+    "build": "bsb -make-world",
+    "watch": "bsb -make-world -w"
+  },
+  "devDependencies": {
+    "bs-platform": "^8.4.2"
+  }
+}

examples/monorepo-yarn-workspaces/app/src/App.res

@@ -0,0 +1,9 @@
+@react.component
+let make = () => {
+  Common.Header.make(Js.Obj.empty())->Js.log
+  Common.Footer.make(Js.Obj.empty())->Js.log
+
+  <> <Common.Header /> <div> {React.string("Main content")} <Common.Footer /> </div> </>
+}
+
+make(Js.Obj.empty())->Js.log

examples/monorepo-yarn-workspaces/common/bsconfig.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://raw.githubusercontent.com/rescript-lang/rescript-compiler/master/docs/docson/build-schema.json",
+  "name": "common",
+  "namespace": "Common",
+  "version": "0.0.1",
+  "sources": {
+    "dir" : "src",
+    "subdirs" : true
+  },
+  "package-specs": {
+    "module": "commonjs",
+    "in-source": true
+  },
+  "suffix": ".js",
+  "bs-dependencies": [
+    "reason-react"
+  ],
+  "ppx-flags": [],
+  "bsc-flags": ["-bs-super-errors", "-bs-no-version-header"],
+  "warnings": {
+    "number": "-44",
+    "error": "+8+26+27+101"
+  },
+  "reason": {"react-jsx": 3}
+}

examples/monorepo-yarn-workspaces/common/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "common",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "clean": "bsb -clean-world",
+    "build": "bsb -make-world",
+    "watch": "bsb -make-world -w"
+  },
+  "dependencies": {
+    "reason-react": "^0.9.1"
+  },
+  "devDependencies": {
+    "bs-platform": "^8.4.2"
+  }
+}

examples/monorepo-yarn-workspaces/common/src/Footer.res

@@ -0,0 +1,4 @@
+@react.component
+let make = () => {
+  <div> {React.string("Footer")} </div>
+}

examples/monorepo-yarn-workspaces/common/src/Header.res

@@ -0,0 +1,4 @@
+@react.component
+let make = () => {
+  <div> {"Header"->React.string} </div>
+}

examples/monorepo-yarn-workspaces/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "rescript-yarn-workspaces-example",
+  "private": true,
+  "workspaces": {
+    "packages": [
+      "app",
+      "common"
+    ]
+  }
+}

examples/monorepo-yarn-workspaces/yarn.lock

@@ -0,0 +1,13 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+bs-platform@^8.4.2:
+  version "8.4.2"
+  resolved "https://registry.yarnpkg.com/bs-platform/-/bs-platform-8.4.2.tgz#778dabd1dfb3bc95e0086c58dabae74e4ebdee8a"
+  integrity sha512-9q7S4/LLV/a68CweN382NJdCCr/lOSsJR3oQYnmPK98ChfO/AdiA3lYQkQTp6T+U0I5Z5RypUAUprNstwDtMDQ==
+
+reason-react@^0.9.1:
+  version "0.9.1"
+  resolved "https://registry.yarnpkg.com/reason-react/-/reason-react-0.9.1.tgz#30a887158200b659aa03e2d75ff4cc54dc462bb0"
+  integrity sha512-nlH0O2TDy9KzOLOW+vlEQk4ExHOeciyzFdoLcsmmiit6hx6H5+CVDrwJ+8aiaLT/kqK5xFOjy4PS7PftWz4plA==