@prettier/plugin-php 0.20.0 → 0.21.0

package/README.md

@@ -97,6 +97,16 @@ npm install --save-dev prettier @prettier/plugin-php
 npm install --global prettier @prettier/plugin-php
 ```
 
+### Activate the plugin
+
+Create or modify your [prettier configuration file](https://prettier.io/docs/en/configuration) to activate the plugin:
+
+```json
+{
+  "plugins": ["@prettier/plugin-php"]
+}
+```
+
 ## Use
 
 ### With Node.js
@@ -139,7 +149,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 +163,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 +227,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).
+
+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"]
+}
+```
 
-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.
+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,57 +1,82 @@
 {
   "name": "@prettier/plugin-php",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "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",
-    "codecov": "3.8.3",
+    "@babel/preset-env": "^7.22.14",
+    "@rollup/plugin-alias": "^5.0.0",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^25.0.4",
+    "@rollup/plugin-inject": "^5.0.3",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-terser": "^0.4.3",
+    "c8": "^8.0.1",
     "cross-env": "^7.0.2",
-    "eslint": "8.47.0",
+    "eslint": "8.51.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-import": "2.28.1",
+    "eslint-plugin-jest": "27.4.2",
+    "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-prettier-doc": "^1.1.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",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "jest-light-runner": "^0.5.1",
+    "jest-snapshot-serializer-raw": "^2.0.0",
     "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"
+    "rollup": "^3.28.1",
+    "strip-ansi": "^7.1.0"
   },
   "peerDependencies": {
     "prettier": "^3.0.0"
   },
   "scripts": {
+    "lint": "yarn lint:eslint && yarn lint:prettier",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier . --check",
+    "fix": "yarn fix:eslint && yarn fix:prettier",
+    "fix:eslint": "eslint . --fix",
+    "fix:prettier": "prettier . --write",
     "test": "yarn test:node && yarn test:standalone",
     "test:node": "jest",
-    "test:standalone": "yarn run build-standalone && cross-env RUN_STANDALONE_TESTS=true yarn jest",
+    "test:standalone": "yarn run build && 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",
+    "build": "rollup --config build/rollup.config.js",
     "debug": "node --inspect-brk node_modules/.bin/jest --runInBand"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "all": true,
+    "include": [
+      "src/**"
+    ]
   }
 }

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,6 @@
-"use strict";
+import { util as prettierUtil, doc } from "prettier";
+import { isLookupNode } from "./util.js";
+import { locStart, locEnd } from "./loc.js";
 
 const {
   addLeadingComment,
@@ -7,15 +9,12 @@ const {
   skipNewline,
   hasNewline,
   hasNewlineInRange,
-} = require("prettier").util;
-const { join, indent, hardline, cursor, lineSuffix, breakParent } =
-  require("prettier").doc.builders;
-const {
   getNextNonSpaceNonCommentCharacterIndex,
   isNextLineEmpty,
   isPreviousLineEmpty,
-  isLookupNode,
-} = require("./util");
+} = prettierUtil;
+const { join, indent, hardline, cursor, lineSuffix, breakParent } =
+  doc.builders;
 
 /*
 Comment functions are meant to inspect various edge cases using given comment nodes,
@@ -274,13 +273,12 @@ function handleLastFunctionArgComments(
   precedingNode,
   enclosingNode,
   followingNode,
-  comment,
-  options
+  comment
+  /* options */
 ) {
   const nextCharIndex = getNextNonSpaceNonCommentCharacterIndex(
     text,
-    comment,
-    options
+    locEnd(comment)
   );
   const nextCharacter = text.charAt(nextCharIndex);
 
@@ -329,8 +327,8 @@ function handleIfStatementComments(
   precedingNode,
   enclosingNode,
   followingNode,
-  comment,
-  options
+  comment
+  /* options */
 ) {
   if (!enclosingNode || enclosingNode.kind !== "if" || !followingNode) {
     return false;
@@ -338,8 +336,7 @@ function handleIfStatementComments(
 
   const nextCharIndex = getNextNonSpaceNonCommentCharacterIndex(
     text,
-    comment,
-    options
+    locEnd(comment)
   );
   const nextCharacter = text.charAt(nextCharIndex);
 
@@ -380,16 +377,12 @@ function handleRetifComments(
   precedingNode,
   followingNode,
   comment,
-  text,
-  options
+  text
+  /* options */
 ) {
   const isSameLineAsPrecedingNode =
     precedingNode &&
-    !hasNewlineInRange(
-      text,
-      options.locEnd(precedingNode),
-      options.locStart(comment)
-    );
+    !hasNewlineInRange(text, locEnd(precedingNode), locStart(comment));
 
   if (
     (!precedingNode || !isSameLineAsPrecedingNode) &&
@@ -507,7 +500,13 @@ function handleClassComments(enclosingNode, followingNode, comment) {
   return false;
 }
 
-function handleFunction(text, enclosingNode, followingNode, comment, options) {
+function handleFunction(
+  text,
+  enclosingNode,
+  followingNode,
+  comment
+  /* options */
+) {
   if (
     enclosingNode &&
     (enclosingNode.kind === "function" || enclosingNode.kind === "method")
@@ -518,18 +517,17 @@ function handleFunction(text, enclosingNode, followingNode, comment, options) {
     let argumentsLocEnd = 0;
     for (let i = 0; i < enclosingNode.arguments.length; i++) {
       argumentsLocEnd =
-        options.locEnd(enclosingNode.arguments[i]) > argumentsLocEnd
-          ? options.locEnd(enclosingNode.arguments[i])
+        locEnd(enclosingNode.arguments[i]) > argumentsLocEnd
+          ? locEnd(enclosingNode.arguments[i])
           : argumentsLocEnd;
     }
     const commentIsBetweenArgumentsAndBody =
       enclosingNode.body &&
-      options.locStart(comment) > argumentsLocEnd &&
-      options.locEnd(comment) < options.locStart(enclosingNode.body);
+      locStart(comment) > argumentsLocEnd &&
+      locEnd(comment) < locStart(enclosingNode.body);
     const nextCharIndex = getNextNonSpaceNonCommentCharacterIndex(
       text,
-      comment,
-      options
+      locEnd(comment)
     );
     // we additionally need to check if this isn't a trailing argument comment,
     // by checking the next character isn't ")"
@@ -538,7 +536,7 @@ function handleFunction(text, enclosingNode, followingNode, comment, options) {
       commentIsBetweenArgumentsAndBody &&
       text.charAt(nextCharIndex) !== ")"
     ) {
-      if (options.locEnd(comment) < options.locStart(enclosingNode.type)) {
+      if (locEnd(comment) < locStart(enclosingNode.type)) {
         // we need to store this as a dangling comment in case the type is nullable
         // ie function(): ?string {} - the "nullable" attribute is part of the
         // function node, not the type.
@@ -609,11 +607,15 @@ function handleHalt(precedingNode, enclosingNode, followingNode, comment) {
   return false;
 }
 
-function handleCommentInEmptyParens(text, enclosingNode, comment, options) {
+function handleCommentInEmptyParens(
+  text,
+  enclosingNode,
+  comment
+  /* options */
+) {
   const nextCharIndex = getNextNonSpaceNonCommentCharacterIndex(
     text,
-    comment,
-    options
+    locEnd(comment)
   );
 
   if (text.charAt(nextCharIndex) !== ")") {
@@ -790,8 +792,8 @@ function handleWhileComments(
   precedingNode,
   enclosingNode,
   followingNode,
-  comment,
-  options
+  comment
+  /* options */
 ) {
   if (!enclosingNode || enclosingNode.kind !== "while" || !followingNode) {
     return false;
@@ -804,8 +806,7 @@ function handleWhileComments(
 
   const nextCharIndex = getNextNonSpaceNonCommentCharacterIndex(
     text,
-    comment,
-    options
+    locEnd(comment)
   );
   const nextCharacter = text.charAt(nextCharIndex);
 
@@ -822,11 +823,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 +839,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");
 
@@ -868,11 +869,11 @@ function hasTrailingComment(node) {
   return node.comments && node.comments.some((comment) => comment.trailing);
 }
 
-function hasLeadingOwnLineComment(text, node, options) {
+function hasLeadingOwnLineComment(text, node) {
   return (
     node.comments &&
     node.comments.some(
-      (comment) => comment.leading && hasNewline(text, options.locEnd(comment))
+      (comment) => comment.leading && hasNewline(text, locEnd(comment))
     )
   );
 }
@@ -887,7 +888,7 @@ function printComments(comments, options) {
       parts.push(hardline);
     }
     if (
-      isNextLineEmpty(options.originalText, comment, options) &&
+      isNextLineEmpty(options.originalText, locEnd(comment)) &&
       !isLastComment
     ) {
       parts.push(hardline);
@@ -917,21 +918,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);
 
@@ -940,26 +942,25 @@ function printLeadingComment(commentPath, print, options) {
   if (isBlock) {
     return [
       contents,
-      hasNewline(options.originalText, options.locEnd(comment))
-        ? hardline
-        : " ",
+      hasNewline(options.originalText, locEnd(comment)) ? hardline : " ",
     ];
   }
 
   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);
 
   if (
-    hasNewline(options.originalText, options.locStart(comment), {
+    hasNewline(options.originalText, locStart(comment), {
       backwards: true,
     })
   ) {
@@ -977,8 +978,7 @@ function printTrailingComment(commentPath, print, options) {
 
     const isLineBeforeEmpty = isPreviousLineEmpty(
       options.originalText,
-      comment,
-      options
+      locStart(comment)
     );
 
     return lineSuffix([hardline, isLineBeforeEmpty ? hardline : "", contents]);
@@ -991,9 +991,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,23 +1002,22 @@ 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;
       }
       leadingParts.push(contents);
 
       const text = options.originalText;
-      if (hasNewline(text, skipNewline(text, options.locEnd(comment)))) {
+      if (hasNewline(text, skipNewline(text, locEnd(comment)))) {
         leadingParts.push(hardline);
       }
     } else if (trailing) {
-      trailingParts.push(printTrailingComment(commentPath, print, options));
+      trailingParts.push(printTrailingComment(path, print, options));
     }
   }, "comments");
 
@@ -1029,7 +1028,7 @@ function printAllComments(path, print, options, needsSemi) {
   );
 }
 
-module.exports = {
+export {
   handleOwnLineComment,
   handleEndOfLineComment,
   handleRemainingComment,