refactor: replace chalk and multimatch (#180)

Co-authored-by: JounQin <[email protected]>
prettier · Jan 17, 2024 · 93924ab · 93924ab
1 parent ed34de4
commit 93924ab
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 51 deletions.
diff --git a/.changeset/two-beds-collect.md b/.changeset/two-beds-collect.md
@@ -0,0 +1,5 @@
+---
+'pretty-quick': minor
+---
+
+refactor: replace `chalk` and `multimatch` with their lightweight and performant alternatives
diff --git a/package.json b/package.json
@@ -47,12 +47,12 @@
     "prettier": "^2.0.0"
   },
   "dependencies": {
-    "chalk": "^4.1.2",
     "execa": "^4.1.0",
     "find-up": "^4.1.0",
     "ignore": "^5.3.0",
     "mri": "^1.2.0",
-    "multimatch": "^5.0.0",
+    "picocolors": "^1.0.0",
+    "picomatch": "^3.0.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
@@ -64,6 +64,7 @@
     "@total-typescript/ts-reset": "^0.5.1",
     "@types/jest": "^29.5.11",
     "@types/mock-fs": "^4.13.4",
+    "@types/picomatch": "^2.3.3",
     "@unts/patch-package": "^8.0.0",
     "clean-pkg-json": "^1.2.0",
     "eslint": "^8.56.0",

diff --git a/src/cli.ts b/src/cli.ts
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-import chalk from 'chalk'
 import mri from 'mri'
+import picocolors from 'picocolors'
 
 import prettyQuick from '.'
 
@@ -16,36 +16,36 @@ const prettyQuickResult = prettyQuick(process.cwd(), {
   ...args,
   onFoundSinceRevision: (scm, revision) => {
     console.log(
-      `🔍  Finding changed files since ${chalk.bold(scm)} revision ${chalk.bold(
-        revision,
-      )}.`,
+      `🔍  Finding changed files since ${picocolors.bold(
+        scm,
+      )} revision ${picocolors.bold(revision)}.`,
     )
   },
 
   onFoundChangedFiles: changedFiles => {
     console.log(
-      `🎯  Found ${chalk.bold(changedFiles.length)} changed ${
+      `🎯  Found ${picocolors.bold(changedFiles.length)} changed ${
         changedFiles.length === 1 ? 'file' : 'files'
       }.`,
     )
   },
 
   onPartiallyStagedFile: file => {
-    console.log(`✗ Found ${chalk.bold('partially')} staged file ${file}.`)
+    console.log(`✗ Found ${picocolors.bold('partially')} staged file ${file}.`)
   },
 
   onWriteFile: file => {
-    console.log(`✍️  Fixing up ${chalk.bold(file)}.`)
+    console.log(`✍️  Fixing up ${picocolors.bold(file)}.`)
   },
 
   onCheckFile: (file, isFormatted) => {
     if (!isFormatted) {
-      console.log(`⛔️  Check failed: ${chalk.bold(file)}`)
+      console.log(`⛔️  Check failed: ${picocolors.bold(file)}`)
     }
   },
 
   onExamineFile: file => {
-    console.log(`🔍  Examining ${chalk.bold(file)}.`)
+    console.log(`🔍  Examining ${picocolors.bold(file)}.`)
   },
 })
 
@@ -55,7 +55,7 @@ if (prettyQuickResult.success) {
   if (prettyQuickResult.errors.includes('PARTIALLY_STAGED_FILE')) {
     console.log(
       '✗ Partially staged files were fixed up.' +
-        ` ${chalk.bold('Please update stage before committing')}.`,
+        ` ${picocolors.bold('Please update stage before committing')}.`,
     )
   }
   if (prettyQuickResult.errors.includes('BAIL_ON_WRITE')) {

diff --git a/src/createMatcher.ts b/src/createMatcher.ts
@@ -2,14 +2,15 @@
 
 import path from 'path'
 
-import multimatch from 'multimatch'
+import picomatch from 'picomatch'
 
 export default (pattern: string[] | string | undefined) => {
   // Match everything if no pattern was given
   if (typeof pattern !== 'string' && !Array.isArray(pattern)) {
     return () => true
   }
   const patterns = Array.isArray(pattern) ? pattern : [pattern]
-  return (file: string) =>
-    multimatch(path.normalize(file), patterns, { dot: true }).length > 0
+
+  const isMatch = picomatch(patterns, { dot: true })
+  return (file: string) => isMatch(path.normalize(file))
 }
diff --git a/yarn.lock b/yarn.lock
@@ -4146,13 +4146,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/minimatch@npm:^3.0.3":
-  version: 3.0.5
-  resolution: "@types/minimatch@npm:3.0.5"
-  checksum: 517a8ea1bfad4cc9d2563fc70c3ecd9afb13f9ef2b2cb06f8910989baf199d24f2fc6a8ccaae16a27c856e022b311042ca67ff42ffbda48750f2f84a5bf48716
-  languageName: node
-  linkType: hard
-
 "@types/minimist@npm:^1.2.0":
   version: 1.2.5
   resolution: "@types/minimist@npm:1.2.5"
@@ -4229,6 +4222,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/picomatch@npm:^2.3.3":
+  version: 2.3.3
+  resolution: "@types/picomatch@npm:2.3.3"
+  checksum: 761493d528c5dcfeab4a82637d833d6154bac5a5ed4af1cc30fe6f0bbe14111e4d30413414151d842484dad75368194a165f1bc9350289f414f1d0fa2311d77c
+  languageName: node
+  linkType: hard
+
 "@types/prettier@npm:^2.0.0":
   version: 2.7.3
   resolution: "@types/prettier@npm:2.7.3"
@@ -4983,13 +4983,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"array-differ@npm:^3.0.0":
-  version: 3.0.0
-  resolution: "array-differ@npm:3.0.0"
-  checksum: 6d87a752b56b9e9b29b617d7092173ac3b418d77621077eb7d7637a143b8df6019d59fe98cb3ba8ceba2677ad9904220dabd816f762c1cd5afaa3eec14db3b92
-  languageName: node
-  linkType: hard
-
 "array-ify@npm:^1.0.0":
   version: 1.0.0
   resolution: "array-ify@npm:1.0.0"
@@ -5083,13 +5076,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"arrify@npm:^2.0.1":
-  version: 2.0.1
-  resolution: "arrify@npm:2.0.1"
-  checksum: 2a19726815590d829e07998aefa2c352bd9061e58bf4391ffffa227129995841a710bef2d8b4c9408a6b0679d96c96bd23764bdbcc29bb21666c976816093972
-  languageName: node
-  linkType: hard
-
 "assign-symbols@npm:^1.0.0":
   version: 1.0.0
   resolution: "assign-symbols@npm:1.0.0"
@@ -12572,19 +12558,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"multimatch@npm:^5.0.0":
-  version: 5.0.0
-  resolution: "multimatch@npm:5.0.0"
-  dependencies:
-    "@types/minimatch": "npm:^3.0.3"
-    array-differ: "npm:^3.0.0"
-    array-union: "npm:^2.1.0"
-    arrify: "npm:^2.0.1"
-    minimatch: "npm:^3.0.4"
-  checksum: 93fcf94313d5a62c9eac21cda21201651af7ad4fdb89c3e35d8b6031568d656f0a7a79c7275bdb2e3446994e9b7ee317b8a8cdf81c74d30e52dc8d92a2aba48b
-  languageName: node
-  linkType: hard
-
 "mustache@npm:^4.2.0":
   version: 4.2.0
   resolution: "mustache@npm:4.2.0"
@@ -13437,6 +13410,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"picomatch@npm:^3.0.1":
+  version: 3.0.1
+  resolution: "picomatch@npm:3.0.1"
+  checksum: d8b119f925c16361e4727f2bf651f73f856cc658affae9b8bde33af1c33436fd18f76cfd64c85b841272c2ee93e48d331457c81fd9d43586812b3f6595baa810
+  languageName: node
+  linkType: hard
+
 "pidtree@npm:0.6.0":
   version: 0.6.0
   resolution: "pidtree@npm:0.6.0"
@@ -13729,8 +13709,8 @@ __metadata:
     "@total-typescript/ts-reset": ^0.5.1
     "@types/jest": ^29.5.11
     "@types/mock-fs": ^4.13.4
+    "@types/picomatch": ^2.3.3
     "@unts/patch-package": ^8.0.0
-    chalk: ^4.1.2
     clean-pkg-json: ^1.2.0
     eslint: ^8.56.0
     eslint-config-prettier: ^9.1.0
@@ -13743,8 +13723,9 @@ __metadata:
     lint-staged: ^13.2.2
     mock-fs: ^4.14.0
     mri: ^1.2.0
-    multimatch: ^5.0.0
     npm-run-all: ^4.1.5
+    picocolors: ^1.0.0
+    picomatch: ^3.0.1
     prettier: ^2.8.8
     pretty-quick: "link:."
     simple-git-hooks: ^2.9.0