refactor(rspeedy/qrcode): replace qrcode-terminal with uqr (#469)

<!--
  Thank you for submitting a pull request!

We appreciate the time and effort you have invested in making these
changes. Please ensure that you provide enough information to allow
others to review your pull request.

Upon submission, your pull request will be automatically assigned with
reviewers.

If you want to learn more about contributing to this project, please
visit:
https://github.com/lynx-family/lynx-stack/blob/main/CONTRIBUTING.md.
-->

## Summary

<!-- Can you explain the reasoning behind implementing this change? What
problem or issue does this pull request resolve? -->

[`uqr`](https://github.com/unjs/uqr) is a modern and simple alternative
to `qrcode-terminal`. And most importantly, we could remove the `.patch`
and make rspack-ecosystem-ci work.

<!-- It would be helpful if you could provide any relevant context, such
as GitHub issues or related discussions. -->

## Checklist

<!--- Check and mark with an "x" -->

- [x] Tests updated (or not required).
- [ ] Documentation updated (or **not required**).

Author: colinaaa

.changeset/four-shoes-cry.md

@@ -0,0 +1,2 @@
+---
+---

packages/rspeedy/plugin-qrcode/package.json

@@ -52,9 +52,8 @@
     "@lynx-js/rspeedy": "workspace:*",
     "@microsoft/api-extractor": "catalog:",
     "@rsbuild/core": "catalog:rsbuild",
-    "@types/qrcode-terminal": "^0.12.2",
     "picocolors": "^1.1.1",
-    "qrcode-terminal": "^0.12.0"
+    "uqr": "0.1.2"
   },
   "engines": {
     "node": ">=18"

packages/rspeedy/plugin-qrcode/src/shortcuts.ts

@@ -42,7 +42,7 @@ export async function registerConsoleShortcuts(
 
   const value: string | symbol = Object.values(devUrls)[0]!
   await options.onPrint?.(value)
-  await showQRCode(value)
+  showQRCode(value)
 
   gExistingShortcuts.add(options)
 
@@ -137,7 +137,7 @@ async function loop(
       await options.customShortcuts[name].action?.()
     }
     await options.onPrint?.(value)
-    await showQRCode(value)
+    showQRCode(value)
   }
 
   // If the `options` is not deleted from `gExistingShortcuts`, means that this is an explicitly

packages/rspeedy/plugin-qrcode/src/showQRCode.ts

@@ -1,24 +1,12 @@
 // Copyright 2024 The Lynx Authors. All rights reserved.
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
-export default async function showQRCode(
-  url: string,
-): Promise<void> {
-  const [
-    { log },
-    { default: color },
-    { default: QRCode },
-  ] = await Promise.all([
-    import('@clack/prompts'),
-    import('picocolors'),
-    import('qrcode-terminal'),
-  ])
-
-  const qrcode = await new Promise<string>((resolve) => {
-    QRCode.generate(url, { small: true }, resolve)
-  })
+import { log } from '@clack/prompts'
+import color from 'picocolors'
+import { renderUnicodeCompact } from 'uqr'
 
+export default function showQRCode(url: string): void {
   log.info(color.green('Scan with Lynx'))
-  log.success(qrcode)
+  log.success(renderUnicodeCompact(url))
   log.success(url)
 }

packages/rspeedy/plugin-qrcode/test/index.test.ts

@@ -86,16 +86,15 @@ describe('Plugins - Terminal', () => {
   })
 
   describe('schema', () => {
+    vi.mock('uqr')
     test('custom schema', async () => {
       vi.stubEnv('NODE_ENV', 'development')
       const { selectKey, isCancel } = await import('@clack/prompts')
       vi.mocked(selectKey).mockResolvedValue('foo')
       vi.mocked(isCancel).mockReturnValueOnce(false)
 
-      const { default: { generate } } = await import('qrcode-terminal')
-      vi.mocked(generate).mockImplementationOnce((_, __, callback) => {
-        callback?.('')
-      })
+      const { renderUnicodeCompact } = await import('uqr')
+      vi.mocked(renderUnicodeCompact).mockReturnValueOnce('<data>')
       const rsbuild = await createRsbuild(
         {
           rsbuildConfig: {
@@ -133,21 +132,24 @@ describe('Plugins - Terminal', () => {
 
       await server.waitDevCompileDone()
 
-      expect(generate).toBeCalledTimes(1)
+      expect(renderUnicodeCompact).toBeCalledTimes(1)
 
-      expect(generate).toBeCalledWith(
+      expect(renderUnicodeCompact).toBeCalledWith(
         `--http://example.com/foo/main.lynx.bundle--`,
-        {
-          small: true,
-        },
-        expect.any(Function),
       )
     })
 
     test('custom schema object', async () => {
       vi.stubEnv('NODE_ENV', 'development')
       const { select, selectKey, isCancel } = await import('@clack/prompts')
-      vi.mocked(selectKey).mockResolvedValue('a')
+      let i = 1
+      vi.mocked(selectKey).mockImplementation(() => {
+        if (i === 1) {
+          i++
+          return Promise.resolve('a')
+        }
+        return Promise.resolve('q')
+      })
       vi.mocked(isCancel).mockReturnValue(false)
 
       let resolve: (v: string) => void
@@ -156,10 +158,8 @@ describe('Plugins - Terminal', () => {
       })
       vi.mocked(select).mockReturnValue(promise)
 
-      const { default: { generate } } = await import('qrcode-terminal')
-      vi.mocked(generate).mockImplementationOnce((_, __, callback) => {
-        callback?.('')
-      })
+      const { renderUnicodeCompact } = await import('uqr')
+      vi.mocked(renderUnicodeCompact).mockReturnValueOnce('<data>')
       const rsbuild = await createRsbuild(
         {
           rsbuildConfig: {
@@ -200,32 +200,31 @@ describe('Plugins - Terminal', () => {
 
       await server.waitDevCompileDone()
 
-      expect(generate).toBeCalledTimes(1)
-      expect(generate).toBeCalledWith(
+      expect(renderUnicodeCompact).toBeCalledTimes(1)
+      expect(renderUnicodeCompact).toBeCalledWith(
         `==http://example.com/foo/main.lynx.bundle==`,
-        {
-          small: true,
-        },
-        expect.any(Function),
       )
 
       // @ts-expect-error xxx
       resolve('bar')
 
-      await expect.poll(() => generate).toBeCalledTimes(2)
-      expect(generate).toBeCalledWith(
+      await expect.poll(() => renderUnicodeCompact).toBeCalledTimes(2)
+      expect(renderUnicodeCompact).toBeCalledWith(
         `$$http://example.com/foo/main.lynx.bundle$$`,
-        {
-          small: true,
-        },
-        expect.any(Function),
       )
     })
 
     test('select between entries', async () => {
       vi.stubEnv('NODE_ENV', 'development')
       const { select, selectKey, isCancel } = await import('@clack/prompts')
-      vi.mocked(selectKey).mockResolvedValue('r')
+      let i = 1
+      vi.mocked(selectKey).mockImplementation(() => {
+        if (i === 1) {
+          i++
+          return Promise.resolve('r')
+        }
+        return Promise.resolve('q')
+      })
       vi.mocked(isCancel).mockReturnValue(false)
 
       let resolve: (v: string) => void
@@ -234,10 +233,8 @@ describe('Plugins - Terminal', () => {
       })
       vi.mocked(select).mockReturnValue(promise)
 
-      const { default: { generate } } = await import('qrcode-terminal')
-      vi.mocked(generate).mockImplementationOnce((_, __, callback) => {
-        callback?.('')
-      })
+      const { renderUnicodeCompact } = await import('uqr')
+      vi.mocked(renderUnicodeCompact).mockReturnValueOnce('<data>')
       const rsbuild = await createRsbuild(
         {
           rsbuildConfig: {
@@ -280,32 +277,28 @@ describe('Plugins - Terminal', () => {
 
       await server.waitDevCompileDone()
 
-      expect(generate).toBeCalledTimes(1)
-      expect(generate).toBeCalledWith(
+      expect(renderUnicodeCompact).toBeCalledTimes(1)
+      expect(renderUnicodeCompact).toBeCalledWith(
         `==http://example.com/foo/main.lynx.bundle==`,
-        {
-          small: true,
-        },
-        expect.any(Function),
       )
 
       // @ts-expect-error xxx
       resolve('main2')
 
-      await expect.poll(() => generate).toBeCalledTimes(2)
-      expect(generate).toBeCalledWith(
+      await expect.poll(() => renderUnicodeCompact).toBeCalledTimes(2)
+      expect(renderUnicodeCompact).toBeCalledWith(
         `==http://example.com/foo/main2.lynx.bundle==`,
-        {
-          small: true,
-        },
-        expect.any(Function),
       )
     })
   })
 
   describe('QRCode', () => {
-    vi.mock('qrcode-terminal')
+    vi.mock('uqr')
     test('not print qrcode when build', async () => {
+      const { renderUnicodeCompact } = await import('uqr')
+
+      vi.mocked(renderUnicodeCompact).mockClear()
+
       const rsbuild = await createRsbuild(
         {
           rsbuildConfig: {
@@ -326,20 +319,17 @@ describe('Plugins - Terminal', () => {
         },
       )
       await rsbuild.build()
-      const QRCode = await import('qrcode-terminal')
 
-      expect(QRCode.default.generate).not.toBeCalled()
+      expect(renderUnicodeCompact).not.toBeCalled()
     })
 
     test('print qrcode when dev', async () => {
       vi.stubEnv('NODE_ENV', 'development')
       const { selectKey, isCancel } = await import('@clack/prompts')
       vi.mocked(selectKey).mockResolvedValue('foo')
       vi.mocked(isCancel).mockReturnValueOnce(false)
-      const { default: { generate } } = await import('qrcode-terminal')
-      vi.mocked(generate).mockImplementationOnce((_, __, callback) => {
-        callback?.('')
-      })
+      const { renderUnicodeCompact } = await import('uqr')
+      vi.mocked(renderUnicodeCompact).mockReturnValueOnce('<data>')
       const rsbuild = await createRsbuild(
         {
           rsbuildConfig: {
@@ -373,13 +363,13 @@ describe('Plugins - Terminal', () => {
 
       await server.waitDevCompileDone()
 
-      expect(generate).toBeCalledTimes(1)
+      expect(renderUnicodeCompact).toBeCalledTimes(1)
     })
 
     test('print qrcode when dev with host specified', async () => {
       vi.stubEnv('NODE_ENV', 'development')
       vi.mock('qrcode', () => ({
-        generate: vi.fn(),
+        renderUnicodeCompact: vi.fn(),
       }))
       const { selectKey, isCancel } = await import('@clack/prompts')
       vi.mocked(selectKey).mockResolvedValue('foo')
@@ -413,22 +403,16 @@ describe('Plugins - Terminal', () => {
         },
       )
 
-      const { default: { generate } } = await import('qrcode-terminal')
-      vi.mocked(generate).mockImplementationOnce((_, __, callback) => {
-        callback?.('')
-      })
+      const { renderUnicodeCompact } = await import('uqr')
+      vi.mocked(renderUnicodeCompact).mockReturnValueOnce('<data>')
 
       await using server = await usingDevServer(rsbuild)
 
       await server.waitDevCompileDone()
 
-      expect(generate).toBeCalledTimes(1)
-      expect(generate).toBeCalledWith(
+      expect(renderUnicodeCompact).toBeCalledTimes(1)
+      expect(renderUnicodeCompact).toBeCalledWith(
         expect.stringContaining('example.com/foo'),
-        {
-          small: true,
-        },
-        expect.anything(),
       )
     })
   })