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.

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

feat(crwa): Always install using yarn v4 #9861

Merged
merged 2 commits into from
Jan 21, 2024
Merged

feat(crwa): Always install using yarn v4 #9861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0e9a4f
feat(crwa): Offer to install with all yarn versions
Tobbe Jan 21, 2024
f0ede66
update crwa e2e tests
Tobbe Jan 21, 2024
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
57 changes: 20 additions & 37 deletions packages/create-redwood-app/src/create-redwood-app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,6 @@ const { telemetry } = Parser(hideBin(process.argv), {

const tui = new RedwoodTUI()

// Credit to esbuild: https://github.com/rtsao/esbuild/blob/c35a4cebf037237559213abc684504658966f9d6/lib/install.ts#L190-L199
function isYarnBerryOrNewer() {
const { npm_config_user_agent: npmConfigUserAgent } = process.env

if (npmConfigUserAgent) {
const match = npmConfigUserAgent.match(/yarn\/(\d+)/)

if (match && match[1]) {
return parseInt(match[1], 10) >= 2
}
}

return false
}

const USE_GITPOD_TEXT = [
` As an alternative solution, you can launch a Redwood project using GitPod instead. GitPod is a an online IDE.`,
` See: ${terminalLink(
Expand Down Expand Up @@ -250,7 +235,10 @@ async function installNodeModules(newAppDir) {
})
tui.startReactive(tuiContent)

const yarnInstallSubprocess = execa('yarn install', {
const oldCwd = process.cwd()
process.chdir(newAppDir)

const yarnInstallSubprocess = execa(`yarn install`, {
shell: true,
cwd: newAppDir,
})
Expand All @@ -271,9 +259,12 @@ async function installNodeModules(newAppDir) {
)
recordErrorViaTelemetry(error)
await shutdownTelemetry()
process.chdir(oldCwd)
process.exit(1)
}

process.chdir(oldCwd)

tuiContent.update({
header: '',
content: `${RedwoodStyling.green('✔')} Installed node modules`,
Expand Down Expand Up @@ -611,6 +602,11 @@ async function handleCommitMessagePreference(commitMessageFlag) {
async function handleYarnInstallPreference(yarnInstallFlag) {
// Handle case where flag is set
if (yarnInstallFlag !== null) {
tui.drawText(
`${RedwoodStyling.green('✔')} ${
yarnInstallFlag ? 'Will' : 'Will not'
} run yarn install based on command line flag`
)
return yarnInstallFlag
}

Expand Down Expand Up @@ -673,6 +669,11 @@ async function createRedwoodApp() {
type: 'string',
describe: 'Commit message for the initial commit',
})
.option('yarn-install', {
default: null,
type: 'boolean',
describe: 'Install node modules. Skip via --no-yarn-install.',
})
.option('telemetry', {
default: true,
type: 'boolean',
Expand All @@ -692,22 +693,10 @@ async function createRedwoodApp() {
].join('\n')
)

const _isYarnBerryOrNewer = isYarnBerryOrNewer()

// Only permit the yarn install flag on yarn 1.
if (!_isYarnBerryOrNewer) {
cli.option('yarn-install', {
default: null,
type: 'boolean',
describe: 'Install node modules. Skip via --no-yarn-install.',
})
}

// Extract the args as provided by the user in the command line
// TODO: Make all flags have the 'flag' suffix
const args = parsedFlags._
const yarnInstallFlag =
parsedFlags['yarn-install'] ?? !_isYarnBerryOrNewer ? parsedFlags.yes : null
const yarnInstallFlag = parsedFlags['yarn-install'] ?? parsedFlags.yes
const typescriptFlag = parsedFlags.typescript ?? parsedFlags.yes
const overwrite = parsedFlags.overwrite
const gitInitFlag = parsedFlags['git-init'] ?? parsedFlags.yes
Expand Down Expand Up @@ -745,11 +734,7 @@ async function createRedwoodApp() {
commitMessage = await handleCommitMessagePreference(commitMessageFlag)
}

let yarnInstall = false

if (!_isYarnBerryOrNewer) {
yarnInstall = await handleYarnInstallPreference(yarnInstallFlag)
}
const yarnInstall = await handleYarnInstallPreference(yarnInstallFlag)

let newAppDir = path.resolve(process.cwd(), targetDir)

Expand All @@ -765,9 +750,7 @@ async function createRedwoodApp() {
.getActiveSpan()
?.setAttribute('yarn-install-time', Date.now() - yarnInstallStart)
} else {
if (!_isYarnBerryOrNewer) {
tui.drawText(`${RedwoodStyling.info('ℹ')} Skipped yarn install step`)
}
tui.drawText(`${RedwoodStyling.info('ℹ')} Skipped yarn install step`)
}

// Generate types
Expand Down
3 changes: 3 additions & 0 deletions packages/create-redwood-app/tests/e2e.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ describe('create-redwood-app', () => {
--git-init, --git Initialize a git repository [boolean] [default: null]
-m, --commit-message Commit message for the initial commit
[string] [default: null]
--yarn-install Install node modules. Skip via --no-yarn-install.
[boolean] [default: null]
--telemetry Enables sending telemetry events for this create
command and all Redwood CLI commands
https://telemetry.redwoodjs.com
Expand Down Expand Up @@ -64,6 +66,7 @@ describe('create-redwood-app', () => {
[?25h✔ Creating your Redwood app in ./redwood-app based on command line argument
✔ Using TypeScript based on command line flag
✔ Will initialize a git repo based on command line flag
✔ Will run yarn install based on command line flag
[?25l⠋ Creating project files
[?25h[?25l✔ Project files created
[?25h[?25l⠋ Initializing a git repo
Expand Down
Loading