@prettier/plugin-php 0.17.2 → 0.17.6

package/README.md

@@ -221,6 +221,20 @@ The official [prettier plugin for atom](https://github.com/prettier/prettier-ato
 
 The official [prettier plugin for vscode](https://github.com/prettier/prettier-vscode) supports plugins since Version 1.10.0. To enable it, install the extension and make sure the plugin is installed _locally_ (in your project folder). After restarting VScode the plugin should work as expected.
 
+### PhpStorm / IntelliJ / Jetbrains IDE
+
+- Install prettier and plugin locally `yarn add -D prettier @prettier/plugin-php`
+- Open Settings (File, Settings)
+- Go to Plugins Section, Select Marketplace, Search for Prettier, Install Plugin, Restart IDE
+- Open Settings, Search for Prettier, select Prettier in left settings navigation
+- Check prettier package has auto-detected, should be something like `myproject/node_modules/prettier`
+- Update Run for Files to include .php, eg: `{**/*,*}.{js,ts,jsx,tsx,php,json,scss,vue,md}`
+- Tick the On Save button, if you want your files formatting updated on file save
+- Clock OK to save settings
+
+_Note: Just pressing save does not reformat your current file unless the file has been modified in some way, 
+alternatively you can use the Prettier shortcut Ctrl+Alt+Shift+P_
+
 ### Sublime Text
 
 Sublime Text support is available through Package Control and the [JsPrettier](https://packagecontrol.io/packages/JsPrettier) plugin.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-php",
-  "version": "0.17.2",
+  "version": "0.17.6",
   "description": "Prettier PHP Plugin",
   "repository": "prettier/prettier-php",
   "author": "Lucas Azzola <@azz>",
@@ -13,21 +13,21 @@
   "dependencies": {
     "linguist-languages": "^7.5.1",
     "mem": "^8.0.0",
-    "php-parser": "https://github.com/glayzzle/php-parser#cca83041d938b972c7ef74648f29de03777b0ea4"
+    "php-parser": "https://github.com/glayzzle/php-parser#27abcb2337ac6450c068ef064982dfabf77916a5"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.7.5",
-    "codecov": "3.8.2",
+    "codecov": "3.8.3",
     "cross-env": "^7.0.2",
-    "eslint": "7.29.0",
+    "eslint": "7.32.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.23.4",
-    "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-prettier": "3.4.0",
-    "jest": "26.6.3",
-    "jest-runner-eslint": "0.10.1",
+    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-jest": "24.4.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "jest": "27.3.1",
+    "jest-runner-eslint": "1.0.0",
     "jest-snapshot-serializer-raw": "^1.1.0",
-    "prettier": "^2.0.0",
+    "prettier": "2.1.2",
     "rollup": "^2.7.5",
     "rollup-plugin-alias": "^2.0.0",
     "rollup-plugin-babel": "^4.3.2",

package/src/index.js

@@ -115,16 +115,29 @@ const printers = {
       }
     },
     hasPrettierIgnore(path) {
-      const node = path.getNode();
       const isSimpleIgnore = (comment) =>
         comment.value.includes("prettier-ignore") &&
         !comment.value.includes("prettier-ignore-start") &&
         !comment.value.includes("prettier-ignore-end");
+
+      const parentNode = path.getParentNode();
+      const node = path.getNode();
+
       return (
-        node &&
-        node.comments &&
-        node.comments.length > 0 &&
-        node.comments.some(isSimpleIgnore)
+        (node &&
+          node.kind !== "classconstant" &&
+          node.comments &&
+          node.comments.length > 0 &&
+          node.comments.some(isSimpleIgnore)) ||
+        // For proper formatting, the classconstant ignore formatting should
+        // run on the "constant" child
+        (node &&
+          node.kind === "constant" &&
+          parentNode &&
+          parentNode.kind === "classconstant" &&
+          parentNode.comments &&
+          parentNode.comments.length > 0 &&
+          parentNode.comments.some(isSimpleIgnore))
       );
     },
   },

package/src/printer.js

@@ -1049,14 +1049,20 @@ function printLines(path, options, print, childrenAttribute = "children") {
           : isProgramLikeNode(node) && isFirstNode && node.kind !== "namespace"
           ? ""
           : concat([beforeCloseTagInlineNode, "?>"]);
+
+      const nextV = path.getNode(index + 1);
+      const skipLastComment = nextV && nextV.children && nextV.children.length;
+
       const afterInline =
         childNode.comments && childNode.comments.length
           ? concat([
               openTag,
               hardline,
-              comments.printComments(childNode.comments, options),
+              skipLastComment
+                ? comments.printComments(childNode.comments, options)
+                : "",
               hardline,
-              "?>",
+              skipLastComment ? "?>" : "",
             ])
           : isProgramLikeNode(node) && isLastNode
           ? ""
@@ -1102,7 +1108,7 @@ function printLines(path, options, print, childrenAttribute = "children") {
       const beforeCloseTag = lastNode
         ? concat([
             hasNewlineInRange(
-              options.originalText,
+              options.originalText.trimEnd(),
               options.locEnd(lastNode),
               options.locEnd(node)
             )
@@ -1199,10 +1205,51 @@ function printClassPart(
   );
 }
 
+function printAttrs(path, options, print, { inline = false } = {}) {
+  const allAttrs = [];
+  if (!path.getValue().attrGroups) {
+    return [];
+  }
+  path.each((agPath) => {
+    const attrGroup = ["#["];
+    if (allAttrs.length > 0) {
+      allAttrs.push(inline ? " " : hardline);
+    }
+    attrGroup.push(ifBreak(softline));
+    agPath.each((attrPath) => {
+      const attrNode = attrPath.getValue();
+      if (attrGroup.length > 2) {
+        attrGroup.push(",", ifBreak(softline, " "));
+      }
+      const attrStmt = [attrNode.name];
+      if (attrNode.args.length > 0) {
+        attrStmt.push(printArgumentsList(attrPath, options, print, "args"));
+      }
+      attrGroup.push(group(concat(attrStmt)));
+    }, "attrs");
+    allAttrs.push(
+      group(
+        concat([
+          indent(concat(attrGroup)),
+          ifBreak(softline),
+          "]",
+          softline,
+          inline ? " " : "",
+        ])
+      )
+    );
+  }, "attrGroups");
+  if (allAttrs.length === 0) {
+    return [];
+  }
+  return [concat([...allAttrs, inline ? "" : hardline])];
+}
+
 function printClass(path, options, print) {
   const node = path.getValue();
-
-  const declaration = [];
+  const isAnonymousClass = node.kind === "class" && node.isAnonymous;
+  const attrs = printAttrs(path, options, print, { inline: isAnonymousClass });
+  const declaration = isAnonymousClass ? [] : [...attrs];
 
   if (node.isFinal) {
     declaration.push("final ");
@@ -1212,8 +1259,6 @@ function printClass(path, options, print) {
     declaration.push("abstract ");
   }
 
-  const isAnonymousClass = node.kind === "class" && node.isAnonymous;
-
   // `new` print `class` keyword with arguments
   declaration.push(isAnonymousClass ? "" : node.kind);
 
@@ -1318,7 +1363,9 @@ function printClass(path, options, print) {
 
 function printFunction(path, options, print) {
   const node = path.getValue();
-  const declaration = [];
+  const declaration = [
+    ...printAttrs(path, options, print, { inline: node.kind === "closure" }),
+  ];
 
   if (node.isFinal) {
     declaration.push("final ");
@@ -1745,6 +1792,7 @@ function printNode(path, options, print) {
       return printFunction(path, options, print);
     case "arrowfunc":
       return concat([
+        ...printAttrs(path, options, print, { inline: true }),
         node.isStatic ? "static " : "",
         "fn",
         printArgumentsList(path, options, print),
@@ -1764,6 +1812,7 @@ function printNode(path, options, print) {
         promoted = "private ";
       }
       const name = concat([
+        ...printAttrs(path, options, print, { inline: true }),
         promoted,
         node.nullable ? "?" : "",
         node.type ? concat([path.call(print, "type"), " "]) : "",
@@ -1823,6 +1872,11 @@ function printNode(path, options, print) {
         ])
       );
     case "propertystatement": {
+      const attrs = [];
+      path.map(
+        (propPath) => attrs.push(...printAttrs(propPath, options, print)),
+        "properties"
+      );
       const printed = path.map((childPath) => {
         return print(childPath);
       }, "properties");
@@ -1842,6 +1896,7 @@ function printNode(path, options, print) {
 
       return group(
         concat([
+          ...attrs,
           hasVisibility
             ? concat([node.visibility === null ? "var" : node.visibility, ""])
             : "",
@@ -2148,6 +2203,7 @@ function printNode(path, options, print) {
       ) {
         return concat([
           "new ",
+          ...path.call(printAttrs, "what"),
           path.call(print, "what"),
           "(",
           join(", ", path.map(print, "arguments")),
@@ -2168,6 +2224,10 @@ function printNode(path, options, print) {
                 " ",
               ])
             : "",
+          ...path.call(
+            (pa, opt, pr) => printAttrs(pa, opt, pr, { inline: true }),
+            "what"
+          ),
           "class",
           node.arguments.length > 0
             ? concat([" ", printArgumentsList(path, options, print)])
@@ -2406,9 +2466,8 @@ function printNode(path, options, print) {
     }
     case "constantstatement":
     case "classconstant": {
-      const printed = path.map((childPath) => {
-        return print(childPath);
-      }, "constants");
+      const attrs = printAttrs(path, options, print);
+      const printed = path.map((childPath) => print(childPath), "constants");
 
       let firstVariable;
 
@@ -2421,6 +2480,7 @@ function printNode(path, options, print) {
 
       return group(
         concat([
+          ...attrs,
           node.visibility ? concat([node.visibility, " "]) : "",
           "const",
           firstVariable ? concat([" ", firstVariable]) : "",