feat: upgrade to prettier 3 (#2200)

* feat: upgrade to prettier 3 (wip)

* fix: array tests (and potentially more?)

* fix: use getVisitorKeys instead of getCommentChildNodes

* fix: tests

* Move `getVisitorKeys` to correct location

* Workaround

* Use `jest-light-runner`

* Run test on Windows

---------

Co-authored-by: fisker <lionkay@gmail.com>

Author: czosel

.eslintrc.yml

@@ -4,6 +4,8 @@ extends:
   - plugin:prettier/recommended
   - plugin:jest/recommended
   - plugin:prettier-doc/recommended
+parserOptions:
+  ecmaVersion: 2023
 plugins:
   - import
 root: true

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

.github/workflows/nodejs.yml

@@ -8,8 +8,8 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        node-version: [14.x, 16.x, 18.x]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [14.x, 16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v1

.prettierrc.yml

@@ -0,0 +1 @@
+trailingComma: "es5"

CONTRIBUTING.md

@@ -15,9 +15,9 @@ yarn test tests/{folder of your choice}
 
 Here's what you need to know about the tests:
 
-* The tests use [Jest](https://facebook.github.io/jest/) snapshots.
-* You can make changes and run `jest -u` (or `yarn test -u`) to update the snapshots. Then run `git diff` to take a look at what changed. Always update the snapshots when opening a PR.
-* You can run `AST_COMPARE=1 yarn test` for a more robust test run. That formats each file, re-parses it, and compares the new AST with the original one and makes sure they are semantically equivalent.
+- The tests use [Jest](https://facebook.github.io/jest/) snapshots.
+- You can make changes and run `jest -u` (or `yarn test -u`) to update the snapshots. Then run `git diff` to take a look at what changed. Always update the snapshots when opening a PR.
+- You can run `AST_COMPARE=1 yarn test` for a more robust test run. That formats each file, re-parses it, and compares the new AST with the original one and makes sure they are semantically equivalent.
 
 Run `yarn lint --fix` to automatically format files.
 
@@ -31,16 +31,14 @@ Add the following configuration to `.vscode/launch.json`:
 
 ```json
 {
-    "type": "node",
-    "request": "launch",
-    "name": "Prettify test.php",
-    "skipFiles": [
-        "<node_internals>/**"
-    ],
-    "program": "${workspaceRoot}/node_modules/.bin/prettier",
-    "args": ["--plugin=.", "--parser=php", "test.php"],
-    "cwd": "${workspaceRoot}",
-    "outputCapture": "std"
+  "type": "node",
+  "request": "launch",
+  "name": "Prettify test.php",
+  "skipFiles": ["<node_internals>/**"],
+  "program": "${workspaceRoot}/node_modules/.bin/prettier",
+  "args": ["--plugin=.", "--parser=php", "test.php"],
+  "cwd": "${workspaceRoot}",
+  "outputCapture": "std"
 }
 ```
 

README.md

@@ -141,7 +141,7 @@ Then use Prettier with PHP, just like this:
 ```js
 prettier.format(YOUR_CODE, {
   plugins: prettierPlugins,
-  parser: "php"
+  parser: "php",
 });
 ```
 
@@ -157,25 +157,25 @@ import phpPlugin from "@prettier/plugin-php/standalone";
 
 prettier.format(YOUR_CODE, {
   plugins: [phpPlugin],
-  parser: "php"
+  parser: "php",
 });
 ```
 
 ## Configuration
 
 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
 
@@ -232,7 +232,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

docs/recipes/php-cs-fixer/README.md

@@ -1,31 +1,34 @@
 # Prettier integration to php-cs-fixer
 
-  This recipe uses `prettier/plugin-php` as a Fixer for `php-cs-fixer`.
+This recipe uses `prettier/plugin-php` as a Fixer for `php-cs-fixer`.
 
-  `prettier` will be executed at the very beginning before the other fixers are
-  applied, such that the `php-cs-fixer` user's configurations is respected.
+`prettier` will be executed at the very beginning before the other fixers are
+applied, such that the `php-cs-fixer` user's configurations is respected.
 
 ## Useful Configurations
 
 ### Priority
 
-  If you would like `prettier` to execute last, which means you prefer to use
-  `php-cs-fixer` to complement the current missing features of `prettier`, you
-  can decrease the priority value of this fixer by decreasing the value returned
-  by `getPriority` function to something like `-999`
+If you would like `prettier` to execute last, which means you prefer to use
+`php-cs-fixer` to complement the current missing features of `prettier`, you
+can decrease the priority value of this fixer by decreasing the value returned
+by `getPriority` function to something like `-999`
 
 ### Configure Prettier's setting
 
-   If you would like to add configuration settings for `prettier` to this Fixer,
-   you can modify the `exec` line in `applyFix` function.
+If you would like to add configuration settings for `prettier` to this Fixer,
+you can modify the `exec` line in `applyFix` function.
 
-   For example,
-   ```diff
-     - exec("yarn exec -- prettier $file");
-     + exec("yarn exec -- prettier --brace-style=1tbs $file");
-   ```
-   will allow you to change the `braceStyle` for this fixer
+For example,
+
+```diff
+  - exec("yarn exec -- prettier $file");
+  + exec("yarn exec -- prettier --brace-style=1tbs $file");
+```
+
+will allow you to change the `braceStyle` for this fixer
 
 ## Possible Improvement
-  - the configuration can be modified from `php-cs-fixer` configuration
-  - autoloading
+
+- the configuration can be modified from `php-cs-fixer` configuration
+- autoloading

jest.config.js

@@ -19,6 +19,8 @@ module.exports = {
       globals: {
         STANDALONE: false,
       },
+      runner: "jest-light-runner",
+      transform: {},
     },
     ...(/^true$/i.test(process.env.RUN_STANDALONE_TESTS)
       ? [
@@ -31,6 +33,8 @@ module.exports = {
             globals: {
               STANDALONE: true,
             },
+            runner: "jest-light-runner",
+            transform: {},
           },
         ]
       : []),

package.json

@@ -16,20 +16,21 @@
     "php-parser": "^3.1.5"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.19.4",
+    "@babel/preset-env": "^7.22.10",
     "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",
@@ -43,12 +44,12 @@
     "yarpm": "^1.1.1"
   },
   "peerDependencies": {
-    "prettier": "^1.15.0 || ^2.0.0"
+    "prettier": "^1.15.0 || ^2.0.0 || ^3.0.0"
   },
   "scripts": {
     "test": "jest",
     "prepublishOnly": "yarpm run build-standalone && cross-env RUN_STANDALONE_TESTS=true yarpm test",
-    "prettier": "prettier --plugin=. --parser=php",
+    "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"
   }

src/comments.js

@@ -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
 
@@ -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) {