qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qtdeclarative/tests/auto/qml/qmlformat/tst_qmlformat.cpp

1071 lines
45 KiB
C++
Raw Normal View History

Use SPDX license identifiers Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I63563bbeb6f60f89d2c99660400dca7fab78a294 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
2022-05-13 13:12:05 +00:00
// Copyright (C) 2019 The Qt Company Ltd.
Correct license for test files According to QUIP-18 [1], all test files should be LicenseRef-Qt-Commercial OR GPL-3.0-only [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: I26d72e8de04d4c7c57b3b7838af5d033265de5ba Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-02-22 14:51:16 +00:00
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
#include <QtTest/QtTest>
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
#include <QDir>
#include <QFile>
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
#include <QProcess>
#include <QString>
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
#include <QTemporaryDir>
qmlformat: use QmlDom Replace qmlformat with the formatter using qml dom Change-Id: Ie90814260f2d3b9e589ce04381d5ad1880c5b519 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-04-19 14:43:21 +00:00
#include <QtTest/private/qemulationdetector_p.h>
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
#include <QtQuickTestUtils/private/qmlutils_p.h>
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
#include <QtQmlDom/private/qqmldomitem_p.h>
#include <QtQmlDom/private/qqmldomlinewriter_p.h>
#include <QtQmlDom/private/qqmldomoutwriter_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
qmlformat: fix --write-defaults Prior to this commit, --write-defaults was only writing the subset of the existing settings. In fact, each setting has a default value and those should be seen in the .qmlformat.ini file to be written. Pick-to: 6.8 6.9 Change-Id: Ie7f8fac653d0bc7099821136f5ad8ce8ee14c714 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-21 16:08:42 +00:00
#include <QtQmlToolingSettings/private/qqmltoolingsettings_p.h>
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
#include <QtQmlFormat/private/qqmlformatoptions_p.h>
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
using namespace QQmlJS::Dom;
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
// TODO refactor extension helpers
const QString QML_EXT = ".qml";
const QString JS_EXT = ".js";
const QString MJS_EXT = ".mjs";
static QStringView fileExt(QStringView filename)
{
if (filename.endsWith(QML_EXT)) {
return QML_EXT;
}
if (filename.endsWith(JS_EXT)) {
return JS_EXT;
}
if (filename.endsWith(MJS_EXT)) {
return MJS_EXT;
}
Q_UNREACHABLE();
};
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
class TestQmlformat: public QQmlDataTest
{
Q_OBJECT
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
public:
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
enum class RunOption { OnCopy, OrigToCopy };
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
TestQmlformat();
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
private Q_SLOTS:
void initTestCase() override;
QmlFormat: Support .js files (CLI tool) This commit contains last pieces of changes necessary for the formatting of .js files using qmlformat CLI. What's not included: normalize && function spacing for .js files Task-number: QTBUG-117849 Pick-to: 6.7 Change-Id: I6a4260f074ce05ce07cdcff185a1cf7737d3a44c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 13:19:41 +00:00
//actually testFormat tests CLI of qmlformat
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
void testFormat();
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
void testFormat_data();
qmlformat: Fix nested ifs Fixes: QTBUG-85077 Change-Id: Ia2fec64a389fd7355f3fcf9438408b021c5abef4 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-06-17 12:06:11 +00:00
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
void testLineEndings();
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void testExample();
void testExample_data();
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
void normalizeExample();
void normalizeExample_data();
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
qmlformat: do not generate backup files qmlformat used to backup the original input file up to 2 copies when used with --inplace mode. Change this hardcoded number into 0 and generate no backup file. Fixes: QTBUG-107685 Change-Id: Ifca86968fa65be0fd678012fc2e41b9ed8601d21 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-10-19 10:50:31 +00:00
void testBackupFileLimit();
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
void testFilesOption_data();
void testFilesOption();
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
void plainJS_data();
void plainJS();
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
void ecmascriptModule();
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
void commandLineOptions_data();
void commandLineOptions();
qmlformat: fix --write-defaults Prior to this commit, --write-defaults was only writing the subset of the existing settings. In fact, each setting has a default value and those should be seen in the .qmlformat.ini file to be written. Pick-to: 6.8 6.9 Change-Id: Ie7f8fac653d0bc7099821136f5ad8ce8ee14c714 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-21 16:08:42 +00:00
void writeDefaults();
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
void settingsFromFileOrCommandLine_data();
void settingsFromFileOrCommandLine();
qmlformat: fix precedence of settings Options set through commandline should have the precedence over the settings read from .ini file. Introduce a mapper in the setting, that marks the option if set by command line input. Add more tests. Pick-to: 6.8 6.9 Fixes: QTBUG-133225 Change-Id: Id0b18655f7bf64670dab4e38f5aff2fdaa889f1b Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-24 12:51:04 +00:00
void multipleSettingsFiles();
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
void qml_data();
void qml();
qmlformat: fix precedence of settings Options set through commandline should have the precedence over the settings read from .ini file. Introduce a mapper in the setting, that marks the option if set by command line input. Add more tests. Pick-to: 6.8 6.9 Fixes: QTBUG-133225 Change-Id: Id0b18655f7bf64670dab4e38f5aff2fdaa889f1b Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-24 12:51:04 +00:00
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
private:
QString readTestFile(const QString &path);
QmlFormat: Support .js files (CLI tool) This commit contains last pieces of changes necessary for the formatting of .js files using qmlformat CLI. What's not included: normalize && function spacing for .js files Task-number: QTBUG-117849 Pick-to: 6.7 Change-Id: I6a4260f074ce05ce07cdcff185a1cf7737d3a44c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 13:19:41 +00:00
//TODO(QTBUG-117849) refactor this helper function
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
QString runQmlformat(const QString &fileToFormat, QStringList args, bool shouldSucceed = true,
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
RunOption rOption = RunOption::OnCopy, QStringView ext = QML_EXT);
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QString formatInMemory(const QString &fileToFormat, bool *didSucceed = nullptr,
LineWriterOptions options = LineWriterOptions(),
WriteOutChecks extraChecks = WriteOutCheck::ReparseCompare,
WriteOutChecks largeChecks = WriteOutCheck::None);
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
QString m_qmlformatPath;
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QStringList m_excludedDirs;
QStringList m_invalidFiles;
Dom: add QQmlJSScope to QmlObject Add a flag that allows to construct the Dom with the QQmlJSScopes obtained by semantic analysis. Added a new AST visitor called QQmlDomAstCreatorWithQQmlJSScope. This visitor synchronizes the qqmldomastcreator and the qqmljsimportvisitor to construct the Dom and the QQmlJSScope from the AST at the same time. It mainly does keeping track which subvisitor (dom creator or scope creator) is active, as one subvisitor may visit AST nodes that the other does not. Using both visitors at the same time allows to insert the newly-generated QQmlJSScope::Ptr directly into the correct Dom structure. The actual implementation of QQmlDomAstCreatorWithQQmlJSScope is in its visitT and endVisitT methods. Both are called in the AST-visitor-overloads. Added a benchmark on two big generated qml files to see how fast/slow does the qqmljsccope semantic analysis runs, compared to the QmlDom creation runtime. Task-number: QTBUG-92876 Change-Id: Ia05b6fdd59a637fef9c14b6ab284f4550414f908 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-03-07 14:49:30 +00:00
QStringList m_ignoreFiles;
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QStringList findFiles(const QDir &);
bool isInvalidFile(const QFileInfo &fileName) const;
Dom: add QQmlJSScope to QmlObject Add a flag that allows to construct the Dom with the QQmlJSScopes obtained by semantic analysis. Added a new AST visitor called QQmlDomAstCreatorWithQQmlJSScope. This visitor synchronizes the qqmldomastcreator and the qqmljsimportvisitor to construct the Dom and the QQmlJSScope from the AST at the same time. It mainly does keeping track which subvisitor (dom creator or scope creator) is active, as one subvisitor may visit AST nodes that the other does not. Using both visitors at the same time allows to insert the newly-generated QQmlJSScope::Ptr directly into the correct Dom structure. The actual implementation of QQmlDomAstCreatorWithQQmlJSScope is in its visitT and endVisitT methods. Both are called in the AST-visitor-overloads. Added a benchmark on two big generated qml files to see how fast/slow does the qqmljsccope semantic analysis runs, compared to the QmlDom creation runtime. Task-number: QTBUG-92876 Change-Id: Ia05b6fdd59a637fef9c14b6ab284f4550414f908 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-03-07 14:49:30 +00:00
bool isIgnoredFile(const QFileInfo &fileName) const;
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
};
Add convenience API for making QQmlDataTest-based tests fail on warnings After this patch, if a QQmlDataTest-derived class passes FailOnWarningsPolicy::FailOnWarnings to the base constructor, any non-empty warning encountered by that test will result in a test failure. This avoids the need to duplicate the catch-all regex in tests that want to fail on warnings. The goal is to gradually enable failure-on-warnings over time. Leave comments and explicitly pass DoNotFailOnWarnings for tests that should never fail on warnings. Task-number: QTBUG-98718 Pick-to: 6.2 6.3 6.4 Change-Id: I4b647d93a0f28ac891c4bdb19ef74569f2918e8f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-06-07 02:23:31 +00:00
// Don't fail on warnings because we read a lot of QML files that might intentionally be malformed.
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
TestQmlformat::TestQmlformat()
Add convenience API for making QQmlDataTest-based tests fail on warnings After this patch, if a QQmlDataTest-derived class passes FailOnWarningsPolicy::FailOnWarnings to the base constructor, any non-empty warning encountered by that test will result in a test failure. This avoids the need to duplicate the catch-all regex in tests that want to fail on warnings. The goal is to gradually enable failure-on-warnings over time. Leave comments and explicitly pass DoNotFailOnWarnings for tests that should never fail on warnings. Task-number: QTBUG-98718 Pick-to: 6.2 6.3 6.4 Change-Id: I4b647d93a0f28ac891c4bdb19ef74569f2918e8f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-06-07 02:23:31 +00:00
: QQmlDataTest(QT_QMLTEST_DATADIR, FailOnWarningsPolicy::DoNotFailOnWarnings)
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
{
}
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
void TestQmlformat::initTestCase()
{
QQmlDataTest::initTestCase();
Fix additional warnings from usage of deprecated APIs Replace more QLibaryInfo::location with QLibraryInfo::path Replace old event accessors APIs, including relevant comments. Change-Id: Ie205fc93b6e1c0dfb3dca9100fbde417ab68fc9f Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
2020-09-16 08:34:53 +00:00
m_qmlformatPath = QLibraryInfo::path(QLibraryInfo::BinariesPath) + QLatin1String("/qmlformat");
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
#ifdef Q_OS_WIN
m_qmlformatPath += QLatin1String(".exe");
#endif
if (!QFileInfo(m_qmlformatPath).exists()) {
QString message = QStringLiteral("qmlformat executable not found (looked for %0)").arg(m_qmlformatPath);
QFAIL(qPrintable(message));
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
// Add directories you want excluded here
// These snippets are not expected to run on their own.
m_excludedDirs << "doc/src/snippets/qml/visualdatamodel_rootindex";
m_excludedDirs << "doc/src/snippets/qml/qtbinding";
m_excludedDirs << "doc/src/snippets/qml/imports";
m_excludedDirs << "doc/src/snippets/qtquick1/visualdatamodel_rootindex";
m_excludedDirs << "doc/src/snippets/qtquick1/qtbinding";
m_excludedDirs << "doc/src/snippets/qtquick1/imports";
m_excludedDirs << "tests/manual/v4";
qmlls: Fix TextSynchronization The offset from a given range was incorrectly calculated in findBlockByNumber because textblocks that are used to obtain that position were mistakenly ignoring the newline character. This were leading us to setting a different text than what we actually typed. Add an extra text block if the text ends with \n. Add a manual test but exclude it from tst_qmlformat as it is not a valid qml document. Fixes: QTBUG-113725 Change-Id: Ifb1b4121fd8af46df7627d986303ae67e170e50c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-05-23 13:02:50 +00:00
m_excludedDirs << "tests/manual/qmllsformatter";
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
m_excludedDirs << "tests/auto/qml/ecmascripttests";
m_excludedDirs << "tests/auto/qml/qmllint";
// Add invalid files (i.e. files with syntax errors)
m_invalidFiles << "tests/auto/quick/qquickloader/data/InvalidSourceComponent.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.5.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/property.4.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/empty.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/missingObject.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/insertedSemicolon.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nonexistantProperty.5.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidRoot.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.2.qml";
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidID.4.qml";
Implement optional chaining This change implements optional chaining (https://github.com/tc39/proposal-optional-chaining) by adding a new type of optional lookup with an offset to the end of a chain. If `undefined` or `null` is encountered during an access marked as optional, we jump to that end offset. Features: - Full support for all kinds of optional chain - With some codegen overhead but zero overhead during normal non-optional FieldMemberExpression resolution - Properly retains this contexts and does not need to resolve anything twice (this has been an issue previously) - No extra AST structures, just flags for existing ones [ChangeLog][QtQml] Added support for optional chaining (https://github.com/tc39/proposal-optional-chaining) Fixes: QTBUG-77926 Change-Id: I9a41cdc4ca272066c79c72b9b22206498a546843 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-04-09 15:42:06 +00:00
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/questionDotEOF.qml";
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
m_invalidFiles << "tests/auto/qml/qquickfolderlistmodel/data/dummy.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.3.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.4.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.5.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.6.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/numberParsing_error.1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/numberParsing_error.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
qmlformat: Fix inconsistent if statements Should now produce more consistent output for if statements. Fixes: QTBUG-82261 Change-Id: I39da0c80c4aadc2c5bdef32953c34ed9f0708a9e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-03-19 12:49:17 +00:00
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
m_invalidFiles << "tests/auto/qml/debugger/qqmlpreview/data/broken.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/fuzzed.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/fuzzed.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/requiredProperties.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_Or.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_RHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_RHS_Or.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/typeAnnotations.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlparser/data/disallowedtypeannotations/qmlnestedfunction.qml";
qmlls: autocomplete scriptexpressions Add some support for autocompletion in script expressions. Add missing getter in QQmlJSScope to be able to list js identifiers of a semantic scope in qmlls. Add static helper methods XXXCompletion that collect some information JavaScript identifiers, methods and properties made available from a QQmlJSScope. Another helper method collectFromAllJavaScriptParents can collect the results of a XXXCompletion method through all JavaScript scopes of a DomItem. Avoid code duplication and remove the implementation searching for methods in the DOM: instead, use the already existing implementation in QQmlJSScope::methods. Finally, add the method scriptIdentifierCompletion() that computes all autocompletions for a scriptIdentifier, that is called in QQmlLSUtils::completions and in the tests. Fix some tests to flag property as properties, inside of "Fields", and add extra tests to see if the newly implemented completions work. Cleanup QQmlLSUtils::completions() by extracting its code into static helper methods reachableTypes() and reachableMethods(), replace two enums by one QFlag as both enums were always used together. Extend reachableTypes() to find also non-object types, like the value types int, date, for example. This is later used for property type or function parameter type completion, for example. Make QQmlLSUtils::completions() more readable by returning early and by separating the completion by QML language constructs, instead of grouping multiple unrelated constructs together. This became possible thanks to the new static helpers mentioned above. Suppress completion inside of function parameter definitions and inside of id definitions. Add some tests for property type completion and pragma completion with QEXPECT_FAIL, those features will be implemented in a later commit. Add 'import' completion for empty files + a test that test completions on an empty file. Fix tests for colon-checking: some completions insert '<propertyName>: ' for properties, e.g. for bindings, and some do not, e.g. for property usage in JS expressions. Also fix the test in tst_qmlls_modules to expect methods instead of functions. Add exception in tst_qmlformat for the empty qml file used to test if completions work in a completely empty file. Task-number: QTBUG-116899 Change-Id: I63de62c71d63aa4ab62ca6d83c6be157f4e6f96c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-09-11 13:50:26 +00:00
m_invalidFiles << "tests/auto/qmlls/utils/data/emptyFile.qml";
qqmljs.g: insert empty identifiers when missing For the completion in qmlls, users usually expect to see a list of completions after typing in a T_DOT ("."). Sadly, this T_DOT usually makes the QML code invalid or ambiguous, such that the parser aborts parsing. For qmlls, this is quite bad: no completions can be proposed if the AST cannot be computed. Therefore, this commit tries to make the parser a little bit more resistant to missing T_IDENTIFIER behind T_DOT. Add a yyprevtoken field in the parser to keep track of what was the last successfully parsed token, and update it with yytoken before yytoken changes. Extract the pushTokenWithEmptyLocation() logic from the automatic semicolon inserting code, and reuse it for the automatic insertion of identifiers after dots. Add some tests in tst_qmlls_utils and adapt the qmlls completion code to work with missing right hand sides (RHS) of dotted expression `a.b`. Create a new file missingRHS.qml because yyy.qml does not seem to stop growing. The fix of this commit does not take care of all possible cases: when T_DOT is followed by an T_IDENTIFIER, then no T_IDENTIFIER is inserted even if the parsing fails afterwards. This happens when a JS statement is behind a T_DOT without identifier, for example. Add tests for that too, QEXPECT_FAIL them and put them in a separate file missingRHS.parserfail.qml. They need to be in a separate file because no completions can be obtained when the parser fails, and that affects all the completions of the entire file. This special file missingRHS.parserfail.qml also needs to be ignored by tst_qmlformat. Task-number: QTBUG-115836 Change-Id: If307430131a7df25ae9bd4ea0393d47c0641c8d3 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-17 13:23:20 +00:00
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/missingRHS.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/missingRHS.parserfail.qml";
qmlls: fix completion on attached and grouped properties Clean up the way in which qualified names (like attached properties) are being completed in bindings and whereever any JSStatement is expected. Qualified types are not being supported yet, this is being tracked into QTBUG-120111. Also add some QEXPECT_FAIL for the completions that fail because of the parser. Currently, we can do: ``` Component.on<request completion here> : {} ``` but we cannot do ``` Component.on<request completion here> ``` as the parser fails because of the missing `: {}`. Pick-to: 6.7 Task-number: QTBUG-120111 Fixes: QTBUG-120102 Fixes: QTBUG-117442 Change-Id: I6c9ccddcc881aa5253530746286e677407a4326d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-12-14 10:45:51 +00:00
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/attachedPropertyMissingRHS.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/groupedPropertyMissingRHS.qml";
qmlls: insert semicolons behind dots as completion workaround IDE's usually ask completion requests whenever users starts typing a '.'. For this patch, we assume that the user is currently writing code, that the '.' he just entered is followed by a newline and that the line below the cursor is unrelated, which should be a pretty realistic scenario of writing code. For example, imagine a user typing in following code: ``` x: root.<current cursor> SomeQualifiedModule.Item {} ``` The LSP client will request completion suggestions when the user types in `root.` and qmlls will be confused about the completion, as it will see a QmlObject binding in the Dom representation. Another example are JS statements, where the parser stops working when he sees ``` root.<current cursor> for (;;) {} ``` because it tries to construct the function call `root.for` and has troubles with the semicolons inside the function call argument. To go around this problem, insert semicolons when the symbol that requested the completion is a dot and when this dot is followed by a newline. In qqmlcompletionsupport, create a new Dom representation with the patched code, and keep it out the QQmlCodeModel to avoid bothering other modules, like the linting module, with the inserted "invisible" semicolon (invisible in the eyes of the user). Now, when the parser is run again on the patched code, it will see ``` root.; ``` and will happily create the correct field member expression using its recovery mode. One could also have inserted any identifier like '_dummyIdentifier' followed by a semicolon to get: ``` root._dummyIdentifier; ``` which would have worked too I believe. Add two tests, one in tst_qmlls_modules to test if the patched Dom can be used to provide the completions, and on in tst_qmlls_utils to test if the "normal" dom construction works on (hand)patched versions of the files. tst_qmlls_utils cannot test the patching itself as that happens in the qqmlcompletionsupport module. The afterDots.qml files are invalid and as such should be ignored by tst_qmlformat. Pick-to: 6.7 Fixes: QTBUG-119839 Change-Id: Ib914b78512894c423792588842d635d3d1467922 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-12-21 10:04:19 +00:00
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/afterDots.qml";
m_invalidFiles << "tests/auto/qmlls/modules/data/completions/bindingAfterDot.qml";
m_invalidFiles << "tests/auto/qmlls/modules/data/completions/defaultBindingAfterDot.qml";
qmlls: add Qt Quick completion snippets Add snippets for Qt Quick types, for feature parity with the Qt Creator code model. Do not propose them when QtQuick is not imported, and add the qualifier to the snippets in case QtQuick is imported with a qualified name, like `import QtQuick as QQ` for example. TODO: move the snippets to their own plugin. Task-number: QTBUG-119969 Change-Id: I874989e28c27d65fcde90b0ccaa4c447c44a5b30 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Dmitrii Akshintsev <dmitrii.akshintsev@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-01-17 15:08:12 +00:00
m_invalidFiles << "tests/auto/qmlls/utils/data/qualifiedModule.qml";
qmlformat: Support even more language features Adds support (among other things) for: - Pragmas - Type annotations - get / set properties - Some previously unsupported escape sequences (\b,\v...) - Calling methods on numeric literals Also now checks whether the dumped code is still parsable. Change-Id: Ia142a7c0b3e608115e79c1d98a62b682dce4eec9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-01-17 13:28:09 +00:00
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
// Files that get changed:
// rewrite of import "bla/bla/.." to import "bla"
m_invalidFiles << "tests/auto/qml/qqmlcomponent/data/componentUrlCanonicalization.4.qml";
// block -> object in internal update
m_invalidFiles << "tests/auto/qml/qqmlpromise/data/promise-executor-throw-exception.qml";
// removal of unsupported indexing of Object declaration
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/hangOnWarning.qml";
// removal of duplicated id
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/component.3.qml";
// Optional chains are not permitted on the left-hand-side in assignments
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/optionalChaining.LHS.qml";
// object literal with = assignements
Remove "2" from Qt Quick Controls directories Qt Quick Controls 2 was named that way because it was a follow-up to Qt Quick Controls 1.x. Now that Qt Quick Controls 1 is no longer supported, we don't need to have "2" in the name. Work on this was already started for the documentation in 1abdfe5d5a052f2298b7bf657513dfa7e0c66a56. By doing this renaming a few weeks before feature freeze, it won't affect the release but still results in as little time possible spent manually fixing conflicts in cherry-picks from non-LTS releases as a result of the renaming. This patch does the following: - Renames directories. - Adapts CMakeLists.txt and other files to account for the new paths. A follow-up patch will handle documentation. It does not touch library names or other user-facing stuff, as that will have to be done in Qt 7. Task-number: QTBUG-95413 Change-Id: I170d8db19033ee71e495ff0c5c1a517a41ed7634 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2022-11-18 07:15:16 +00:00
m_invalidFiles << "tests/auto/quickcontrols/controls/data/tst_scrollbar.qml";
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
qmlformat: Support even more language features Adds support (among other things) for: - Pragmas - Type annotations - get / set properties - Some previously unsupported escape sequences (\b,\v...) - Calling methods on numeric literals Also now checks whether the dumped code is still parsable. Change-Id: Ia142a7c0b3e608115e79c1d98a62b682dce4eec9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-01-17 13:28:09 +00:00
// These files rely on exact formatting
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon2.qml";
Dom: add QQmlJSScope to QmlObject Add a flag that allows to construct the Dom with the QQmlJSScopes obtained by semantic analysis. Added a new AST visitor called QQmlDomAstCreatorWithQQmlJSScope. This visitor synchronizes the qqmldomastcreator and the qqmljsimportvisitor to construct the Dom and the QQmlJSScope from the AST at the same time. It mainly does keeping track which subvisitor (dom creator or scope creator) is active, as one subvisitor may visit AST nodes that the other does not. Using both visitors at the same time allows to insert the newly-generated QQmlJSScope::Ptr directly into the correct Dom structure. The actual implementation of QQmlDomAstCreatorWithQQmlJSScope is in its visitT and endVisitT methods. Both are called in the AST-visitor-overloads. Added a benchmark on two big generated qml files to see how fast/slow does the qqmljsccope semantic analysis runs, compared to the QmlDom creation runtime. Task-number: QTBUG-92876 Change-Id: Ia05b6fdd59a637fef9c14b6ab284f4550414f908 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-03-07 14:49:30 +00:00
// These files are too big
Move dom construction time test into Benchmarks It takes considerable time to finish as auto test, slowing down the development speed. It should live in benchmarks. Change-Id: I4cb6f7712774a6d36e000dec713db67019d84f6e Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2023-05-25 09:54:52 +00:00
m_ignoreFiles << "tests/benchmarks/qml/qmldom/data/longQmlFile.qml";
m_ignoreFiles << "tests/benchmarks/qml/qmldom/data/deeplyNested.qml";
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
}
QStringList TestQmlformat::findFiles(const QDir &d)
{
Port from container::count() and length() to size() This is a semantic patch using ClangTidyTransformator as in qtbase/df9d882d41b741fef7c5beeddb0abe9d904443d8: auto QtContainerClass = anyOf( expr(hasType(cxxRecordDecl(isSameOrDerivedFrom(hasAnyName(classes))))).bind(o), expr(hasType(namedDecl(hasAnyName(<classes>)))).bind(o)); makeRule(cxxMemberCallExpr(on(QtContainerClass), callee(cxxMethodDecl(hasAnyName({"count", "length"), parameterCountIs(0))))), changeTo(cat(access(o, cat("size"), "()"))), cat("use 'size()' instead of 'count()/length()'")) a.k.a qt-port-to-std-compatible-api with config Scope: 'Container', with the extended set of container classes recognized. Change-Id: Idb1f75dfe2323bd1d9e8b4d58d54f1b4b80c7ed7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-10-05 05:29:16 +00:00
for (int ii = 0; ii < m_excludedDirs.size(); ++ii) {
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QString s = m_excludedDirs.at(ii);
if (d.absolutePath().endsWith(s))
return QStringList();
}
QStringList rv;
tst_qmlformat: Don't use non-standard foreach macro Change-Id: I537cdaebd53687b34db7285f520cfdd9319e5bfa Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-03-02 13:20:12 +00:00
const QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
QDir::Files);
for (const QString &file: files) {
Dom: add QQmlJSScope to QmlObject Add a flag that allows to construct the Dom with the QQmlJSScopes obtained by semantic analysis. Added a new AST visitor called QQmlDomAstCreatorWithQQmlJSScope. This visitor synchronizes the qqmldomastcreator and the qqmljsimportvisitor to construct the Dom and the QQmlJSScope from the AST at the same time. It mainly does keeping track which subvisitor (dom creator or scope creator) is active, as one subvisitor may visit AST nodes that the other does not. Using both visitors at the same time allows to insert the newly-generated QQmlJSScope::Ptr directly into the correct Dom structure. The actual implementation of QQmlDomAstCreatorWithQQmlJSScope is in its visitT and endVisitT methods. Both are called in the AST-visitor-overloads. Added a benchmark on two big generated qml files to see how fast/slow does the qqmljsccope semantic analysis runs, compared to the QmlDom creation runtime. Task-number: QTBUG-92876 Change-Id: Ia05b6fdd59a637fef9c14b6ab284f4550414f908 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-03-07 14:49:30 +00:00
QString absoluteFilePath = d.absoluteFilePath(file);
if (!isIgnoredFile(QFileInfo(absoluteFilePath)))
rv << absoluteFilePath;
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
}
tst_qmlformat: Don't use non-standard foreach macro Change-Id: I537cdaebd53687b34db7285f520cfdd9319e5bfa Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-03-02 13:20:12 +00:00
const QStringList dirs = d.entryList(QDir::Dirs | QDir::NoDotAndDotDot |
QDir::NoSymLinks);
for (const QString &dir: dirs) {
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QDir sub = d;
sub.cd(dir);
rv << findFiles(sub);
}
return rv;
}
bool TestQmlformat::isInvalidFile(const QFileInfo &fileName) const
{
for (const QString &invalidFile : m_invalidFiles) {
if (fileName.absoluteFilePath().endsWith(invalidFile))
return true;
}
return false;
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
}
Dom: add QQmlJSScope to QmlObject Add a flag that allows to construct the Dom with the QQmlJSScopes obtained by semantic analysis. Added a new AST visitor called QQmlDomAstCreatorWithQQmlJSScope. This visitor synchronizes the qqmldomastcreator and the qqmljsimportvisitor to construct the Dom and the QQmlJSScope from the AST at the same time. It mainly does keeping track which subvisitor (dom creator or scope creator) is active, as one subvisitor may visit AST nodes that the other does not. Using both visitors at the same time allows to insert the newly-generated QQmlJSScope::Ptr directly into the correct Dom structure. The actual implementation of QQmlDomAstCreatorWithQQmlJSScope is in its visitT and endVisitT methods. Both are called in the AST-visitor-overloads. Added a benchmark on two big generated qml files to see how fast/slow does the qqmljsccope semantic analysis runs, compared to the QmlDom creation runtime. Task-number: QTBUG-92876 Change-Id: Ia05b6fdd59a637fef9c14b6ab284f4550414f908 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-03-07 14:49:30 +00:00
bool TestQmlformat::isIgnoredFile(const QFileInfo &fileName) const
{
for (const QString &file : m_ignoreFiles) {
if (fileName.absoluteFilePath().endsWith(file))
return true;
}
return false;
}
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
QString TestQmlformat::readTestFile(const QString &path)
{
QFile file(testFile(path));
if (!file.open(QIODevice::ReadOnly))
return "";
return QString::fromUtf8(file.readAll());
}
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
void TestQmlformat::testLineEndings()
{
// macos
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
const QString macosContents =
runQmlformat(testFile("Example1.formatted.qml"), { "-l", "macos" });
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
QVERIFY(!macosContents.contains("\n"));
QVERIFY(macosContents.contains("\r"));
// windows
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
const QString windowsContents =
runQmlformat(testFile("Example1.formatted.qml"), { "-l", "windows" });
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
QVERIFY(windowsContents.contains("\r\n"));
// unix
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
const QString unixContents = runQmlformat(testFile("Example1.formatted.qml"), { "-l", "unix" });
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
QVERIFY(unixContents.contains("\n"));
QVERIFY(!unixContents.contains("\r"));
}
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
void TestQmlformat::testFormat_data()
qmlformat: Fix trailing newline in if blocks Fixes: QTBUG-85003 Change-Id: Ie68c838c9bc1d52181a741871279bee5a8020855 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-06-12 13:24:25 +00:00
{
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
QTest::addColumn<QStringList>("args");
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
QTest::addColumn<RunOption>("runOption");
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
QTest::newRow("example1 (tabs)")
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
<< "Example1.qml"
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
<< "Example1.formatted.tabs.qml" << QStringList { "-t" } << RunOption::OnCopy;
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
QTest::newRow("example1 (two spaces)")
<< "Example1.qml"
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
<< "Example1.formatted.2spaces.qml" << QStringList { "-w", "2" } << RunOption::OnCopy;
qmlformat: Implement settings file Implements controlling qmlformat via a settings file as can be done for qmllint. [ChangeLog][General][qmlformat] Adds the ability to set linting options via a settings file rather than using command line parameters. Use --write-defaults to generate a template with default values for editing. Use --ignore-settings to disable this feature. Fixes: QTBUG-86415 Change-Id: I282c3b994ca6cc491a27b45f531f1ba1c2652ef7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-10-25 16:30:26 +00:00
QTest::newRow("settings") << "settings/Example1.qml"
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
<< "settings/Example1.formatted_mac_cr.qml" << QStringList {}
<< RunOption::OrigToCopy;
qmlformat: add 'ensure new line between objects' option This option allows to format files into more 'refreshing' ones. It improves readability thanks to a clearer visualization of objects inside files. Change-Id: Ic3592e87ae16d14d70317d09d819cc5d331be822 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-11-06 20:40:50 +00:00
QTest::newRow("objects spacing (no changes)")
<< "objectsSpacing.qml"
<< "objectsSpacing.formatted.qml" << QStringList { "--objects-spacing" } << RunOption::OnCopy;
QTest::newRow("normalize + objects spacing")
<< "normalizedObjectsSpacing.qml"
<< "normalizedObjectsSpacing.formatted.qml" << QStringList { "-n", "--objects-spacing" } << RunOption::OnCopy;
qmlformat: fix 'new line after ids properties' with normalize option Fixes: QTBUG-105479 Change-Id: I12ef7c2ffddb9127c1a0844c92d1050134863922 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-11-06 19:42:07 +00:00
qmlformat: Reorder imports alphabetically Reorder imports alphabetically. [ChangeLog][qmlformat] qmlformat now supports sorting of imports, there is a new commandline option -S that is used to sort imports. Fixes: QTBUG-132061 Change-Id: Ic163456d2beed84833f7aadef0688d37292ef0f2 Reviewed-by: Semih Yavuz <semih.yavuz@qt.io>
2024-12-18 14:15:50 +00:00
QTest::newRow("sorting imports")
<< "sortingImports.qml"
<< "sortingImports.formatted.qml" << QStringList { "-S" } << RunOption::OnCopy;
qmlformat: fix 'new line after ids properties' with normalize option Fixes: QTBUG-105479 Change-Id: I12ef7c2ffddb9127c1a0844c92d1050134863922 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-11-06 19:42:07 +00:00
QTest::newRow("ids new lines")
<< "checkIdsNewline.qml"
<< "checkIdsNewline.formatted.qml" << QStringList { "-n" } << RunOption::OnCopy;
qmlformat: add 'ensure new line between functions' option Fixes: QTBUG-108659 Change-Id: I3e21727bd946089d89ce9c42f640f05230de8c8e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-11-23 18:33:40 +00:00
QTest::newRow("functions spacing (no changes)")
<< "functionsSpacing.qml"
<< "functionsSpacing.formatted.qml" << QStringList { "--functions-spacing" } << RunOption::OnCopy;
QTest::newRow("normalize + functions spacing")
<< "normalizedFunctionsSpacing.qml"
<< "normalizedFunctionsSpacing.formatted.qml" << QStringList { "-n", "--functions-spacing" } << RunOption::OnCopy;
QmlFormat: Support .js files (CLI tool) This commit contains last pieces of changes necessary for the formatting of .js files using qmlformat CLI. What's not included: normalize && function spacing for .js files Task-number: QTBUG-117849 Pick-to: 6.7 Change-Id: I6a4260f074ce05ce07cdcff185a1cf7737d3a44c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 13:19:41 +00:00
QTest::newRow("indentEquals2")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedW2.js" << QStringList{"-w=2"} << RunOption::OnCopy;
QTest::newRow("tabIndents")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedTabs.js" << QStringList{"-t"} << RunOption::OnCopy;
QTest::newRow("normalizedFunctionSpacing")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedFuncSpacing.js"
<< QStringList{ "-n", "--functions-spacing" } << RunOption::OnCopy;
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
QTest::newRow("esm_tabIndents")
<< "mini_esm.mjs"
<< "mini_esm.formattedTabs.mjs" << QStringList{ "-t" } << RunOption::OnCopy;
qmlformat: Fix trailing newline in if blocks Fixes: QTBUG-85003 Change-Id: Ie68c838c9bc1d52181a741871279bee5a8020855 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-06-12 13:24:25 +00:00
}
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
void TestQmlformat::testFormat()
qmlformat: Fix nested functions Fixes: QTBUG-85035 Change-Id: I5e1cb003b7b84547e3408a086eebf3be740e6860 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-06-18 12:36:37 +00:00
{
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
QFETCH(QStringList, args);
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
QFETCH(RunOption, runOption);
tst_qmlformat: refactor tests Change-Id: I2090b78417caf43b6dfb4106802988742a5a119e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 07:03:24 +00:00
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
auto formatted = runQmlformat(testFile(file), args, true, runOption, fileExt(file));
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
auto exp = readTestFile(fileFormatted);
QmlFormat: Support .js files (CLI tool) This commit contains last pieces of changes necessary for the formatting of .js files using qmlformat CLI. What's not included: normalize && function spacing for .js files Task-number: QTBUG-117849 Pick-to: 6.7 Change-Id: I6a4260f074ce05ce07cdcff185a1cf7737d3a44c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 13:19:41 +00:00
QEXPECT_FAIL("normalizedFunctionSpacing",
"Normalize && function spacing are not yet supported for JS", Abort);
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
QCOMPARE(formatted, exp);
qmlformat: Fix nested functions Fixes: QTBUG-85035 Change-Id: I5e1cb003b7b84547e3408a086eebf3be740e6860 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-06-18 12:36:37 +00:00
}
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
void TestQmlformat::plainJS_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
QTest::newRow("simpleStatement") << "simpleJSStatement.js"
<< "simpleJSStatement.formatted.js";
QTest::newRow("simpleFunction") << "simpleOnelinerJSFunc.js"
<< "simpleOnelinerJSFunc.formatted.js";
QTest::newRow("simpleLoop") << "simpleLoop.js"
<< "simpleLoop.formatted.js";
QTest::newRow("messyIfStatement") << "messyIfStatement.js"
<< "messyIfStatement.formatted.js";
QTest::newRow("lambdaFunctionWithLoop") << "lambdaFunctionWithLoop.js"
<< "lambdaFunctionWithLoop.formatted.js";
QTest::newRow("lambdaWithIfElse") << "lambdaWithIfElse.js"
<< "lambdaWithIfElse.formatted.js";
QTest::newRow("nestedLambdaWithIfElse") << "lambdaWithIfElseInsideLambda.js"
<< "lambdaWithIfElseInsideLambda.formatted.js";
QTest::newRow("twoFunctions") << "twoFunctions.js"
<< "twoFunctions.formatted.js";
QTest::newRow("pragma") << "pragma.js"
<< "pragma.formatted.js";
QTest::newRow("classConstructor") << "class.js"
<< "class.formatted.js";
QTest::newRow("legacyDirectives") << "directives.js"
<< "directives.formatted.js";
QTest::newRow("legacyDirectivesWithComments") << "directivesWithComments.js"
<< "directivesWithComments.formatted.js";
qmlformat: Preserve "?." tokens for various member access expressions Fixes: QTBUG-132280 Pick-to: 6.9 6.8 Change-Id: I9307a70eea4640da19124f65e49cb3c661d443a1 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 09:33:45 +00:00
QTest::newRow("preserveOptionalTokens") << "preserveOptionalTokens.js"
<< "preserveOptionalTokens.formatted.js";
qmlformat: Have the outWriter ensure spaces instead of adding them When formatting comments we try to preserve the spacing that the user used around them. We keep track of how many spaces come before and after a comment and insert them back accordingly. However, when we continue to write out the following tokens we add spaces to separate them. This space was being inserted unconditionally. This could lead to a space being accounted for twice for certain comment configurations. Once by the recorded amount of spaces after the comment and once by the standard space to separate tokens. This would lead to spaces being inserted in the formatted code that weren't there originally in the user's code. One space would be inserted like this for every format call. To solve this, don't unconditionally insert a space to separate the tokens but only make sure there is a space. This issue can be reproduced in many "places" of the grammar. This patch eliminates a good amount of them but not all. Created QTBUG-133315 and QTBUG-133316. Fixes: QTBUG-131386 Pick-to: 6.9 6.8 Change-Id: I25ac67f49a0198047912ef3f04dda3afc5cb9f66 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 15:45:28 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_pragma")
<< "noSuperfluousSpaceInsertions.fail_pragma.js"
<< "noSuperfluousSpaceInsertions.fail_pragma.formatted.js";
qmlformat: Accept `from` as an identifier From is defined as an identifier with a special meaning in the context of imports. This means it should generally be accepted as an identifier in other contexts. This fixes weird line indentation issues with the IndentingLineWriter. Fixes: QTBUG-132065 Pick-to: 6.9 6.8 Change-Id: Iea5bf3af5d43af9a97f0f8e7867d12337e4041ca Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2025-01-29 14:51:09 +00:00
QTest::newRow("fromAsIdentifier") << "fromAsIdentifier.js"
<< "fromAsIdentifier.formatted.js";
qmlformat: add custom comment anchoring for case Add a way to customize where comments are anchored. Prior to this commit, comments could only be anchored to an AST::Node firstSourceLocation() or lastSourceLocation(). This commit extends the current functionality to be able to anchor comments somewhere between firstSourceLocation() and lastSourceLocation(). This allows to fix the bug where comments would be printed before the ":" in case statements, because they would get attached to the expression inside the case-statement, instead of getting attached to the colon of the case-statement. Extend AstRangesVisitor to add the sourcelocation of the ":" in case- statements to the list of sourcelocations where comments can be attached to. The anchors enum is not meant to be extended: instead, an anchor is either DefaultAnchor for comments attached to AST::Node*, or token.begin() for some QQmlJS::SourceLocation token inside an AST::Node*. Pick-to: 6.9 6.8 6.5 Fixes: QTBUG-132886 Change-Id: I0a18f09b3631b8798b6697298e532b47ddc7cb20 Reviewed-by: Dmitrii Akshintsev <dmitrii.akshintsev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-01-20 13:29:58 +00:00
QTest::newRow("caseWithComment") << "caseWithComment.js"
<< "caseWithComment.formatted.js";
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
}
void TestQmlformat::plainJS()
{
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
bool wasSuccessful;
LineWriterOptions opts;
#ifdef Q_OS_WIN
opts.lineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings::Windows;
#endif
QString output = formatInMemory(testFile(file), &wasSuccessful, opts, WriteOutCheck::None);
QVERIFY(wasSuccessful && !output.isEmpty());
// TODO(QTBUG-119770)
QEXPECT_FAIL("legacyDirectivesWithComments", "see QTBUG-119770", Abort);
qmlformat: Have the outWriter ensure spaces instead of adding them When formatting comments we try to preserve the spacing that the user used around them. We keep track of how many spaces come before and after a comment and insert them back accordingly. However, when we continue to write out the following tokens we add spaces to separate them. This space was being inserted unconditionally. This could lead to a space being accounted for twice for certain comment configurations. Once by the recorded amount of spaces after the comment and once by the standard space to separate tokens. This would lead to spaces being inserted in the formatted code that weren't there originally in the user's code. One space would be inserted like this for every format call. To solve this, don't unconditionally insert a space to separate the tokens but only make sure there is a space. This issue can be reproduced in many "places" of the grammar. This patch eliminates a good amount of them but not all. Created QTBUG-133315 and QTBUG-133316. Fixes: QTBUG-131386 Pick-to: 6.9 6.8 Change-Id: I25ac67f49a0198047912ef3f04dda3afc5cb9f66 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 15:45:28 +00:00
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_pragma",
"Not all cases have been covered yet (QTBUG-133315)", Abort);
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
auto exp = readTestFile(fileFormatted);
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
QCOMPARE(output, exp);
}
void TestQmlformat::ecmascriptModule()
{
QString file("esm.mjs");
QString formattedFile("esm.formatted.mjs");
bool wasSuccessful;
LineWriterOptions opts;
#ifdef Q_OS_WIN
opts.lineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings::Windows;
#endif
QString output = formatInMemory(testFile(file), &wasSuccessful, opts, WriteOutCheck::None);
QVERIFY(wasSuccessful && !output.isEmpty());
auto exp = readTestFile(formattedFile);
QCOMPARE(output, readTestFile(formattedFile));
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample_data()
{
qmlformat: use QmlDom Replace qmlformat with the formatter using qml dom Change-Id: Ie90814260f2d3b9e589ce04381d5ad1880c5b519 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-04-19 14:43:21 +00:00
if (QTestPrivate::isRunningArmOnX86())
QSKIP("Crashes in QEMU. (timeout)");
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QTest::addColumn<QString>("file");
QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";
QString tests = QLatin1String(SRCDIR) + "/../../../../tests/";
qmlformat: "Move" testExample e2e tests to /manual testExample, normalizeExample and actually most of the tests in tst_qmlformat are e2e tests and in general QmlFormat lacks unit test coverage, compensating it with e2e. The biggest problem atm that some of those tests (namely testExample) take too much time to execute because it runs QmlFormat over almost all files in examples and tests directories. Unfortunately atm our QA&QE infra can't provide tools for an easy automated setup of potentially time-consuming tests. As a workaround this commit: 1. "Moves" testExample and normalizeExample to the /manual tests 2. Preserves a very small fraction of testData for automated testing "just in case" Steps to repro: 1. configure with the flag `-make manual-tests` 2. `ninja e2e_qmlformat` 3. run ;) Fixes: QTBUG-122990 Change-Id: Id41baee15e8826f4def5787f62790ed46f00e5dc Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-04-22 14:49:00 +00:00
QStringList exampleFiles;
QStringList testFiles;
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QStringList files;
qmlformat: "Move" testExample e2e tests to /manual testExample, normalizeExample and actually most of the tests in tst_qmlformat are e2e tests and in general QmlFormat lacks unit test coverage, compensating it with e2e. The biggest problem atm that some of those tests (namely testExample) take too much time to execute because it runs QmlFormat over almost all files in examples and tests directories. Unfortunately atm our QA&QE infra can't provide tools for an easy automated setup of potentially time-consuming tests. As a workaround this commit: 1. "Moves" testExample and normalizeExample to the /manual tests 2. Preserves a very small fraction of testData for automated testing "just in case" Steps to repro: 1. configure with the flag `-make manual-tests` 2. `ninja e2e_qmlformat` 3. run ;) Fixes: QTBUG-122990 Change-Id: Id41baee15e8826f4def5787f62790ed46f00e5dc Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-04-22 14:49:00 +00:00
exampleFiles << findFiles(QDir(examples));
testFiles << findFiles(QDir(tests));
// Actually this test is an e2e test and not the unit test.
// At the moment of writing, CI lacks providing instruments for the automated tests
// which might be time-consuming, as for example this one.
// Therefore as part of QTBUG-122990 this test was copied to the /manual/e2e/qml/qmlformat
// however very small fraction of the test data is still preserved here for the sake of
// testing automatically at least a small part of the examples
const int nBatch = 10;
files << exampleFiles.mid(0, nBatch) << exampleFiles.mid(exampleFiles.size() / 2, nBatch)
<< exampleFiles.mid(exampleFiles.size() - nBatch, nBatch);
files << testFiles.mid(0, nBatch) << testFiles.mid(exampleFiles.size() / 2, nBatch)
<< testFiles.mid(exampleFiles.size() - nBatch, nBatch);
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
for (const QString &file : files)
QTest::newRow(qPrintable(file)) << file;
}
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
void TestQmlformat::normalizeExample_data()
{
if (QTestPrivate::isRunningArmOnX86())
QSKIP("Crashes in QEMU. (timeout)");
QTest::addColumn<QString>("file");
QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";
QString tests = QLatin1String(SRCDIR) + "/../../../../tests/";
// normalizeExample is similar to testExample, so we test it only on nExamples + nTests
// files to avoid making too many
QStringList files;
const int nExamples = 10;
int i = 0;
for (const auto &f : findFiles(QDir(examples))) {
files << f;
if (++i == nExamples)
break;
}
const int nTests = 10;
i = 0;
for (const auto &f : findFiles(QDir(tests))) {
files << f;
if (++i == nTests)
break;
}
for (const QString &file : files)
QTest::newRow(qPrintable(file)) << file;
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample()
{
QFETCH(QString, file);
Use QFileInfo constructor explicitly Prepare for upcoming changes in qtbase. Change-Id: I592fe857dde13ce570f1525b5f327a07773be123 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
2020-11-14 13:30:42 +00:00
const bool isInvalid = isInvalidFile(QFileInfo(file));
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
QString output = formatInMemory(file, &wasSuccessful, opts);
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
Use QFileInfo constructor explicitly Prepare for upcoming changes in qtbase. Change-Id: I592fe857dde13ce570f1525b5f327a07773be123 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
2020-11-14 13:30:42 +00:00
if (!isInvalid)
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QVERIFY(wasSuccessful && !output.isEmpty());
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
}
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
void TestQmlformat::normalizeExample()
{
QFETCH(QString, file);
const bool isInvalid = isInvalidFile(QFileInfo(file));
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Normalize;
QString output = formatInMemory(file, &wasSuccessful, opts);
if (!isInvalid)
QVERIFY(wasSuccessful && !output.isEmpty());
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
qmlformat: do not generate backup files qmlformat used to backup the original input file up to 2 copies when used with --inplace mode. Change this hardcoded number into 0 and generate no backup file. Fixes: QTBUG-107685 Change-Id: Ifca86968fa65be0fd678012fc2e41b9ed8601d21 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-10-19 10:50:31 +00:00
void TestQmlformat::testBackupFileLimit()
{
// Create a temporary directory
QTemporaryDir tempDir;
// Unformatted file to format
const QString fileToFormat{ testFile("Annotations.qml") };
{
const QString tempFile = tempDir.path() + QDir::separator() + "test_0.qml";
const QString backupFile = tempFile + QStringLiteral("~");
QFile::copy(fileToFormat, tempFile);
QProcess process;
process.start(m_qmlformatPath, QStringList{ "--verbose", "--inplace", tempFile });
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
QCOMPARE(process.exitCode(), 0);
QVERIFY(QFileInfo::exists(tempFile));
QVERIFY(!QFileInfo::exists(backupFile));
};
}
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
void TestQmlformat::testFilesOption_data()
{
QTest::addColumn<QString>("containerFile");
QTest::addColumn<QStringList>("individualFiles");
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
QTest::newRow("initial") << "fileListToFormat" << QStringList{ "valid1.qml", "valid2.qml" };
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
}
void TestQmlformat::testFilesOption()
{
QFETCH(QString, containerFile);
QFETCH(QStringList, individualFiles);
// Create a temporary directory
QTemporaryDir tempDir;
QStringList actualFormattedFilesPath;
// Iterate through files in the source directory and copy them to the temporary directory
const auto sourceDir = dataDirectory() + QDir::separator() + "filesOption";
// Create a file that contains the list of files to be formatted
const QString tempFilePath = tempDir.path() + QDir::separator() + containerFile;
QFile container(tempFilePath);
tst_qmlformat: Clean up testFilesOption The test would leave behind the temporary directory it created and would fail to detect when qmlformat returns with a non-zero value. Change-Id: Ib6c5a43599aea5d8f7bfec9d6a13059a7386e133 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-02-11 10:03:55 +00:00
QVERIFY2(container.open(QIODevice::Text | QIODevice::WriteOnly),
"Cannot create temp test file");
QTextStream out(&container);
for (const auto &file : individualFiles) {
QString destinationFilePath = tempDir.path() + QDir::separator() + file;
if (QFile::copy(sourceDir + QDir::separator() + file, destinationFilePath))
actualFormattedFilesPath << destinationFilePath;
out << destinationFilePath << "\n";
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
}
tst_qmlformat: Clean up testFilesOption The test would leave behind the temporary directory it created and would fail to detect when qmlformat returns with a non-zero value. Change-Id: Ib6c5a43599aea5d8f7bfec9d6a13059a7386e133 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-02-11 10:03:55 +00:00
container.close();
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
{
QProcess process;
process.start(m_qmlformatPath, QStringList{"-F", tempFilePath});
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
tst_qmlformat: Clean up testFilesOption The test would leave behind the temporary directory it created and would fail to detect when qmlformat returns with a non-zero value. Change-Id: Ib6c5a43599aea5d8f7bfec9d6a13059a7386e133 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-02-11 10:03:55 +00:00
QCOMPARE(process.exitCode(), 0);
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
}
const auto readFile = [](const QString &filePath){
QFile file(filePath);
if (!file.open(QIODevice::ReadOnly)) {
qWarning() << "Error on opening the file " << filePath;
return QByteArray{};
}
return file.readAll();
};
tst_qmlformat: Clean up testFilesOption The test would leave behind the temporary directory it created and would fail to detect when qmlformat returns with a non-zero value. Change-Id: Ib6c5a43599aea5d8f7bfec9d6a13059a7386e133 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-02-11 10:03:55 +00:00
for (const auto &filePath : std::as_const(actualFormattedFilesPath)) {
qmlformat: fix formatting with -F option qmlformat accepts -F option to format a list of files given in another file. That should supposed to be inplace, but qmlformat would send output to stdout. To fix this, force inplace formatting if the options.files are not empty. Change-Id: If62dd3edde91460eba5812b1d7aea1b7422f46bf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2023-10-13 11:30:27 +00:00
auto expectedFormattedFile = QFileInfo(filePath).fileName();
const auto expectedFormattedFilePath = sourceDir + QDir::separator() +
expectedFormattedFile.replace(".qml", ".formatted.qml");
QCOMPARE(readFile(filePath), readFile(expectedFormattedFilePath));
}
}
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
void TestQmlformat::commandLineOptions_data()
{
QTest::addColumn<QStringList>("args");
QTest::addColumn<QString>("expectedErrorMessage");
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
const QString dummy = testFile("dummy.qml");
const QString empty = testFile("empty");
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
QTest::newRow("columnWidthError")
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
<< QStringList{ dummy, "-W", "-11111" }
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
<< "Error: Invalid value passed to -W. Must be an integer >= -1\n";
QTest::newRow("columnWidthNoError")
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
<< QStringList{ dummy, "-W", "80" } << "";
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
QTest::newRow("indentWidthError")
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
<< QStringList{ dummy, "--indent-width", "expect integer" }
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
<< "Error: Invalid value passed to -w\n";
QTest::newRow("indentWidthNoError")
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
<< QStringList{ dummy, "--indent-width", "4" } << "";
QTest::newRow("noInputFiles.qml")
<< QStringList{} << "Error: Expected at least one input file.\n";
QTest::newRow("fOptionFileDoesNotExist")
<< QStringList{ "-F", "nope" }
<< "Error: Could not open file \"nope\" for option -F.\n";
QTest::newRow("fOptionFileIsEmpty")
<< QStringList{ "-F", empty }
<< "Error: File \"" + empty + "\" for option -F is empty.\n";
QTest::newRow("fOptionFileContainsNope")
<< QStringList{ "-F", testFile("filesToFormatNope") }
<< "Error: Entry \"nope\" of file \"" + testFile("filesToFormatNope")
+ "\" passed to option -F could not be found.\n";
QTest::newRow("positionalArgumentDoesNotExist")
<< QStringList{ "nope" }
<< "Error: Could not find file \"nope\".\n";
qmlformat: fix error message output We don't need m_valid to check if there is an error. Do validity check by m_error.isEmpty(). Prior to this commit, an invalid command line option given to qmlformat wouldn't spit out the error message and qmlformat would silently ignore the error and run with default settings. For example, the command qmlformat -W -342523 <filepath> should error out with this commit since a negative line length is given. Change-Id: Ie7d07e3b2b3714793f9abed4558003cc5ad77b34 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-12-04 10:20:09 +00:00
}
void TestQmlformat::commandLineOptions()
{
QFETCH(QStringList, args);
QFETCH(QString, expectedErrorMessage);
auto verify = [&]() {
QTemporaryDir tempDir;
const QString tempFile = tempDir.path() + QDir::separator() + "test_0.qml";
QProcess process;
process.setStandardOutputFile(tempFile);
process.start(m_qmlformatPath, args);
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
// normalized error message
auto rawError = process.readAllStandardError();
QTextStream stream(&rawError, QIODeviceBase::ReadOnly | QIODeviceBase::Text);
QCOMPARE(stream.readAll(), expectedErrorMessage.toUtf8());
if (expectedErrorMessage.isEmpty())
QCOMPARE(process.exitCode(), 0);
else
QCOMPARE_NE(process.exitCode(), 0);
};
verify();
}
qmlformat: fix --write-defaults Prior to this commit, --write-defaults was only writing the subset of the existing settings. In fact, each setting has a default value and those should be seen in the .qmlformat.ini file to be written. Pick-to: 6.8 6.9 Change-Id: Ie7f8fac653d0bc7099821136f5ad8ce8ee14c714 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-21 16:08:42 +00:00
void TestQmlformat::writeDefaults()
{
auto verify = [&]() {
QTemporaryDir tempDir;
const QString qmlformatIni = tempDir.path() + QDir::separator() + ".qmlformat.ini";
QProcess process;
process.setWorkingDirectory(tempDir.path());
process.start(m_qmlformatPath, QStringList{ "--write-defaults" });
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
QQmlToolingSettings settings("qmlformat");
QVERIFY(settings.search(qmlformatIni));
QCOMPARE(settings.value("UseTabs").toBool(), false);
QCOMPARE(settings.value("IndentWidth").toInt(), 4);
QCOMPARE(settings.value("MaxColumnWidth").toInt(), -1);
QCOMPARE(settings.value("NormalizeOrder").toBool(), false);
QCOMPARE(settings.value("NewlineType").toString(), "native");
QCOMPARE(settings.value("ObjectSpacing").toBool(), false);
QCOMPARE(settings.value("FunctionsSpacing").toBool(), false);
QCOMPARE(settings.value("SortImports").toBool(), false);
};
verify();
}
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
void TestQmlformat::settingsFromFileOrCommandLine_data()
{
QTest::addColumn<QString>("qmlformatIniPath");
QTest::addColumn<QStringList>("qmlformatInitOptions");
QTest::addColumn<QQmlFormatOptions>("expectedOptions");
{
QQmlFormatOptions options;
options.setIndentWidth(20);
// In settings file, indentwidth is set to 4000, while cli overrides it to 20
// 20 should be the final value
QTest::newRow("clOverridesIndentWidth")
<< testFile("iniFiles/dummySettingsFile.ini")
<< QStringList{ m_qmlformatPath, "--indent-width", "20" } << options;
qmlformat: fix precedence of settings Options set through commandline should have the precedence over the settings read from .ini file. Introduce a mapper in the setting, that marks the option if set by command line input. Add more tests. Pick-to: 6.8 6.9 Fixes: QTBUG-133225 Change-Id: Id0b18655f7bf64670dab4e38f5aff2fdaa889f1b Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-24 12:51:04 +00:00
options.setIndentWidth(4000);
// In settings file, indentwidth is set to 4000, and nothing overrides it.
// 4000 should be the final value
QTest::newRow("iniFileIndentWidth") << testFile("iniFiles/dummySettingsFile.ini")
<< QStringList{ m_qmlformatPath } << options;
options.setMaxColumnWidth(100);
// In settings file, maxcolumnwidth is set to -1, but cli overrides it 100.
// 100 should be the final value
QTest::newRow("clOverridesColumnWidth")
<< testFile("iniFiles/dummySettingsFile.ini")
<< QStringList{ m_qmlformatPath, "-W", "100" } << options;
}
{
QQmlFormatOptions options;
// settings file sets all bools excepts Tabs to true.
options.setTabsEnabled(false);
options.setNormalizeEnabled(true);
options.setObjectsSpacing(true);
options.setFunctionsSpacing(true);
QTest::newRow("iniFileSetsBools") << testFile("iniFiles/toggledBools.ini")
<< QStringList{ m_qmlformatPath } << options;
// cli overrides the Tabs option to true
options.setTabsEnabled(true);
QTest::newRow("cliOverridesTabs") << testFile("iniFiles/toggledBools.ini")
<< QStringList{ m_qmlformatPath, "--tabs" } << options;
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
}
qmlformat: add test for applying settings for files option Pick-to: 6.8 6.9 Change-Id: I65b430362895259d8b91f064426e34d71eaf2c72 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:01:56 +00:00
{
// settings should apply when -F is passed
QQmlFormatOptions options;
options.setIndentWidth(4000);
QTest::newRow("settingOnFilesOption")
<< testFile("iniFiles/dummySettingsFile.ini")
<< QStringList{ m_qmlformatPath, "-F", "dummyFilesPath" } << options;
}
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
}
void TestQmlformat::settingsFromFileOrCommandLine()
{
QFETCH(QString, qmlformatIniPath);
QFETCH(QStringList, qmlformatInitOptions);
QFETCH(QQmlFormatOptions, expectedOptions);
auto verify = [&]() {
QTemporaryDir tempDir;
const QString qmlformatIni = tempDir.path() + QDir::separator() + ".qmlformat.ini";
const QString dummyQmlFile = tempDir.path() + QDir::separator() + "test.qml";
QFile::copy(qmlformatIniPath, qmlformatIni);
QQmlFormatSettings settings("qmlformat");
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
QStringList cmdlineOptions;
qmlformat: add test for applying settings for files option Pick-to: 6.8 6.9 Change-Id: I65b430362895259d8b91f064426e34d71eaf2c72 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:01:56 +00:00
if ((qstrcmp(QTest::currentDataTag(), "settingOnFilesOption") == 0))
qmlformat: Error out when no input files are provided qmlformat now errors out if -No input is provided as a positional argument and -F is not set -A positional argument does not exist -Option -F is set but the file does not exist -Option -F is set but the file is empty -Option -F is set but the file points to a file that doesn't exist TestQmlformat::testFilesOption was modified to no longer try to format a nonexistent file. That should now get rejected early. TestQmlformat::settingsFromFileOrCommandLine was modified to pass at least one file to prevent an error. [ChangeLog][Qml][qmlformat] qmlformat will now error out if no files are provided as positional arguments or via the -F option. Pick-to: 6.9 6.8 Change-Id: I7f900242c3e9e9041c9a08057a7e898e26c17493 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-02-10 09:57:15 +00:00
cmdlineOptions = qmlformatInitOptions << "-F" << dummyQmlFile;
else
cmdlineOptions = QStringList(dummyQmlFile) << qmlformatInitOptions;
QQmlFormatOptions options = QQmlFormatOptions::buildCommandLineOptions(cmdlineOptions);
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
auto overridenOptions = options.optionsForFile(dummyQmlFile, &settings);
QCOMPARE(overridenOptions.tabsEnabled(), expectedOptions.tabsEnabled());
QCOMPARE(overridenOptions.indentWidth(), expectedOptions.indentWidth());
QCOMPARE(overridenOptions.maxColumnWidth(), expectedOptions.maxColumnWidth());
QCOMPARE(overridenOptions.normalizeEnabled(), expectedOptions.normalizeEnabled());
QCOMPARE(overridenOptions.newline(), expectedOptions.newline());
QCOMPARE(overridenOptions.objectsSpacing(), expectedOptions.objectsSpacing());
QCOMPARE(overridenOptions.functionsSpacing(), expectedOptions.functionsSpacing());
QCOMPARE(overridenOptions.sortImports(), expectedOptions.sortImports());
};
verify();
}
qmlformat: fix precedence of settings Options set through commandline should have the precedence over the settings read from .ini file. Introduce a mapper in the setting, that marks the option if set by command line input. Add more tests. Pick-to: 6.8 6.9 Fixes: QTBUG-133225 Change-Id: Id0b18655f7bf64670dab4e38f5aff2fdaa889f1b Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-24 12:51:04 +00:00
/*
* Create a temporary directory with the following structure
|--dir1
| |--.qmlformat.ini
| |-- test1.qml
|--dir2
| |-- test2.qml
* test2.qml should differ from the test2.qml options on indentwidth, because test1 gets it from
* its settings file.
*/
void TestQmlformat::multipleSettingsFiles()
{
QTemporaryDir tempDir;
QTemporaryDir dir1(tempDir.path() + "/dir1");
QTemporaryDir dir2(tempDir.path() + "/dir2");
const QString qmlformat1Ini = dir1.path() + "/.qmlformat.ini";
const QString test1Qml = dir1.path() + "/test.qml";
const QString test2Qml = dir2.path() + "/test.qml";
QFile::copy(testFile("iniFiles/dummySettingsFile.ini"), qmlformat1Ini);
QQmlFormatSettings settings("qmlformat");
QQmlFormatOptions options =
QQmlFormatOptions::buildCommandLineOptions(QStringList{ m_qmlformatPath });
auto test1Options = options.optionsForFile(test1Qml, &settings);
auto test2Options = options.optionsForFile(test2Qml, &settings);
QCOMPARE(test1Options.tabsEnabled(), test2Options.tabsEnabled());
QCOMPARE_NE(test1Options.indentWidth(), test2Options.indentWidth());
QCOMPARE(test1Options.maxColumnWidth(), test2Options.maxColumnWidth());
QCOMPARE(test1Options.normalizeEnabled(), test2Options.normalizeEnabled());
QCOMPARE(test1Options.newline(), test2Options.newline());
QCOMPARE(test1Options.objectsSpacing(), test2Options.objectsSpacing());
QCOMPARE(test1Options.functionsSpacing(), test2Options.functionsSpacing());
QCOMPARE(test1Options.sortImports(), test2Options.sortImports());
}
qmlformat: Add indent options Adds the ability to use tabs or any amount of spaces for indentation instead of the default of 4 spaces. [ChangeLog][QML][qmlformat] Added option to customize indentation. Fixes: QTBUG-86413 Change-Id: I3c370dda2d0069ef61202a2d862ce15bc513e55e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-09-02 10:34:29 +00:00
QString TestQmlformat::runQmlformat(const QString &fileToFormat, QStringList args,
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
bool shouldSucceed, RunOption rOptions, QStringView ext)
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
{
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
// Copy test file to temporary location
QTemporaryDir tempDir;
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
const QString tempFile = (tempDir.path() + QDir::separator() + "to_format") % ext;
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
if (rOptions == RunOption::OnCopy) {
QFile::copy(fileToFormat, tempFile);
args << QLatin1String("-i");
args << tempFile;
} else {
args << fileToFormat;
}
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
auto verify = [&]() {
QProcess process;
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
if (rOptions == RunOption::OrigToCopy)
process.setStandardOutputFile(tempFile);
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
process.start(m_qmlformatPath, args);
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
if (shouldSucceed)
QCOMPARE(process.exitCode(), 0);
};
verify();
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
QFile temp(tempFile);
Tests: check that QFile::open succeeds Wrap it in QVERIFY if possible. If not possible (e.g. a function that returns non-void, or not an autotest function) use qFatal to abort the test. Change-Id: Ie255024d29507e928a94e67d9af1cd436df4f1df Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-23 19:41:57 +00:00
if (!temp.open(QIODevice::ReadOnly))
qFatal("Could not open %s", qPrintable(tempFile));
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
QString formatted = QString::fromUtf8(temp.readAll());
return formatted;
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
}
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QString TestQmlformat::formatInMemory(const QString &fileToFormat, bool *didSucceed,
LineWriterOptions options, WriteOutChecks extraChecks,
WriteOutChecks largeChecks)
{
DOM refactoring. Remove DomItem::loadItem. enable_shared_from_this for DomEnv* As it was mentioned in the previous commits in the chain one of the goals of the refactoring is to introduce clearer separation of concerns. Only DomTop types are allowed to load files, hence it's arguable should be reflected in the interfaces explicitly. With the help of previous commits the relevant pieces of this function were moved to the corresponding DomEnvironment and DomUniverse types. This commit finally removes loadFile from the DomItem API. *It's also worth noting that in order to minimaze refactoring efforts and to keep the public API simple (not requiring DomItem &self argument on the top level), this commit also makes DomEnvironment a child of the std::enable_shared_from_this. This somewhat "breaks" the initial design approach inscribed in the DOM API allowing DomEnvironemt to get a shared_ptr to itself bypassing corresponding DomItem.ownerAs<> API. However, in the tradeoff of preserving consistency of the previous design and the explicitness of the interface, I would value the latter, hence I find this change acceptable. Change-Id: Ic2ce3fc80876be6bdbec93e4d273e4c6b7a2b218 Task-number: QTBUG-119550 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-12-28 20:31:13 +00:00
auto env = DomEnvironment::create(
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QStringList(), // as we load no dependencies we do not need any paths
QQmlJS::Dom::DomEnvironment::Option::SingleThreaded
| QQmlJS::Dom::DomEnvironment::Option::NoDependencies);
DomItem tFile;
DOM refactoring. Remove LoadOptions Only defaultLoad is being used, hence it doesn't make sense to have them at all at the current stage Task-number: QTBUG-119550 Change-Id: I761e7c55d6aaafa29d234ace4b4b65bcc46a9855 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-01-24 13:39:30 +00:00
env->loadFile(FileToLoad::fromFileSystem(env, fileToFormat),
[&tFile](Path, const DomItem &, const DomItem &newIt) { tFile = newIt; });
DOM refactoring. Move loadPendingDependencies to DomEnvironment One of the goals of this refactoring is to move DomTop specific functionality from DomItem API to the corresponding DomEnvironment and DomUniverse. This commit moves loading of the dependencies (which are added to the pending load queue implicitly as part of the callbacks of the loadFile when DomEnv is created without the flag "NoDependencies") to the DomEnvironment interface Moreover, once work with dependencies is happening through the DomEnvironment explicitly, it allows us to get rid of "self" parameter. Task-number: QTBUG-119550 Change-Id: Ib3deb97eabe091ffded8c8c782ee08f8024468f2 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-01-08 16:52:18 +00:00
env->loadPendingDependencies();
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
MutableDomItem myFile = tFile.field(Fields::currentItem);
QQmlJS::Dom::OutWriter. Refactoring The refactoring consists of: - Changing writeOut & writeOutForFile API to return boolean instead of MutableDomItem, which better reflects the existing usecases improving consistency of the data model* Moreover, previous API was exposing DomItem, which was not "committed to base" (MutableDomItem.commitToBase()), meaning it was exposing the "unmerged" Item alongside with the "temporary environment" - Refactoring & renaming OutWriter::updatedFile breaking it into smaller chunks preserving only necessary functionality - Adding some comments / documentation Before this commit, the writeOut API was "exposing",so called, "updatedFile", which is basically the copy of the original fileItem + renewed scriptExpressions which were modified during the writeOut of the original fileItem. The idea behind the "mutating" Dom API is that one has to create a MutableDomItem, do some changes to it and then "commit" them. This process is also facilitated by the creation of separate Env. (git analogy might be handy here: We create a separate branch, where all the mutation will happen and then we "merge" this branch) However, in the writeOutForFile usecase this "updatedFile" was needed only for the verifying of the consistency of the "writtenOut" DOM, however the API was exposing it further back to the caller sites, without "committing". The potential issue here is inconsistency of the data Model. On one side we have an original File Item owned by the Base Env, on the other side we have an "updatedFile" which is owned by another Env. Taking into account that there are no usecases requiring "exposing" "updatedFile", but also no need for "committing" the changes, It's arguably better to keep that temporary "updatedFile" locally, not exposing it outside the writeOutForFile function. Thereby improving consistency of the data model. Change-Id: If45eca4b4d6d703e2a76d0580f124d0292af5ed8 Reviewed-by: Semih Yavuz <semih.yavuz@qt.io>
2023-12-05 09:42:23 +00:00
bool writtenOut;
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QString resultStr;
if (myFile.field(Fields::isValid).value().toBool()) {
WriteOutChecks checks = extraChecks;
const qsizetype largeFileSize = 32000;
if (tFile.field(Fields::code).value().toString().size() > largeFileSize)
checks = largeChecks;
QTextStream res(&resultStr);
LineWriter lw([&res](QStringView s) { res << s; }, QLatin1String("*testStream*"), options);
OutWriter ow(lw);
ow.indentNextlines = true;
DomItem qmlFile = tFile.field(Fields::currentItem);
writtenOut = qmlFile.writeOutForFile(ow, checks);
lw.eof();
res.flush();
}
if (didSucceed)
QQmlJS::Dom::OutWriter. Refactoring The refactoring consists of: - Changing writeOut & writeOutForFile API to return boolean instead of MutableDomItem, which better reflects the existing usecases improving consistency of the data model* Moreover, previous API was exposing DomItem, which was not "committed to base" (MutableDomItem.commitToBase()), meaning it was exposing the "unmerged" Item alongside with the "temporary environment" - Refactoring & renaming OutWriter::updatedFile breaking it into smaller chunks preserving only necessary functionality - Adding some comments / documentation Before this commit, the writeOut API was "exposing",so called, "updatedFile", which is basically the copy of the original fileItem + renewed scriptExpressions which were modified during the writeOut of the original fileItem. The idea behind the "mutating" Dom API is that one has to create a MutableDomItem, do some changes to it and then "commit" them. This process is also facilitated by the creation of separate Env. (git analogy might be handy here: We create a separate branch, where all the mutation will happen and then we "merge" this branch) However, in the writeOutForFile usecase this "updatedFile" was needed only for the verifying of the consistency of the "writtenOut" DOM, however the API was exposing it further back to the caller sites, without "committing". The potential issue here is inconsistency of the data Model. On one side we have an original File Item owned by the Base Env, on the other side we have an "updatedFile" which is owned by another Env. Taking into account that there are no usecases requiring "exposing" "updatedFile", but also no need for "committing" the changes, It's arguably better to keep that temporary "updatedFile" locally, not exposing it outside the writeOutForFile function. Thereby improving consistency of the data model. Change-Id: If45eca4b4d6d703e2a76d0580f124d0292af5ed8 Reviewed-by: Semih Yavuz <semih.yavuz@qt.io>
2023-12-05 09:42:23 +00:00
*didSucceed = writtenOut;
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
return resultStr;
}
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
void TestQmlformat::qml_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
QTest::addColumn<QStringList>("args");
QTest::addColumn<RunOption>("runOption");
QTest::newRow("example1") << "Example1.qml"
<< "Example1.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("annotation") << "Annotations.qml"
<< "Annotations.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("front inline") << "FrontInline.qml"
<< "FrontInline.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("if blocks") << "IfBlocks.qml"
<< "IfBlocks.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("read-only properties")
<< "readOnlyProps.qml"
<< "readOnlyProps.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("states and transitions")
<< "statesAndTransitions.qml"
<< "statesAndTransitions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("large bindings")
<< "largeBindings.qml"
<< "largeBindings.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("verbatim strings")
<< "verbatimString.qml"
<< "verbatimString.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("inline components")
<< "inlineComponents.qml"
<< "inlineComponents.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("nested ifs") << "nestedIf.qml"
<< "nestedIf.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("QTBUG-85003") << "QtBug85003.qml"
<< "QtBug85003.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("nested functions")
<< "nestedFunctions.qml"
<< "nestedFunctions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("multiline comments")
<< "multilineComment.qml"
<< "multilineComment.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("for of") << "forOf.qml"
<< "forOf.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("property names")
<< "propertyNames.qml"
<< "propertyNames.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("empty object") << "emptyObject.qml"
<< "emptyObject.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("arrow functions")
<< "arrowFunctions.qml"
<< "arrowFunctions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("forWithLet")
<< "forWithLet.qml"
<< "forWithLet.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("dontRemoveComments")
<< "dontRemoveComments.qml"
<< "dontRemoveComments.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("ecmaScriptClassInQml")
<< "ecmaScriptClassInQml.qml"
<< "ecmaScriptClassInQml.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("arrowFunctionWithBinding")
<< "arrowFunctionWithBinding.qml"
<< "arrowFunctionWithBinding.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("blanklinesAfterComment")
<< "blanklinesAfterComment.qml"
<< "blanklinesAfterComment.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("pragmaValueList")
<< "pragma.qml"
<< "pragma.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("objectDestructuring")
<< "objectDestructuring.qml"
<< "objectDestructuring.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("destructuringFunctionParameter")
<< "destructuringFunctionParameter.qml"
<< "destructuringFunctionParameter.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("ellipsisFunctionArgument")
<< "ellipsisFunctionArgument.qml"
<< "ellipsisFunctionArgument.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("importStatements")
<< "importStatements.qml"
<< "importStatements.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("arrayEndComma")
<< "arrayEndComma.qml"
<< "arrayEndComma.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("escapeChars")
<< "escapeChars.qml"
<< "escapeChars.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("javascriptBlock")
<< "javascriptBlock.qml"
<< "javascriptBlock.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("enumWithValues")
<< "enumWithValues.qml"
<< "enumWithValues.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("typeAnnotatedSignal")
<< "signal.qml"
<< "signal.formatted.qml" << QStringList{} << RunOption::OnCopy;
//plainJS
QTest::newRow("nestedLambdaWithIfElse")
<< "lambdaWithIfElseInsideLambda.js"
<< "lambdaWithIfElseInsideLambda.formatted.js" << QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions")
<< "noSuperfluousSpaceInsertions.qml"
<< "noSuperfluousSpaceInsertions.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions.fail_id")
<< "noSuperfluousSpaceInsertions.fail_id.qml"
<< "noSuperfluousSpaceInsertions.fail_id.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions.fail_QtObject")
<< "noSuperfluousSpaceInsertions.fail_QtObject.qml"
<< "noSuperfluousSpaceInsertions.fail_QtObject.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions.fail_signal")
<< "noSuperfluousSpaceInsertions.fail_signal.qml"
<< "noSuperfluousSpaceInsertions.fail_signal.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions.fail_enum")
<< "noSuperfluousSpaceInsertions.fail_enum.qml"
<< "noSuperfluousSpaceInsertions.fail_enum.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("noSuperfluousSpaceInsertions.fail_parameters")
<< "noSuperfluousSpaceInsertions.fail_parameters.qml"
<< "noSuperfluousSpaceInsertions.fail_parameters.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("nonInitializedPropertyInComponent")
<< "nonInitializedPropertyInComponent.qml"
<< "nonInitializedPropertyInComponent.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("fromAsIdentifier")
<< "fromAsIdentifier.qml"
<< "fromAsIdentifier.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
QTest::newRow("finalProperties")
<< "finalProperties.qml"
<< "finalProperties.formatted.qml"
<< QStringList{} << RunOption::OnCopy;
}
void TestQmlformat::qml()
{
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
QFETCH(QStringList, args);
QFETCH(RunOption, runOption);
Q_UNUSED(args);
Q_UNUSED(runOption);
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
#ifdef Q_OS_WIN
opts.lineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings::Windows;
#endif
QString output = formatInMemory(testFile(file), &wasSuccessful, opts, WriteOutCheck::None);
QVERIFY(wasSuccessful && !output.isEmpty());
auto exp = readTestFile(fileFormatted);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_id",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_QtObject",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_signal",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_enum",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_parameters",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QCOMPARE(output, exp);
}
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
QTEST_MAIN(TestQmlformat)
#include "tst_qmlformat.moc"