@aforemendude/prettier-plugin-wrap-comments 1.0.4 → 1.0.6

package/README.md

@@ -67,6 +67,11 @@ Non-JSDoc `/* ... */` comments are also normalized as Markdown. A block comment
 comment fits within `printWidth`; otherwise, only standalone block comments are expanded into star-prefixed blocks. Long
 inline block comments are left unchanged when they cannot fit on one line.
 
+Multiline block comments are normalized as conventional block-comment text before Markdown parsing: leading indentation
+is removed, and a `*` that is the first non-whitespace character on a body line is treated as comment formatting, not
+Markdown content. This also applies to unstarred `/* ... */` blocks, so use line comments when Markdown-significant
+indentation or leading `*` characters must be preserved exactly.
+
 ```ts
 if (ready) {
   /*
@@ -78,9 +83,10 @@ if (ready) {
 ```
 
 JSX and TSX expression comments use the expression contents, not the outer React expression braces, to decide whether a
-block comment is standalone, trailing, or inline. A comment-only expression like `{/* ... */}` can wrap as a standalone
-JSX comment. A trailing expression comment like `{label /* ... */}` can move before `label` and wrap. A true inline
-expression comment like `{"abc" + /* ... */ "123"}` is left unchanged when it cannot fit on one line.
+block comment is standalone, leading, trailing, or inline. A comment-only expression like `{/* ... */}` can wrap as a
+standalone JSX comment. A leading expression comment like `{/* ... */ label}` can move above `label` and wrap. A
+trailing expression comment like `{label /* ... */}` can move before `label` and wrap. A true inline expression comment
+like `{"abc" + /* ... */ "123"}` is left unchanged when it cannot fit on one line.
 
 <!-- prettier-ignore-start -->
 ```tsx
@@ -91,6 +97,13 @@ expression comment like `{"abc" + /* ... */ "123"}` is left unchanged when it ca
      * make it inline.
      */
   }
+  {
+    /*
+     * This expression comment moved above the expression value because it was
+     * leading.
+     */
+    label
+  }
   {
     /*
      * This expression comment moved above the expression value because it was
@@ -109,11 +122,16 @@ the block comment is one the plugin would otherwise wrap, the following code sti
 comment is already skipped by the plugin, such as a JSDoc or directive block, Prettier keeps its normal ignore behavior
 for the following code.
 
-For trailing line comments, a `// prettier-ignore` line can apply to the code line and its inline comment. The plugin
-walks past adjacent standalone comments that it normally leaves alone, such as an `eslint-disable-next-line` directive,
-so an ignored code line's trailing comment remains inline and unchanged. A directive comment by itself does not ignore
-the following code line; without `// prettier-ignore`, an overlong trailing comment below a directive is still moved
-above the statement and wrapped.
+An exact `// prettier-ignore` marker can also apply to the following adjacent standalone `//` comment group. The plugin
+leaves that group unchanged and neutralizes the marker for Prettier, so code after the ignored comment group still
+formats normally.
+
+For trailing line comments, a standalone exact-body `prettier-ignore` marker, written as `// prettier-ignore` or
+`/* prettier-ignore */`, can apply to the code line and its inline comment. The plugin walks past adjacent standalone
+comments that it normally leaves alone, such as an `eslint-disable-next-line` directive, so an ignored code line's
+trailing comment remains inline and unchanged. A directive comment by itself does not ignore the following code line;
+without `prettier-ignore`, an overlong trailing comment below a directive is still moved above the statement and
+wrapped.
 
 The plugin leaves these comments unchanged:
 

package/dist/comments/block.d.ts

