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

Allow glob imports in optimizeDeps.include #1571

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/playground/optimize-deps-glob/glob_example/baz.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const barMsg = '[success] glob import baz succesful'
1 change: 1 addition & 0 deletions packages/playground/optimize-deps-glob/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const str = 'Not exporting glob_example'
5 changes: 5 additions & 0 deletions packages/playground/optimize-deps-glob/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "optimize-deps-glob",
"version": "0.0.0",
"main": "index.js"
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ test('dep with css import', async () => {
test('dep w/ non-js files handled via plugin', async () => {
expect(await page.textContent('.plugin')).toMatch(`[success]`)
})

test('dep w/ deep import using glob pattern', async () => {
expect(await page.textContent('.glob')).toMatch(`[success]`)
})
3 changes: 3 additions & 0 deletions packages/playground/optimize-deps/glob.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { barMsg } from 'optimize-deps-glob/glob_example/baz'

document.querySelector('.glob').textContent = barMsg
4 changes: 4 additions & 0 deletions packages/playground/optimize-deps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ <h2>Dep w/ special file format supported via plugins</h2>
document.querySelector('.force-include').textContent = msg
document.querySelector('.plugin').textContent = VueSFC.render()
</script>

<h2>Include using glob pattern</h2>
<div class="glob"></div>
<script type="module" src="./glob.js"></script>
3 changes: 2 additions & 1 deletion packages/playground/optimize-deps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"react-dom": "^17.0.1",
"resolve-linked": "0.0.0",
"optimize-deps-linked": "0.0.0",
"optimize-deps-linked-include": "0.0.0"
"optimize-deps-linked-include": "0.0.0",
"optimize-deps-glob": "0.0.0"
}
}
5 changes: 4 additions & 1 deletion packages/playground/optimize-deps/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ module.exports = {
dedupe: ['react'],

optimizeDeps: {
include: ['optimize-deps-linked-include'],
include: [
'optimize-deps-linked-include',
'optimize-deps-glob/glob_example/*'
],
plugins: [vue()]
},

Expand Down
42 changes: 41 additions & 1 deletion packages/vite/src/node/optimizer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import { buildDefinePlugin } from '../plugins/define'
import { createFilter } from '@rollup/pluginutils'
import { Plugin } from '../plugin'
import { prompt } from 'enquirer'
import glob from 'fast-glob'
import { resolvePackageData } from '../plugins/resolve'

const debug = createDebugger('vite:optimize')

Expand Down Expand Up @@ -159,9 +161,47 @@ export async function optimizeDeps(

// Force included deps - these can also be deep paths
if (options.include) {
for (let id of options.include) {
const includedDeps = options.include.filter((id) => !id.includes('*'))
log(JSON.stringify(includedDeps))
// Resolve glob includes
for (const globId of options.include.filter((id) => id.includes('*'))) {
if (!/^[^\*]*\/\*.*$/.test(globId)) {
logger.error(
chalk.red(
`\nGlob patterns in ${chalk.white(
'optimizeDeps.include'
)} are only allowed after packages names, i.e. ${chalk.white(
'<package-name>/<pattern>'
)}.\nInvalid pattern found: "${chalk.yellow(globId)}".`
)
)
return
}

const [packageName, ...rest] = globId.split('/')
const aliased =
(await aliasResolver.resolveId(packageName))?.id || packageName
const packageData = resolvePackageData(aliased, root)

if (!packageData) {
logger.error(
chalk.red(
`\nNo corresponding package ${chalk.white(
packageName
)} found for glob pattern "${chalk.yellow(globId)}".`
)
)
} else {
glob.sync(rest.join('/'), { cwd: packageData.dir }).forEach((file) => {
includedDeps.push(packageName + '/' + file)
})
}
}

for (let id of includedDeps) {
const aliased = (await aliasResolver.resolveId(id))?.id || id
const filePath = tryNodeResolve(aliased, root, config.isProduction)

if (filePath) {
qualified[id] = filePath.id
}
Expand Down