fix: compatibility with prettier 2.0 (#1359)

Author: czosel

build/rollup.config.js

@@ -20,28 +20,28 @@ export default {
     name: "prettierPlugins.php",
     exports: "named",
     globals: {
-      prettier: "prettier"
+      prettier: "prettier",
     },
     paths: {
-      prettier: "prettier/standalone"
-    }
+      prettier: "prettier/standalone",
+    },
   },
   external: ["prettier"],
   plugins: [
     nodeResolve({
-      preferBuiltins: true
+      preferBuiltins: true,
     }),
     commonjs(),
     alias({
       entries: [
-        { find: "assert", replacement: resolve(BUILD_DIR, "shims/assert.js") }
-      ]
+        { find: "assert", replacement: resolve(BUILD_DIR, "shims/assert.js") },
+      ],
     }),
     inject({
-      Buffer: resolve(BUILD_DIR, "shims/buffer.js")
+      Buffer: resolve(BUILD_DIR, "shims/buffer.js"),
     }),
     replace({
-      "process.arch": JSON.stringify("x32")
+      "process.arch": JSON.stringify("x32"),
     }),
     json(),
     babel({
@@ -53,11 +53,11 @@ export default {
           require.resolve("@babel/preset-env"),
           {
             targets: { browsers: [">0.25%", "not ie 11", "not op_mini all"] },
-            modules: false
-          }
-        ]
-      ]
+            modules: false,
+          },
+        ],
+      ],
     }),
-    terser()
-  ]
+    terser(),
+  ],
 };

build/shims/assert.js

@@ -1,4 +1,4 @@
 "use strict";
 function assert() {}
-assert.strictEqual = function() {};
+assert.strictEqual = function () {};
 module.exports = assert;

build/shims/buffer.js

@@ -1,6 +1,6 @@
 "use strict";
 const Buffer = {};
-Buffer.isBuffer = function() {
+Buffer.isBuffer = function () {
   return false;
 };
 module.exports = Buffer;

jest.config.js

@@ -7,7 +7,7 @@ module.exports = {
   collectCoverageFrom: [
     "<rootDir>/src/**/*.js",
     "!<rootDir>/node_modules/",
-    "!<rootDir>/tests_config/"
+    "!<rootDir>/tests_config/",
   ],
   projects: [
     {
@@ -17,8 +17,8 @@ module.exports = {
       snapshotSerializers: ["jest-snapshot-serializer-raw"],
       testEnvironment: "node",
       globals: {
-        STANDALONE: false
-      }
+        STANDALONE: false,
+      },
     },
     ...(/^true$/i.test(process.env.RUN_STANDALONE_TESTS)
       ? [
@@ -29,16 +29,19 @@ module.exports = {
             snapshotSerializers: ["jest-snapshot-serializer-raw"],
             testEnvironment: "jsdom",
             globals: {
-              STANDALONE: true
-            }
-          }
+              STANDALONE: true,
+            },
+          },
         ]
       : []),
     {
       runner: "jest-runner-eslint",
       displayName: "lint",
       testMatch: ["<rootDir>/**/*.js"],
-      testPathIgnorePatterns: ["<rootDir>/node_modules/", "<rootDir>/coverage/"]
-    }
-  ]
+      testPathIgnorePatterns: [
+        "<rootDir>/node_modules/",
+        "<rootDir>/coverage/",
+      ],
+    },
+  ],
 };

package.json

@@ -27,7 +27,7 @@
     "jest": "25.2.3",
     "jest-runner-eslint": "0.7.6",
     "jest-snapshot-serializer-raw": "^1.1.0",
-    "prettier": "^1.19.1",
+    "prettier": "^2.0.0",
     "rollup": "^1.1.2",
     "rollup-plugin-alias": "^2.0.0",
     "rollup-plugin-babel": "^4.3.2",

src/clean.js

