search

errata-ai / vale

:pencil: A markup-aware linter for prose built with speed and extensibility in mind.
https://vale.sh
MIT License
4.42k stars 150 forks source link

latex support #54

Closed hermannsblum closed 5 years ago

hermannsblum commented 6 years ago

Especially for academic writing this tool would be awesome, but with the only scope beeing text the styleguides are not very useful.

jdkato commented 6 years ago

Thanks for the suggestion.

This actually existed in an earlier version, but our current parsing technique of markup -> HTML didn't fit very well with LaTeX (there were a lot of syntax-related false positives). I'd like to bring this back eventually, though (especially since I do most of my writing in LaTeX, too).

languitar commented 6 years ago

For the reference, i think for my main use cases, a simple script that I could hand-craft for preprocessing LaTeX should be enough to eliminate most of the parsing issues. The only problem is that exact locations get lost in that process.

ProgramFan commented 6 years ago

Another reference: vale works with latex document at the moment and the only downside is the false-positives in listings, macros, and comments. So It might be easier to just double check an error if it resides in such environments, which can be done using regular expressions.

hermannsblum commented 6 years ago

Unfortunately, there are also a lot of false-negatives as all rules set for a specific scope like paragraph get ignored.

jdkato commented 5 years ago

I think this is something that I'm going to close for now, as I was unable to implement a means of handling LaTeX well: ignoring certain sections is doable with regular expressions (as mentioned above), but supporting Vale's markup-related scopes (e.g., heading, paragraph, blockquote, etc.) is difficult without an AST to traverse.

Some ideas that could be explored, though, are using Pandoc's AST or a library like syntect to create one.

CsatiZoltan commented 5 years ago

You yourself linked this site in the examples section. That author deals with the Latex-specific markup using detex.py. Is it possible to somehow use that to make vale support Latex?

jdkato commented 5 years ago

No, my comment above (https://github.com/errata-ai/vale/issues/54#issuecomment-356004908) still addresses this issue: Vale needs an AST-like structure to traverse in order to "support" a format.

CsatiZoltan commented 5 years ago

I have an idea, maybe it could be useful. I realized that when I use LanguageTool from within TeXstudio, LanguageTool does not parse the Latex-related commands/environments. Note that "LanguageTool does not support stripping TeX formatting markup", so it must be TeXstudio which does it. Indeed, this header file defines the LanguageTool interface and this directory is responsible for parsing Latex. I am not a computer scientist, so I don't know if this is an AST-like structure you need.

tronroberto commented 4 years ago

Would this help? https://github.com/stepmuel/tex2ast