Details
-
User Story
-
Resolution: Done
-
Not Evaluated
-
None
-
None
Description
vale is an open-source, command-line tool to check spelling, grammar, and documentation style in markup and plain text. It is, for instance, used by technical writers for checking Qt documentation. Direct support for it in Qt Creator would allow easy use of the tool.
Integration options
vale both provides a command line tool. There's also a language server (vale-ls) wrapping the CLI tool.
See https://vale.sh/docs/integrations/guide/ for more details.
Basic integration
Basic integration would check the active file open in the editor upon user request. Issues that are found would then show up in the Issues pane.
Further integrations
Ideas for further extensions:
- Showing issues in the editor itself
- Support for quick fixes
- Allow to check unsaved files
- Allow to check all files open in editor / all files in project
- Direct way to edit configuration
Attachments
Issue Links
- relates to
-
QTCREATORBUG-1861 Spell checking in comment blocks
-
- Open
-