Merge pull request #408 from ember-tooling/upgrade-prettier

Fix problems with prettier v3.6.0+

Author: NullVoxPopuli

.prettierignore

@@ -1,6 +1,6 @@
 # compiled output
 /dist/
- 
+
 # misc
 !.*
 .*/
@@ -13,3 +13,4 @@ pnpm-lock.yaml
 CHANGELOG.md
 README.md
 RELEASE.md
+CONTRIBUTING.md

examples/package.json

@@ -8,7 +8,7 @@
     "test": "node ./bin/test.mjs"
   },
   "dependencies": {
-    "prettier": "^3.5.3",
+    "prettier": "^3.7.3",
     "prettier-plugin-ember-template-tag": "workspace:^"
   },
   "devDependencies": {

examples/pnpm-lock.yaml

@@ -75,8 +75,8 @@
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^59.0.1",
     "globals": "^16.2.0",
-    "prettier": "^3.5.3",
-    "prettier-plugin-jsdoc": "^1.3.2",
+    "prettier": "^3.7.3",
+    "prettier-plugin-jsdoc": "^1.7.0",
     "release-plan": "^0.11.0",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.34.0",

package.json

@@ -28,18 +28,44 @@ function convertNode(
   });
 }
 
+function findCorrectCommentBlockIndex(
+  comments: File['comments'],
+  start: number,
+  end: number,
+): number {
+  if (!comments) {
+    return -1;
+  }
+
+  return comments.findIndex((comment) => {
+    const { start: commentStart, end: commentEnd } = comment;
+
+    return (
+      (commentStart === start && commentEnd === end) ||
+      (commentStart === start + 1 && commentEnd === end - 1) ||
+      (commentStart === start + 7 && commentEnd === end - 1)
+    );
+  });
+}
+
 /** Traverses the AST and replaces the transformed template parts with other AST */
 function convertAst(ast: File, templates: Template[]): void {
   traverse(ast, {
     enter(path) {
+      if (templates.length === 0) {
+        return null;
+      }
+
       const { node } = path;
 
       switch (node.type) {
         case 'BlockStatement':
         case 'ObjectExpression':
         case 'StaticBlock': {
-          assert('expected range', node.range);
-          const [start, end] = node.range;
+          const [start, end] = [
+            typescript.locStart(node),
+            typescript.locEnd(node),
+          ];
 
           const templateIndex = templates.findIndex((template) => {
             const { utf16Range } = template;
@@ -67,12 +93,16 @@ function convertAst(ast: File, templates: Template[]): void {
             );
           }
 
-          const index =
-            node.innerComments?.[0] &&
-            ast.comments?.indexOf(node.innerComments[0]);
+          if (ast.comments && ast.comments.length > 0) {
+            const commentBlockIndex = findCorrectCommentBlockIndex(
+              ast.comments,
+              start,
+              end,
+            );
 
-          if (ast.comments && index !== undefined && index >= 0) {
-            ast.comments.splice(index, 1);
+            if (commentBlockIndex !== undefined && commentBlockIndex >= 0) {
+              ast.comments.splice(commentBlockIndex, 1);
+            }
           }
 
           convertNode(node, rawTemplate);

pnpm-lock.yaml

@@ -32,6 +32,10 @@ export const printer: Printer<Node | undefined> = {
     return estreePrinter.getVisitorKeys?.(node, nonTraversableKeys) || [];
   },
 
+  printPrettierIgnored(path: AstPath<Node | undefined>, options: Options) {
+    return printRawText(path, options);
+  },
+
   print(
     path: AstPath<Node | undefined>,
     options: Options,
@@ -154,7 +158,15 @@ function printRawText(
 }
 
 function hasPrettierIgnore(path: AstPath<Node | undefined>): boolean {
-  return path.node?.leadingComments?.at(-1)?.value.trim() === 'prettier-ignore';
+  let possibleComment = path.node?.leadingComments?.at(-1)?.value.trim();
+
+  // @ts-expect-error Comments exist on node sometimes
+  if (!path.node?.leadingComments && path.node?.comments) {
+    // @ts-expect-error Comments exist on node sometimes
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+    possibleComment = path.node.comments?.at(-1)?.value.trim();
+  }
+  return possibleComment === 'prettier-ignore';
 }
 
 function checkPrettierIgnore(path: AstPath<Node | undefined>): boolean {