@d3lm/lint-preset 1.5.4 → 1.5.6

package/dist/comments.cjs

@@ -293,6 +293,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) {
@@ -380,7 +382,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) {
@@ -446,6 +448,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, (_nullishCoalesce(costs.get(end), () => ( 0))) + SENTENCE_START_COST);
+    }
+  }
+  return costs;
+}
 function hasParentheticals(tokens, restLimit, options) {
   if (options.parentheticalOverflow === void 0) {
     return false;
@@ -1043,9 +1061,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);
@@ -1062,9 +1080,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);
@@ -1079,11 +1097,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);
   }
@@ -1108,6 +1134,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;
@@ -1135,7 +1165,7 @@ function analyzeParagraph(paragraph, options) {
         wrapped.findIndex((words, position) => words.join(" ") !== _optionalChain([currentLines, 'access', _38 => _38[position], 'optionalAccess', _39 => _39.join, 'call', _40 => _40(" ")])),
         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 });
@@ -1144,10 +1174,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 };
 }
@@ -1339,7 +1381,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.