feat: support prettier v3

close #164

.gitignore

@@ -1,4 +1,4 @@
-dist
+lib
 node_modules
 *.log
 /.yarn/*

.prettierignore

@@ -1,3 +1,3 @@
 coverage
-dist
+lib
 /.yarn

.yarnrc.yml

@@ -4,6 +4,8 @@ nodeLinker: node-modules
 
 plugins:
   - path: .yarn/plugins/plugin-prepare-lifecycle.cjs
-    spec: 'https://github.com/un-es/yarn-plugin-prepare-lifecycle/releases/download/v0.0.1/index.js'
+    spec: "https://github.com/un-es/yarn-plugin-prepare-lifecycle/releases/download/v0.0.1/index.js"
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
 
-yarnPath: .yarn/releases/yarn-2.4.3.cjs
+yarnPath: .yarn/releases/yarn-3.6.4.cjs

__mocks__/prettier.ts

@@ -1,17 +1,15 @@
+/* eslint-disable @typescript-eslint/require-await */
+
 import path from 'path'
 
-export = {
-  format: jest.fn((input: string) => 'formatted:' + input),
-  resolveConfig: {
-    sync: jest.fn((file: string) => ({ file })),
-  },
-  getFileInfo: {
-    sync: jest.fn((file: string) => {
-      const ext = path.extname(file)
-      if (ext === '.js' || ext === '.md') {
-        return { ignored: false, inferredParser: 'babel' }
-      }
-      return { ignored: false, inferredParser: null }
-    }),
-  },
-}
+export const format = jest.fn(async (input: string) => 'formatted:' + input)
+
+export const resolveConfig = jest.fn(async (file: string) => ({ file }))
+
+export const getFileInfo = jest.fn(async (file: string) => {
+  const ext = path.extname(file)
+  return {
+    ignored: false,
+    inferredParser: ext === '.js' || ext === '.md' ? 'babel' : null,
+  }
+})

package.json

@@ -8,18 +8,27 @@
     "JounQin (https://www.1stG.me) <admin@1stg.me>"
   ],
   "license": "MIT",
-  "packageManager": "yarn@2.4.3",
+  "packageManager": "yarn@3.6.4",
   "engines": {
-    "node": ">=10.13"
+    "node": ">=14.8.0"
   },
-  "bin": "dist/cli.js",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.mjs",
-  "types": "dist/index.d.ts",
+  "bin": "lib/cli.mjs",
+  "main": "lib/index.js",
+  "module": "lib/index.esm.mjs",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "require": "./lib/index.js",
+      "default": "./lib/index.esm.mjs"
+    },
+    "./*": "./lib/*.js",
+    "./package.json": "./package.json"
+  },
+  "types": "lib/index.d.ts",
   "files": [
     "bin",
-    "dist",
-    "img"
+    "img",
+    "lib"
   ],
   "keywords": [
     "git",
@@ -34,7 +43,7 @@
   ],
   "scripts": {
     "build": "run-p 'build:*'",
-    "build:r": "r -f esm -o dist || exit 0",
+    "build:r": "r -f esm || exit 0",
     "build:tsc": "tsc -b",
     "lint": "run-p 'lint:*'",
     "lint:es": "eslint . --cache",
@@ -44,11 +53,11 @@
     "test": "jest"
   },
   "peerDependencies": {
-    "prettier": "^2.0.0"
+    "prettier": "^3.0.0"
   },
   "dependencies": {
-    "execa": "^4.1.0",
-    "find-up": "^4.1.0",
+    "execa": "^5.1.1",
+    "find-up": "^5.0.0",
     "ignore": "^5.3.0",
     "mri": "^1.2.0",
     "picocolors": "^1.0.0",
@@ -68,25 +77,24 @@
     "@unts/patch-package": "^8.0.0",
     "clean-pkg-json": "^1.2.0",
     "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.6.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^26.6.3",
+    "jest": "^29.7.0",
     "lint-staged": "^13.2.2",
     "mock-fs": "^4.14.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.8",
+    "prettier": "^3.2.2",
     "pretty-quick": "link:.",
     "simple-git-hooks": "^2.9.0",
     "size-limit": "^11.0.1",
     "size-limit-preset-node-lib": "^0.3.0",
-    "ts-jest": "^26.5.6",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
-    "typescript": "~4.4.4"
+    "typescript": "^5.3.3"
   },
   "resolutions": {
-    "typescript": "~4.4.4",
-    "yaml": "^1.10.2"
+    "@1stg/prettier-config": "^4.0.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "prettier": "^3.2.0"
   },
   "commitlint": {
     "extends": "@1stg"
@@ -107,7 +115,7 @@
   },
   "eslintIgnore": [
     "coverage",
-    "dist",
+    "lib",
     "!/.*.js"
   ],
   "jest": {
@@ -117,6 +125,7 @@
     ],
     "collectCoverage": true,
     "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1",
       "^pretty-quick$": "<rootDir>/src",
       "^pretty-quick/(.+)$": "<rootDir>/src/$1"
     }

