[CALCITE-5765] Add LintTest, to apply custom lint rules to source code

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.35.0
• Assignee: Julian Hyde
• Reporter: Julian Hyde
• Created: 07/Jun/23 21:15
• Updated: 04/Jan/24 20:50
• Resolved: 28/Jun/23 19:16

Description

Add LintTest, to apply custom lint rules to source code. If there are any violations, the test prints the warnings and fails.

Example lint rules:

• Javadoc paragraphs must be separated by blank lines
• Javadoc paragraphs must start with <p>
• In Javadoc, there must be a blank line between the description
  and the first @param

LintTest is built using Puffin (see CALCITE-5764), which allows regular expressions to be applied to individual lines and state that is carried from one line to the next. (The regular expressions provided by Autostyle are too cumbersome to match multi-line patterns.)

Issue Links

• relates to: CALCITE-5764 Puffin, an Awk for Java
• relates to: CALCITE-6187 Linter should disallow tags such as '[MINOR]' in commit messages