@prettier/plugin-php 0.19.7 → 0.20.1

package/README.md

@@ -139,9 +139,9 @@ First, grab both standalone scripts from an npm CDN like [unpkg](https://unpkg.c
 Then use Prettier with PHP, just like this:
 
 ```js
-prettier.format(YOUR_CODE, {
+await prettier.format(YOUR_CODE, {
   plugins: prettierPlugins,
-  parser: "php"
+  parser: "php",
 });
 ```
 
@@ -153,11 +153,11 @@ Bundlers like webpack, Rollup or browserify automatically recognize how to handl
 
 ```js
 import prettier from "prettier/standalone";
-import phpPlugin from "@prettier/plugin-php/standalone";
+import * as prettierPluginPhp from "@prettier/plugin-php/standalone";
 
-prettier.format(YOUR_CODE, {
-  plugins: [phpPlugin],
-  parser: "php"
+await prettier.format(YOUR_CODE, {
+  plugins: [prettierPluginPhp],
+  parser: "php",
 });
 ```
 
@@ -165,17 +165,17 @@ prettier.format(YOUR_CODE, {
 
 Prettier for PHP supports the following options. We recommend that all users set the `phpVersion` option.
 
-| Name               | Default    | Description                                                                                                                                                                                                                                                                          |
-| ------------------ |------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Name               | Default    | Description                                                                                                                                                                                                                                                                            |
+| ------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `phpVersion`       | `"7.0"`    | Allows specifying the PHP version you're using. If you're using PHP 7.1 or later, setting this option will make use of modern language features in the printed output. If you're using PHP lower than 7.0, you'll have to set this option or Prettier will generate incompatible code. |
-| `printWidth`       | `80`       | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width))                                                                                                                                                                                      |
-| `tabWidth`         | `4`        | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)), The default is `4` based on the `PSR-2` coding standard.                                                                                                                              |
-| `useTabs`          | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tabs))                                                                                                                                                                                             |
-| `singleQuote`      | `false`    | If set to `"true"`, strings that use double quotes but do not rely on the features they add, will be reformatted. Example: `"foo" -> 'foo'`, `"foo $bar" -> "foo $bar"`.                                                                                                             |
-| `trailingCommaPHP` | `true`     | If set to `true`, trailing commas will be added wherever possible. <br> If set to `false`, no trailing commas are printed.                                                                                                                                                           |
-| `braceStyle`       | `"per-cs"` | If set to `"per-cs"`, prettier will move open brace for code blocks (classes, functions and methods) onto new line. <br> If set to `"1tbs"`, prettier will move open brace for code blocks (classes, functions and methods) onto same line.                                           |
-| `requirePragma`    | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma))                                                                                                                                                                                   |
-| `insertPragma`     | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#insert-pragma))                                                                                                                                                                                    |
+| `printWidth`       | `80`       | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width))                                                                                                                                                                                        |
+| `tabWidth`         | `4`        | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)), The default is `4` based on the `PSR-2` coding standard.                                                                                                                                |
+| `useTabs`          | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tabs))                                                                                                                                                                                               |
+| `singleQuote`      | `false`    | If set to `"true"`, strings that use double quotes but do not rely on the features they add, will be reformatted. Example: `"foo" -> 'foo'`, `"foo $bar" -> "foo $bar"`.                                                                                                               |
+| `trailingCommaPHP` | `true`     | If set to `true`, trailing commas will be added wherever possible. <br> If set to `false`, no trailing commas are printed.                                                                                                                                                             |
+| `braceStyle`       | `"per-cs"` | If set to `"per-cs"`, prettier will move open brace for code blocks (classes, functions and methods) onto new line. <br> If set to `"1tbs"`, prettier will move open brace for code blocks (classes, functions and methods) onto same line.                                            |
+| `requirePragma`    | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma))                                                                                                                                                                                     |
+| `insertPragma`     | `false`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#insert-pragma))                                                                                                                                                                                      |
 
 ## Ignoring code
 