src/cli.ts → src/cli.mts

@@ -3,7 +3,7 @@
 import mri from 'mri'
 import picocolors from 'picocolors'
 
-import prettyQuick from '.'
+import prettyQuick from './index.js'
 
 const args = mri(process.argv.slice(2), {
   alias: {
@@ -12,7 +12,7 @@ const args = mri(process.argv.slice(2), {
   },
 })
 
-const prettyQuickResult = prettyQuick(process.cwd(), {
+const prettyQuickResult = await prettyQuick(process.cwd(), {
   ...args,
   onFoundSinceRevision: (scm, revision) => {
     console.log(

src/index.ts

@@ -1,11 +1,12 @@
-import createIgnorer from './createIgnorer'
-import createMatcher from './createMatcher'
-import isSupportedExtension from './isSupportedExtension'
-import processFiles from './processFiles'
-import scms from './scms'
-import { PrettyQuickOptions } from './types'
+import createIgnorer from './createIgnorer.js'
+import createMatcher from './createMatcher.js'
+import isSupportedExtension from './isSupportedExtension.js'
+import processFiles from './processFiles.js'
+import scms from './scms/index.js'
+import { PrettyQuickOptions } from './types.js'
+import { filterAsync } from './utils.js'
 
-export = (
+export = async (
   currentDirectory: string,
   {
     config,
@@ -44,33 +45,37 @@ export = (
       ? () => true
       : createIgnorer(currentDirectory, ignorePath)
 
-  const changedFiles = scm
-    .getChangedFiles(directory, revision, staged)
-    .filter(createMatcher(pattern))
-    .filter(rootIgnorer)
-    .filter(cwdIgnorer)
-    .filter(isSupportedExtension(resolveConfig))
+  const patternMatcher = createMatcher(pattern)
+
+  const isFileSupportedExtension = isSupportedExtension(resolveConfig)
+
+  const changedFiles = await filterAsync(
+    scm
+      .getChangedFiles(directory, revision, staged)
+      .filter(patternMatcher)
+      .filter(rootIgnorer)
+      .filter(cwdIgnorer),
+    isFileSupportedExtension,
+  )
 
   const unstagedFiles = staged
-    ? scm
-        .getUnstagedChangedFiles(
-          directory,
-          // @ts-expect-error -- TODO: check
-          revision,
-        )
-        .filter(isSupportedExtension(resolveConfig))
-        .filter(createMatcher(pattern))
-        .filter(rootIgnorer)
-        .filter(cwdIgnorer)
+    ? await filterAsync(
+        scm
+          .getUnstagedChangedFiles(directory)
+          .filter(patternMatcher)
+          .filter(rootIgnorer)
+          .filter(cwdIgnorer),
+        isFileSupportedExtension,
+      )
     : []
 
-  const wasFullyStaged = (f: string) => !unstagedFiles.includes(f)
+  const wasFullyStaged = (file: string) => !unstagedFiles.includes(file)
 
   onFoundChangedFiles?.(changedFiles)
 
-  const failReasons = new Set()
+  const failReasons = new Set<string>()
 
-  processFiles(directory, changedFiles, {
+  await processFiles(directory, changedFiles, {
     check,
     config,
     onWriteFile(file: string) {

src/isSupportedExtension.ts

@@ -1,12 +1,16 @@
 /* eslint-disable unicorn/filename-case */
 
-import * as prettier from 'prettier'
+import {
+  type FileInfoOptions,
+  getFileInfo,
+  resolveConfig as prettierResolveConfig,
+} from 'prettier'
 
-export default (resolveConfig?: boolean) => (file: string) => {
-  const config = prettier.resolveConfig.sync(file, {
+export default (resolveConfig?: boolean) => async (file: string) => {
+  const config = (await prettierResolveConfig(file, {
     editorconfig: true,
-  }) as prettier.FileInfoOptions
-  const fileInfo = prettier.getFileInfo.sync(file, {
+  })) as FileInfoOptions
+  const fileInfo = await getFileInfo(file, {
     resolveConfig,
     ...config,
   })

src/processFiles.ts

@@ -3,11 +3,11 @@
 import fs from 'fs'
 import path from 'path'
 
-import prettier from 'prettier'
+import { format, check as prettierCheck, resolveConfig } from 'prettier'
 
-import { PrettyQuickOptions } from './types'
+import type { PrettyQuickOptions } from './types.js'
 
-export default (
+export default async (
   directory: string,
   files: string[],
   {
@@ -22,21 +22,21 @@ export default (
     onExamineFile?.(relative)
     const file = path.join(directory, relative)
     const options = {
-      ...prettier.resolveConfig.sync(file, {
+      ...(await resolveConfig(file, {
         config,
         editorconfig: true,
-      }),
+      })),
       filepath: file,
     }
     const input = fs.readFileSync(file, 'utf8')
 
     if (check) {
-      const isFormatted = prettier.check(input, options)
+      const isFormatted = await prettierCheck(input, options)
       onCheckFile?.(relative, isFormatted)
       continue
     }
 
-    const output = prettier.format(input, options)
+    const output = await format(input, options)
 
     if (output !== input) {
       fs.writeFileSync(file, output)

src/scms/index.ts

@@ -1,10 +1,10 @@
-import * as gitScm from './git'
-import * as hgScm from './hg'
+import * as gitScm from './git.js'
+import * as hgScm from './hg.js'
 
-const scms = [gitScm, hgScm]
+const scmList = [gitScm, hgScm]
 
 export default (directory: string) => {
-  for (const scm of scms) {
+  for (const scm of scmList) {
     const rootDirectory = scm.detect(directory)
     if (rootDirectory) {
       return {

src/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig.lib",
   "compilerOptions": {
     "composite": true,
-    "outDir": "../dist"
+    "outDir": "../lib"
   },
   "include": ["../shim.d.ts", "."]
 }

src/utils.ts

@@ -0,0 +1,7 @@
+export const filterAsync = async <T>(
+  items: T[],
+  predicate: (item: T) => Promise<boolean>,
+) => {
+  const boolItems = await Promise.all(items.map(predicate))
+  return items.filter((_, i) => boolItems[i])
+}

test/isSupportedExtension.spec.ts

@@ -1,31 +1,31 @@
 /* eslint-disable unicorn/filename-case */
 
-import prettier from 'prettier'
+import { getFileInfo } from 'prettier'
 
 import isSupportedExtension from 'pretty-quick/isSupportedExtension'
 
 afterEach(() => jest.clearAllMocks())
 
-test('return true when file with supported extension passed in', () => {
-  expect(isSupportedExtension(true)('banana.js')).toEqual(true)
-  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.js', {
+test('return true when file with supported extension passed in', async () => {
+  expect(await isSupportedExtension(true)('banana.js')).toEqual(true)
+  expect(getFileInfo).toHaveBeenCalledWith('banana.js', {
     file: 'banana.js',
     resolveConfig: true,
   })
 })
 
-test('return false when file with not supported extension passed in', () => {
+test('return false when file with not supported extension passed in', async () => {
   // eslint-disable-next-line sonarjs/no-duplicate-string
-  expect(isSupportedExtension(true)('banana.txt')).toEqual(false)
-  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.txt', {
+  expect(await isSupportedExtension(true)('banana.txt')).toEqual(false)
+  expect(getFileInfo).toHaveBeenCalledWith('banana.txt', {
     file: 'banana.txt',
     resolveConfig: true,
   })
 })
 
-test('do not resolve config when false passed', () => {
-  expect(isSupportedExtension(false)('banana.txt')).toEqual(false)
-  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.txt', {
+test('do not resolve config when false passed', async () => {
+  expect(await isSupportedExtension(false)('banana.txt')).toEqual(false)
+  expect(getFileInfo).toHaveBeenCalledWith('banana.txt', {
     file: 'banana.txt',
     resolveConfig: false,
   })