feat: support prettier v3 (#195)

* feat: support prettier v3

* chore: fix prettier versions range in peerDependencies

issue: #194

Author: auvred

.eslintrc.js .eslintrc.cjs.eslintrc.js renamed to .eslintrc.cjs

@@ -13,8 +13,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [12.x, 14.x, 16.x, 18.x]
-        prettier: [2.1, 2.2, 2.4, latest]
+        node: [14.x, 16.x, 18.x, 20.x]
+        prettier: [3.0]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/test.yml

@@ -1,19 +1,8 @@
 // @ts-check
 
-"use strict";
-
 /** @type {import('@jest/types').Config.InitialOptions} */
 const config = {
-  preset: 'ts-jest/presets/js-with-babel',
-  globals: {
-    "ts-jest": {
-      useESM: true,
-    },
-  },
-  moduleNameMapper: {
-    "^(\\.{1,2}\\/.*)\\.js$": "$1",
-  },
-  transformIgnorePatterns: ['node_modules/(?!(mdast-util-from-markdown))/'],
+  runner: 'jest-light-runner'
 };
 
-module.exports = config;
+export default config;

babel.config.js

@@ -3,23 +3,25 @@
   "version": "0.4.2",
   "description": "A Prettier plugin to format JSDoc comments.",
   "private": false,
-  "workspaces": {
-    "prettier-plugin-fake": "./prettier-plugin-fake"
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/index.js"
+    }
   },
-  "main": "dist/index.js",
-  "module": "dist/index.min.mjs",
+  "browser": "dist/index.umd.min.js",
   "unpkg": "dist/index.umd.min.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist/index.js",
-    "dist/index.min.mjs",
     "dist/index.umd.min.js",
     "dist/index.d.ts"
   ],
   "scripts": {
     "prepare": "yarn build",
     "lint": "eslint --ext '.ts' ./src",
-    "test": "yarn build --test && jest",
+    "test": "yarn build --test && NODE_OPTIONS=\"--loader ts-node/esm\" jest",
     "release": "standard-version && yarn publish && git push --follow-tags origin master",
     "prettierAll": "prettier --write \"**/*.ts\"",
     "clean": "rm -fr dist",
@@ -42,8 +44,6 @@
     "url": "git+https://github.com/hosseinmd/prettier-plugin-jsdoc.git"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.5",
-    "@babel/preset-env": "^7.18.2",
     "@commitlint/config-conventional": "^14.1.0",
     "@rollup/plugin-commonjs": "^21.0.3",
     "@rollup/plugin-json": "^4.1.0",
@@ -52,30 +52,30 @@
     "@types/mdast": "^3.0.10",
     "@typescript-eslint/eslint-plugin": "^5.3.0",
     "@typescript-eslint/parser": "^5.3.0",
-    "babel-jest": "^28.1.1",
     "commitlint": "^14.1.0",
     "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
+    "jest-light-runner": "^0.5.0",
     "jest-specific-snapshot": "^5.0.0",
-    "prettier": "^2.6.1",
+    "prettier": "^3.0.0",
     "rollup": "^2.70.1",
     "standard-version": "^9.3.2",
     "terser": "^5.12.1",
-    "ts-jest": "^27.1.4",
+    "ts-node": "^10.9.1",
     "typescript": "^4.4.4"
   },
   "peerDependencies": {
-    "prettier": ">=2.1.2"
+    "prettier": "^3.0.0"
   },
   "dependencies": {
     "binary-searching": "^2.0.5",
     "comment-parser": "^1.3.1",
     "mdast-util-from-markdown": "^1.2.0"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.13.1 || >=16.0.0"
   }
 }

jest.config.js

@@ -1,4 +1,4 @@
-const { parsers: typescriptParsers } = require("prettier/parser-typescript");
+import { parsers as typescriptParsers } from "prettier/plugins/typescript";
 
 /**
  *
@@ -8,14 +8,14 @@ const { parsers: typescriptParsers } = require("prettier/parser-typescript");
  */
 const preprocess = (text, options) => {
   if (
-    options.plugins.find((plugin) => plugin.name === "prettier-plugin-fake")
+    options.plugins.find((plugin) => plugin.name?.includes("prettier-plugin-fake"))
   ) {
     return `//prettier-plugin-fake\n${text}`;
   }
   return text;
 };
 
-exports.parsers = {
+export const parsers = {
   typescript: {
     ...typescriptParsers.typescript,
     preprocess: typescriptParsers.typescript.preprocess
@@ -25,8 +25,8 @@ exports.parsers = {
             options,
           )
       : preprocess,
-    parse: (text, parsers, options) => {
-      const ast = typescriptParsers.typescript.parse(text, parsers, options);
+    parse: (text, options) => {
+      const ast = typescriptParsers.typescript.parse(text, options);
       if (ast.comments) {
         ast.comments[0].value = "PRETTIER-PLUGIN-FAKE";
       }

package.json

@@ -2,8 +2,8 @@
   "name": "prettier-plugin-fake",
   "version": "1.1.1",
   "private": true,
-  "main": "index.js",
+  "type": "module",
   "files": [
     "index.js"
   ]
-}
+}

prettier-plugin-fake/index.js

@@ -6,20 +6,14 @@ import json from "@rollup/plugin-json";
 // ignore all bare imports from node_modules
 // which are not relative and not absolute
 const external = (id) =>
-  !id.startsWith("mdast-util-from-markdown") &&
-  !id.startsWith("mdast-util-to-string") &&
-  !id.startsWith("micromark") &&
-  !id.startsWith("decode-named-character-reference") &&
-  !id.startsWith("character-entities") &&
-  !id.startsWith("unist-util-stringify-position") &&
   id.startsWith(".") === false &&
   path.isAbsolute(id) === false;
 
 export default {
   input: "./dist/index.js",
   output: {
     file: "dist/index.js",
-    format: "commonjs",
+    format: "esm",
   },
   external,
   plugins: [

prettier-plugin-fake/package.json

@@ -18,8 +18,6 @@ function $(commands) {
 const lint = "npm run clean && npm run lint && tsc --project tsconfig.json";
 
 const bundleEsm = "rollup --config rollup.config.js";
-const bundleEsmMin =
-  "terser --ecma 6 --compress --mangle --module -o dist/index.min.mjs -- dist/index.js && gzip -9 -c dist/index.min.mjs > dist/index.min.mjs.gz";
 const bundleUmd =
   "rollup dist/index.js --file dist/index.umd.js --format umd --name sayHello";
 const bundleUmdMin =
@@ -30,7 +28,6 @@ const buildStats =
 $(`${lint}`);
 $(`${bundleEsm}`);
 if (!__TEST__) {
-  $(`${bundleEsmMin}`);
   $(`${bundleUmd}`);
   $(`${bundleUmdMin}`);
   $(`${buildStats}`);