violations gradle plugin
v3.0.2
Ini adalah plugin Gradle untuk pelanggaran Lib. Ada juga plugin Maven untuk ini.
| Versi | Versi Java |
|---|---|
| Versi <2.0.0 | 8 |
| 2.0.0 <= Versi | 11 |
Diterbitkan ke plugins.gradle.org.
Ini dapat menguraikan hasil dari analisis kode statis dan:
Anda juga dapat melakukan ini dengan alat baris perintah.
Cuplikan output mungkin terlihat seperti ini:
...
se/bjurr/violations/lib/example/OtherClass.java
╔══════════╤════════════╤══════════╤══════╤════════════════════════════════════════════════════╗
║ Reporter │ Rule │ Severity │ Line │ Message ║
╠══════════╪════════════╪══════════╪══════╪════════════════════════════════════════════════════╣
║ Findbugs │ MS_SHOULD_ │ INFO │ 7 │ Field isn ' t final but should be ║
║ │ BE_FINAL │ │ │ ║
║ │ │ │ │ ║
║ │ │ │ │ <p> ║
║ │ │ │ │ This static field public but not final, and ║
║ │ │ │ │ could be changed by malicious code or ║
║ │ │ │ │ by accident from another package. ║
║ │ │ │ │ The field could be made final to avoid ║
║ │ │ │ │ this vulnerability.</p> ║
╟──────────┼────────────┼──────────┼──────┼────────────────────────────────────────────────────╢
║ Findbugs │ NM_FIELD_N │ INFO │ 6 │ Field names should start with a lower case letter ║
║ │ AMING_CONV │ │ │ ║
║ │ ENTION │ │ │ ║
║ │ │ │ │ <p> ║
║ │ │ │ │ Names of fields that are not final should be in mi ║
║ │ │ │ │ xed case with a lowercase first letter and the fir ║
║ │ │ │ │ st letters of subsequent words capitalized. ║
║ │ │ │ │ </p> ║
╚══════════╧════════════╧══════════╧══════╧════════════════════════════════════════════════════╝
Summary of se/bjurr/violations/lib/example/OtherClass.java
╔══════════╤══════╤══════╤═══════╤═══════╗
║ Reporter │ INFO │ WARN │ ERROR │ Total ║
╠══════════╪══════╪══════╪═══════╪═══════╣
║ Findbugs │ 2 │ 0 │ 0 │ 2 ║
╟──────────┼──────┼──────┼───────┼───────╢
║ │ 2 │ 0 │ 0 │ 2 ║
╚══════════╧══════╧══════╧═══════╧═══════╝
Summary
╔════════════╤══════╤══════╤═══════╤═══════╗
║ Reporter │ INFO │ WARN │ ERROR │ Total ║
╠════════════╪══════╪══════╪═══════╪═══════╣
║ Checkstyle │ 4 │ 1 │ 1 │ 6 ║
╟────────────┼──────┼──────┼───────┼───────╢
║ Findbugs │ 2 │ 2 │ 5 │ 9 ║
╟────────────┼──────┼──────┼───────┼───────╢
║ │ 6 │ 3 │ 6 │ 15 ║
╚════════════╧══════╧══════╧═══════╧═══════╝Contoh laporan yang didukung tersedia di sini.
Sejumlah parser telah diimplementasikan. Beberapa parser dapat menguraikan output dari beberapa wartawan .
| Reporter | Parser | Catatan |
|---|---|---|
| ARM-GCC | CLANG | |
| Androidlint | ANDROIDLINT | |
| Ansible-later | ANSIBLELATER | Dengan format json |
| Ansiblelint | FLAKE8 | Dengan -p |
| Bandit | CLANG | Dengan bandit -r examples/ -f custom -o bandit.out --msg-template "{abspath}:{line}: {severity}: {test_id}: {msg}" |
| Dentang | CLANG | |
| CPD | CPD | |
| CPPCHECK | CPPCHECK | Dengan cppcheck test.cpp --output-file=cppcheck.xml --xml |
| CPPLINT | CPPLINT | |
| Csslint | CSSLINT | |
| Centang | CHECKSTYLE | |
| Cloudformation linter | JUNIT | cfn-lint . -f junit --output-file report-junit.xml |
| Codeclimate | CODECLIMATE | |
| Codenarc | CODENARC | |
| Coverity | COVERITY | |
| Anak panah | MACHINE | Dengan dart analyze --format=machine |
| Pemeriksaan ketergantungan | SARIF | Menggunakan --format SARIF |
| Detekt | CHECKSTYLE | Dengan --output-format xml . |
| Docfx | DOCFX | |
| Doxygen | CLANG | |
| Erb | CLANG | Dengan erb -P -x -T '-' "${it}" | ruby -c 2>&1 >/dev/null | grep '^-' | sed -E 's/^-([a-zA-Z0-9:]+)/${filename}1 ERROR:/p' > erbfiles.out . |
| Eslint | CHECKSTYLE | Dengan format: 'checkstyle' . |
| Findbugs | FINDBUGS | |
| Flake8 | FLAKE8 | |
| Fxcop | FXCOP | |
| GCC | CLANG | |
| GHS | GHS | |
| Polisi | GENDARME | |
| Reporter generik | GENERIC | Akan membuat satu pelanggaran tunggal dengan semua konten sebagai pesan. |
| Golint | GOLINT | |
| Pemerintah | GOLINT | Format yang sama seperti Golint. |
| Golangci-Lint | CHECKSTYLE | Dengan --out-format=checkstyle . |
| GoogleErrorProne | GOOGLEERRORPRONE | |
| Hadolint | CHECKSTYLE | Dengan -f checkstyle |
| Iar | IAR | Dengan --no_wrap_diagnostics |
| Menyimpulkan | PMD | Facebook Infer. Dengan --pmd-xml . |
| Jacoco | JACOCO | |
| Jcreport | JCREPORT | |
| Jshint | JSLINT | Dengan --reporter=jslint atau parser checkstyle dengan --reporter=checkstyle |
| Junit | JUNIT | Itu hanya berisi kegagalan. |
| Ktlint | CHECKSTYLE | |
| Klocwork | KLOCWORK | |
| Kotlingradle | KOTLINGRADLE | Output dari plugin Gradle Kotlin. |
| Kotlinmaven | KOTLINMAVEN | Output dari plugin Kotlin Maven. |
| Serat | LINT | Format XML yang umum, digunakan oleh linter yang berbeda. |
| MsBuildlog | MSBULDLOG | Dengan penggunaan -fileLogger .*msbuild\.log$ as pola atau -fl -flp:logfile=MyProjectOutput.log;verbosity=diagnostic untuk nama file output khusus khusus |
| Mscpp | MSCPP | |
| McCabe | FLAKE8 | |
| Mypy | MYPY | |
| Nullaway | GOOGLEERRORPRONE | Format yang sama seperti google error rawan. |
| Pclint | PCLINT | PC-Lint menggunakan format output yang sama dengan plugin Jenkins Warnings, detailnya di sini |
| Phpcs | CHECKSTYLE | Dengan phpcs api.php --report=checkstyle . |
| Phppmd | PMD | Dengan phpmd api.php xml ruleset.xml . |
| PMD | PMD | |
| Pep8 | FLAKE8 | |
| Perlcritic | PERLCRITIC | |
| Paling tajam | PITEST | |
| Protolint | PROTOLINT | |
| Boneka-lint | CLANG | Dengan -log-format %{fullpath}:%{line}:%{column}: %{kind}: %{message} |
| Pydocstyle | PYDOCSTYLE | |
| Pyflake | FLAKE8 | |
| Pylint | PYLINT | Dengan pylint --output-format=parseable . |
| Resharper | RESHARPER | |
| Rubycop | CLANG | Dengan rubycop -f clang file.rb |
| Sarif | SARIF | v2.x. Microsoft Visual C# dapat menghasilkannya dengan ErrorLog="BuildErrors.sarif,version=2" . |
| SBTScalac | SBTSCALAC | |
| Scalastyle | CHECKSTYLE | |
| SEMGREP | SEMGREP | Dengan --json . |
| Simian | SIMIAN | |
| Sonar | SONAR | Dengan mvn sonar:sonar -Dsonar.analysis.mode=preview -Dsonar.report.export.path=sonar-report.json . Dihapus dalam 7.7, lihat Sonar-11670 tetapi dapat diambil dengan: curl --silent 'http://sonar-server/api/issues/search?componentKeys=unique-key&resolved=false' | jq -f sonar-report-builder.jq > sonar-report.json . |
| Spotbugs | FINDBUGS | |
| Stylecop | STYLECOP | |
| Swiftlint | CHECKSTYLE | Dengan --reporter checkstyle . |
| Tslint | CHECKSTYLE | Dengan -t checkstyle |
| Valgrind | VALGRIND | Dengan --xml=yes . |
| Xmllint | XMLLINT | |
| Xunit | XUNIT | Itu hanya berisi kegagalan. |
| Yamllint | YAMLLINT | Dengan -f parsable |
| Zptlint | ZPTLINT |
52 parsers dan 79 wartawan.
Kehilangan format? Buka masalah di sini!
Ada contoh berjalan di sini.
Memiliki yang berikut dalam skrip build akan membuat plugin dijalankan dengan ./gradlew build .
plugins {
id " se.bjurr.violations.violations-gradle-plugin " version " X "
}
task violations ( type : se.bjurr.violations.gradle.plugin.ViolationsTask ) {
//
// Optional config
//
maxReporterColumnWidth . set( 0 ) // 0 is disabled
maxRuleColumnWidth . set( 10 )
maxSeverityColumnWidth . set( 0 )
maxLineColumnWidth . set( 0 )
maxMessageColumnWidth . set( 50 )
codeClimateFile . set(file( ' code-climate-file.json ' )) // Will create a CodeClimate JSON report.
violationsFile . set(file( ' violations-file.json ' )) // Will create a normalized JSON report.
//
// Global configuration, remove if you dont want to report violations for
// the entire repo.
//
minSeverity . set(se . bjurr . violations . lib . model . SEVERITY . INFO ) // INFO, WARN or ERROR
detailLevel . set( se.bjurr.violations.git.ViolationsReporterDetailLevel . VERBOSE ) // PER_FILE_COMPACT, COMPACT or VERBOSE
maxViolations . set( 99999999 ) // Will fail the build if total number of found violations is higher
printViolations . set( true ) // Will print violations found in diff
//
// Diff configuration, remove if you dont want to report violations for
// files changed between specific revisions.
//
// diff-properties can be supplied with something like:
//
// ./gradlew violations -i -PdiffFrom=e4de20e -PdiffTo=HEAD
//
// And in Travis, you could add:
//
// script:
// - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then bash ./gradlew check -PdiffFrom=$TRAVIS_PULL_REQUEST_BRANCH -PdiffTo=$TRAVIS_BRANCH ; fi'
//
diffFrom . set(project . properties . diffFrom) // Can be empty (ignored), Git-commit or any Git-reference
diffTo . set(project . properties . diffTo) // Same as above
diffMinSeverity . set(se . bjurr . violations . lib . model . SEVERITY . INFO ) // INFO, WARN or ERROR
diffDetailLevel . set( se.bjurr.violations.git.ViolationsReporterDetailLevel . VERBOSE ) // PER_FILE_COMPACT, COMPACT or VERBOSE
diffMaxViolations . set( 99 ) // Will fail the build if number of violations, in the diff within from/to, is higher
diffPrintViolations . set( true ) // Will print violations found in diff
gitRepo . set(file( ' . ' )) // Where to look for Git
//
// This is mandatory regardless of if you want to report violations between
// revisions or the entire repo.
//
// Many more formats available, see: https://github.com/tomasbjerre/violations-lib
violationConfig()
.setFolder(projectDir . path)
.setParser( se.bjurr.violations.lib.reports.Parser . FINDBUGS )
.setPattern( " .*/findbugs/.* \ .xml $ " )
.setReporter( " Findbugs " )
violationConfig()
.setFolder(projectDir . path)
.setParser( se.bjurr.violations.lib.reports.Parser . PMD )
.setPattern( " .*/pmd/.* \ .xml $ " )
.setReporter( " PMD " )
}
check . finalizedBy violations