@@ -23,8 +23,8 @@ function clean(node, newObj) {
     "end",
     "tokens",
     "errors",
-    "extra"
-  ].forEach(name => {
+    "extra",
+  ].forEach((name) => {
     delete newObj[name];
   });
 
@@ -77,7 +77,7 @@ function clean(node, newObj) {
     if (node.body && node.body.kind !== "block") {
       newObj.body = {
         kind: "block",
-        children: [newObj.body]
+        children: [newObj.body],
       };
     } else {
       newObj.body = newObj.body ? newObj.body : null;
@@ -86,7 +86,7 @@ function clean(node, newObj) {
     if (node.alternate && node.alternate.kind !== "block") {
       newObj.alternate = {
         kind: "block",
-        children: [newObj.alternate]
+        children: [newObj.alternate],
       };
     } else {
       newObj.alternate = newObj.alternate ? newObj.alternate : null;

src/comments.js

@@ -4,12 +4,9 @@ const {
   addLeadingComment,
   addDanglingComment,
   addTrailingComment,
-  getNextNonSpaceNonCommentCharacterIndex,
-  isNextLineEmpty,
   skipNewline,
-  isPreviousLineEmpty,
   hasNewline,
-  hasNewlineInRange
+  hasNewlineInRange,
 } = require("prettier").util;
 const {
   concat,
@@ -18,9 +15,14 @@ const {
   hardline,
   cursor,
   lineSuffix,
-  breakParent
+  breakParent,
 } = require("prettier").doc.builders;
-const { isLookupNode } = require("./util");
+const {
+  getNextNonSpaceNonCommentCharacterIndex,
+  isNextLineEmpty,
+  isPreviousLineEmpty,
+  isLookupNode,
+} = require("./util");
 
 /*
 Comment functions are meant to inspect various edge cases using given comment nodes,
@@ -461,7 +463,7 @@ function handleClassComments(enclosingNode, followingNode, comment) {
         }
       } else {
         if (
-          enclosingNode.extends.some(extendsNode => {
+          enclosingNode.extends.some((extendsNode) => {
             if (followingNode && followingNode === extendsNode) {
               addDanglingComment(followingNode, comment);
               return true;
@@ -477,7 +479,7 @@ function handleClassComments(enclosingNode, followingNode, comment) {
     // them as dangling comments and handle them in the printer
     if (followingNode && enclosingNode.implements) {
       if (
-        enclosingNode.implements.some(implementsNode => {
+        enclosingNode.implements.some((implementsNode) => {
           if (followingNode && followingNode === implementsNode) {
             addDanglingComment(followingNode, comment);
             return true;
@@ -830,7 +832,7 @@ function printDanglingComments(path, options, sameIndent, filter) {
     return "";
   }
 
-  path.each(commentPath => {
+  path.each((commentPath) => {
     const comment = commentPath.getValue();
     if (
       comment &&
@@ -853,18 +855,18 @@ function printDanglingComments(path, options, sameIndent, filter) {
 }
 
 function hasLeadingComment(node) {
-  return node.comments && node.comments.some(comment => comment.leading);
+  return node.comments && node.comments.some((comment) => comment.leading);
 }
 
 function hasTrailingComment(node) {
-  return node.comments && node.comments.some(comment => comment.trailing);
+  return node.comments && node.comments.some((comment) => comment.trailing);
 }
 
 function hasLeadingOwnLineComment(text, node, options) {
   return (
     node.comments &&
     node.comments.some(
-      comment => comment.leading && hasNewline(text, options.locEnd(comment))
+      (comment) => comment.leading && hasNewline(text, options.locEnd(comment))
     )
   );
 }
@@ -897,10 +899,10 @@ function getCommentChildNodes(node) {
     return [];
   }
 
-  const getChildNodes = node =>
+  const getChildNodes = (node) =>
     Object.keys(node)
       .filter(
-        n =>
+        (n) =>
           n !== "kind" &&
           n !== "loc" &&
           n !== "errors" &&
@@ -911,7 +913,7 @@ function getCommentChildNodes(node) {
           n !== "precedingNode" &&
           n !== "followingNode"
       )
-      .map(n => node[n]);
+      .map((n) => node[n]);
 
   return getChildNodes(node);
 }
@@ -948,7 +950,9 @@ function printLeadingComment(commentPath, print, options) {
   if (isBlock) {
     return concat([
       contents,
-      hasNewline(options.originalText, options.locEnd(comment)) ? hardline : " "
+      hasNewline(options.originalText, options.locEnd(comment))
+        ? hardline
+        : " ",
     ]);
   }
 
@@ -966,7 +970,7 @@ function printTrailingComment(commentPath, print, options) {
 
   if (
     hasNewline(options.originalText, options.locStart(comment), {
-      backwards: true
+      backwards: true,
     })
   ) {
     // This allows comments at the end of nested structures:
@@ -997,7 +1001,7 @@ function printTrailingComment(commentPath, print, options) {
 
   return concat([
     lineSuffix(concat([" ", contents])),
-    !isBlock ? breakParent : ""
+    !isBlock ? breakParent : "",
   ]);
 }
 
@@ -1013,7 +1017,7 @@ function printAllComments(path, print, options, needsSemi) {
   const leadingParts = [];
   const trailingParts = [needsSemi ? ";" : "", printed];
 
-  path.each(commentPath => {
+  path.each((commentPath) => {
     const comment = commentPath.getValue();
     const { leading, trailing } = comment;
 
@@ -1052,5 +1056,5 @@ module.exports = {
   hasTrailingComment,
   hasLeadingOwnLineComment,
   printComments,
-  printAllComments
+  printAllComments,
 };

src/index.js

@@ -34,18 +34,18 @@ const languages = [
   createLanguage(require("linguist-languages/data/PHP"), {
     override: {
       parsers: ["php"],
-      vscodeLanguageIds: ["php"]
-    }
+      vscodeLanguageIds: ["php"],
+    },
   }),
   createLanguage(require("linguist-languages/data/HTML+PHP"), {
     override: {
       parsers: ["php"],
-      vscodeLanguageIds: ["php"]
-    }
-  })
+      vscodeLanguageIds: ["php"],
+    },
+  }),
 ];
 
-const loc = prop => node => {
+const loc = (prop) => (node) => {
   return node.loc && node.loc[prop] && node.loc[prop].offset;
 };
 
@@ -55,8 +55,8 @@ const parsers = {
     astFormat: "php",
     locStart: loc("start"),
     locEnd: loc("end"),
-    hasPragma
-  }
+    hasPragma,
+  },
 };
 
 const printers = {
@@ -70,7 +70,7 @@ const printers = {
     handleComments: {
       ownLine: comments.handleOwnLineComment,
       endOfLine: comments.handleEndOfLineComment,
-      remaining: comments.handleRemainingComment
+      remaining: comments.handleRemainingComment,
     },
     willPrintOwnComments(path) {
       const node = path.getValue();
@@ -92,7 +92,7 @@ const printers = {
           if (
             lines
               .slice(1, lines.length - 1)
-              .every(line => line.trim()[0] === "*")
+              .every((line) => line.trim()[0] === "*")
           ) {
             return join(
               hardline,
@@ -117,7 +117,7 @@ const printers = {
     },
     hasPrettierIgnore(path) {
       const node = path.getNode();
-      const isSimpleIgnore = comment =>
+      const isSimpleIgnore = (comment) =>
         comment.value.includes("prettier-ignore") &&
         !comment.value.includes("prettier-ignore-start") &&
         !comment.value.includes("prettier-ignore-end");
@@ -127,8 +127,8 @@ const printers = {
         node.comments.length > 0 &&
         node.comments.some(isSimpleIgnore)
       );
-    }
-  }
+    },
+  },
 };
 
 module.exports = {
@@ -137,6 +137,6 @@ module.exports = {
   parsers,
   options,
   defaultOptions: {
-    tabWidth: 4
-  }
+    tabWidth: 4,
+  },
 };

src/needs-parens.js

@@ -27,7 +27,7 @@ function needsParens(path) {
       "include",
       "print",
       "return",
-      "echo"
+      "echo",
     ].includes(parent.kind)
   ) {
     return false;