Skip to content

Skip generating pnpm-workspace.yaml when template provides one #7591

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.

Sign up for GitHub

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

Merged
jantnovi merged 1 commit into from
May 21, 2026
+37 −2
Merged

Skip generating pnpm-workspace.yaml when template provides one #7591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions packages/app/src/cli/services/init/init.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import {ensurePnpmWorkspaceFile} from './init.js'
import {describe, expect, test} from 'vitest'
import {inTemporaryDirectory, writeFile, readFile} from '@shopify/cli-kit/node/fs'
import {joinPath} from '@shopify/cli-kit/node/path'

describe('ensurePnpmWorkspaceFile', () => {
test('generates file when template has none', async () => {
await inTemporaryDirectory(async (tmpDir) => {
await ensurePnpmWorkspaceFile(tmpDir, ['extensions/*'])

const content = await readFile(joinPath(tmpDir, 'pnpm-workspace.yaml'))
expect(content).toBe("packages:\n - 'extensions/*'")
})
})

test('does not overwrite existing file from template', async () => {
await inTemporaryDirectory(async (tmpDir) => {
const templateContent = `packages:\n - 'extensions/*'\nallowBuilds:\n esbuild: true\n`
await writeFile(joinPath(tmpDir, 'pnpm-workspace.yaml'), templateContent)

await ensurePnpmWorkspaceFile(tmpDir, ['extensions/*'])

const content = await readFile(joinPath(tmpDir, 'pnpm-workspace.yaml'))
expect(content).toBe(templateContent)
})
})
})
12 changes: 10 additions & 2 deletions packages/app/src/cli/services/init/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,7 @@ async function init(options: InitOptions) {
packageJSON.workspaces = workspacesFolders
break
case 'pnpm': {
const workspacesContent = workspacesFolders.map((folder) => ` - '${folder}'`).join(`\n`)
await writeFile(joinPath(templateScaffoldDir, 'pnpm-workspace.yaml'), `packages:\n${workspacesContent}`)
await ensurePnpmWorkspaceFile(templateScaffoldDir, workspacesFolders)
// Ensure that the installation of dependencies doesn't fail when using
// pnpm due to missing peerDependencies.
await appendFile(joinPath(templateScaffoldDir, '.npmrc'), `auto-install-peers=true\n`)
Expand Down Expand Up @@ -273,4 +272,13 @@ function detectAdditionalWorkspacesFolders(directory: string) {
return ['web', 'web/frontend'].filter((folder) => fileExistsSync(joinPath(directory, folder)))
}

export async function ensurePnpmWorkspaceFile(directory: string, workspacesFolders: string[]) {
const pnpmWorkspacePath = joinPath(directory, 'pnpm-workspace.yaml')
if (await fileExists(pnpmWorkspacePath)) {
return
}
const workspacesContent = workspacesFolders.map((folder) => ` - '${folder}'`).join(`\n`)
await writeFile(pnpmWorkspacePath, `packages:\n${workspacesContent}`)
}

export default init
Loading