Fix support for multi-lines commands #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sorawee
added a commit
to sorawee/mdx
that referenced
this pull request
Dec 2, 2023
Prior this PR, the following code fails:
```
{@ocaml ocaml[
#require "astring";;
let x = Astring.strf;;
]}
```
because MDX incorrectly infers that the code block is a toplevel
interaction (from the fact that the block starts with `#`),
resulting in an error:
incomplete toplevel entry: unexpected character '#'.
Did you forget a space after the '#' at the start of the line
It is possible to workaround this issue as suggested in realworldocaml#421 by adding a
comment as a first line.
```
{@ocaml ocaml[
(* This works! *)
#require "astring";;
let x = Astring.strf;;
]}
```
but ideally the workaround should not be needed.
One may wonder why the inference is needed, since the above code block
is already specified to be in the `ocaml` mode.
The answer appears to be that we are expected to use the inference heuristics
for a light sanity check, as the existing tests
("invalid ocaml" and "invalid toplevel" in `test_block.ml`) require:
"let x = 2;;" in the toplevel mode should error with
invalid toplevel syntax in toplevel blocks
"# let x = 2;;" in the ocaml mode should error with
toplevel syntax is not allowed in OCaml blocks
As a result, this PR keeps the light sanity check intact, but
adjusts the inference heuristics to be more conservative.
A block is now considered a toplevel interaction when
it starts with `#` followed by a space.
This fixes the issue, making it possible to use directives.
As a bonus, directives will now also work even when
the mode is not specified at all. But one disadvantage is that
this kind of code will no longer be considered invalid.
realworldocaml#1+1;;
...
realworldocaml#2+2;;
...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.