JEO xmir Format Documentation

[volodya-lombrozo]

Originally issue comes from this comments:

#687 (comment)

@volodya-lombrozo I understand. How about we make JEO more strict by writing the documentation for it. Basically, we must explain to the users of JEO-output what is possible to do with it in order to keep it understandable by JEO. If you publish such a documentation, we will make sure our normalizations/optimizations send to JEO only the XMIR it is prepared for.

and #687 (comment)

@volodya-lombrozo XSD is a rather weak format, it won't allow you to define complex rules. It's mostly about types of data. Maybe a collection of XPath assertions (both "positive" that must be in the incoming XMIR and "negative" that are not allowed). Just an idea.

We should write documentation about xmir generated by jeo-maven-plugin. Also, it's important to add xsd file that would check xmir before even trying to parse it.

BTW, we can try to generate documentation directly from xsd file.

[yegor256]

@volodya-lombrozo I believe, this problem is solved. Our XMIR is much more detailed now and strict: https://www.eolang.org/XMIR.xsd Its documentation is here: https://www.eolang.org/XMIR.html Moreover, we have a list of lints now, on top of XMIR: https://github.com/objectionary/lints/

[volodya-lombrozo]

@yegor256 It's the issue related to xmir generated by jeo. Not for xmir in general. I suppose this XSD for jeo should have a narrow definition. For example, we can mention where opcodes are placed.