Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Read deno.json in islandComponents vite plugin #249

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

4513ECHO
Copy link
Contributor

@4513ECHO 4513ECHO commented Jan 8, 2025

When I use HonoX from Deno, I got an error that vite cannot read tsconfig.json because Deno does not support tsconfig.json but directly deno.json.

I have added deno.json support to HonoX.

@yusukebe
Copy link
Member

yusukebe commented Jan 8, 2025

Hi @4513ECHO

Thank you for the PR! I have some ideas for testing this fix. I'm working on implementing it. Please wait a bit.

@yusukebe
Copy link
Member

yusukebe commented Jan 9, 2025

Hi @4513ECHO

Basically, we should add a test for a new fix. I think the following test will be okay. If it's okay, can you apply it?

diff --git a/src/vite/island-components.test.ts b/src/vite/island-components.test.ts
index 038c096..f442637 100644
--- a/src/vite/island-components.test.ts
+++ b/src/vite/island-components.test.ts
@@ -1,4 +1,4 @@
-import fs from 'fs'
+import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import { islandComponents, transformJsxTags } from './island-components.js'
@@ -220,35 +220,94 @@ export { utilityFn, WrappedExportViaVariable as default };`
 
 describe('options', () => {
   describe('reactApiImportSource', () => {
-    describe('vite/components', () => {
-      // get full path of honox-island.tsx
-      const component = path
-        .resolve(__dirname, '../vite/components/honox-island.tsx')
-        // replace backslashes for Windows
-        .replace(/\\/g, '/')
+    describe('vite/components', async () => {
+      const honoPattern = /'hono\/jsx'/
+      const reactPattern = /'react'/
+      const setup = async () => {
+        // get full path of honox-island.tsx
+        const component = path
+          .resolve(__dirname, '../vite/components/honox-island.tsx')
+          // replace backslashes for Windows
+          .replace(/\\/g, '/')
+        const componentContent = await fs.readFile(component, 'utf8')
+        return { component, componentContent }
+      }
 
-      // prettier-ignore
-      it('use \'hono/jsx\' by default', async () => {
-        const plugin = islandComponents()
-        await (plugin.configResolved as Function)({ root: 'root' })
-        const res = await (plugin.load as Function)(component)
-        expect(res.code).toMatch(/'hono\/jsx'/)
-        expect(res.code).not.toMatch(/'react'/)
-      })
+      test.each([
+        {
+          name: 'default with both config files (deno.json preferred)',
+          configFiles: {
+            'deno.json': { jsxImportSource: 'react' },
+            'tsconfig.json': { jsxImportSource: 'hono/jsx' },
+          },
+          config: {},
+          expect: { hono: false, react: true },
+        },
+        {
+          name: 'default with only deno.json',
+          configFiles: {
+            'deno.json': { jsxImportSource: 'react' },
+          },
+          config: {},
+          expect: { hono: false, react: true },
+        },
+        {
+          name: 'default with only tsconfig.json',
+          configFiles: {
+            'tsconfig.json': { jsxImportSource: 'react' },
+          },
+          config: {},
+          expect: { hono: false, react: true },
+        },
+        {
+          name: 'explicit react config overrides all',
+          configFiles: {
+            'deno.json': { jsxImportSource: 'hono/jsx' },
+            'tsconfig.json': { jsxImportSource: 'hono/jsx' },
+          },
+          config: { reactApiImportSource: 'react' },
+          expect: { hono: false, react: true },
+        },
+      ])('should handle $name', async (testCase) => {
+        const { component, componentContent } = await setup()
 
-      // prettier-ignore
-      it('enable to specify \'react\'', async () => {
-        const plugin = islandComponents({
-          reactApiImportSource: 'react',
+        vi.spyOn(fs, 'readFile').mockImplementation(async (filePath) => {
+          if (filePath.toString().includes('honox-island.tsx')) {
+            return componentContent
+          }
+          for (const [fileName, config] of Object.entries(testCase.configFiles)) {
+            if (filePath.toString().includes(fileName)) {
+              return JSON.stringify({ compilerOptions: config })
+            }
+            throw new Error('Config file does not exist')
+          }
+          return ''
         })
+
+        const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+        const plugin = islandComponents(testCase.config)
         await (plugin.configResolved as Function)({ root: 'root' })
         const res = await (plugin.load as Function)(component)
-        expect(res.code).not.toMatch(/'hono\/jsx'/)
-        expect(res.code).toMatch(/'react'/)
+
+        expect(honoPattern.test(res.code)).toBe(testCase.expect.hono)
+        expect(reactPattern.test(res.code)).toBe(testCase.expect.react)
+
+        if (Object.keys(testCase.configFiles).length === 0) {
+          expect(consoleWarnSpy).toHaveBeenCalledWith(
+            'Cannot find neither tsconfig.json nor deno.json',
+            expect.any(Error),
+            expect.any(Error)
+          )
+        }
       })
     })
 
-    describe('server/components', () => {
+    describe('server/components', async () => {
+      beforeEach(() => {
+        vi.restoreAllMocks()
+      })
+
       const tmpdir = os.tmpdir()
 
       // has-islands.tsx under src/server/components does not contain 'hono/jsx'
@@ -258,9 +317,9 @@ describe('options', () => {
         .resolve(tmpdir, 'honox/dist/server/components/has-islands.js')
         // replace backslashes for Windows
         .replace(/\\/g, '/')
-      fs.mkdirSync(path.dirname(component), { recursive: true })
+      await fs.mkdir(path.dirname(component), { recursive: true })
       // prettier-ignore
-      fs.writeFileSync(component, 'import { jsx } from \'hono/jsx/jsx-runtime\'')
+      await fs.writeFile(component, 'import { jsx } from \'hono/jsx/jsx-runtime\'')
 
       // prettier-ignore
       it('use \'hono/jsx\' by default', async () => {

@4513ECHO
Copy link
Contributor Author

I have added the test and it works well. Thanks!

Copy link
Member

@yusukebe yusukebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@yusukebe
Copy link
Member

@4513ECHO

Looks good! I'll merge this and release a new version. Thank you for your contribution!

@yusukebe yusukebe merged commit e2f327f into honojs:main Jan 10, 2025
2 checks passed
@4513ECHO 4513ECHO deleted the read-deno-json branch January 10, 2025 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants