QQmlJSLinter Class Reference

#include <qqmljslinter_p.h>

Collaboration diagram for QQmlJSLinter:

Classes
class	Plugin

Public Types
enum	LintResult {   FailedToOpen , FailedToParse , HasWarnings , HasErrors ,   LintSuccess }
enum	FixResult { NothingToFix , FixError , FixSuccess }

Public Member Functions
	QQmlJSLinter (const QStringList &importPaths, const QStringList &extraPluginPaths={}, bool useAbsolutePath=false)
LintResult	lintFile (const QString &filename, const QString *fileContents, const bool silent, QJsonArray *json, const QStringList &qmlImportPaths, const QStringList &qmldirFiles, const QStringList &resourceFiles, const QList< QQmlJS::LoggerCategory > &categories, const QQmlJS::HeuristicContextProperties &contextProperties={})
LintResult	lintModule (const QString &uri, const bool silent, QJsonArray *json, const QStringList &qmlImportPaths, const QStringList &resourceFiles)
FixResult	applyFixes (QString *fixedCode, bool silent)
const QQmlJSLogger *	logger () const
std::vector< Plugin > &	plugins ()
void	setPlugins (std::vector< Plugin > plugins)
void	setPluginsEnabled (bool enablePlugins)
bool	pluginsEnabled () const
void	clearCache ()

Static Public Member Functions
static std::vector< Plugin >	loadPlugins (QStringList paths)

Detailed Description

Definition at line 46 of file qqmljslinter_p.h.

Member Enumeration Documentation

FixResult

enum QQmlJSLinter::FixResult

Enumerator
NothingToFix
FixError
FixSuccess

Definition at line 53 of file qqmljslinter_p.h.

LintResult

enum QQmlJSLinter::LintResult

Enumerator
FailedToOpen
FailedToParse
HasWarnings
HasErrors
LintSuccess

Definition at line 52 of file qqmljslinter_p.h.

Constructor & Destructor Documentation

QQmlJSLinter()

QQmlJSLinter::QQmlJSLinter	(	const QStringList &	importPaths,
		const QStringList &	extraPluginPaths = {},
		bool	useAbsolutePath = false )

Definition at line 144 of file qqmljslinter.cpp.

Member Function Documentation

applyFixes()

QQmlJSLinter::FixResult QQmlJSLinter::applyFixes	(	QString *	fixedCode,
		bool	silent )

Definition at line 934 of file qqmljslinter.cpp.

clearCache()

void QQmlJSLinter::clearCache ( )

inline

Definition at line 136 of file qqmljslinter_p.h.

lintFile()

QQmlJSLinter::LintResult QQmlJSLinter::lintFile	(	const QString &	filename,
		const QString *	fileContents,
		const bool	silent,
		QJsonArray *	json,
		const QStringList &	qmlImportPaths,
		const QStringList &	qmldirFiles,
		const QStringList &	resourceFiles,
		const QList< QQmlJS::LoggerCategory > &	categories,
		const QQmlJS::HeuristicContextProperties &	contextProperties = {} )

Definition at line 531 of file qqmljslinter.cpp.

lintModule()

QQmlJSLinter::LintResult QQmlJSLinter::lintModule	(	const QString &	uri,
		const bool	silent,
		QJsonArray *	json,
		const QStringList &	qmlImportPaths,
		const QStringList &	resourceFiles )

Definition at line 770 of file qqmljslinter.cpp.

loadPlugins()

std::vector< QQmlJSLinter::Plugin > QQmlJSLinter::loadPlugins ( QStringList paths )

static

Definition at line 287 of file qqmljslinter.cpp.

logger()

const QQmlJSLogger * QQmlJSLinter::logger ( ) const

inline

Definition at line 125 of file qqmljslinter_p.h.

plugins()

std::vector< Plugin > & QQmlJSLinter::plugins ( )

inline

Definition at line 127 of file qqmljslinter_p.h.

pluginsEnabled()

bool QQmlJSLinter::pluginsEnabled ( ) const

inline

Definition at line 134 of file qqmljslinter_p.h.

setPlugins()

void QQmlJSLinter::setPlugins ( std::vector< Plugin > plugins )

inline

Definition at line 131 of file qqmljslinter_p.h.

setPluginsEnabled()

void QQmlJSLinter::setPluginsEnabled ( bool enablePlugins )

inline

Definition at line 133 of file qqmljslinter_p.h.

---

The documentation for this class was generated from the following files:

• qtdeclarative/src/qmlcompiler/qqmljslinter_p.h (2e4c66160f0cfbc76b0154d8b989f8931b1963bf)
• qtdeclarative/src/qmlcompiler/qqmljslinter.cpp (2e4c66160f0cfbc76b0154d8b989f8931b1963bf)