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

chore!: update rollup commonjs plugin to v22 #8743

Merged
merged 13 commits into from Jun 24, 2022
Merged
Show file tree
Hide file tree
Changes from 12 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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Expand Up @@ -89,6 +89,9 @@ jobs:
- name: Test build
run: pnpm run test-build

- name: Test build with CJS plugin
run: pnpm run test-build-legacy-cjs

- name: Test docs
run: pnpm run test-docs

Expand Down
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -17,9 +17,10 @@
"format": "prettier --write --cache .",
"lint": "eslint --cache packages/*/{src,types,__tests__}/** playground/**/__tests__/**/*.ts scripts/**",
"typecheck": "tsc -p scripts --noEmit && tsc -p playground --noEmit",
"test": "run-s test-unit test-serve test-build",
"test": "run-s test-unit test-serve test-build test-build-legacy-cjs",
sodatea marked this conversation as resolved.
Show resolved Hide resolved
"test-serve": "vitest run -c vitest.config.e2e.ts",
"test-build": "cross-env VITE_TEST_BUILD=1 vitest run -c vitest.config.e2e.ts",
"test-build-legacy-cjs": "cross-env VITE_TEST_LEGACY_CJS_PLUGIN=1 pnpm test-build",
"test-unit": "vitest run",
"test-docs": "pnpm run docs-build",
"debug-serve": "cross-env VITE_DEBUG_SERVE=1 vitest run -c vitest.config.e2e.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/vite/package.json
Expand Up @@ -71,7 +71,7 @@
"@babel/types": "^7.18.4",
"@jridgewell/trace-mapping": "^0.3.13",
"@rollup/plugin-alias": "^3.1.9",
"@rollup/plugin-commonjs": "^21.1.0",
"@rollup/plugin-commonjs": "^22.0.1",
"@rollup/plugin-dynamic-import-vars": "^1.4.3",
"@rollup/plugin-json": "^4.1.0",
"@rollup/plugin-node-resolve": "13.3.0",
Expand Down
28 changes: 21 additions & 7 deletions packages/vite/rollup.config.ts
@@ -1,6 +1,7 @@
/* eslint-disable no-restricted-globals */
import fs from 'node:fs'
import path from 'node:path'
import url from 'node:url'
import nodeResolve from '@rollup/plugin-node-resolve'
import typescript from '@rollup/plugin-typescript'
import commonjs from '@rollup/plugin-commonjs'
Expand Down Expand Up @@ -134,15 +135,13 @@ function createNodePlugins(
},
// postcss-load-config calls require after register ts-node
'postcss-load-config/src/index.js': {
src: `require(configFile)`,
replacement: `__require(configFile)`
},
// @rollup/plugin-commonjs uses incorrect esm
'@rollup/plugin-commonjs/dist/index.es.js': {
src: `import { sync } from 'resolve';`,
replacement: `import __resolve from 'resolve';const sync = __resolve.sync;`
pattern: /require(?=\((configFile|'ts-node')\))/g,
replacement: `eval('require')`
}
}),

buildTimeImportMetaUrl(),

commonjs({
extensions: ['.js'],
// Optional peer deps of ws. Native deps that are mostly for performance.
Expand Down Expand Up @@ -287,6 +286,21 @@ function shimDepsPlugin(deps: Record<string, ShimOptions>): Plugin {
}
}

// The use of `import.meta.url` in source code is not reliable after bundling.
// For example, it is affected by the `isEntry` bug brought in by the Rollup CJS plugin
// https://github.com/rollup/plugins/pull/1180
// The better way is to resolve it at build time.
function buildTimeImportMetaUrl(): Plugin {
return {
name: 'buildTimeImportMetaUrl',
resolveImportMeta: (property, chunk) => {
if (property === 'url') {
return `'${url.pathToFileURL(chunk.moduleId).href}'`
}
}
}
}

function licensePlugin() {
return license({
thirdParty(dependencies) {
Expand Down
7 changes: 7 additions & 0 deletions packages/vite/src/node/config.ts
Expand Up @@ -588,6 +588,13 @@ export async function resolveConfig(
config = mergeConfig(config, externalConfigCompat(config, configEnv))
const optimizeDeps = config.optimizeDeps || {}

if (process.env.VITE_TEST_LEGACY_CJS_PLUGIN) {
config.legacy = {
...config.legacy,
buildRollupPluginCommonjs: true
}
}

const BASE_URL = resolvedBase

const resolved: ResolvedConfig = {
Expand Down
3 changes: 3 additions & 0 deletions playground/external/vite.config.js
Expand Up @@ -5,6 +5,9 @@ export default defineConfig({
minify: false,
rollupOptions: {
external: ['vue']
},
commonjsOptions: {
esmExternals: ['vue']
}
}
})
15 changes: 10 additions & 5 deletions playground/optimize-deps/__tests__/optimize-deps.spec.ts
Expand Up @@ -103,11 +103,16 @@ test('vue + vuex', async () => {
expect(await page.textContent('.vue')).toMatch(`[success]`)
})

test('esbuild-plugin', async () => {
expect(await page.textContent('.esbuild-plugin')).toMatch(
`Hello from an esbuild plugin`
)
})
// When we use the Rollup CommonJS plugin instead of esbuild prebundling,
// the esbuild plugins won't apply to dependencies
test.skipIf(isBuild && process.env.VITE_TEST_LEGACY_CJS_PLUGIN)(
'esbuild-plugin',
async () => {
expect(await page.textContent('.esbuild-plugin')).toMatch(
`Hello from an esbuild plugin`
)
}
)

test('import from hidden dir', async () => {
expect(await page.textContent('.hidden-dir')).toBe('hello!')
Expand Down
2 changes: 1 addition & 1 deletion playground/optimize-deps/vite.config.js
Expand Up @@ -72,7 +72,7 @@ module.exports = {
apply: 'build',
enforce: 'pre',
load(id) {
if (id === '__vite-browser-external:fs') {
if (id === '__vite-browser-external') {
return `export default {}; export function readFileSync() {}`
}
}
Expand Down
22 changes: 19 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.