Commits on Dec 2, 2023

1. fix: make directives usable in the ocaml mode …

   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;;
       ...

   

   sorawee committed Dec 2, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for 3fd9e80
   • Browse repository at this point

   Copy the full SHA

   3fd9e80 View commit details

   Browse the repository at this point in the history