Uploaded image for project: 'Qt Creator'
  1. Qt Creator
  2. QTCREATORBUG-32964

Document how to use the new "Global qmlformat Configuration"

    XMLWordPrintable

Details

    • 428842dd5 (17.0)

    Description

      Preferences > Qt Quick > Code Style was revamped in Qt Creator 17 (QTCREATORBUG-32600), but the snapshot docs still show the old screenshot: https://doc-snapshots.qt.io/qtcreator-master/creator-preferences-qtquick-code-style.html

      We need to document the new options, especially the "Global qmlformat Configuration" field because users are expected to type in a config file (as opposed to using a GUI to select from possible options).

      What does that field expect? Is it .qmlformat.ini entries? I made an educated guess, and that seems to be it (but users shouldn't be expected to guess):

       

      Ideally, the Qt Creator docs can simply point users to the official qmlformat docs. Unfortunately, those haven't been written yet: QTBUG-127286

      Furthermore, even though the preview pane shows that my settings would use Tabs instead of Spaces, the code editor still gives me spaces: QTCREATORBUG-32963

      Attachments

        Issue Links

          depends on

          Suggestion - Public suggestions QTBUG-127286 Provide documentation for all options and their valid values for .qmlformat.ini file

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. QTCREATORBUG-32963 [Reg 16.0.1 -> 17.0.0b1] Custom Qt Quick code style is now ignored

          • P1: Critical - Urgent and Important, will STOP the release if matched with set FixVersion field. This includes regressions from the last version that are not edge cases; Data loss; Build issues; Flaky tests; All but the most unlikely crashes/lockups/hanging; Serious usability issues and embarrassing bugs & Bugs critical to a deliverable. This is the highest possible priority for requirements.
          • Closed
          resulted from

          Technical task - A technical task. QTCREATORBUG-32358 Add settings widget in the QtC Preferences

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Technical task - A technical task. QTCREATORBUG-32600 separate builtin formatter and qmlformat settings

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          For Gerrit Dashboard: QTCREATORBUG-32964
          # Subject Branch Project Status CR V
          647498,4 Document qmlformat global configuration 17.0 qt-creator/qt-creator Status: MERGED +2 +1

          Activity

            People

              semih.yavuz Semih Yavuz
              skoh-qt Sze Howe Koh
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes