From 537148c90a98e11b9f11e905bb36f10df2ff8e13 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Thu, 12 Sep 2024 10:29:51 +0200 Subject: [PATCH] [doc] Reformatting tools.md and ci.md --- docs/pages/pmd/userdocs/tools/ci.md | 12 ++++---- docs/pages/pmd/userdocs/tools/tools.md | 41 +++++++++++++++----------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/docs/pages/pmd/userdocs/tools/ci.md b/docs/pages/pmd/userdocs/tools/ci.md index 513374f26e..cccb1b41d6 100644 --- a/docs/pages/pmd/userdocs/tools/ci.md +++ b/docs/pages/pmd/userdocs/tools/ci.md @@ -7,7 +7,7 @@ author: Romain PELISSE ## Introduction -PMD can be integrate through some of the Continuous Integration tools that exist now. +PMD can be integrated through some of the Continuous Integration tools that exist now. Here is a list of known (to us) plugin to do so. ## Jenkins Plugin @@ -16,12 +16,12 @@ Here is a list of known (to us) plugin to do so. [Warnings Next Generation](https://plugins.jenkins.io/warnings-ng/) plugin for Jenkins. It supports PMD among many other linting tools. -* Homepage: https://plugins.jenkins.io/warnings-ng/ -* Source: https://github.com/jenkinsci/warnings-ng-plugin and https://github.com/jenkinsci/analysis-model +* Homepage: +* Source: and ## Continuum -Continuum does not have a plugin for PMD per see, but can failed the build according to the +Continuum does not have a plugin for PMD per see, but can fail the build according to the result of the PMD maven plugin. ## GitHub Action @@ -30,7 +30,9 @@ See [Other Tools / Integrations](pmd_userdocs_tools.html#github-actions) ## MegaLinter -[🦙 Mega-Linter](https://oxsecurity.github.io/megalinter/latest/) analyzes 50 languages, 22 formats, 21 tooling formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a GitHub Action, other CI tools or locally. +[🦙 Mega-Linter](https://oxsecurity.github.io/megalinter/latest/) analyzes 50 languages, 22 formats, 21 tooling +formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a +GitHub Action, other CI tools or locally. It [natively embeds PMD](https://oxsecurity.github.io/megalinter/latest/descriptors/java_pmd/). diff --git a/docs/pages/pmd/userdocs/tools/tools.md b/docs/pages/pmd/userdocs/tools/tools.md index 99026e24ae..ace5b4e816 100644 --- a/docs/pages/pmd/userdocs/tools/tools.md +++ b/docs/pages/pmd/userdocs/tools/tools.md @@ -12,45 +12,50 @@ author: David Dixon-Peugh ### Codacy [Codacy](https://www.codacy.com/) automates code reviews and monitors code quality on every commit and pull request. -It gives visibility into the technical debt and it can track code style and security issues, code coverage, code duplication, cyclomatic complexity and enforce best practices. +It gives visibility into the technical debt and can track code style and security issues, code coverage, code +duplication, cyclomatic complexity and enforce best practices. Codacy is static analysis without the hassle. With Codacy you have PMDJava analysis out-of-the-box, and it is free for open source projects. -* Homepage: [https://www.codacy.com/](https://www.codacy.com/) -* Source code: [https://github.com/codacy/codacy-pmdjava](https://github.com/codacy/codacy-pmdjava) +* Homepage: +* Source code: * Maintainer: Codacy ### Codety -[Codety](https://www.codety.io/) provides comprehensive code scanning solution designed to detect code issues for 30+ programming languages and IaC frameworks. It embeds more than 6,000 code analysis rules(including pmd rules) and can detect code smells, vulnerable code, secrets in the code, performance issues, style violations, and more. +[Codety](https://www.codety.io/) provides comprehensive code scanning solution designed to detect code issues for +30+ programming languages and IaC frameworks. It embeds more than 6,000 code analysis rules (including pmd rules) +and can detect code smells, vulnerable code, secrets in the code, performance issues, style violations, and more. -Codety Scanner provides out-of-the-box PMD integration, it is free for personal and commercial use. +Codety Scanner provides out-of-the-box PMD integration, it is free for personal and commercial use. -* Homepage: [https://www.codety.io/](https://www.codety.io/) -* Source code: [https://github.com/codetyio/codety-scanner](https://github.com/codetyio/codety-scanner) +* Homepage: +* Source code: ### Codiga -[Codiga](https://www.codiga.io) automates code review, check your code quality and helps you manage your technical debt. -It is integrated with GitHub, GitLab and Bitbucket. The platform also analyzes code directly in your IDE using its integration -plugins for VS Code and IntelliJ, providing a consistent analysis along your development cycle (from the IDE to the CI/CD pipeline). +[Codiga](https://www.codiga.io) automates code review, check your code quality and helps you manage your +technical debt. It is integrated with GitHub, GitLab and Bitbucket. The platform also analyzes code directly in +your IDE using its integration plugins for VS Code and IntelliJ, providing a consistent analysis along your +development cycle (from the IDE to the CI/CD pipeline). Codiga uses PMD to check Java and Apex code. -* Homepage: [https://www.codiga.io](https://www.codiga.io) -* Documentation: [https://doc.codiga.io](https://doc.codiga.io) +* Homepage: +* Documentation: ### GitHub Actions PMD provides its own GitHub Action, that can be integrated in custom workflows. -It can execute PMD with your own ruleset against your project. It creates a [SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) -report which is uploaded as a build artifact. Furthermore the build can be failed based on the number of violations. +It can execute PMD with your own ruleset against your project. It creates a +[SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) report which is uploaded as a +build artifact. Furthermore, the build can be failed based on the number of violations. The action can also be used as a code scanner to create "Code scanning alerts". -* Homepage: [pmd/pmd-github-action](https://github.com/pmd/pmd-github-action) +* Homepage: ### TCA @@ -66,9 +71,9 @@ code quality, and be more conducive to inheriting an excellent team code culture With TCA you have PMD analysis out-of-the-box, and it is open source under the MIT license. -* Homepage: [http://tca.tencent.com/](http://tca.tencent.com/) -* Source code: [https://github.com/Tencent/CodeAnalysis](https://github.com/Tencent/CodeAnalysis) -* Documentation: [https://tencent.github.io/CodeAnalysis](https://tencent.github.io/CodeAnalysis) +* Homepage: +* Source code: +* Documentation: * Maintainer: TCA ## IDE Integrations