@prettier/plugin-php 0.20.0 → 0.20.1

package/README.md

@@ -139,7 +139,7 @@ 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",
 });
@@ -153,10 +153,10 @@ 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],
+await prettier.format(YOUR_CODE, {
+  plugins: [prettierPluginPhp],
   parser: "php",
 });
 ```
@@ -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
 

package/package.json

@@ -1,22 +1,34 @@
 {
   "name": "@prettier/plugin-php",
-  "version": "0.20.0",
+  "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.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.47.0",
@@ -34,13 +46,11 @@
     "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"
+    "strip-ansi": "^7.1.0"
   },
   "peerDependencies": {
     "prettier": "^3.0.0"

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,
@@ -822,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
@@ -838,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");
 
@@ -917,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);
 
@@ -949,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);
 
@@ -991,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);
@@ -1002,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;
       }
@@ -1018,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");
 
@@ -1029,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"],
@@ -81,21 +92,21 @@ const printers = {
     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": {
@@ -138,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 &&
@@ -161,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");

package/src/needs-parens.js

@@ -1,18 +1,14 @@
-"use strict";
-
-const assert = require("assert");
-
-const { getPrecedence, shouldFlatten, isBitwiseOperator } = require("./util");
+import assert from "assert";
+import { getPrecedence, shouldFlatten, isBitwiseOperator } from "./util.js";
 
 function needsParens(path) {
-  const parent = path.getParentNode();
+  const { parent } = path;
 
   if (!parent) {
     return false;
   }
 
-  const name = path.getName();
-  const node = path.getNode();
+  const { key, node } = path;
 
   if (
     [
@@ -56,9 +52,9 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
         case "bin":
-          return parent.type === "**" && name === "left";
+          return parent.type === "**" && key === "left";
         default:
           return false;
       }
@@ -80,7 +76,7 @@ function needsParens(path) {
         case "nullsafepropertylookup":
         case "staticlookup":
         case "offsetlookup":
-          return name === "what" && parent.what === node;
+          return key === "what";
         case "bin": {
           const po = parent.type;
           const pp = getPrecedence(po);
@@ -95,7 +91,7 @@ function needsParens(path) {
             return true;
           }
 
-          if (pp === np && name === "right") {
+          if (pp === np && key === "right") {
             assert.strictEqual(parent.right, node);
 
             return true;
@@ -127,11 +123,7 @@ function needsParens(path) {
     case "staticlookup": {
       switch (parent.kind) {
         case "call":
-          return (
-            name === "what" &&
-            parent.what === node &&
-            node.parenthesizedExpression
-          );
+          return key === "what" && node.parenthesizedExpression;
 
         default:
           return false;
@@ -145,7 +137,7 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
         default:
           return false;
       }
@@ -157,10 +149,10 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         case "retif":
-          return parent.test === node;
+          return key === "test";
 
         default:
           return !!(node.key || node.value);
@@ -195,7 +187,7 @@ function needsParens(path) {
         case "unary":
         case "bin":
         case "retif":
-          if (name === "test" && !parent.trueExpr) {
+          if (key === "test" && !parent.trueExpr) {
             return false;
           }
 
@@ -205,7 +197,7 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         default:
           return false;
@@ -213,7 +205,7 @@ function needsParens(path) {
     case "closure":
       switch (parent.kind) {
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         // https://github.com/prettier/plugin-php/issues/1675
         case "propertylookup":
@@ -243,7 +235,7 @@ function needsParens(path) {
             return false;
           }
 
-          return name === "what" && parent.what === node;
+          return key === "what";
         default:
           return false;
       }
@@ -255,4 +247,4 @@ function needsParens(path) {
   return false;
 }
 
-module.exports = needsParens;
+export default needsParens;

package/src/options.js

@@ -1,8 +1,6 @@
-"use strict";
-
 const CATEGORY_PHP = "PHP";
 
-module.exports = {
+export default {
   phpVersion: {
     since: "0.13.0",
     category: CATEGORY_PHP,

package/src/parser.js

@@ -1,5 +1,4 @@
-"use strict";
-const engine = require("php-parser");
+import engine from "php-parser";
 
 function parse(text, opts) {
   const inMarkdown = opts && opts.parentParser === "markdown";
@@ -61,4 +60,4 @@ function parse(text, opts) {
   return ast;
 }
 
-module.exports = parse;
+export default parse;

package/src/pragma.js

@@ -1,7 +1,5 @@
-"use strict";
-
-const parse = require("./parser");
-const memoize = require("mem");
+import memoize from "mem";
+import parse from "./parser.js";
 
 const reHasPragma = /@prettier|@format/;
 
@@ -91,7 +89,4 @@ function insertPragma(text) {
 ${after}`;
 }
 
-module.exports = {
-  hasPragma,
-  insertPragma,
-};
+export { hasPragma, insertPragma };