@d3lm/lint-preset 1.6.0 → 1.6.1

package/dist/comments.d.cts

@@ -84,10 +84,10 @@ interface ParagraphReport {
     readonly reason?: string;
     readonly issues: readonly IssueReport[];
     /**
-     * Holds the exact source lines for `startLine` through `endLine` when the paragraph is
-     * greedily wrapped to the width, or `null` when the paragraph isn't prose, e.g. code,
-     * a table, a diagram, or `@example`. A paragraph that is accepted with the layout for a
-     * wider width within the tolerance keeps its lines.
+     * Holds the exact source lines for `startLine` through `endLine` when the paragraph is greedily
+     * wrapped to the width, or `null` when the paragraph isn't prose, e.g. code, a table, a diagram,
+     * or `@example`. A paragraph that the tolerance accepts as it is, with the layout for a wider
+     * width or with lines close to this one, keeps its lines.
      */
     readonly suggestion: readonly string[] | null;
 }
@@ -232,10 +232,12 @@ interface CommentsConfig {
      */
     readonly singleLineWidth?: number;
     /**
-     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph of
-     * three or more lines. A paragraph that already has the layout for a wider `width`, up to `width`
-     * plus this many columns, also passes as it is. It never goes past `maxWidth`. When `maxWidth` is
-     * omitted, it also sets a legacy hard limit of `width + tolerance`.
+     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph
+     * of three or more lines. A paragraph that already has the layout for a wider `width`, up to
+     * `width` plus this many columns, also passes as it is. So does a paragraph with as many lines
+     * as the rewrap whose lines are each at most this many columns shorter or longer than in the
+     * rewrap. 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

@@ -84,10 +84,10 @@ interface ParagraphReport {
     readonly reason?: string;
     readonly issues: readonly IssueReport[];
     /**
-     * Holds the exact source lines for `startLine` through `endLine` when the paragraph is
-     * greedily wrapped to the width, or `null` when the paragraph isn't prose, e.g. code,
-     * a table, a diagram, or `@example`. A paragraph that is accepted with the layout for a
-     * wider width within the tolerance keeps its lines.
+     * Holds the exact source lines for `startLine` through `endLine` when the paragraph is greedily
+     * wrapped to the width, or `null` when the paragraph isn't prose, e.g. code, a table, a diagram,
+     * or `@example`. A paragraph that the tolerance accepts as it is, with the layout for a wider
+     * width or with lines close to this one, keeps its lines.
      */
     readonly suggestion: readonly string[] | null;
 }
@@ -232,10 +232,12 @@ interface CommentsConfig {
      */
     readonly singleLineWidth?: number;
     /**
-     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph of
-     * three or more lines. A paragraph that already has the layout for a wider `width`, up to `width`
-     * plus this many columns, also passes as it is. It never goes past `maxWidth`. When `maxWidth` is
-     * omitted, it also sets a legacy hard limit of `width + tolerance`.
+     * Sets how many columns prose lines may go past `width` when that saves a line in a paragraph
+     * of three or more lines. A paragraph that already has the layout for a wider `width`, up to
+     * `width` plus this many columns, also passes as it is. So does a paragraph with as many lines
+     * as the rewrap whose lines are each at most this many columns shorter or longer than in the
+     * rewrap. 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

@@ -1383,7 +1383,20 @@ function analyzeParagraph(paragraph, options, language) {
     }
     return false;
   };
-  const accepted = lineIssues.some((issue) => isVerdict(issue)) && matchesWiderLayout();
+  const staysNearLayout = () => {
+    if (currentLines.length !== wrapped.length || splitTokenLine(currentLines, units) !== -1) {
+      return false;
+    }
+    return currentLines.every((words, position) => {
+      const length = words.join(" ").length;
+      const suggestedLength = wrapped[position].join(" ").length;
+      const limit = (position === 0 ? firstLimit : restLimit) + layoutOptions.tolerance;
+      return Math.abs(length - suggestedLength) <= layoutOptions.tolerance && length <= Math.max(suggestedLength, limit);
+    });
+  };
+  const hasVerdict = lineIssues.some((issue) => isVerdict(issue));
+  const onlyUnbalanced = lineIssues.every((issue) => issue.type === "unbalanced");
+  const accepted = hasVerdict && (matchesWiderLayout() || onlyUnbalanced && staysNearLayout());
   const suggested = accepted ? currentLines : wrapped;
   const suggestion = suggested.map(
     (words, position) => `${prefix}${position === 0 ? paragraph.marker : hang}${words.join(" ")}`