Unduh detekt maven plugin - Unduh Kode Sumber detekt maven plugin

Plugin Detekt Maven

Plugin Maven yang membungkus detekt CLI. Ini mendukung parameter yang sama dengan Detekt CLI.

Cara menggunakan

Lihat di bawah cara mengeksekusi setelah mengkonfigurasi.

Penggunaan dasar

< 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 >

Menggunakan konfigurasi di atas Detekt akan memindai file sumber di ${basedir}/src dan output hasilnya di ${basedir}/detekt .

Konfigurasi

Semua parameter yang tersedia untuk Detekt Versi 1.23.7 dapat dikonfigurasi dalam plugin.

Konfigurasi Aturan Lokal

Plugin mendukung file lokal sebagai konfigurasi yang akan diteruskan ke 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 >

Beberapa file dapat terdaftar ; sebagai pemisah.

Konfigurasi aturan jarak jauh

Plugin mendukung konfigurasi jarak jauh melalui HTTP dan 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 >

Ekstensi

Detekt mendukung aturan, prosesor, laporan, dll. Dikemas dalam plugin Detekt.

Plugin Detekt yang diterbitkan

Lihat Detekt Marketplace untuk daftar plugin yang dikenal.

< 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 >

Plugin Detekt Lokal

< 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 >

Pelaporan

Lihat Dokumentasi Detekt untuk jenis laporan yang didukung.

< 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 >

Sebagai alternatif, konfigurasi dapat ditempatkan di luar <executions> . Ini memungkinkan konfigurasi digunakan saat menjalankan tujuan mandiri.

< 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 >

Baseline

Pertama file dasar perlu dihasilkan:

mvn detekt:cb

Ini akan menghasilkan file baseline untuk setiap modul yang dinamai sebagai baseline-<module-name>.xml . Untuk informasi lebih lanjut tentang menghasilkan garis dasar, lihat Create-Baseline. Anda sekarang dapat merujuk file baseline dalam konfigurasi Anda, seperti di bawah ini.

< 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 >

Ketik resolusi

Lihat masalah #144 untuk penjelasan.

< 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 >

Sasaran

`check`

Digunakan untuk menjalankan Detekt. Semua parameter CLI, tidak termasuk -gc dan -cb, tersedia menggunakan -ddetekt. {Parameter}

Contoh

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

Jika Anda memerlukan resolusi tipe, gunakan yang berikut ini sebagai gantinya

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

`create-baseline`

Digunakan untuk membuat garis dasar. Semua parameter CLI, tidak termasuk -gc dan -cb, tersedia menggunakan -ddetekt. {Parameter}. Secara default, file yang disebut baseline-.xml akan dihasilkan. Jika Anda memasukkan -ddetekt.baseline dalam panggilan, Anda dapat menentukan beberapa nama lain untuk file baseline.

Contoh