@@ -1,8 +1,13 @@
 import type { CommentRange, Replacement, WrapOptions } from '../shared/types.js';
 export type BlockCommentLayout = {
     contentColumn?: number;
+    leadingMove?: {
+        removeEnd: number;
+        removeStart: number;
+    };
     multilineIndent?: string;
     placement: 'inline' | 'standalone' | 'trailing';
+    singleLineSuffixWidth?: number;
     trailingMove?: {
         insertAt: number;
         removeEnd: number;

package/dist/comments/block.js

@@ -36,7 +36,8 @@ function buildBlockReplacement(text, comment, formattedLines, options, layout) {
     const markerColumn = getColumnAt(text, comment.start, tabWidth);
     const singleLine = `/* ${formattedLines.join(' ')} */`;
     const singleLineWidth = getColumns(singleLine, tabWidth);
-    if (formattedLines.length === 1 && markerColumn + singleLineWidth <= getPrintWidth(options)) {
+    const singleLineSuffixWidth = layout.singleLineSuffixWidth ?? 0;
+    if (formattedLines.length === 1 && markerColumn + singleLineWidth + singleLineSuffixWidth <= getPrintWidth(options)) {
         return singleLine;
     }
     if (layout.placement === 'inline') {
@@ -59,6 +60,20 @@ function buildBlockReplacement(text, comment, formattedLines, options, layout) {
             },
         ];
     }
+    if (layout.leadingMove !== undefined) {
+        return [
+            {
+                end: comment.end,
+                start: comment.start,
+                text: `${replacementText}${newline}`,
+            },
+            {
+                end: layout.leadingMove.removeEnd,
+                start: layout.leadingMove.removeStart,
+                text: '',
+            },
+        ];
+    }
     return replacementText;
 }
 function buildMultilineBlockReplacement(formattedLines, newline, indent) {

package/dist/comments/core.js

@@ -22,14 +22,6 @@ export function toCommentRange(comment, text) {
     if (rawStart.startsWith('/*')) {
         return { end, kind: 'block', start };
     }
-    if (typeof comment.type === 'string') {
-        if (comment.type.includes('Line')) {
-            return { end, kind: 'line', start };
-        }
-        if (comment.type.includes('Block')) {
-            return { end, kind: 'block', start };
-        }
-    }
     return undefined;
 }
 export function normalizeLineCommentBody(rawBody) {

package/dist/comments/wrap.d.ts

@@ -1,3 +1,3 @@
 import type { WrapOptions } from '../shared/types.js';
 export declare function wrapComments<T>(text: string, ast: T, options: WrapOptions): Promise<string>;
-export declare function neutralizePrettierIgnoreForIgnoredBlockComments<T>(text: string, ast: T): T;
+export declare function neutralizePrettierIgnoreForIgnoredComments<T>(text: string, ast: T): T;

package/dist/comments/wrap.js

@@ -53,6 +53,10 @@ export async function wrapComments(text, ast, options) {
         if (shouldSkipLineComment(text, comment)) {
             continue;
         }
+        if (isPrettierIgnoredStandaloneLineComment(text, commentEntries, index)) {
+            index = getStandaloneLineCommentGroupEndIndex(text, comments, index, tabWidth);
+            continue;
+        }
         if (!isStandaloneLineComment(text, comment)) {
             if (isPrettierIgnoredTrailingLineComment(text, commentEntries, index)) {
                 continue;
@@ -88,15 +92,16 @@ export async function wrapComments(text, ast, options) {
     }
     return applyReplacements(text, replacements);
 }
-export function neutralizePrettierIgnoreForIgnoredBlockComments(text, ast) {
+export function neutralizePrettierIgnoreForIgnoredComments(text, ast) {
     const comments = collectSortedCommentEntries(ast, text);
     for (let index = 0; index < comments.length; index += 1) {
         const entry = comments[index];
         const previousEntry = comments[index - 1];
-        if (entry !== undefined &&
+        const shouldNeutralize = entry !== undefined &&
             previousEntry !== undefined &&
-            isPrettierIgnoredBlockComment(text, comments, index) &&
-            !isBlockCommentNormallyIgnored(text, entry.range)) {
+            ((isPrettierIgnoredBlockComment(text, comments, index) && !isBlockCommentNormallyIgnored(text, entry.range)) ||
+                (isPrettierIgnoredStandaloneLineComment(text, comments, index) && !shouldSkipLineComment(text, entry.range)));
+        if (shouldNeutralize) {
             previousEntry.raw.value = NEUTRALIZED_PRETTIER_IGNORE_COMMENT;
         }
     }
@@ -114,8 +119,7 @@ function collectPrettierIgnoredLineRanges(text, ast, comments) {
     for (let index = 0; index < comments.length; index += 1) {
         const comment = comments[index]?.range;
         if (comment === undefined ||
-            comment.kind !== 'line' ||
-            !isStandaloneLineComment(text, comment) ||
+            !isStandaloneComment(text, comment) ||
             !isPrettierIgnoreComment(getCommentBody(text, comment))) {
             continue;
         }
@@ -251,7 +255,12 @@ function getJsxExpressionBlockCommentLayout(text, comment, jsxExpressionContaine
     const expressionTextAfterComment = text.slice(comment.end, container.end - 1).trim();
     const containerOutputColumn = getJsxExpressionContainerOutputColumn(text, container, tabWidth);
     if (expressionTextBeforeComment === '' && expressionTextAfterComment === '') {
-        return { contentColumn: containerOutputColumn + tabWidth + 3, multilineIndent: '', placement: 'standalone' };
+        return {
+            contentColumn: containerOutputColumn + tabWidth + 3,
+            multilineIndent: '',
+            placement: 'standalone',
+            singleLineSuffixWidth: 1,
+        };
     }
     if (expressionTextBeforeComment !== '' && expressionTextAfterComment === '') {
         const expressionStart = skipWhitespace(text, container.start + 1);
@@ -261,6 +270,7 @@ function getJsxExpressionBlockCommentLayout(text, comment, jsxExpressionContaine
             contentColumn: containerOutputColumn + tabWidth + 3,
             multilineIndent: '',
             placement: 'trailing',
+            singleLineSuffixWidth: 1,
             trailingMove: {
                 insertAt: expressionStart,
                 removeEnd: removalEnd,
@@ -268,6 +278,22 @@ function getJsxExpressionBlockCommentLayout(text, comment, jsxExpressionContaine
             },
         };
     }
+    if (expressionTextBeforeComment === '') {
+        if (isStandaloneBlockComment(text, comment)) {
+            return { placement: 'inline' };
+        }
+        const expressionStart = skipWhitespace(text, comment.end);
+        return {
+            contentColumn: containerOutputColumn + tabWidth + 3,
+            leadingMove: {
+                removeEnd: expressionStart,
+                removeStart: comment.end,
+            },
+            multilineIndent: '',
+            placement: 'standalone',
+            singleLineSuffixWidth: getColumns(text.slice(comment.end, container.end), tabWidth),
+        };
+    }
     return { placement: 'inline' };
 }
 function getJsxExpressionContainerOutputColumn(text, container, tabWidth) {
@@ -312,6 +338,43 @@ function isPrettierIgnoredBlockComment(text, comments, index) {
     }
     return isPrettierIgnoreComment(getCommentBody(text, previousComment));
 }
+function isPrettierIgnoredStandaloneLineComment(text, comments, index) {
+    const comment = comments[index]?.range;
+    const previousComment = comments[index - 1]?.range;
+    if (comment === undefined ||
+        comment.kind !== 'line' ||
+        !isStandaloneLineComment(text, comment) ||
+        previousComment === undefined ||
+        previousComment.kind !== 'line') {
+        return false;
+    }
+    if (!isStandaloneComment(text, previousComment) || !isAdjacentPreviousComment(text, previousComment, comment)) {
+        return false;
+    }
+    return isPrettierIgnoreComment(getCommentBody(text, previousComment));
+}
+function getStandaloneLineCommentGroupEndIndex(text, comments, startIndex, tabWidth) {
+    const firstComment = comments[startIndex];
+    if (firstComment === undefined) {
+        return startIndex;
+    }
+    let endIndex = startIndex;
+    let previousComment = firstComment;
+    while (endIndex + 1 < comments.length) {
+        const nextComment = comments[endIndex + 1];
+        if (nextComment === undefined ||
+            nextComment.kind !== 'line' ||
+            !isStandaloneLineComment(text, nextComment) ||
+            shouldSkipLineComment(text, nextComment) ||
+            !areAdjacentLineComments(text, previousComment, nextComment) ||
+            getColumnAt(text, firstComment.start, tabWidth) !== getColumnAt(text, nextComment.start, tabWidth)) {
+            break;
+        }
+        previousComment = nextComment;
+        endIndex += 1;
+    }
+    return endIndex;
+}
 function isPrettierIgnoredTrailingLineComment(text, comments, index) {
     const comment = comments[index]?.range;
     if (comment === undefined || comment.kind !== 'line' || isStandaloneLineComment(text, comment)) {
@@ -330,7 +393,7 @@ function isPrettierIgnoredTrailingLineComment(text, comments, index) {
             return false;
         }
         const body = getCommentBody(text, previousComment);
-        if (previousComment.kind === 'line' && isPrettierIgnoreComment(body)) {
+        if (isPrettierIgnoreComment(body)) {
             return true;
         }
         if (!isCommentNormallyIgnored(text, previousComment)) {

package/dist/plugin/parsers.js

@@ -1,13 +1,13 @@
 import * as babelPlugin from 'prettier/plugins/babel';
 import * as typescriptPlugin from 'prettier/plugins/typescript';
-import { neutralizePrettierIgnoreForIgnoredBlockComments, wrapComments } from '../comments/wrap.js';
+import { neutralizePrettierIgnoreForIgnoredComments, wrapComments } from '../comments/wrap.js';
 const parserNames = ['babel', 'babel-ts', 'typescript'];
 function wrapParser(parser) {
     return {
         ...parser,
         async parse(text, options) {
             const ast = await parser.parse(text, options);
-            return neutralizePrettierIgnoreForIgnoredBlockComments(text, ast);
+            return neutralizePrettierIgnoreForIgnoredComments(text, ast);
         },
         async preprocess(text, options) {
             const preprocessed = parser.preprocess === undefined ? text : await parser.preprocess(text, options);

package/package.json

@@ -51,5 +51,5 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "1.0.4"
+  "version": "1.0.6"
 }