Skip to content

[cli] Display pmd banner, version improvement, logging#4843

Merged
jsotuyod merged 7 commits into
pmd:masterfrom
adangel:cli-banner-display
Mar 5, 2024
Merged

[cli] Display pmd banner, version improvement, logging#4843
jsotuyod merged 7 commits into
pmd:masterfrom
adangel:cli-banner-display

Conversation

@adangel

@adangel adangel commented Mar 1, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Describe the PR

This tidies up the CLI interface a bit:

  • I converted our logo to ascii art on https://www.asciiart.eu/image-to-ascii
    from docs/images/logo/pmd-logo-300px.png
  • This banner is displayed now when PMD is started, along with a improved version info
  • The improved version info contains now also the git commit id of the build as well as the build timestamp (which is the timestamp of the commit for snapshot builds or the release timestamp from pom.xml project.build.timestamp which is updated for a release).
  • The default simplelogger.properties is updated to only display the logging level and message and not anymore the thread or logger name. I think, this is more suitable for CLI. If this info is needed, you can change it temporarily in PMD_HOME/conf/simplelogger.properties.

Example for pmd --version:

  ████                            ████
  ██                                ██
  ██  █████ █ ███    ███  ███████   ██
 ███  ██  ███ ████  ████  ██    ██  ███
 ███  ███████ ██ ████ ██  ██    ██  ███
  ██  ██      ██  ██  ██  ███████   ██
  ██                                ██
  ████                            ████
PMD 7.0.0-SNAPSHOT (f0c42da8277604242d3b1d6026217fc53778709d, 2024-02-29T19:19:29+0100)
Java version: 21.0.1, vendor: Eclipse Adoptium, runtime: /home/andreas/programs/openjdk/jdk-21.0.1+12
  • I've also updated the pmd-demo.gif screencast

Related issues

  • None

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel
[core] Include revision and build time in PMDVersion
80db40b 
- Using git-commit-id-maven-plugin
- Adding the version via an explicit property file
  and resource filtering
- For snapshots, it will be the git commit timestamp
- For release, it will be the release timestamp
@adangel
[cli] Display a PMD banner and more detailed version info
c2a215d 
Generated via https://www.asciiart.eu/image-to-ascii
from docs/images/logo/pmd-logo-300px.png
@adangel
[cli] Remove unnecessary logging
aa672e9
@adangel
[doc] Update pmd-demo.gif
5b84459
@adangel adangel added this to the 7.0.0 milestone Mar 1, 2024
@adangel adangel added the in:cli Affects the PMD Command Line Interface label Mar 1, 2024
@ghost

ghost commented Mar 1, 2024 •
edited by ghost
Loading

Copy link
Copy Markdown
1 Message
📖 Compared to master:
This changeset changes 0 violations,
introduces 112 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact

Generated by 🚫 Danger

@adangel adangel mentioned this pull request Mar 1, 2024
Open
12 tasks
jsotuyod
jsotuyod reviewed Mar 2, 2024
View reviewed changes
Comment thread pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/AbstractPmdSubcommand.java Outdated
@jsotuyod jsotuyod merged commit daa741c into pmd:master Mar 5, 2024
@adangel adangel deleted the cli-banner-display branch March 7, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsotuyod jsotuyod jsotuyod left review comments

Assignees

No one assigned

Labels

in:cli Affects the PMD Command Line Interface

Projects

None yet

Milestone

7.0.0

Development

Successfully merging this pull request may close these issues.

2 participants

@adangel @jsotuyod