diff options
| author | Maximilian Goldstein <max.goldstein@qt.io> | 2022-01-11 18:03:25 +0100 |
|---|---|---|
| committer | Maximilian Goldstein <max.goldstein@qt.io> | 2022-01-17 12:36:04 +0100 |
| commit | 2ffed97aac48e27b01ed29813e8e29b054f99254 (patch) | |
| tree | 582ac11443caa34549defefccb4556b4e61990cb /src/qmlcompiler/qqmljsutils.cpp | |
| parent | f19582f630b7af1498cf4d83c2ecb339d51f6ffa (diff) | |
qmllint: Offer suggestions for typos
Automatically suggests fixes if a user has a typo in the naming of a
component, property or binding.
Also now warns about calling undefined functions.
[ChangeLog][qmllint][New Feature] qmllint will now automatically suggest
fixes if it thinks a component, property or binding was not found due to
a typo.
Fixes: QTBUG-97693
Change-Id: Ia66c1ba84e187a2eb31bbdf33ca30d7e5141bea9
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/qmlcompiler/qqmljsutils.cpp')
| -rw-r--r-- | src/qmlcompiler/qqmljsutils.cpp | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/src/qmlcompiler/qqmljsutils.cpp b/src/qmlcompiler/qqmljsutils.cpp new file mode 100644 index 0000000000..9feb102298 --- /dev/null +++ b/src/qmlcompiler/qqmljsutils.cpp @@ -0,0 +1,76 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qqmljsutils_p.h" + +#include <algorithm> + +std::optional<FixSuggestion> QQmlJSUtils::didYouMean(const QString &userInput, + const QStringList &candidates, + QQmlJS::SourceLocation location) +{ + QString shortestDistanceWord; + int shortestDistance = userInput.length(); + for (const QString &candidate : candidates) { + /* + * Calculate the distance between the userInput and candidate using Damerau–Levenshtein + * Roughly based on + * https://en.wikipedia.org/wiki/Levenshtein_distance#Iterative_with_two_matrix_rows. + */ + QList<int> v0(candidate.length() + 1); + QList<int> v1(candidate.length() + 1); + + std::iota(v0.begin(), v0.end(), 0); + + for (qsizetype i = 0; i < userInput.length(); i++) { + v1[0] = i + 1; + for (qsizetype j = 0; j < candidate.length(); j++) { + int deletionCost = v0[j + 1] + 1; + int insertionCost = v1[j] + 1; + int substitutionCost = userInput[i] == candidate[j] ? v0[j] : v0[j] + 1; + v1[j + 1] = std::min({ deletionCost, insertionCost, substitutionCost }); + } + std::swap(v0, v1); + } + + int distance = v0[candidate.length()]; + if (distance < shortestDistance) { + shortestDistanceWord = candidate; + shortestDistance = distance; + } + } + + if (shortestDistance + < std::min(std::max(userInput.length() / 2, qsizetype(3)), userInput.length())) { + return FixSuggestion { { FixSuggestion::Fix { + u"Did you mean \"%1\"?"_qs.arg(shortestDistanceWord), location, + shortestDistanceWord } } }; + } else { + return {}; + } +} |