@@ -217,9 +217,28 @@ matrix(
 
 The official [prettier plugin for atom](https://github.com/prettier/prettier-atom) supports plugins.
 
-### VScode
+### Visual Studio Code
 
-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.
+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).
+
+Visual Studio Code may not recognise the document selectors provided by this plugin, and so you can add php to your document selectors by adding the following line to `.vscode/settings.json`:
+
+```json
+  "prettier.documentSelectors": [
+    "**/*.{js,jsx,ts,tsx,vue,html,css,scss,less,json,md,mdx,graphql,yaml,yml,php}"
+  ]
+```
+
+You may also need to declare php as the parser in your prettier config file:
+
+```json
+{
+  "parser": "php",
+  "plugins": ["@prettier/plugin-php"],
+}
+```
+
+See (this issue)[https://github.com/prettier/plugin-php/issues/1730] for more discussion around potential VS Code solutions.
 
 ### PhpStorm / IntelliJ / Jetbrains IDE
 
@@ -232,7 +251,7 @@ The official [prettier plugin for vscode](https://github.com/prettier/prettier-v
 - 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, 
+_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

package/package.json

@@ -1,54 +1,66 @@
 {
   "name": "@prettier/plugin-php",
-  "version": "0.19.7",
+  "version": "0.20.1",
   "description": "Prettier PHP Plugin",
   "repository": "prettier/prettier-php",
   "author": "Lucas Azzola <@azz>",
   "license": "MIT",
-  "main": "src",
+  "type": "module",
+  "unpkg": "./standalone.js",
+  "browser": "./standalone.js",
+  "exports": {
+    ".": {
+      "browser": "./standalone.js",
+      "default": "./src/index.js"
+    },
+    "./standalone": "./standalone.js",
+    "./package.json": "./package.json"
+  },
   "files": [
     "src",
     "standalone.js"
   ],
   "dependencies": {
     "linguist-languages": "^7.21.0",
-    "mem": "^8.0.0",
+    "mem": "^9.0.2",
     "php-parser": "^3.1.5"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.19.4",
+    "@babel/preset-env": "^7.22.10",
+    "@rollup/plugin-commonjs": "^25.0.4",
+    "@rollup/plugin-node-resolve": "^15.1.0",
     "codecov": "3.8.3",
     "cross-env": "^7.0.2",
-    "eslint": "8.42.0",
-    "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-prettier": "4.2.1",
+    "eslint": "8.47.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-import": "2.28.0",
+    "eslint-plugin-jest": "27.2.3",
+    "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-prettier-doc": "^1.1.0",
-    "jest": "29.5.0",
-    "jest-environment-jsdom": "29.5.0",
+    "jest": "29.6.2",
+    "jest-environment-jsdom": "29.6.2",
+    "jest-light-runner": "^0.5.0",
     "jest-runner-eslint": "2.1.0",
     "jest-snapshot-serializer-raw": "^1.1.0",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.1",
     "rollup": "^2.75.7",
     "rollup-plugin-alias": "^2.0.0",
     "rollup-plugin-babel": "^4.3.2",
-    "rollup-plugin-commonjs": "^10.0.2",
     "rollup-plugin-inject": "^3.0.1",
     "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-replace": "^2.1.0",
     "rollup-plugin-terser": "^7.0.2",
-    "strip-ansi": "^6.0.0",
-    "yarpm": "^1.1.1"
+    "strip-ansi": "^7.1.0"
   },
   "peerDependencies": {
-    "prettier": "^1.15.0 || ^2.0.0"
+    "prettier": "^3.0.0"
   },
   "scripts": {
-    "test": "jest",
-    "prepublishOnly": "yarpm run build-standalone && cross-env RUN_STANDALONE_TESTS=true yarpm test",
-    "prettier": "prettier --plugin=. --parser=php",
+    "test": "yarn test:node && yarn test:standalone",
+    "test:node": "jest",
+    "test:standalone": "yarn run build-standalone && cross-env RUN_STANDALONE_TESTS=true yarn jest",
+    "prepublishOnly": "yarn test",
+    "prettier": "prettier --plugin=src/index.js --parser=php",
     "build-standalone": "rollup -c build/rollup.config.js",
     "debug": "node --inspect-brk node_modules/.bin/jest --runInBand"
   }

package/src/clean.js

@@ -1,6 +1,4 @@
-"use strict";
-
-const util = require("./util");
+import { printNumber, normalizeMagicMethodName } from "./util.js";
 
 const ignoredProperties = new Set([
   "loc",
@@ -28,7 +26,7 @@ const ignoredProperties = new Set([
 function clean(node, newObj) {
   if (node.kind === "string") {
     // TODO if options are available in this method, replace with
-    // newObj.isDoubleQuote = !util.useSingleQuote(node, options);
+    // newObj.isDoubleQuote = !useSingleQuote(node, options);
     delete newObj.isDoubleQuote;
   }
 
@@ -66,7 +64,7 @@ function clean(node, newObj) {
 
   // Normalize numbers
   if (node.kind === "number") {
-    newObj.value = util.printNumber(node.value);
+    newObj.value = printNumber(node.value);
   }
 
   const statements = ["foreach", "for", "if", "while", "do"];
@@ -100,7 +98,7 @@ function clean(node, newObj) {
   }
 
   if (node.kind === "method" && node.name.kind === "identifier") {
-    newObj.name.name = util.normalizeMagicMethodName(newObj.name.name);
+    newObj.name.name = normalizeMagicMethodName(newObj.name.name);
   }
 
   if (node.kind === "noop") {
@@ -110,4 +108,4 @@ function clean(node, newObj) {
 
 clean.ignoredProperties = ignoredProperties;
 
-module.exports = clean;
+export default clean;

package/src/comments.js

@@ -1,4 +1,10 @@
-"use strict";
+import { util as prettierUtil, doc } from "prettier";
+import {
+  getNextNonSpaceNonCommentCharacterIndex,
+  isNextLineEmpty,
+  isPreviousLineEmpty,
+  isLookupNode,
+} from "./util.js";
 
 const {
   addLeadingComment,
@@ -7,15 +13,9 @@ const {
   skipNewline,
   hasNewline,
   hasNewlineInRange,
-} = require("prettier").util;
+} = prettierUtil;
 const { join, indent, hardline, cursor, lineSuffix, breakParent } =
-  require("prettier").doc.builders;
-const {
-  getNextNonSpaceNonCommentCharacterIndex,
-  isNextLineEmpty,
-  isPreviousLineEmpty,
-  isLookupNode,
-} = require("./util");
+  doc.builders;
 
 /*
 Comment functions are meant to inspect various edge cases using given comment nodes,
@@ -445,6 +445,10 @@ function handleClassComments(enclosingNode, followingNode, comment) {
     enclosingNode &&
     ["class", "interface", "trait"].includes(enclosingNode.kind)
   ) {
+    if (enclosingNode.__parent_new_arguments?.includes(followingNode)) {
+      return false;
+    }
+
     // for extends nodes that have leading comments, we can store them as
     // dangling comments so we can handle them in the printer
 
@@ -818,11 +822,11 @@ function handleWhileComments(
   return false;
 }
 
-// https://github.com/prettier/prettier/blob/master/src/main/comments.js#L335
-function printComment(commentPath, options) {
-  const comment = commentPath.getValue();
+// https://github.com/prettier/prettier/blob/c01661f311a2e1e033f1f9cb127882cc13e293bd/src/main/comments/print.js#L23
+function printComment(path, options) {
+  const comment = path.node;
   comment.printed = true;
-  return options.printer.printComment(commentPath, options);
+  return options.printer.printComment(path, options);
 }
 
 // https://github.com/prettier/prettier/blob/master/src/main/comments.js#L440
@@ -834,15 +838,15 @@ function printDanglingComments(path, options, sameIndent, filter) {
     return "";
   }
 
-  path.each((commentPath) => {
-    const comment = commentPath.getValue();
+  path.each(() => {
+    const comment = path.node;
     if (
       comment &&
       !comment.leading &&
       !comment.trailing &&
       (!filter || filter(comment))
     ) {
-      parts.push(printComment(commentPath, options));
+      parts.push(printComment(path, options));
     }
   }, "comments");
 
@@ -897,27 +901,11 @@ function isBlockComment(comment) {
 }
 
 function getCommentChildNodes(node) {
-  if (typeof node !== "object") {
-    return [];
+  if (node.kind === "new" && node.what.kind === "class") {
+    // Pretend to be child of `class`
+    node.what.__parent_new_arguments = [...node.arguments];
+    return [node.what];
   }
-
-  const getChildNodes = (node) =>
-    Object.keys(node)
-      .filter(
-        (n) =>
-          n !== "kind" &&
-          n !== "loc" &&
-          n !== "errors" &&
-          n !== "extra" &&
-          n !== "comments" &&
-          n !== "leadingComments" &&
-          n !== "enclosingNode" &&
-          n !== "precedingNode" &&
-          n !== "followingNode"
-      )
-      .map((n) => node[n]);
-
-  return getChildNodes(node);
 }
 
 function canAttachComment(node) {
@@ -929,21 +917,22 @@ function canAttachComment(node) {
 // Based on https://github.com/prettier/prettier/blob/master/src/main/comments.js
 // TODO remove after https://github.com/prettier/prettier/issues/5087
 function prependCursorPlaceholder(path, options, printed) {
-  if (path.getNode() === options.cursorNode && path.getValue()) {
+  const { node } = path;
+  if (node && node === options.cursorNode) {
     return [cursor, printed, cursor];
   }
 
   return printed;
 }
 
-function printLeadingComment(commentPath, print, options) {
-  const comment = commentPath.getValue();
-  const contents = printComment(commentPath, options);
+function printLeadingComment(path, print, options) {
+  const contents = printComment(path, options);
 
   if (!contents) {
     return "";
   }
 
+  const comment = path.node;
   const isBlock =
     options.printer.isBlockComment && options.printer.isBlockComment(comment);
 
@@ -961,12 +950,13 @@ function printLeadingComment(commentPath, print, options) {
   return [contents, hardline];
 }
 
-function printTrailingComment(commentPath, print, options) {
-  const comment = commentPath.getValue();
-  const contents = printComment(commentPath, options);
+function printTrailingComment(path, print, options) {
+  const contents = printComment(path, options);
   if (!contents) {
     return "";
   }
+
+  const comment = path.node;
   const isBlock =
     options.printer.isBlockComment && options.printer.isBlockComment(comment);
 
@@ -1003,9 +993,9 @@ function printTrailingComment(commentPath, print, options) {
 }
 
 function printAllComments(path, print, options, needsSemi) {
-  const value = path.getValue();
+  const { node } = path;
   const printed = print(path);
-  const comments = value && value.comments;
+  const comments = node && node.comments;
 
   if (!comments || comments.length === 0) {
     return prependCursorPlaceholder(path, options, printed);
@@ -1014,12 +1004,11 @@ function printAllComments(path, print, options, needsSemi) {
   const leadingParts = [];
   const trailingParts = [needsSemi ? ";" : "", printed];
 
-  path.each((commentPath) => {
-    const comment = commentPath.getValue();
+  path.each(({ node: comment }) => {
     const { leading, trailing } = comment;
 
     if (leading) {
-      const contents = printLeadingComment(commentPath, print, options);
+      const contents = printLeadingComment(path, print, options);
       if (!contents) {
         return;
       }
@@ -1030,7 +1019,7 @@ function printAllComments(path, print, options, needsSemi) {
         leadingParts.push(hardline);
       }
     } else if (trailing) {
-      trailingParts.push(printTrailingComment(commentPath, print, options));
+      trailingParts.push(printTrailingComment(path, print, options));
     }
   }, "comments");
 
@@ -1041,7 +1030,7 @@ function printAllComments(path, print, options, needsSemi) {
   );
 }
 
-module.exports = {
+export {
   handleOwnLineComment,
   handleEndOfLineComment,
   handleRemainingComment,

package/src/index.js

@@ -1,12 +1,23 @@
-"use strict";
-
-const parse = require("./parser");
-const print = require("./printer");
-const clean = require("./clean");
-const options = require("./options");
-const comments = require("./comments");
-const { join, hardline } = require("prettier").doc.builders;
-const { hasPragma, insertPragma } = require("./pragma");
+import { doc } from "prettier";
+import {
+  LINGUIST_LANGUAGES_PHP,
+  LINGUIST_LANGUAGES_HTML_PHP,
+} from "./linguist-languages.cjs";
+import parse from "./parser.js";
+import print from "./printer.js";
+import clean from "./clean.js";
+import options from "./options.js";
+import {
+  handleOwnLineComment,
+  handleEndOfLineComment,
+  handleRemainingComment,
+  getCommentChildNodes,
+  canAttachComment,
+  isBlockComment,
+} from "./comments.js";
+import { hasPragma, insertPragma } from "./pragma.js";
+
+const { join, hardline } = doc.builders;
 
 function createLanguage(linguistData, { extend, override }) {
   const language = {};
@@ -30,13 +41,13 @@ function createLanguage(linguistData, { extend, override }) {
 }
 
 const languages = [
-  createLanguage(require("linguist-languages/data/PHP"), {
+  createLanguage(LINGUIST_LANGUAGES_PHP, {
     override: {
       parsers: ["php"],
       vscodeLanguageIds: ["php"],
     },
   }),
-  createLanguage(require("linguist-languages/data/HTML+PHP"), {
+  createLanguage(LINGUIST_LANGUAGES_HTML_PHP, {
     override: {
       parsers: ["php"],
       vscodeLanguageIds: ["php"],
@@ -58,26 +69,44 @@ const parsers = {
   },
 };
 
+const ignoredKeys = new Set([
+  "kind",
+  "loc",
+  "errors",
+  "extra",
+  "comments",
+  "leadingComments",
+  "enclosingNode",
+  "precedingNode",
+  "followingNode",
+]);
+function getVisitorKeys(node, nonTraversableKeys) {
+  return Object.keys(node).filter(
+    (key) => !nonTraversableKeys.has(key) && !ignoredKeys.has(key)
+  );
+}
+
 const printers = {
   php: {
     print,
+    getVisitorKeys,
     insertPragma,
     massageAstNode: clean,
-    getCommentChildNodes: comments.getCommentChildNodes,
-    canAttachComment: comments.canAttachComment,
-    isBlockComment: comments.isBlockComment,
+    getCommentChildNodes,
+    canAttachComment,
+    isBlockComment,
     handleComments: {
-      ownLine: comments.handleOwnLineComment,
-      endOfLine: comments.handleEndOfLineComment,
-      remaining: comments.handleRemainingComment,
+      ownLine: handleOwnLineComment,
+      endOfLine: handleEndOfLineComment,
+      remaining: handleRemainingComment,
     },
     willPrintOwnComments(path) {
-      const node = path.getValue();
+      const { node } = path;
 
       return node && node.kind === "noop";
     },
-    printComment(commentPath) {
-      const comment = commentPath.getValue();
+    printComment(path) {
+      const comment = path.node;
 
       switch (comment.kind) {
         case "commentblock": {
@@ -120,8 +149,7 @@ const printers = {
         !comment.value.includes("prettier-ignore-start") &&
         !comment.value.includes("prettier-ignore-end");
 
-      const parentNode = path.getParentNode();
-      const node = path.getNode();
+      const { node, parent: parentNode } = path;
 
       return (
         (node &&
@@ -143,12 +171,8 @@ const printers = {
   },
 };
 
-module.exports = {
-  languages,
-  printers,
-  parsers,
-  options,
-  defaultOptions: {
-    tabWidth: 4,
-  },
+const defaultOptions = {
+  tabWidth: 4,
 };
+
+export { languages, printers, parsers, options, defaultOptions };

package/src/linguist-languages.cjs

@@ -0,0 +1,4 @@
+"use strict";
+
+module.exports.LINGUIST_LANGUAGES_PHP = require("linguist-languages/data/PHP");
+module.exports.LINGUIST_LANGUAGES_HTML_PHP = require("linguist-languages/data/HTML+PHP");