@prettier/plugin-php 0.20.1 → 0.22.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
@@ -234,7 +244,7 @@ You may also need to declare php as the parser in your prettier config file:
 ```json
 {
   "parser": "php",
-  "plugins": ["@prettier/plugin-php"],
+  "plugins": ["@prettier/plugin-php"]
 }
 ```
 

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@prettier/plugin-php",
-  "version": "0.20.1",
+  "version": "0.22.0",
   "description": "Prettier PHP Plugin",
   "repository": "prettier/prettier-php",
   "author": "Lucas Azzola <@azz>",
   "license": "MIT",
-  "type": "module",
   "unpkg": "./standalone.js",
   "browser": "./standalone.js",
   "exports": {
@@ -21,47 +20,62 @@
     "standalone.js"
   ],
   "dependencies": {
-    "linguist-languages": "^7.21.0",
+    "linguist-languages": "^7.27.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",
+    "@babel/preset-env": "^7.23.6",
+    "@rollup/plugin-alias": "^5.1.0",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-terser": "^0.4.3",
+    "c8": "^8.0.1",
     "cross-env": "^7.0.2",
-    "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": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jest": "27.6.0",
+    "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.6.0",
+    "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-inject": "^3.0.1",
-    "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-replace": "^2.1.0",
-    "rollup-plugin-terser": "^7.0.2",
+    "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",
+    "prettier": "prettier --plugin=src/index.mjs --parser=php",
+    "build": "rollup --config build/rollup.config.mjs",
     "debug": "node --inspect-brk node_modules/.bin/jest --runInBand"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "all": true,
+    "include": [
+      "src/**"
+    ]
   }
 }

package/src/{clean.js → clean.mjs}

@@ -1,4 +1,4 @@
-import { printNumber, normalizeMagicMethodName } from "./util.js";
+import { printNumber, normalizeMagicMethodName } from "./util.mjs";
 
 const ignoredProperties = new Set([
   "loc",

package/src/{comments.js → comments.mjs}

@@ -1,10 +1,6 @@
 import { util as prettierUtil, doc } from "prettier";
-import {
-  getNextNonSpaceNonCommentCharacterIndex,
-  isNextLineEmpty,
-  isPreviousLineEmpty,
-  isLookupNode,
-} from "./util.js";
+import { isLookupNode } from "./util.mjs";
+import { locStart, locEnd } from "./loc.mjs";
 
 const {
   addLeadingComment,
@@ -13,6 +9,9 @@ const {
   skipNewline,
   hasNewline,
   hasNewlineInRange,
+  getNextNonSpaceNonCommentCharacterIndex,
+  isNextLineEmpty,
+  isPreviousLineEmpty,
 } = prettierUtil;
 const { join, indent, hardline, cursor, lineSuffix, breakParent } =
   doc.builders;
@@ -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);
 
@@ -829,7 +830,7 @@ function printComment(path, options) {
   return options.printer.printComment(path, options);
 }
 
-// https://github.com/prettier/prettier/blob/master/src/main/comments.js#L440
+// https://github.com/prettier/prettier/blob/6bff776efd0951b7812818d02d1cae3fda184737/src/main/comments/print.js#L119
 function printDanglingComments(path, options, sameIndent, filter) {
   const parts = [];
   const node = path.getValue();
@@ -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);
@@ -941,9 +942,7 @@ function printLeadingComment(path, print, options) {
   if (isBlock) {
     return [
       contents,
-      hasNewline(options.originalText, options.locEnd(comment))
-        ? hardline
-        : " ",
+      hasNewline(options.originalText, locEnd(comment)) ? hardline : " ",
     ];
   }
 
@@ -961,7 +960,7 @@ function printTrailingComment(path, print, options) {
     options.printer.isBlockComment && options.printer.isBlockComment(comment);
 
   if (
-    hasNewline(options.originalText, options.locStart(comment), {
+    hasNewline(options.originalText, locStart(comment), {
       backwards: true,
     })
   ) {
@@ -979,8 +978,7 @@ function printTrailingComment(path, print, options) {
 
     const isLineBeforeEmpty = isPreviousLineEmpty(
       options.originalText,
-      comment,
-      options
+      locStart(comment)
     );
 
     return lineSuffix([hardline, isLineBeforeEmpty ? hardline : "", contents]);
@@ -1015,7 +1013,7 @@ function printAllComments(path, print, options, needsSemi) {
       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) {

package/src/{index.js → index.mjs}

@@ -3,10 +3,10 @@ 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 parse from "./parser.mjs";
+import print from "./printer.mjs";
+import clean from "./clean.mjs";
+import options from "./options.mjs";
 import {
   handleOwnLineComment,
   handleEndOfLineComment,
@@ -14,8 +14,9 @@ import {
   getCommentChildNodes,
   canAttachComment,
   isBlockComment,
-} from "./comments.js";
-import { hasPragma, insertPragma } from "./pragma.js";
+} from "./comments.mjs";
+import { hasPragma, insertPragma } from "./pragma.mjs";
+import { locStart, locEnd } from "./loc.mjs";
 
 const { join, hardline } = doc.builders;
 
@@ -55,16 +56,12 @@ const languages = [
   }),
 ];
 
-const loc = (prop) => (node) => {
-  return node.loc && node.loc[prop] && node.loc[prop].offset;
-};
-
 const parsers = {
   php: {
     parse,
     astFormat: "php",
-    locStart: loc("start"),
-    locEnd: loc("end"),
+    locStart,
+    locEnd,
     hasPragma,
   },
 };
@@ -138,7 +135,7 @@ const printers = {
         case "commentline": {
           return comment.value.trimRight();
         }
-        /* istanbul ignore next */
+        /* c8 ignore next 2 */
         default:
           throw new Error(`Not a comment: ${JSON.stringify(comment)}`);
       }

package/src/linguist-languages.cjs

@@ -1,4 +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");
+"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/loc.mjs

@@ -0,0 +1,4 @@
+const loc = (prop) => (node) => node.loc?.[prop]?.offset;
+
+export const locStart = loc("start");
+export const locEnd = loc("end");

package/src/{needs-parens.js → needs-parens.mjs}

@@ -1,5 +1,4 @@
-import assert from "assert";
-import { getPrecedence, shouldFlatten, isBitwiseOperator } from "./util.js";
+import { getPrecedence, shouldFlatten, isBitwiseOperator } from "./util.mjs";
 
 function needsParens(path) {
   const { parent } = path;
@@ -92,8 +91,6 @@ function needsParens(path) {
           }
 
           if (pp === np && key === "right") {
-            assert.strictEqual(parent.right, node);
-
             return true;
           }
 

package/src/{pragma.js → pragma.mjs}

@@ -1,5 +1,5 @@
 import memoize from "mem";
-import parse from "./parser.js";
+import parse from "./parser.mjs";
 
 const reHasPragma = /@prettier|@format/;