feat: support custom image dirs within layers

[wuiyang]

🔗 Linked issue

resolves #1879

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

For Nuxt project that uses IPX provider, it would not search nuxt layer's custom dir.

This changes allows Nuxt project with local layers to look for image in layer's dir.

Note: with this changes, similar to root nuxt config with custom dir, would not work for runtime IPX, and only works for ipxStatic provider.

Note 2: As nuxt.options compiles all layer's config, if root is using default config (not providing any), it will have layer's dir value. The image dir config will retrieve from layer's config instead to prevent this issue.

-    const path = isRootLayer ? moduleOptions.dir : layer.config.dir?.public || 'public'
+    const path = layer?.config.image?.dir || layer.config.dir?.public || 'public'

[vercel]

@wuiyang is attempting to deploy a commit to the NuxtLabs Team on Vercel.

A member of the Team first needs to authorize it.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@nuxt/image@1880

commit: 165ae13

[danielroe]

this is great - thank you! ❤️

would you add unit tests in ssr.test.ts and no-ssr.test.ts, e.g.:

image/test/e2e/ssr.test.ts

Lines 58 to 72 in aaeb7d5

	it('should emit load and error events', async () => {
	const page = await createPage()
	const logs: string[] = []
	page.on('console', (msg) => {
	logs.push(msg.text())
	})
	await page.goto(url('/events'), { waitUntil: 'networkidle' })
	expect(logs.filter(log => log === 'Image was loaded').length).toBe(4)
	expect(logs.filter(log => log === 'Error loading image').length).toBe(2)
	await page.close()
	})

[wuiyang]

this is great - thank you! ❤️

would you add unit tests in ssr.test.ts and no-ssr.test.ts, e.g.:

image/test/e2e/ssr.test.ts

Lines 58 to 72 in aaeb7d5

	it('should emit load and error events', async () => {
	const page = await createPage()
	const logs: string[] = []
	page.on('console', (msg) => {
	logs.push(msg.text())
	})
	await page.goto(url('/events'), { waitUntil: 'networkidle' })
	expect(logs.filter(log => log === 'Image was loaded').length).toBe(4)
	expect(logs.filter(log => log === 'Error loading image').length).toBe(2)
	await page.close()
	})

Thank you for the feedback, I couldn't get e2e test to run on my end, not sure if I setup something wrong, I'm using github codespaces to work on the PR

[danielroe]

fixed the test suite! you should be able to run e2e tests now....

[codecov-commenter]

Codecov Report

❌ Patch coverage is 0% with 24 lines in your changes missing coverage. Please review.
✅ Project coverage is 7.03%. Comparing base (bf778b5) to head (165ae13).

Files with missing lines	Patch %	Lines
src/module.ts	0.00%	21 Missing ⚠️
src/ipx.ts	0.00%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##            main   #1880      +/-   ##
========================================
- Coverage   7.06%   7.03%   -0.03%     
========================================
  Files         77      77              
  Lines       3555    3569      +14     
  Branches     138     138              
========================================
  Hits         251     251              
- Misses      3256    3270      +14     
  Partials      48      48              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[wuiyang]

apologize for slow update on PR, was busy with work for the last month and now got the time to add test into it

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
image-docus	⬜️ Ignored (Inspect)		Aug 4, 2025 10:46am

[danielroe]

thank you ❤️

and my apologies for taking so long to review.