Escape square brackets, braces and at characters in text nodes (fixes #4)

[dmbaturin]

As @Niols pointes out in #4,

special characters (’{’, ’}’, ’[’, ’]’ and ’@’) must be escaped by a ’\’.

None of these characters have any special meaning by themselves in Markdown. Square brackets only have a special meaning in the [<link text>](<link address>) syntax, and in that case Omd returns an Omd.Link node so they don't appear in the text. The only case when they can appear and need escaping is Omd.Text.

One peculiarity of current Omd versions is that insignificant square brackets still force it emit a text node, so any text with anything in square brackets will produce three nodes instead of one. It doesn't change escaping logic, however.

utop # Omd.of_string "[text in brackets]" ;;
- : Omd.doc =
[Omd.Paragraph ([],
  Omd.Concat ([],
   [Omd.Text ([], "["); Omd.Text ([], "text in brackets"); Omd.Text ([], "]")]))]

With my patch it seems to behave as expected:

$ echo 'Text with [square brackets], {braces}, and @-characters' | ./_build/default/src/md2mld.exe
Text with \[square brackets\], \{braces\}, and \@-characters

(Stdin reading support is from #8)

[mseri]

Thanks! As the other I’ll wait for ci to finish. I will make a new release in the next few days

[dmbaturin]

Thanks! As the other I’ll wait for ci to finish. I will make a new release in the next few days

Tests fail because of ocp-indent errors at the dune build @fmt stage, and the problem is that it fails on your original code, so that code needs to be reformatted before the CI run can succeed.

How should we go about it? Shall I make a separate PR for formatting fixes and rebase these two PRs to that new branch?

[mseri]

I should probably fix a ocaml format version. Let’s not worry about that

[mseri]

I’ll fix it manually before release tomorrow or on Tuesday

[dmbaturin]

@mseri I also wanted to add a --version option before the next release. I'm not sure what would be your preferred approach to storing the option, though — whether you are fine with a hardcoded constant or you prefer cppo or similar.

[mseri]

We can use dune subst mechanism I think