XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • Not Evaluated
    • None
    • None
    • All Other Issues
    • 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

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              davschul David Schulz
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes