You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@calcite.apache.org by "Julian Hyde (Jira)" <ji...@apache.org> on 2023/06/07 21:16:00 UTC

[jira] [Created] (CALCITE-5765) Add LintTest, to apply custom lint rules to source code

Julian Hyde created CALCITE-5765:
------------------------------------

             Summary: Add LintTest, to apply custom lint rules to source code
                 Key: CALCITE-5765
                 URL: https://issues.apache.org/jira/browse/CALCITE-5765
             Project: Calcite
          Issue Type: Bug
            Reporter: Julian Hyde


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.)



--
This message was sent by Atlassian Jira
(v8.20.10#820010)