@d3lm/lint-preset 1.5.1 → 1.5.2

package/dist/comments.d.cts

@@ -9,7 +9,8 @@ interface WrapOptions {
      */
     readonly avoidSentenceOrphans: boolean;
     /**
-     * Sets how many columns a line may exceed its limit before it counts as overflowing.
+     * Sets how many columns a line may exceed its limit before it counts as overflowing. A layout
+     * also uses them when that saves a line.
      */
     readonly tolerance: number;
     /**
@@ -210,8 +211,9 @@ interface CommentsConfig {
      */
     readonly singleLineWidth?: number;
     /**
-     * Sets a legacy hard limit of `width + tolerance` when `maxWidth` is omitted.
-     * An explicit `maxWidth` takes precedence.
+     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph of
+     * three or more lines. It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a
+     * legacy hard limit of `width + tolerance`.
      */
     readonly tolerance?: number;
     /**

package/dist/comments.d.ts

@@ -9,7 +9,8 @@ interface WrapOptions {
      */
     readonly avoidSentenceOrphans: boolean;
     /**
-     * Sets how many columns a line may exceed its limit before it counts as overflowing.
+     * Sets how many columns a line may exceed its limit before it counts as overflowing. A layout
+     * also uses them when that saves a line.
      */
     readonly tolerance: number;
     /**
@@ -210,8 +211,9 @@ interface CommentsConfig {
      */
     readonly singleLineWidth?: number;
     /**
-     * Sets a legacy hard limit of `width + tolerance` when `maxWidth` is omitted.
-     * An explicit `maxWidth` takes precedence.
+     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph of
+     * three or more lines. It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a
+     * legacy hard limit of `width + tolerance`.
      */
     readonly tolerance?: number;
     /**

package/dist/comments.js

@@ -535,6 +535,19 @@ function layoutLines(tokens, firstLimit, restLimit, options) {
       return lines;
     }
   }
+  if (options.tolerance > 0 && greedy.length > 2) {
+    const fewer = balanceTokens(
+      tokens,
+      firstLimit + options.tolerance,
+      restLimit + options.tolerance,
+      greedy.length - 1,
+      options,
+      restLimit
+    );
+    if (fewer && !hasStep(fewer, restLimit - firstLimit)) {
+      return fewer;
+    }
+  }
   const balanced = balanceTokens(tokens, firstLimit, restLimit, greedy.length, options);
   if (balanced) {
     return balanced;
@@ -1282,7 +1295,7 @@ When rules pull in different directions, the earlier one wins.
 
 ## Layout
 
-- After you finish, the tool rewraps prose paragraphs, list items, and JSDoc tag descriptions. The width is a preferred target. A parenthetical may extend a line up to the configured maximum so it stays together. In longer paragraphs, balanced lines take priority over keeping every parenthetical on one line. The tool also avoids short last lines where possible. Leave these line breaks to the tool, except for the sentence-orphan case below.
+- After you finish, the tool rewraps prose paragraphs, list items, and JSDoc tag descriptions. The width is a preferred target. A parenthetical may extend a line up to the configured maximum so it stays together, and lines may go up to the configured tolerance past the width when that saves a line. In longer paragraphs, balanced lines take priority over keeping every parenthetical on one line. The tool also avoids short last lines where possible. Leave these line breaks to the tool, except for the sentence-orphan case below.
 - Don't end a line with the first word of a new sentence, clause, or parenthetical, like \`This\` after a period, \`the\` after a comma, or \`(the\`. Move it to the next line instead.
 - In a paragraph of two lines, the first line ends with a sentence whenever the rest fits on the second line and is no longer than the first. Don't end it with the start of the next sentence, like \`A wrap\` in \`...lay out differently. A wrap\`. Move those words to the second line instead.
 - A comment whose whole text is one paragraph stays on a single line when that line fits a separate, larger single-line width, even past the width. Only a longer comment wraps to the width.