Téléchargement detekt maven plugin - Demoteur de code source detekt maven plugin Téléchargement

Plugin Detekt Maven

Un plugin Maven qui enroule la CLI Detekt. Il prend en charge les mêmes paramètres que la CLI Detekt.

Comment utiliser

Voir ci-dessous comment exécuter après la configuration.

Utilisation de base

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

L'utilisation de la configuration ci-dessus Detekt analysera les fichiers source dans ${basedir}/src et sortira les résultats dans ${basedir}/detekt .

Configuration

Tous les paramètres disponibles pour Detekt version 1.23.7 peuvent être configurés dans le plugin.

Configuration de la règle locale

Le plugin prend en charge les fichiers locaux sous forme de configuration à transmettre à Detekt.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                    < configuration >
                        < config >config/detekt/detekt.yml</ config >
                    </ configuration >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Plusieurs fichiers peuvent être répertoriés avec ; comme séparateur.

Configuration des règles distantes

Le plugin prend en charge la configuration distante sur HTTP et HTTPS.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                    < configuration >
                        < config >https://raw.githubusercontent.com/Ozsie/detekt-maven-plugin/fd0de6d59e6ae1e062a9d2b030a171da1d3225ab/src/test/resources/resolve-config/remote/remote-config.yml</ config >
                    </ configuration >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Extensions

Detekt prend en charge les ensembles de règles, les processeurs, les rapports, etc. emballés dans les plugins Detekt.

Plugins Detekt publiés

Voir Detekt Marketplace pour la liste des plugins connus.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                </ execution >
            </ executions >
            < dependencies >
                <!-- Detekt's first-party unbundled plugin for library authors:
                     https://detekt.dev/docs/next/rules/libraries -->
                < dependency >
                    < groupId >io.gitlab.arturbosch.detekt</ groupId >
                    < artifactId >detekt-rules-libraries</ artifactId >
                    < version >1.23.7</ version >
                </ dependency >
            </ dependencies >
        </ plugin >
    </ plugins >
</ build >

Plugins Detekt locaux

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                    < configuration >
                        < plugins >
                            < plugin >local/path/to/plugin.jar</ plugin >
                        </ plugins >
                    </ configuration >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Déclaration

Voir la documentation Detekt pour les types de rapports pris en charge.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                    < configuration >
                        < report >
                            < report >txt:reports/detekt.txt</ report >
                            < report >xml:reports/detekt.xml</ report >
                        </ report >
                    </ configuration >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Alternativement, la configuration peut être placée à l'extérieur des <executions> . Cela permet à la configuration d'être utilisée lors de l'exécution des objectifs autonomes.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < configuration >
                < report >
                    < report >txt:reports/detekt.txt</ report >
                    < report >xml:reports/detekt.xml</ report >
                </ report >
            </ configuration >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Base de base

D'abord un fichier de référence doit être généré:

mvn detekt:cb

Cela générera un fichier de référence pour chaque module nommé sous forme baseline-<module-name>.xml . Pour plus d'informations sur la génération de lignes de base, voir Create-Baseline. Vous pouvez désormais référencer le fichier de base dans votre configuration, comme ci-dessous.

< build >
    < plugins >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < configuration >
                < baseline >baseline.xml</ baseline >
            </ configuration >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >check</ goal ></ goals >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Résolution de type

Voir le numéro 144 pour une explication.

< build >
    < plugins >
        < plugin >
            < groupId >org.apache.maven.plugins</ groupId >
            < artifactId >maven-dependency-plugin</ artifactId >
            < version >3.2.0</ version >
            < executions >
                < execution >
                    < id >generate-classpath-var</ id >
                    < phase >package</ phase >
                    < goals >< goal >build-classpath</ goal ></ goals >
                    < configuration >
                        < outputProperty >generated.classpath</ outputProperty >
                        < silent >true</ silent >
                    </ configuration >
                </ execution >
            </ executions >
        </ plugin >
        < plugin >
            < groupId >com.github.ozsie</ groupId >
            < artifactId >detekt-maven-plugin</ artifactId >
            < version >1.23.7</ version >
            < configuration >
                < baseline >baseline.xml</ baseline >
                < classPath >${generated.classpath}</ classPath >
                < jvmTarget >17</ jvmTarget >
            </ configuration >
            < executions >
                < execution >
                    < phase >verify</ phase >
                    < goals >< goal >ctr</ goal ></ goals >
                </ execution >
            </ executions >
        </ plugin >
    </ plugins >
</ build >

Objectifs

`check`

Utilisé pour exécuter Detekt. Tous les paramètres CLI, à l'exclusion -gc et -cb, sont disponibles en utilisant -ddetekt. {Paramètre}

Exemples

mvn detekt:check -Ddetekt.config=detekt.yml
mvn detekt:check -Ddetekt.debug=true

Si vous avez besoin de résolution de type, utilisez à la place ce qui suit

mvn detekt:ctr -Ddetekt.config=detekt.yml
mvn detekt:ctr -Ddetekt.debug=true

`create-baseline`

Utilisé pour créer une ligne de base. Tous les paramètres CLI, à l'exclusion -gc et -cb, sont disponibles en utilisant -ddetekt. {Paramètre}. Par défaut, un fichier appelé Baseline-.xml sera généré. Si vous incluez -ddetekt.baseline dans l'appel, vous pouvez spécifier un autre nom pour le fichier de base.

Exemples