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(vitest): install dependencies with the same version when prompted #6611

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,10 @@ You can specify additional CLI options like `--port` or `--https`. For a full li

Learn more about the [Command Line Interface](/guide/cli)

## Automatic Dependency Installation

Vitest will prompt you to install certain dependencies if they are not already installed. You can disable this behavior by setting the `VITEST_SKIP_INSTALL_CHECKS=1` environment variable.

## IDE Integrations

We also provided a official extension for Visual Studio Code to enhance your testing experience with Vitest.
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/node/cli/cli-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export async function startVitest(

if (requiredPackages) {
if (
!(await ctx.packageInstaller.ensureInstalled(requiredPackages, root))
!(await ctx.packageInstaller.ensureInstalled(requiredPackages, root, ctx.version))
) {
process.exitCode = 1
return ctx
Expand Down
7 changes: 4 additions & 3 deletions packages/vitest/src/node/packageInstaller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { isCI } from '../utils/env'
const __dirname = url.fileURLToPath(new URL('.', import.meta.url))

export class VitestPackageInstaller {
async ensureInstalled(dependency: string, root: string) {
async ensureInstalled(dependency: string, root: string, version?: string) {
if (process.env.VITEST_SKIP_INSTALL_CHECKS) {
return true
}
Expand Down Expand Up @@ -49,13 +49,14 @@ export class VitestPackageInstaller {
})

if (install) {
const packageName = version ? `${dependency}@${version}` : dependency
await (
await import('@antfu/install-pkg')
).installPackage(dependency, { dev: true })
).installPackage(packageName, { dev: true })
// TODO: somehow it fails to load the package after installation, remove this when it's fixed
process.stderr.write(
c.yellow(
`\nPackage ${dependency} installed, re-run the command to start.\n`,
`\nPackage ${packageName} installed, re-run the command to start.\n`,
),
)
process.exit()
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/node/plugins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export async function VitestPlugin(
const getRoot = () => ctx.config?.root || options.root || process.cwd()

async function UIPlugin() {
await ctx.packageInstaller.ensureInstalled('@vitest/ui', getRoot())
await ctx.packageInstaller.ensureInstalled('@vitest/ui', getRoot(), ctx.version)
return (await import('@vitest/ui')).default(ctx)
}

Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/node/reporters/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function createReporters(
const [reporterName, reporterOptions] = referenceOrInstance

if (reporterName === 'html') {
await ctx.packageInstaller.ensureInstalled('@vitest/ui', runner.root)
await ctx.packageInstaller.ensureInstalled('@vitest/ui', runner.root, ctx.version)
const CustomReporter = await loadCustomReporterModule(
'@vitest/ui/reporter',
runner,
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/node/workspace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ export class WorkspaceProject {
if (!this.isBrowserEnabled()) {
return
}
await this.ctx.packageInstaller.ensureInstalled('@vitest/browser', this.config.root)
await this.ctx.packageInstaller.ensureInstalled('@vitest/browser', this.config.root, this.ctx.version)
const { createBrowserServer } = await import('@vitest/browser')
await this.browser?.close()
const browser = await createBrowserServer(
Expand Down
Loading