Non-server command-line interface (CLI)

[hdorgeval]

Hi, I am using your extension to manually correct markdown files and it works great!

I would like to know if there is a way to write a script inside my visual studio project (nodejs + typescript), that could tell for any given markdown filepath if there is an error or not in the file.

Thanks for your response.

---

Note: Originally posted as issue 317 “How to use this extension programmatically?” at valentjn/vscode-ltex.

[valentjn]

LT_EX uses the Language Server Protocol (LSP) architecture, which separates the display of diagnostics (“language client”) from the actual checking of documents (“language server”). Therefore, LT_EX is split into the language client vscode-ltex and the language server ltex-ls. You should use ltex-ls instead and communicate with it via LSP messages. You can do so via standard input and output or via TCP sockets. Maybe we can add a non-server, file checker mode to ltex-ls.

[hdorgeval]

@valentjn : thanks for your answer.

It would be great if you could provide a non-server, file checker mode to ltex-ls.

[valentjn]

It's not straightforward, and I'm currently pretty busy, so this will take a while. Learning to use the LSP might be faster for you. The file checker will probably print the results in the LSP response format, anyway.

[valentjn]

This is now implemented via --input-documents. I opted for a human-readable output, which may be processed by scripts at the same time. The exit code indicates whether no grammar/spelling errors were found (exit code 0), or at least one error (exit code 3).

[hdorgeval]

Hi @valentjn , thank you so much for integrating this new feature 👍 .

I will test it and I will give you some feedback as soon as it is published.

Regards

[valentjn]

FWIW, develop, which includes this feature, is already published as pre-release on a nightly basis. The same holds for vscode-ltex, which should be irrelevant in this case.

[valentjn]

Feature released in 13.0.0.