@d3lm/lint-preset 1.5.4 → 1.5.6

package/dist/comments.d.cts

@@ -4,8 +4,9 @@ interface WrapOptions {
     /**
      * Sets whether a line may not end with the first word of a sentence, clause, or parenthetical,
      * like `This`, `the` after a comma, or `(the`. Such a word moves to the next line instead.
-     * It also sets whether the first of two lines ends with a sentence instead of the start of the
-     * next one, as long as the second line is then no longer than the first.
+     * It also sets whether a line avoids ending with the first two words of a sentence, and whether
+     * the first of two lines ends with a sentence instead of the start of the next one, as long as
+     * the second line is then no longer than the first.
      */
     readonly avoidSentenceOrphans: boolean;
     /**
@@ -74,7 +75,8 @@ interface ParagraphReport {
     /**
      * 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 table, a diagram, or `@example`. A paragraph that is accepted with the layout for a
+     * wider width within the tolerance keeps its lines.
      */
     readonly suggestion: readonly string[] | null;
 }
@@ -213,16 +215,19 @@ 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. It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a
-     * legacy hard limit of `width + tolerance`.
+     * 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`.
      */
     readonly tolerance?: number;
     /**
      * Keep the first word of a new sentence or parenthetical off the end of a line, e.g.
      * `...the module. This` or `...reflows (the` followed by the rest on the next line.
      * A paragraph of two lines also ends its first line with a sentence when the rest fits
-     * on the second line and is no longer than the first, instead of with the start of the
-     * next sentence, like `...the module. This one`. Defaults to `true`.
+     * on the second line and is no longer than the first, instead of with the start of
+     * the next sentence, like `...the module. This one`. Other lines avoid ending with the
+     * first two words of a sentence, like `...opens. It allocates`, unless that makes them
+     * much less even. Defaults to `true`.
      */
     readonly avoidSentenceOrphans?: boolean;
     /**

package/dist/comments.d.ts

@@ -4,8 +4,9 @@ interface WrapOptions {
     /**
      * Sets whether a line may not end with the first word of a sentence, clause, or parenthetical,
      * like `This`, `the` after a comma, or `(the`. Such a word moves to the next line instead.
-     * It also sets whether the first of two lines ends with a sentence instead of the start of the
-     * next one, as long as the second line is then no longer than the first.
+     * It also sets whether a line avoids ending with the first two words of a sentence, and whether
+     * the first of two lines ends with a sentence instead of the start of the next one, as long as
+     * the second line is then no longer than the first.
      */
     readonly avoidSentenceOrphans: boolean;
     /**
@@ -74,7 +75,8 @@ interface ParagraphReport {
     /**
      * 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 table, a diagram, or `@example`. A paragraph that is accepted with the layout for a
+     * wider width within the tolerance keeps its lines.
      */
     readonly suggestion: readonly string[] | null;
 }
@@ -213,16 +215,19 @@ 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. It never goes past `maxWidth`. When `maxWidth` is omitted, it also sets a
-     * legacy hard limit of `width + tolerance`.
+     * 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`.
      */
     readonly tolerance?: number;
     /**
      * Keep the first word of a new sentence or parenthetical off the end of a line, e.g.
      * `...the module. This` or `...reflows (the` followed by the rest on the next line.
      * A paragraph of two lines also ends its first line with a sentence when the rest fits
-     * on the second line and is no longer than the first, instead of with the start of the
-     * next sentence, like `...the module. This one`. Defaults to `true`.
+     * on the second line and is no longer than the first, instead of with the start of
+     * the next sentence, like `...the module. This one`. Other lines avoid ending with the
+     * first two words of a sentence, like `...opens. It allocates`, unless that makes them
+     * much less even. Defaults to `true`.
      */
     readonly avoidSentenceOrphans?: boolean;
     /**

package/dist/comments.js

@@ -291,6 +291,8 @@ function hasWidow(lines) {
 }
 var FULLNESS_WEIGHT = 0.07;
 var PARENTHETICAL_SPLIT_WEIGHT = 2;
+var SENTENCE_START_COST = 25;
+var MAX_SENTENCE_START_WORDS = 2;
 var MAX_STEP = 15;
 var EXTRA_LINES = 2;
 function fewestLines(starts, target) {
@@ -378,7 +380,7 @@ function balanceTokens(tokens, firstLimit, restLimit, count, options, preferredL
     afterOrphan: tokens.map((_, index) => {
       return options.avoidSentenceOrphans && index >= 2 && isOrphan(tokens[index - 2], tokens[index - 1]);
     }),
-    splitCosts
+    splitCosts: withSentenceStartCosts(tokens, splitCosts, options)
   };
   const targets = [];
   for (let target = restLimit; target >= Math.max(longest, Math.floor(restLimit / 2)); target -= 1) {
@@ -444,6 +446,22 @@ function splitCostsOf(tokens, limit) {
   }
   return splitCosts;
 }
+function withSentenceStartCosts(tokens, splitCosts, options) {
+  if (!options.avoidSentenceOrphans || options.ignoreSentenceStarts) {
+    return splitCosts;
+  }
+  const costs = new Map(splitCosts);
+  for (const [index, token] of tokens.entries()) {
+    if (!endsSentence(token)) {
+      continue;
+    }
+    const last = Math.min(index + 1 + MAX_SENTENCE_START_WORDS, tokens.length - 1);
+    for (let end = index + 2; end <= last && !endsSentence(tokens[end - 1]); end += 1) {
+      costs.set(end, (costs.get(end) ?? 0) + SENTENCE_START_COST);
+    }
+  }
+  return costs;
+}
 function hasParentheticals(tokens, restLimit, options) {
   if (options.parentheticalOverflow === void 0) {
     return false;
@@ -1041,9 +1059,9 @@ function analyzeParagraph(paragraph, options) {
     parentheticalOverflow: options.maxWidth === void 0 ? void 0 : options.maxWidth - options.width,
     keepFirstLine: paragraph.kind === "tag"
   };
-  const layOut = (from, settings) => {
-    const even2 = layoutTokens(from, firstLimit, restLimit, settings);
-    return { even: even2, wrapped: breakAfterSentence(even2, firstLimit, restLimit, settings) };
+  const layOut = (from, settings, extra) => {
+    const even2 = layoutTokens(from, firstLimit + extra, restLimit + extra, settings);
+    return { even: even2, wrapped: breakAfterSentence(even2, firstLimit + extra, restLimit + extra, settings) };
   };
   const units = bindLineStarts(paragraph.kind === "tag" ? bindTagHead(tokens) : tokens, startsLine);
   const hardLimit = restLimit + (options.maxWidth === void 0 ? options.tolerance : options.maxWidth - options.width);
@@ -1060,9 +1078,9 @@ function analyzeParagraph(paragraph, options) {
       return { ...first, text, verbatim: false, hardBreak: HARD_BREAK.test(text) };
     });
   };
-  const settle = (settings) => {
+  const settle = (settings, extra = 0) => {
     let current = units;
-    let { even: even2, wrapped: wrapped2 } = layOut(current, settings);
+    let { even: even2, wrapped: wrapped2 } = layOut(current, settings, extra);
     for (; ; ) {
       const body = bodyOf(wrapped2);
       const rewrap = structureOf(body);
@@ -1077,11 +1095,19 @@ function analyzeParagraph(paragraph, options) {
         return { tier: "manual", reason: `rewrap would read as ${reading}` };
       }
       current = current.toSpliced(start - 1, 2, pair);
-      ({ even: even2, wrapped: wrapped2 } = layOut(current, settings));
+      ({ even: even2, wrapped: wrapped2 } = layOut(current, settings, extra));
     }
   };
-  const settled = settle(layoutOptions);
-  const layout = "wrapped" in settled ? settled : settle({ ...layoutOptions, keepSteps: true });
+  const layoutAt = (extra) => {
+    const settings = {
+      ...layoutOptions,
+      tolerance: layoutOptions.tolerance - extra,
+      parentheticalOverflow: layoutOptions.parentheticalOverflow === void 0 ? void 0 : layoutOptions.parentheticalOverflow - extra
+    };
+    const settled = settle(settings, extra);
+    return "wrapped" in settled ? settled : settle({ ...settings, keepSteps: true }, extra);
+  };
+  const layout = layoutAt(0);
   if (!("wrapped" in layout)) {
     return keep(layout);
   }
@@ -1106,6 +1132,10 @@ function analyzeParagraph(paragraph, options) {
       const free = settle({ ...layoutOptions, avoidSentenceOrphans: false });
       return !("wrapped" in free) || sameLayout(free.wrapped, currentLines);
     };
+    const keepsOnlySentenceStarts = () => {
+      const free = settle({ ...layoutOptions, ignoreSentenceStarts: true });
+      return "wrapped" in free && (sameLayout(free.even, currentLines) || sameLayout(free.wrapped, currentLines));
+    };
     const splitsOnlyParenthetical = (line) => {
       if (layoutOptions.parentheticalOverflow === void 0) {
         return false;
@@ -1133,7 +1163,7 @@ function analyzeParagraph(paragraph, options) {
         wrapped.findIndex((words, position) => words.join(" ") !== currentLines[position]?.join(" ")),
         0
       );
-      if (lineIssues.length === 0 && sameLayout(even, currentLines)) {
+      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 });
@@ -1142,10 +1172,22 @@ function analyzeParagraph(paragraph, options) {
       }
     }
   }
-  const suggestion = wrapped.map(
+  const isVerdict = (issue) => ISSUE_TIERS[issue.type] === "verdict";
+  const matchesWiderLayout = () => {
+    for (let extra = 1; extra <= layoutOptions.tolerance; extra += 1) {
+      const wider = layoutAt(extra);
+      if ("wrapped" in wider && sameLayout(wider.wrapped, currentLines)) {
+        return true;
+      }
+    }
+    return false;
+  };
+  const accepted = lineIssues.some((issue) => isVerdict(issue)) && matchesWiderLayout();
+  const suggested = accepted ? currentLines : wrapped;
+  const suggestion = suggested.map(
     (words, position) => `${prefix}${position === 0 ? paragraph.marker : hang}${words.join(" ")}`
   );
-  const wrapIssues = lineIssues.map((issue) => lineIssue(issue.type, paragraph.lines[issue.line], options));
+  const wrapIssues = lineIssues.filter((issue) => !accepted || !isVerdict(issue)).map((issue) => lineIssue(issue.type, paragraph.lines[issue.line], options));
   const issues = byLine([...overflow, ...wrapIssues, ...styleIssues(paragraph, options)]);
   return { ...base, reflowable: true, issues, suggestion };
 }
@@ -1337,7 +1379,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, 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. A long word, like an identifier or a code span, may stay at the end of a line when moving it would leave that line far shorter than the lines around it. Then leave the line breaks as they are.
+- 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. The same goes for the first two words of a sentence, like \`It allocates\` after a period, when the note points at them. A long word, like an identifier or a code span, may stay at the end of a line when moving it would leave that line far shorter than the lines around it. Then leave the line breaks as they are.
 - 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.
 - Separate paragraphs with an empty comment line.