File indexing completed on 2025-01-05 05:20:15

 /*  This file is part of the Kate project.
  *
  *  SPDX-FileCopyrightText: 2017 Héctor Mesa Jiménez <hector@lcc.uma.es>
  *
  *  SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #include "flake8.h"
 
 #include "kateproject.h"
 
 #include <KLocalizedString>
 #include <QRegularExpression>
 
 KateProjectCodeAnalysisToolFlake8::KateProjectCodeAnalysisToolFlake8(QObject *parent)
     : KateProjectCodeAnalysisTool(parent)
 {
 }
 
 KateProjectCodeAnalysisToolFlake8::~KateProjectCodeAnalysisToolFlake8()
 {
 }
 
 QString KateProjectCodeAnalysisToolFlake8::name() const
 {
     return i18n("Flake8 (Python)");
 }
 
 QString KateProjectCodeAnalysisToolFlake8::description() const
 {
     return i18n("Flake8: Your Tool For Style Guide Enforcement for Python");
 }
 
 QString KateProjectCodeAnalysisToolFlake8::fileExtensions() const
 {
     return QStringLiteral("py");
 }
 
 QStringList KateProjectCodeAnalysisToolFlake8::filter(const QStringList &files) const
 {
     // for now we expect files with extension
     return files.filter(QRegularExpression(QStringLiteral("\\.(") + fileExtensions() + QStringLiteral(")$")));
 }
 
 QString KateProjectCodeAnalysisToolFlake8::path() const
 {
     /*
      * for now, only the executable in the path can be called,
      * but it would be great to be able to specify a version
      * installed in a virtual environment
      */
     return QStringLiteral("flake8");
 }
 
 QStringList KateProjectCodeAnalysisToolFlake8::arguments()
 {
     QStringList _args;
 
     _args << QStringLiteral("--exit-zero")
           /*
            * translating a flake8 code to a severity level is subjective,
            * so the code is provided as a severity level.
            */
           << QStringLiteral("--format=%(path)s////%(row)d////%(code)s////%(text)s");
 
     if (m_project) {
         auto &&fileList = filter(m_project->files());
         setActualFilesCount(fileList.size());
         _args.append(fileList);
     }
 
     return _args;
 }
 
 QString KateProjectCodeAnalysisToolFlake8::notInstalledMessage() const
 {
     return i18n("Please install 'flake8'.");
 }
 
 FileDiagnostics KateProjectCodeAnalysisToolFlake8::parseLine(const QString &line) const
 {
     const QStringList elements = line.split(QLatin1String("////"), Qt::SkipEmptyParts);
     const auto url = QUrl::fromLocalFile(elements[0]);
     Diagnostic d;
     d.message = elements[3];
     d.severity = DiagnosticSeverity::Warning;
     int ln = elements[1].toInt() - 1;
     d.range = KTextEditor::Range(ln, 0, ln, -1);
     return {url, {d}};
 }
 
 QString KateProjectCodeAnalysisToolFlake8::stdinMessages()
 {
     return QString();
 }