Introducing qmllint tool.

A command line program that returns 0 if a .qml file is syntactically
correct.

Ideal to integrate into continuous integration systems.

[ChangeLog][QtQml] Added QML linter tool.

Change-Id: Id420159298e9d2390acd870fee9cf1c3d08e2dec
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

2 files changed, 120 insertions, 0 deletions

diff --git a/tools/qmllint/main.cpp b/tools/qmllint/main.cpp
new file mode 100644
index 0000000000..db3f98fafe
--- /dev/null
+++ b/tools/qmllint/main.cpp
@@ -0,0 +1,113 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Sergio Martins <sergio.martins@kdab.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QDebug>
+#include <QFile>
+#include <QFileInfo>
+#include <QCommandLineParser>
+#include <QCoreApplication>
+
+#include <private/qv4value_inl_p.h>
+#include <private/qqmljslexer_p.h>
+#include <private/qqmljsparser_p.h>
+#include <private/qqmljsengine_p.h>
+#include <private/qqmlirbuilder_p.h>
+
+static bool lint_file(const QString &filename, bool silent)
+{
+    QFile file(filename);
+    if (!file.open(QFile::ReadOnly)) {
+        qWarning() << "Failed to open file" << filename << file.error();
+        return false;
+    }
+
+    QString code = QString::fromUtf8(file.readAll());
+    file.close();
+
+    QQmlJS::Engine engine;
+    QQmlJS::Lexer lexer(&engine);
+
+    QFileInfo info(filename);
+    bool isJavaScript = info.suffix().toLower() == QLatin1String("js");
+    if (isJavaScript)
+        QmlIR::Document::removeScriptPragmas(/*by-ref*/code);
+
+    lexer.setCode(code, /*line = */ 1, true);
+    QQmlJS::Parser parser(&engine);
+
+    bool success = isJavaScript ? parser.parseProgram() : parser.parse();
+
+    if (!success && !silent) {
+        foreach (const QQmlJS::DiagnosticMessage &m, parser.diagnosticMessages()) {
+            qWarning("%s:%d : %s", qPrintable(filename), m.loc.startLine, qPrintable(m.message));
+        }
+    }
+
+    return success;
+}
+
+int main(int argv, char *argc[])
+{
+    QCoreApplication app(argv, argc);
+    QCoreApplication::setApplicationName("qmllint");
+    QCoreApplication::setApplicationVersion("1.0");
+    QCommandLineParser parser;
+    parser.setApplicationDescription(QLatin1String("QML syntax verifier"));
+    parser.addHelpOption();
+    parser.addVersionOption();
+    QCommandLineOption silentOption(QStringList() << "s" << "silent", QLatin1String("Don't output syntax errors"));
+    parser.addOption(silentOption);
+    parser.addPositionalArgument(QLatin1String("files"), QLatin1String("list of qml or js files to verify"));
+
+    parser.process(app);
+
+    if (parser.positionalArguments().isEmpty()) {
+        parser.showHelp(-1);
+    }
+
+    bool silent = parser.isSet(silentOption);
+    bool success = true;
+    foreach (const QString &filename, parser.positionalArguments()) {
+        success &= lint_file(filename, silent);
+    }
+
+    return success ? 0 : -1;
+}
diff --git a/tools/qmllint/qmllint.pro b/tools/qmllint/qmllint.pro
new file mode 100644
index 0000000000..bc6e27cec2
--- /dev/null
+++ b/tools/qmllint/qmllint.pro
@@ -0,0 +1,7 @@
+option(host_build)
+
+QT = core qmldevtools-private
+
+SOURCES += main.cpp
+
+load(qt_tool)