@d3lm/lint-preset 1.5.2 → 1.5.5

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;
     /**
@@ -18,7 +19,7 @@ interface WrapOptions {
      */
     readonly parentheticalOverflow?: number;
 }
-type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced';
+type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'split-parenthetical';
 /**
  * JSDoc writes types and `{@link ...}` tags as `{...}` groups, so they stay intact like code spans.
  */
@@ -43,8 +44,8 @@ interface AnalyzeOptions extends WrapOptions {
     readonly maxWidth?: number;
     /**
      * Sets the maximum length of the line that holds a comment whose whole text is one
-     * prose paragraph. Such a comment stays on one line up to this length, even past
-     * `width`. It defaults to `width`.
+     * prose paragraph. Such a comment stays on one line up to this length plus `tolerance`,
+     * even past `width`, but never past `maxWidth`. It defaults to `width`.
      */
     readonly singleLineWidth?: number;
     readonly tabWidth: number;
@@ -206,8 +207,9 @@ interface CommentsConfig {
     readonly maxWidth?: number;
     /**
      * Sets the maximum length of the line that holds a comment whose whole text is one prose
-     * paragraph. Such a comment stays on one line up to this length, even past `width`, and is
-     * wrapped to `width` beyond it. Defaults to 120 and never exceeds `maxWidth`.
+     * paragraph. Such a comment stays on one line up to this length plus `tolerance`, even past
+     * `width`, and is wrapped to `width` beyond it. Defaults to 120, and the line never exceeds
+     * `maxWidth`.
      */
     readonly singleLineWidth?: number;
     /**
@@ -220,8 +222,10 @@ interface CommentsConfig {
      * 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;
     /**
@@ -18,7 +19,7 @@ interface WrapOptions {
      */
     readonly parentheticalOverflow?: number;
 }
-type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced';
+type LineIssueType = 'overflow' | 'underfill' | 'orphan' | 'widow' | 'unbalanced' | 'split-parenthetical';
 /**
  * JSDoc writes types and `{@link ...}` tags as `{...}` groups, so they stay intact like code spans.
  */
@@ -43,8 +44,8 @@ interface AnalyzeOptions extends WrapOptions {
     readonly maxWidth?: number;
     /**
      * Sets the maximum length of the line that holds a comment whose whole text is one
-     * prose paragraph. Such a comment stays on one line up to this length, even past
-     * `width`. It defaults to `width`.
+     * prose paragraph. Such a comment stays on one line up to this length plus `tolerance`,
+     * even past `width`, but never past `maxWidth`. It defaults to `width`.
      */
     readonly singleLineWidth?: number;
     readonly tabWidth: number;
@@ -206,8 +207,9 @@ interface CommentsConfig {
     readonly maxWidth?: number;
     /**
      * Sets the maximum length of the line that holds a comment whose whole text is one prose
-     * paragraph. Such a comment stays on one line up to this length, even past `width`, and is
-     * wrapped to `width` beyond it. Defaults to 120 and never exceeds `maxWidth`.
+     * paragraph. Such a comment stays on one line up to this length plus `tolerance`, even past
+     * `width`, and is wrapped to `width` beyond it. Defaults to 120, and the line never exceeds
+     * `maxWidth`.
      */
     readonly singleLineWidth?: number;
     /**
@@ -220,8 +222,10 @@ interface CommentsConfig {
      * 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

@@ -199,6 +199,9 @@ function parentheticalGroups(tokens, limit) {
   }
   return groups;
 }
+function parentheticalAround(tokens, at, limit) {
+  return parentheticalGroups(tokens, limit).find((group) => group.start < at && at < group.end);
+}
 function bindParentheticals(tokens, limit) {
   const groups = new Map(parentheticalGroups(tokens, limit).map((group) => [group.start, group.end]));
   const units = [];
@@ -288,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) {
@@ -375,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) {
@@ -441,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;
@@ -603,6 +624,7 @@ var ISSUE_TIERS = {
   widow: "verdict",
   unbalanced: "verdict",
   orphan: "hint",
+  "split-parenthetical": "hint",
   banner: "hint",
   "em-dash": "hint",
   semicolon: "hint",
@@ -1098,9 +1120,48 @@ function analyzeParagraph(paragraph, options) {
     if (hasWidow(currentLines) && !hasWidow(wrapped)) {
       lineIssues.push({ type: "widow", line: currentLines.length - 1 });
     }
-    if (lineIssues.length === 0 && overflow.length === 0 && (currentLines.length === wrapped.length || options.maxWidth !== void 0)) {
-      const line = wrapped.findIndex((words, position) => words.join(" ") !== currentLines[position]?.join(" "));
-      lineIssues.push({ type: sameLayout(even, currentLines) ? "orphan" : "unbalanced", line: Math.max(line, 0) });
+    const keepsOnlyOrphans = () => {
+      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;
+      }
+      const tokenCount = (lines) => tokenize(lines.flat().join(" ")).length;
+      const end = tokenCount(currentLines.slice(0, line + 1));
+      const group = parentheticalAround(tokens, end, restLimit + layoutOptions.parentheticalOverflow);
+      if (!group) {
+        return false;
+      }
+      const keepsGroup = wrapped.every((_, position) => {
+        const breakAt = tokenCount(wrapped.slice(0, position + 1));
+        return breakAt <= group.start || breakAt >= group.end;
+      });
+      if (!keepsGroup) {
+        return false;
+      }
+      const restOptions = { ...layoutOptions, keepFirstLine: false };
+      const rest = bindLineStarts(tokens.slice(end), startsLine);
+      const restLines = layoutTokens(rest, restLimit, restLimit, restOptions);
+      return sameLayout(breakAfterSentence(restLines, restLimit, restLimit, restOptions), currentLines.slice(line + 1));
+    };
+    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(" ")),
+        0
+      );
+      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 });
+      } else if (lineIssues.every((issue) => issue.type === "orphan") && !sameLayout(even, currentLines) && !keepsOnlyOrphans()) {
+        lineIssues.push({ type: "unbalanced", line });
+      }
     }
   }
   const suggestion = wrapped.map(
@@ -1233,7 +1294,9 @@ function inspectSource(source, filename, options) {
       options.width,
       Math.min(options.singleLineWidth ?? options.width, options.maxWidth ?? Infinity)
     );
-    const paragraphOptions = shape.paragraphs.length === 1 && singleLineLength(shape.paragraphs[0], options) <= singleLineWidth ? { ...options, width: singleLineWidth } : options;
+    const singleLineLimit = Math.min(singleLineWidth + options.tolerance, options.maxWidth ?? Infinity);
+    const singleLine = shape.paragraphs.length === 1 ? singleLineLength(shape.paragraphs[0], options) : Infinity;
+    const paragraphOptions = singleLine <= singleLineLimit ? { ...options, width: Math.max(singleLineWidth, singleLine) } : options;
     const lines = sourceLines.slice(shape.startLine, shape.endLine + 1);
     reports.push({
       file: filename,
@@ -1296,7 +1359,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.
+- 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.