Text doc generator does not allow for multi-line rule explanations

[jrfnl]

While new lines were (accidentally) being respected by the existing code, the line length count was not being reset when a new line character was encountered, causing weird line wrapping.

This has been fixed now by:

• First splitting the received text into individual lines.
• Then doing the line wrapping calculations for each line individually.

Includes:

• Reducing the code complexity by removing an else and using an early continue instead.
• Removing some duplicate function calls.

To test this:

• Make sure you are on the master branch and:

  • Create a Standard/Docs/Category/SomeSniffStandard.xml file with the following content:

    XML Documentation code sample

      ```xml
      <documentation title="Yoda Conditions">
          <standard>
          <![CDATA[
            When doing logical comparisons involving variables, the variable must be placed on the right side. All constants, literals, and function calls must be placed on the left side. If neither side is a variable, the order is unimportant.
    
      For more information:
      https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/#yoda-conditions
          ]]>
          </standard>
          <code_comparison>
              <code title="Valid: The variable $the_force is placed on the right">
              <![CDATA[
      if ( true === $the_force ) {
          $victorious = you_will( $be );
      }
              ]]>
              </code>
              <code title="Invalid: The variable $the_force has been placed on the left">
              <![CDATA[
      if ( $the_force === false ) {
          $victorious = you_will_not( $be );
      }
              ]]>
              </code>
          </code_comparison>
      </documentation>
      ```
    

  • Run: phpcs --generator=Text --sniffs=Standard.Category.SomeSniff

  • Take note of the incorrect line wrapping for the For more information line.
    

• Now, check out this branch and follow the same steps.
  • Take note of the now correct line wrapping for the For more information line.
    

[gsherwood]

Thanks