[RAT-323] Harmonize UIs

• Type: Improvement
• Status: In Progress
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 0.16
• Fix Version/s: 0.17
• Component/s: Client - cli
• Assignee: Claude Warren
• Reporter: Claude Warren
• Created: 28/Oct/23 15:24
• Updated: 16/Nov/24 10:54

Description

The UIs (CLI, ANT and Maven) were all developed separately and have different options.

There is an overlap in some functionality and the functionality of some UIs is not found in others.

This task is to do two things:

1. collect all the UI options, and ensure that they are all supported in the ReportConfiguration class. 
2. modify the UIs so that the names of the options are the same (or as similar as possible) across the three UIs.  Renamed methods are to be deprecated in favour of new methods.

 

Example:

apache-rat-plugin has 3 options: parseSCMIgnoresAsExcludes, useEclipseDefaultExcludes, useIdeaDefaultExcludes that change the file filter.  These are options that would be useful in all UIs and should be moved to the ReportConfiguration so that any UI can set them.

By harmonization I mean that options like the above are extracted from the specific UIs where they are implemented and moved to the ReportConfiguration so that the implementations are in one place and can be shared across all UIs.

 
 

 

Issue Links

• causes: RAT-444 Site links do not render headlines properly
• is related to: RAT-352 Define a .ratignore file and processor (Was: Enable use of wildcard expressions in exclude file)
• links to: GitHub Pull Request #257
• links to: GitHub Pull Request #268
• links to: GitHub Pull Request #285

Sub-Tasks

• Add tests to validate that UI options update the ReportConfiguration as expected: Resolved
• Refactor/standardize Client arguments: Resolved
• Allow configuration of files to be scanned for CLI module: Resolved
• CLI: Rat does not support a .ratignore file that lives in the source tree.: Resolved
• CLI: Certain wildcard file filters do not work anymore: Resolved
• Update documentation to match configuration options and files: In Progress
• Refactor CLI options after release of commons-cli 1.7.1: Resolved
• Extract CLI Options into static class.: Resolved
• Add capabilities to write Ant Readme information: Resolved
• Add capabilities to write Maven Readme information: Resolved
• Generate base Ant code from CLI Optons: Resolved
• Generate base Maven code from CLI Optons: Resolved
• Migrate exclusion calculations from plugin to core and add inclusion: Resolved
• Switch to DefaultLogger for all logging and remove Log parameters where possible.: Resolved
• Deprecate methods in Ant Report: Open
• Migrate ignore errors functionality from Maven module: Resolved
• Migrate console output functionality from Maven to core: Open
• RAT reports should be able to skip certain file types or contents: Resolved
• Add the ability to exclude SCM files.: Resolved
• .gitignore in parent dir not honored: Resolved
• Bug: generated ArgumentTypes end with a double ..: Closed
• Bug: Deprecation warning does not contain dots at the end of sentences: Closed
• Bug: generated classes are in packages with unusual package names: Closed
• Rework plain text XSLT output: Resolved
• Improve log message for Rat check: Resolved