PMD integration & test #5393
PMD integration & test #5393
Conversation
…into pmd-integration
…into pmd-integration
|
Updated. |
…d CLI args according to newer PMD versions
…into pmd-integration
…into pmd-integration
| @@ -42,7 +42,7 @@ PMD found 1 violation(s) | |||
| // Here's an example of producing HTML report: | |||
| /** Usage | |||
| > ./mill pmd -f "html" | |||
There was a problem hiding this comment.
What would be the command to write that to a file?
There was a problem hiding this comment.
I think it's the more likely use-case, as it can then easily be opened with a browser.
There was a problem hiding this comment.
Currently, the logic is: if user hasn't specified 'stdout' -> report will be saved to a file (see PmdModule, line 37).
If the user specified 'stdout' -> report won't be saved to a file.
I agree that case with reporting to a file is more likely, so it's default.
What would be the command to write that to a file?
There was a problem hiding this comment.
Improved docs to make it more clear #7d89e00
There was a problem hiding this comment.
So, I don't get why we see the HTML output here, since we didn't specify -s.
I also think it would be good to just print a line: "Writing output to path/to/file.html", so users do recognize and can click (most terminals support this, if it's an URL) on it.
There was a problem hiding this comment.
- Added log message for output file location.
- Changed options to make it more clear and in line with official PMD command-line options (now -s option is responsible only for enabling stdout, as it should be).
|
CI failing as I pulled from main and scalalib is no longer present there. Refactoring in progress. |
…from final report string
…into pmd-integration
| * | ||
| * @note [[sources]] are processed when no [[PmdArgs.sources]] are specified. | ||
| */ | ||
| def pmd(@mainargs.arg pmdArgs: PmdArgs): Command[Int] = Task.Command { |
There was a problem hiding this comment.
I think just returning a Int isn't that useful. It's unclear, if these are warning or errors. If there are errors, I would fail the task anyways. Also, I'd like to return the actual report file as PathRef.
Maybe, we should return a named tuple instead, so each value can have a proper name and we can extend it over time.
There was a problem hiding this comment.
- Added exit codes handling to
pmdHandleExitCode, in line with PMD documentation. - Changed return type to tuple with exit code and PathRef.
- Cleaned up some code in PmdModule.
…into pmd-integration
|
This is ready for review/merge. |
Resolves #5379