Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix esy sandbox setup #1297

Merged
merged 3 commits into from
Dec 7, 2023
Merged

Fix esy sandbox setup #1297

merged 3 commits into from
Dec 7, 2023

Conversation

AriaFallah
Copy link
Contributor

@AriaFallah AriaFallah commented Dec 4, 2023

This wasn't working for me, and I eventually found this #1222 (comment)

{
  "ocaml.sandbox": {
    "kind": "esy",
    "root": "${firstWorkspaceFolder}"
  }
}

Is the correct way to do this by default

@smorimoto
Copy link
Collaborator

@AriaFallah Could you add a change log entry?

@smorimoto smorimoto added the type: documentation Improvements or additions to documentation label Dec 6, 2023
Copy link
Collaborator

@mnxn mnxn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That section of the README is just an example configuration. The old version wasn't incorrect, it just has the name of the folder in the variable, which means the example only works in workspaces with the vscode-ocaml-platform folder. If you use the sandbox selector UI or commands in VS Code, it should automatically change absolute paths to use the correct variable for your environment.

That being said, changing the example is a good idea if it's misleading users this way.
The README should probably document both ways (${workspaceFolder:folderName} and ${firstWorkspaceFolder}) in the future though.

@smorimoto smorimoto merged commit 6cbdaa8 into ocamllabs:master Dec 7, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants