Differential D17314 Diff 47118 addons/project/tools/kateprojectcodeanalysistoolshellcheck.cpp

Changeset View

Standalone View

addons/project/tools/kateprojectcodeanalysistoolshellcheck.cpp

This file was added.

1		/* This file is part of the Kate project.
2		*
3		* Copyright (C) 2018 Gregor Mi <codestruct@posteo.org>
4		*
5		* This library is free software; you can redistribute it and/or
6		* modify it under the terms of the GNU Library General Public
7		* License as published by the Free Software Foundation; either
8		* version 2 of the License, or (at your option) any later version.
9		*
10		* This library is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Library General Public License for more details.
14		*
15		* You should have received a copy of the GNU Library General Public License
16		* along with this library; see the file COPYING.LIB. If not, write to
17		* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18		* Boston, MA 02110-1301, USA.
19		*/
20
21		#include "kateprojectcodeanalysistoolshellcheck.h"
22
23		#include <QRegularExpression>
24		#include <klocalizedstring.h>
25
26		KateProjectCodeAnalysisToolShellcheck::KateProjectCodeAnalysisToolShellcheck(QObject *parent)
27		: KateProjectCodeAnalysisTool(parent)
28		{
29
30		}
31
32		KateProjectCodeAnalysisToolShellcheck::~KateProjectCodeAnalysisToolShellcheck()
33		{
34
35		}
36
37		QString KateProjectCodeAnalysisToolShellcheck::name()
38		{
39		// "ShellCheck is a static analysis and linting tool for sh/bash scripts"
40		return i18n("ShellCheck (sh/bash)");
41		}
42
43		QString KateProjectCodeAnalysisToolShellcheck::fileExtensions()
44		{
45		// TODO: How to also handle files with no file extension?
46		return QStringLiteral("sh\|bash");
47		}
48
49		QStringList KateProjectCodeAnalysisToolShellcheck::filter(const QStringList &files)
50		{
51		// for now we expect files with extension
52		return files.filter(QRegularExpression(QStringLiteral("\\.(") + fileExtensions() + QStringLiteral(")$")));
53		}
54
55		QString KateProjectCodeAnalysisToolShellcheck::path()
56		{
57		return QStringLiteral("shellcheck");
58		}
59
60		QStringList KateProjectCodeAnalysisToolShellcheck::arguments()
61		{
62		QStringList _args;
63
64		// shellcheck --format=gcc script.sh
65		// Example output:
66		// script.sh:2:12: note: Use ./glob or -- glob so names with dashes won't become options. [SC2035]
67		// script.sh:3:11: note: Use ./glob or -- glob so names with dashes won't become options. [SC2035]
68		// script.sh:3:20: warning: podir is referenced but not assigned. [SC2154]
69		// script.sh:3:20: note: Double quote to prevent globbing and word splitting. [SC2086]
70
71		_args << QStringLiteral("--format=gcc");
72
73		if (m_project) {
74		auto&& fileList = filter(m_project->files());
75		setActualFilesCount(fileList.size());
76		_args.append(fileList);
77		}
78
79		return _args;
80		}
81
82		QString KateProjectCodeAnalysisToolShellcheck::notInstalledMessage()
83		{
84		return i18n("Please install ShellCheck (see https://www.shellcheck.net).");
85		}
86
87		QStringList KateProjectCodeAnalysisToolShellcheck::parseLine(const QString &line)
88		{
89		// Example:
	dhaumannUnsubmitted Done QRegExp is deprecated in favor of QRegeularExplression. Could you replace this? If you want to save time by avoiding creating the QRegularExpression every time parseLine() is called, you can make it static: static QRegularExpression regex(...); dhaumann: QRegExp is deprecated in favor of QRegeularExplression. Could you replace this? If you want to…
90		// IN:
91		// script.sh:3:11: note: Use ./glob or -- glob so names with dashes won't become options. [SC2035]
92		// OUT:
93		// file, line, severity, message
94		// "script.sh", "3", "note", "... ..."
95
96		QRegularExpression regex(QStringLiteral("([^:]+):(\\d+):\\d+: (\\w+): (.*)"));
97		QRegularExpressionMatch match = regex.match(line);
98		QStringList outList = match.capturedTexts();
99		outList.erase(outList.begin()); // remove first element
100		if (outList.size() != 4) {
101		// if parsing fails we clear the list
102		outList.clear();
103		}
104
105		return outList;
106		}
107
108		bool KateProjectCodeAnalysisToolShellcheck::isSuccessfulExitCode(int exitCode)
109		{
110		// "0: All files successfully scanned with no issues."
111		// "1: All files successfully scanned with some issues."
112		return exitCode == 0 \|\| exitCode == 1;
113		}
114
115		QString KateProjectCodeAnalysisToolShellcheck::stdinMessages()
116		{
117		return QString();
118		}