@d3lm/lint-preset 1.6.2 → 1.6.3

package/dist/comments.d.cts

@@ -20,7 +20,7 @@ interface WrapOptions {
      */
     readonly parentheticalOverflow?: number;
 }
-type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'split-parenthetical';
+type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'wide' | 'split-parenthetical';
 /**
  * Splits text into words. JSDoc writes types and `{@link ...}` tags as `{...}` groups, so they stay
  * intact like code spans.
@@ -234,11 +234,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. 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`.
+     * 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, the last aside, are at most this many columns shorter
+     * than the shortest of them in the rewrap, and end at most this many columns past `width`.
+     * It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a legacy hard limit
+     * of `width + tolerance` columns.
      */
     readonly tolerance?: number;
     /**

package/dist/comments.d.ts

@@ -20,7 +20,7 @@ interface WrapOptions {
      */
     readonly parentheticalOverflow?: number;
 }
-type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'split-parenthetical';
+type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'wide' | 'split-parenthetical';
 /**
  * Splits text into words. JSDoc writes types and `{@link ...}` tags as `{...}` groups, so they stay
  * intact like code spans.
@@ -234,11 +234,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. 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`.
+     * 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, the last aside, are at most this many columns shorter
+     * than the shortest of them in the rewrap, and end at most this many columns past `width`.
+     * It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a legacy hard limit
+     * of `width + tolerance` columns.
      */
     readonly tolerance?: number;
     /**

package/dist/comments.js

@@ -771,6 +771,7 @@ var ISSUE_TIERS = {
   underfill: "verdict",
   widow: "verdict",
   unbalanced: "verdict",
+  wide: "verdict",
   orphan: "hint",
   "split-parenthetical": "hint",
   banner: "hint",
@@ -1357,6 +1358,14 @@ function analyzeParagraph(paragraph, options, language) {
       const restLines = layoutTokens(rest, restLimit, restLimit, restOptions);
       return sameLayout(breakAfterSentence(restLines, restLimit, restLimit, restOptions), currentLines.slice(line + 1));
     };
+    const differenceAt = (line) => {
+      const longest = Math.max(...wrapped.map((words) => words.join(" ").length));
+      const wide = currentLines.flatMap((words, position) => {
+        const limit = (position === 0 ? firstLimit : restLimit) + layoutOptions.tolerance;
+        return words.join(" ").length > Math.max(limit, longest) ? [{ type: "wide", line: position }] : [];
+      });
+      return wide.length > 0 ? wide : [{ type: "unbalanced", line }];
+    };
     if (overflow.length === 0 && (currentLines.length === wrapped.length || options.maxWidth !== void 0)) {
       const line = Math.max(
         wrapped.findIndex((words, position) => words.join(" ") !== currentLines[position]?.join(" ")),
@@ -1365,9 +1374,11 @@ function analyzeParagraph(paragraph, options, language) {
       if (lineIssues.length === 0 && (sameLayout(even, currentLines) || keepsOnlySentenceStarts())) {
         lineIssues.push({ type: "orphan", line });
       } else if (lineIssues.length === 0) {
-        lineIssues.push({ type: splitsOnlyParenthetical(line) ? "split-parenthetical" : "unbalanced", line });
+        lineIssues.push(
+          ...splitsOnlyParenthetical(line) ? [{ type: "split-parenthetical", line }] : differenceAt(line)
+        );
       } else if (lineIssues.every((issue) => issue.type === "orphan") && !sameLayout(even, currentLines) && !keepsOnlyOrphans()) {
-        lineIssues.push({ type: "unbalanced", line });
+        lineIssues.push(...differenceAt(line));
       }
     }
     const splitLine = splitTokenLine(currentLines, tokens);
@@ -1385,14 +1396,15 @@ function analyzeParagraph(paragraph, options, language) {
     return false;
   };
   const staysNearLayout = () => {
-    if (currentLines.length !== wrapped.length || splitTokenLine(currentLines, units) !== -1) {
+    if (layoutOptions.tolerance === 0 || currentLines.length !== wrapped.length || splitTokenLine(currentLines, units) !== -1) {
       return false;
     }
+    const shortest = Math.min(...wrapped.slice(0, -1).map((words) => words.join(" ").length));
     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 isLast = position === currentLines.length - 1;
+      return (isLast || length >= shortest - layoutOptions.tolerance) && length <= Math.max(wrapped[position].join(" ").length, limit);
     });
   };
   const hasVerdict = lineIssues.some((issue) => isVerdict(issue));