qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qtdeclarative/src/qmlcompiler/qqmljslogger.cpp

277 lines
12 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) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
#include "qqmljslogger_p.h"
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
#include <QtCore/qfile.h>
#include <QtCore/qfileinfo.h>
qmlcompiler: Use QT_BEGIN_NAMESPACE / QT_END_NAMESPACE everywhere Some code was not properly wrapped in a namespace. Change-Id: If70fd9782391309c511b66ae01eae43cb36292ac Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-22 12:41:14 +00:00
QT_BEGIN_NAMESPACE
Replace uses of deprecated _qs with _s/QStringLiteral Task-number: QTBUG-101408 Change-Id: Ic925751b73f52d8fa5add5cacc52d6dd6ea2dc27 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-03-21 09:21:18 +00:00
using namespace Qt::StringLiterals;
qmllint: add options for setting logging levels Add the ability to individually disable and set the severity of all warnings produced by qmllint. Change-Id: I46081f8b37fb90f8d0f4a5f2f08223d7b7285041 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-03-30 10:58:26 +00:00
const QMap<QString, QQmlJSLogger::Option> &QQmlJSLogger::options() {
static QMap<QString, QQmlJSLogger::Option> optionsMap = {
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("required"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Required, QStringLiteral("RequiredProperty"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about required properties"), QtWarningMsg) },
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("alias"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Alias, QStringLiteral("PropertyAlias"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about alias errors"), QtWarningMsg) },
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("import"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Import, QStringLiteral("ImportFailure"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about failing imports and deprecated qmltypes"),
QtWarningMsg) },
{ QStringLiteral("with"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_WithStatement, QStringLiteral("WithStatement"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about with statements as they can cause false "
"positives when checking for unqualified access"),
QtWarningMsg) },
{ QStringLiteral("inheritance-cycle"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_InheritanceCycle, QStringLiteral("InheritanceCycle"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about inheritance cycles"), QtWarningMsg) },
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("deprecated"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Deprecation, QStringLiteral("Deprecated"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about deprecated properties and types"),
QtWarningMsg) },
{ QStringLiteral("signal"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Signal, QStringLiteral("BadSignalHandler"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about bad signal handler parameters"),
QtWarningMsg) },
{ QStringLiteral("type"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Type, QStringLiteral("TypeError"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about unresolvable types and type mismatches"),
QtWarningMsg) },
{ QStringLiteral("property"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_Property, QStringLiteral("UnknownProperty"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about unknown properties"), QtWarningMsg) },
tst_sanity: Also handle ids via qmllint Utilize our warning against using ids on deferred properties instead of the id visitor. To accomplish this cleanly we have to move our deferred property warnings into a different category. Also remove the BLACKLIST since the corresponding tests no longer exist and the qmllint version of them does not require any blacklisting. Fixes: QTBUG-96021 Change-Id: I35f88157c9c4aa20e006f09a1402e3100fe09fb9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-11-26 11:42:03 +00:00
{ QStringLiteral("deferred-property-id"),
QQmlJSLogger::Option(
Log_DeferredPropertyId, QStringLiteral("DeferredPropertyId"),
QStringLiteral(
"Warn about making deferred properties immediate by giving them an id."),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QtWarningMsg) },
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("unqualified"),
QQmlJSLogger::Option(
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
Log_UnqualifiedAccess, QStringLiteral("UnqualifiedAccess"),
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
QStringLiteral("Warn about unqualified identifiers and how to fix them"),
QtWarningMsg) },
{ QStringLiteral("unused-imports"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_UnusedImport, QStringLiteral("UnusedImports"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about unused imports"), QtInfoMsg) },
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
{ QStringLiteral("multiline-strings"),
qmllint: Add support for loading options from settings This change adds support for a reading a simple settings file (.qmllint.ini) to set log levels and various other options. The settings file applies on a per-directory basis so linting files in two subdirectories with different settings will use their respective settings files. If the directory of the linted file does not contain any settings we search through all parent directories. This is implemented in a way that qmlformat can also utilize the settings file code. This makes qmllint more useful for larger projects that might want different settings for different parts of their QML code. It also allows for better integration in CI checks and pre-commit hooks. [ChangeLog][General][qmllint] 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 Change-Id: I94e4a47916b5dfd16c3a69efdba3858235cab738 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-12 16:32:57 +00:00
QQmlJSLogger::Option(Log_MultilineString, QStringLiteral("MultilineStrings"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about multiline strings"), QtInfoMsg) },
qmllint: Integrate type inference warnings This change helps bring in type inference and compiler warnings previously only generated by qmlcachegen+. These warnings are disabled by default and have to be enabled manually via the --compiler option. Also makes the logger handle zero length SourceLocations properly by just highlighting the entire line instead of hitting an assert. Change-Id: Iebad6e9236214d9367f97487e7b5787592edab7d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-05 10:48:49 +00:00
{ QStringLiteral("compiler"),
QQmlJSLogger::Option(Log_Compiler, QStringLiteral("CompilerWarnings"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QStringLiteral("Warn about compiler issues"), QtCriticalMsg, true) },
qmllint: Add ability to warn about function declarations Another warning ability we need in order to replace controls' tst_sanity with something more sensible. Probably not useful outside of that, so it is disabled by default. Fixes: QTBUG-96573 Change-Id: I6241899f167f7ea5463ff5b3f157c616c1936cd2 Reviewed-by: Fawzi Mohamed <fawzi.mohamed@qt.io>
2021-09-23 10:18:17 +00:00
{ QStringLiteral("controls-sanity"),
QQmlJSLogger::Option(
Log_ControlsSanity, QStringLiteral("ControlsSanity"),
tst_sanity: Also handle ids via qmllint Utilize our warning against using ids on deferred properties instead of the id visitor. To accomplish this cleanly we have to move our deferred property warnings into a different category. Also remove the BLACKLIST since the corresponding tests no longer exist and the qmllint version of them does not require any blacklisting. Fixes: QTBUG-96021 Change-Id: I35f88157c9c4aa20e006f09a1402e3100fe09fb9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-11-26 11:42:03 +00:00
QStringLiteral("Performance checks used for QuickControl's implementation"),
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QtCriticalMsg, true) },
qmllint: Add ability to warn about not reusing attached types This is mostly useful as an replacement for Quick Controls' tst_sanity but might also be useful in some other instances. Fixes: QTBUG-96572 Change-Id: I5cf414bfeb369cbc394563c5c5ed807599b09a2f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-09-22 16:57:27 +00:00
{ QStringLiteral("multiple-attached-objects"),
QQmlJSLogger::Option(
Log_AttachedPropertyReuse, QStringLiteral("AttachedPropertyReuse"),
QStringLiteral("Warn if attached types from parent components aren't reused"),
qmlcompiler: Implement structured QML static analysis This patch adds the qqmlsa "framework", which is meant as a starting point for a more structured, extendible static analysis for QML. While qmllint (or rather, the QQmlJSImportVisitor used by it) can already do quite a few checks internally, it is hard to extend. Moreover, the checks there are interspersed with parsing code, and might run before all types are resolved. We also do not want to add check that are specific to QtQuick, Controls, Quick3D... into the core QtQml module. This poses quite a few challenges: For instance, the color in QML resolver depends on QtQuick/QtGui to check whether a string is actually a color. To overcome the issues mentioned above, we introduce the concept of analysis passes, and a PassManger class. Passes can come in two shapes currently: - PropertyPasses run on each property that has a binding assigned to it - ElementPasses run on each (sub-)object instantiated in the file A property can have multiple bindings assigned to it (due to e.g. Interceptors, but also for list properties). Therefore we pass a list of them to the ElementPass. Passes which only want to handle the "normal" case of one binding per property can use SimpleElementPass, which for now just takes the first property in the list. Passes have a pure virtual run function, in which the actual work is done. They also have a filter function, which in the default implementation simply returns true, which means that the pass will run. The filter function is there to make writing passes a bit more structured, by separating the "do I need to analyze this" question from the actual analysis part. To solve the issue of library dependencies, we expose a plugin interface that then returns passes to be run based on the root component. Then, user can create a plugin implementing the interface, which we will load the plugins from a known location, and register all of them. This will be implemented in the next patch in this set. Limitations: - The current passes cannot touch the IR, and thus cannot really analyze what happens in script binding. - (inline) components are currently badly handled - QQmlJSScope has various issuse with grouped properties Fixes: QTBUG-101604 Original-patch-by: Fabian Kosmale <fabian.kosmale@qt.io> Change-Id: Ic96259a947fbb17f79aa58ca613c8d0905a9a74c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-03-16 12:18:41 +00:00
QtCriticalMsg, true) },
{ QStringLiteral("plugin"),
QQmlJSLogger::Option(Log_Plugin, QStringLiteral("LintPluginWarnings"),
QStringLiteral("Warn if a qmllint plugin finds an issue"),
qmllint: Integrate plugin infrastructure Integrates the plugin and pass infrastructure into qmlcompiler and qmllint proper. Plugins are searched for in the "qmllint" subfolder of the Qt installation's plugin directory. In addition we also support loading statically linked plugins. [ChangeLog][qmllint][New Feature] qmllint can now be extended via plugins. Use --plugins to get a list of available plugins. Original-patch-by: Fabian Kosmale <fabian.kosmale@qt.io> Change-Id: I75a09dd978fc7724aca4931f055cc71c7ced971b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-03-16 12:19:54 +00:00
QtWarningMsg) }
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
};
qmllint: add options for setting logging levels Add the ability to individually disable and set the severity of all warnings produced by qmllint. Change-Id: I46081f8b37fb90f8d0f4a5f2f08223d7b7285041 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-03-30 10:58:26 +00:00
return optionsMap;
}
Add a default implementation for QQmlJSAotCompiler The default AOT compiler compiles QML code in indirect, dynamic mode. It uses the logger's Log_Compiler category to determine the verbosity of its output. In addition you can use the qt.qml.compiler.aot category for even more verbosity. In preparation for using QQmlJSAotCompiler with qmlcachegen, the default level of that category is increased to QtFatalMsg. The highest level we actually output is QtDebugMsg, so it doesn't make a difference yet. If the logger's Log_Compiler category is set to produce errors, it will qFatal() on "pragma Strict" violations. Change-Id: Ieb74bfa7cd51cfa8616792ab467c32f6ba0e0702 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-18 13:26:29 +00:00
QQmlJSLogger::QQmlJSLogger()
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
{
qmllint: add options for setting logging levels Add the ability to individually disable and set the severity of all warnings produced by qmllint. Change-Id: I46081f8b37fb90f8d0f4a5f2f08223d7b7285041 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-03-30 10:58:26 +00:00
const auto &opt = options();
for (auto it = opt.cbegin(); it != opt.cend(); ++it) {
m_categoryLevels[it.value().m_category] = it.value().m_level;
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
m_categoryIgnored[it.value().m_category] = it.value().m_ignored;
qmllint: add options for setting logging levels Add the ability to individually disable and set the severity of all warnings produced by qmllint. Change-Id: I46081f8b37fb90f8d0f4a5f2f08223d7b7285041 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-03-30 10:58:26 +00:00
}
qmllint: Add inline component support Adds support for inline components for qmllint with a few things not working yet: - Two inline components referencing each other - Using inline components before they are declared These two issues require a larger overhaul of qmllint as a whole and will be addressed in a different change. Change-Id: I2834702c21a8eb728db4709d6f475c33796b3e4d Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-05-11 15:36:08 +00:00
// These have to be set up manually since we don't expose it as an option
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
m_categoryLevels[Log_RecursionDepthError] = QtCriticalMsg;
m_categoryLevels[Log_Syntax] = QtWarningMsg; // TODO: because we usually report it as a warning!
m_categoryLevels[Log_SyntaxIdQuotation] = QtWarningMsg;
m_categoryLevels[Log_SyntaxDuplicateIds] = QtCriticalMsg;
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
// setup color output
m_output.insertMapping(QtCriticalMsg, QColorOutput::RedForeground);
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
m_output.insertMapping(QtWarningMsg, QColorOutput::PurpleForeground); // Yellow?
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
m_output.insertMapping(QtInfoMsg, QColorOutput::BlueForeground);
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
m_output.insertMapping(QtDebugMsg, QColorOutput::GreenForeground); // None?
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
}
qmllint: Implement severity levels qmllint now supports logging levels of different severities. Still lacking a good way to toggle the verbosity more granularly though (i.e. disabling only info messages while still receiving the rest). Change-Id: I71abddcdf1adf60315a87d776af8085acf7aeffe Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 15:30:42 +00:00
static bool isMsgTypeLess(QtMsgType a, QtMsgType b)
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
{
qmllint: Implement severity levels qmllint now supports logging levels of different severities. Still lacking a good way to toggle the verbosity more granularly though (i.e. disabling only info messages while still receiving the rest). Change-Id: I71abddcdf1adf60315a87d776af8085acf7aeffe Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 15:30:42 +00:00
static QHash<QtMsgType, int> level = { { QtDebugMsg, 0 },
{ QtInfoMsg, 1 },
{ QtWarningMsg, 2 },
{ QtCriticalMsg, 3 },
{ QtFatalMsg, 4 } };
return level[a] < level[b];
}
void QQmlJSLogger::log(const QString &message, QQmlJSLoggerCategory category,
const QQmlJS::SourceLocation &srcLocation, QtMsgType type, bool showContext,
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
bool showFileName, const std::optional<FixSuggestion> &suggestion,
const QString overrideFileName)
qmllint: Implement severity levels qmllint now supports logging levels of different severities. Still lacking a good way to toggle the verbosity more granularly though (i.e. disabling only info messages while still receiving the rest). Change-Id: I71abddcdf1adf60315a87d776af8085acf7aeffe Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 15:30:42 +00:00
{
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
if (isCategoryIgnored(category))
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
return;
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
// Note: assume \a type is the type we should prefer for logging
qmllint: Add ability to ignore individual warnings Allows users to ignore individual warnings by adding a "// qmllint disable" comment in the line that triggers the warning. This feature is especially useful for use in pre-commit / CI tests as it allows to add exceptions for individual warnings that cannot be fixed immediately. [ChangeLog][qmllint][New Feature] You can now ignore individual warnings by adding "// qmllint disable" in the line causing it. You may also specify one or more warning type to ignore ("// qmllint disable warningtype1 warningtype2...") which is preferable. This can also be done for entire blocks of code by using "// qmllint disable" in an empty line and ending it with "// qmllint enable" Change-Id: Iea6c29132d6b51ecfb5e5d8a19a43446a7286c24 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-05-27 12:32:43 +00:00
if (srcLocation.isValid() && m_ignoredWarnings[srcLocation.startLine].contains(category))
return;
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
QString prefix;
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
if ((!overrideFileName.isEmpty() || !m_fileName.isEmpty()) && showFileName)
prefix =
(!overrideFileName.isEmpty() ? overrideFileName : m_fileName) + QStringLiteral(":");
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
if (srcLocation.isValid())
prefix += QStringLiteral("%1:%2:").arg(srcLocation.startLine).arg(srcLocation.startColumn);
if (!prefix.isEmpty())
prefix.append(QLatin1Char(' '));
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
// Note: we do the clamping to [Info, Critical] range since our logger only
// supports 3 categories
type = std::clamp(type, QtInfoMsg, QtCriticalMsg, isMsgTypeLess);
qmllint: Implement severity levels qmllint now supports logging levels of different severities. Still lacking a good way to toggle the verbosity more granularly though (i.e. disabling only info messages while still receiving the rest). Change-Id: I71abddcdf1adf60315a87d776af8085acf7aeffe Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 15:30:42 +00:00
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
// Note: since we clamped our \a type, the output message is not printed
// exactly like it was requested, bear with us
m_output.writePrefixedMessage(prefix + message, type);
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
qmllint: Use fix suggestions in a more structured way Fix suggestions are now attached to the warnings they are caused by and are also accessible via JSON. This allows us to use the qmllint library for more of tst_qmllint, greatly improving performance. Change-Id: Idd0398028bff1272a75dc1193d2c15a25d335dbf Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-12-07 17:48:08 +00:00
Message diagMsg;
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
diagMsg.message = message;
diagMsg.loc = srcLocation;
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
diagMsg.type = type;
qmllint: Use fix suggestions in a more structured way Fix suggestions are now attached to the warnings they are caused by and are also accessible via JSON. This allows us to use the qmllint library for more of tst_qmllint, greatly improving performance. Change-Id: Idd0398028bff1272a75dc1193d2c15a25d335dbf Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-12-07 17:48:08 +00:00
diagMsg.fixSuggestion = suggestion;
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
switch (type) {
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
case QtWarningMsg: m_warnings.push_back(diagMsg); break;
case QtCriticalMsg: m_errors.push_back(diagMsg); break;
case QtInfoMsg: m_infos.push_back(diagMsg); break;
default: break;
}
if (srcLocation.isValid() && !m_code.isEmpty() && showContext)
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
printContext(overrideFileName, srcLocation);
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
qmllint: Use fix suggestions in a more structured way Fix suggestions are now attached to the warnings they are caused by and are also accessible via JSON. This allows us to use the qmllint library for more of tst_qmllint, greatly improving performance. Change-Id: Idd0398028bff1272a75dc1193d2c15a25d335dbf Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-12-07 17:48:08 +00:00
if (suggestion.has_value())
printFix(suggestion.value());
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
}
qmllint: Implement severity levels qmllint now supports logging levels of different severities. Still lacking a good way to toggle the verbosity more granularly though (i.e. disabling only info messages while still receiving the rest). Change-Id: I71abddcdf1adf60315a87d776af8085acf7aeffe Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 15:30:42 +00:00
void QQmlJSLogger::processMessages(const QList<QQmlJS::DiagnosticMessage> &messages,
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
QQmlJSLoggerCategory category)
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
{
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
if (messages.isEmpty() || isCategoryIgnored(category))
qmllint: Improve import warnings Import warnings will now always be clearly associated with the line and import that caused them. They're also visually separated now and don't redundantly show the importing files name in every warning. Some type of imports such as file or URI based imports never had their warnings processed which is also fixed by this change. Change-Id: I63d720fcf198ff5302c2566a91cde4c716697f7e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-30 08:16:03 +00:00
return;
m_output.write(QStringLiteral("---\n"));
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
// TODO: we should instead respect message's category here (potentially, it
// should hold a category instead of type)
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
for (const QQmlJS::DiagnosticMessage &message : messages)
Redesign QQmlJSLogger internals High-level goal: be able to reuse existing infrastructure "as is" to configure semantic analysis categories in tools (qmllint, qmltc, qmlsc, etc.) To achieve that, simplify the logging to always "log" something, without explicitly specifying the severity. The severity is now baked into the category (and we can extend those to cover different cases) One slight deviation is the cache generation which likes to do its own thing at present. Provide a "forced logging" option where we can specify which severify we want. The hope is that this gets removed at some point Particular list of (noteworthy) changes: * No more "thresholding" by the level (this is rarely needed and is actually questionable). Instead, we can ignore a particular category explicitly * Category levels are repurposed as category severities (at least from the high-level picture that always should've been this way) * log{Warning,Info,Critical} removed. We use category severity instead * "category error" makes zero sense so removed: if our severity is: - QtWarningMsg (qmllint), it is already an "error" - QtCriticalMsg (compilers), it is already an "error" * Align m_output and m_{infos,warnings,errors} stored information * Accept the fact that we don't support QtDebugMsg and QtFatalMsg * Additional categories added to cover for places where the same category would be both an error and not an error Task-number: QTBUG-100052 Change-Id: I3cd5d17d58be204f48428877bed053f756ac40a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-02-03 12:45:18 +00:00
log(message.message, category, QQmlJS::SourceLocation(), false, false);
qmllint: Improve import warnings Import warnings will now always be clearly associated with the line and import that caused them. They're also visually separated now and don't redundantly show the importing files name in every warning. Some type of imports such as file or URI based imports never had their warnings processed which is also fixed by this change. Change-Id: I63d720fcf198ff5302c2566a91cde4c716697f7e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-30 08:16:03 +00:00
m_output.write(QStringLiteral("---\n\n"));
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
}
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
void QQmlJSLogger::printContext(const QString &overrideFileName,
const QQmlJS::SourceLocation &location)
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
{
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
QString code = m_code;
if (!overrideFileName.isEmpty() && overrideFileName != QFileInfo(m_fileName).absolutePath()) {
QFile file(overrideFileName);
const bool success = file.open(QFile::ReadOnly);
Q_ASSERT(success);
code = QString::fromUtf8(file.readAll());
}
IssueLocationWithContext issueLocationWithContext { code, location };
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
if (const QStringView beforeText = issueLocationWithContext.beforeText(); !beforeText.isEmpty())
m_output.write(beforeText);
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
bool locationMultiline = issueLocationWithContext.issueText().contains(QLatin1Char('\n'));
qmllint: Integrate type inference warnings This change helps bring in type inference and compiler warnings previously only generated by qmlcachegen+. These warnings are disabled by default and have to be enabled manually via the --compiler option. Also makes the logger handle zero length SourceLocations properly by just highlighting the entire line instead of hitting an assert. Change-Id: Iebad6e9236214d9367f97487e7b5787592edab7d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-05 10:48:49 +00:00
if (!issueLocationWithContext.issueText().isEmpty())
m_output.write(issueLocationWithContext.issueText().toString(), QtCriticalMsg);
qmlcompiler: enable standalone building: - convert to string to in a couple of places to work without QStringView + operator - import local files with "*" (not via <private/*>) Change-Id: I1d7cdcbd39e609f36693733e98d4f74a7260ce88 Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-08-13 07:44:42 +00:00
m_output.write(issueLocationWithContext.afterText().toString() + QLatin1Char('\n'));
qmllint: Warn about multiline strings Task-number: QTBUG-92448 Change-Id: Ic6305f05cb8a0af5c36ac03d8b541ac78cea0612 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-04-19 14:54:45 +00:00
// Do not draw location indicator for multiline locations
if (locationMultiline)
return;
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
int tabCount = issueLocationWithContext.beforeText().count(QLatin1Char('\t'));
qmllint: Integrate type inference warnings This change helps bring in type inference and compiler warnings previously only generated by qmlcachegen+. These warnings are disabled by default and have to be enabled manually via the --compiler option. Also makes the logger handle zero length SourceLocations properly by just highlighting the entire line instead of hitting an assert. Change-Id: Iebad6e9236214d9367f97487e7b5787592edab7d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-05 10:48:49 +00:00
int locationLength = location.length == 0 ? 1 : location.length;
m_output.write(QString::fromLatin1(" ").repeated(issueLocationWithContext.beforeText().length()
- tabCount)
+ QString::fromLatin1("\t").repeated(tabCount)
+ QString::fromLatin1("^").repeated(locationLength) + QLatin1Char('\n'));
qmlcompiler/qmllint: Use unified logger Improves the logging situation greatly by allowing all logging messages to be assigned different severities, highlighting the code that caused them and by now ensuring a qmllint warning will always result in a non-zero exit code. A later patch will expose more of these options to the user. Change-Id: Id9b036fe3ba80dd18e9f8cb1b05efa891713d5a8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-03-25 14:34:42 +00:00
}
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
void QQmlJSLogger::printFix(const FixSuggestion &fix)
{
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
const QString currentFileAbsPath = QFileInfo(m_fileName).absolutePath();
QString code = m_code;
QString currentFile;
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
for (const auto &fixItem : fix.fixes) {
qmllint: Force fix suggestions to use QtInfoMsg It makes no sense to use a higher message level for a fix suggestion. A fix suggestion should be prefixed by the warning or error that triggers it. That warning or error should have the actual level. Change-Id: I4b5a2ec150afd469ea53697546541a7890c525ec Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-23 09:39:28 +00:00
m_output.writePrefixedMessage(fixItem.message, QtInfoMsg);
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
if (!fixItem.cutLocation.isValid())
continue;
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
if (fixItem.fileName == currentFile) {
// Nothing to do in this case, we've already read the code
} else if (fixItem.fileName.isEmpty() || fixItem.fileName == currentFileAbsPath) {
code = m_code;
} else {
QFile file(fixItem.fileName);
const bool success = file.open(QFile::ReadOnly);
Q_ASSERT(success);
code = QString::fromUtf8(file.readAll());
currentFile = fixItem.fileName;
}
IssueLocationWithContext issueLocationWithContext { code, fixItem.cutLocation };
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
if (const QStringView beforeText = issueLocationWithContext.beforeText();
!beforeText.isEmpty()) {
m_output.write(beforeText);
}
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
// The replacement string can be empty if we're only pointing something out to the user
QStringView replacementString = fixItem.replacementString.isEmpty()
? issueLocationWithContext.issueText()
: fixItem.replacementString;
// But if there's nothing to change it has to be a hint
if (fixItem.replacementString.isEmpty())
Q_ASSERT(fixItem.isHint);
m_output.write(replacementString, QtDebugMsg);
qmlcompiler: enable standalone building: - convert to string to in a couple of places to work without QStringView + operator - import local files with "*" (not via <private/*>) Change-Id: I1d7cdcbd39e609f36693733e98d4f74a7260ce88 Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-08-13 07:44:42 +00:00
m_output.write(issueLocationWithContext.afterText().toString() + u'\n');
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
int tabCount = issueLocationWithContext.beforeText().count(u'\t');
qmlcompiler: Suggest fix for multiline strings We can now suggest a template string to use instead that is properly escaped. Once auto-fixing becomes available we can automatically replace deprecated multiline strings with the new suggestion. Task-number: QTBUG-92448 Change-Id: I4e77820b66ae960cde558a62689c5da328b8df5b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2022-02-25 11:15:06 +00:00
// Do not draw location indicator for multiline replacement strings
qmlcompiler: Allow for logging other files and add auto-fix infrastructure This change makes sure the logger can write messages and show excerpts from files other than the current one. This is necessary in order to give users hints about problems that arise due to other components. It also adds a field to FixSuggestion::Fix which specifies whether a suggested fix can be applied automatically or is only a hint. Change-Id: I94a929d3fc3fc966591cffb99e67309d264c38e7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-02-24 09:28:52 +00:00
if (replacementString.contains(u'\n'))
qmlcompiler: Suggest fix for multiline strings We can now suggest a template string to use instead that is properly escaped. Once auto-fixing becomes available we can automatically replace deprecated multiline strings with the new suggestion. Task-number: QTBUG-92448 Change-Id: I4e77820b66ae960cde558a62689c5da328b8df5b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2022-02-25 11:15:06 +00:00
continue;
Replace uses of deprecated _qs with _s/QStringLiteral Task-number: QTBUG-101408 Change-Id: Ic925751b73f52d8fa5add5cacc52d6dd6ea2dc27 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-03-21 09:21:18 +00:00
m_output.write(u" "_s.repeated(
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
issueLocationWithContext.beforeText().length() - tabCount)
Replace uses of deprecated _qs with _s/QStringLiteral Task-number: QTBUG-101408 Change-Id: Ic925751b73f52d8fa5add5cacc52d6dd6ea2dc27 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-03-21 09:21:18 +00:00
+ u"\t"_s.repeated(tabCount)
+ u"^"_s.repeated(fixItem.replacementString.length()) + u'\n');
qmllint: Formalize fix suggestions They are now handled by the logger instead of being done by external classes using the ColorOutput directly. This will allow for modernizing the logger and for automatically applying those suggested fixes. Fixes: QTBUG-94170 Change-Id: I90b960d22cb91203b8e8a5c69b0fdaf6fca2fc0c Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
2021-07-01 11:55:11 +00:00
}
}
qmlcompiler: Use QT_BEGIN_NAMESPACE / QT_END_NAMESPACE everywhere Some code was not properly wrapped in a namespace. Change-Id: If70fd9782391309c511b66ae01eae43cb36292ac Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-22 12:41:14 +00:00
QT_END_NAMESPACE