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

Add support to choose a package manager in hydrogen init #1958

Merged
merged 6 commits into from
Apr 9, 2024
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
14 changes: 14 additions & 0 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1229,6 +1229,20 @@
"name": "quickstart",
"allowNo": false,
"type": "boolean"
},
"package-manager": {
"env": "SHOPIFY_HYDROGEN_FLAG_PACKAGE_MANAGER",
"hidden": true,
"name": "package-manager",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"npm",
"yarn",
"pnpm",
"unknown"
],
"type": "option"
}
},
"hasDynamicHelp": false,
Expand Down
19 changes: 19 additions & 0 deletions packages/cli/src/commands/hydrogen/init.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {runViteBuild} from './build-vite.js';
import {runViteDev} from './dev-vite.js';
import {runBuild as runClassicBuild} from './build.js';
import {runDev as runClassicDev} from './dev.js';
import {renderSelectPrompt} from '@shopify/cli-kit/node/ui';

const {renderTasksHook} = vi.hoisted(() => ({renderTasksHook: vi.fn()}));

Expand Down Expand Up @@ -488,6 +489,24 @@ describe('init', () => {
});
});

it('creates project prompting for package-manager', async () => {
await inTemporaryDirectory(async (tmpDir) => {
await runInit({
path: tmpDir,
git: false,
language: 'ts',
packageManager: 'unknown',
mockShop: true,
});

expect(renderSelectPrompt).toHaveBeenCalledWith(
expect.objectContaining({
message: 'Select package manager to install dependencies',
}),
);
});
});

it('creates projects with route files', async () => {
await inTemporaryDirectory(async (tmpDir) => {
await runInit({path: tmpDir, git: false, routes: true, language: 'ts'});
Expand Down
8 changes: 7 additions & 1 deletion packages/cli/src/commands/hydrogen/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ export default class Init extends Command {
env: 'SHOPIFY_HYDROGEN_FLAG_QUICKSTART',
default: false,
}),
'package-manager': Flags.string({
env: 'SHOPIFY_HYDROGEN_FLAG_PACKAGE_MANAGER',
hidden: true,
options: ['npm', 'yarn', 'pnpm', 'unknown'],
}),
};

async run(): Promise<void> {
Expand Down Expand Up @@ -140,7 +145,8 @@ export async function runInit(
);

if (showUpgrade) {
const packageManager = packageManagerFromUserAgent();
const packageManager =
options.packageManager ?? packageManagerFromUserAgent();
showUpgrade(
packageManager === 'unknown'
? ''
Expand Down
25 changes: 13 additions & 12 deletions packages/cli/src/lib/onboarding/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export type InitOptions = {
installDeps?: boolean;
git?: boolean;
quickstart?: boolean;
packageManager?: PackageManager;
};

export const LANGUAGES = {
Expand Down Expand Up @@ -459,9 +460,11 @@ export async function handleCssStrategy(
export async function handleDependencies(
projectDir: string,
controller: AbortController,
packageManagerFromFlag?: PackageManager,
shouldInstallDeps?: boolean,
) {
const detectedPackageManager = packageManagerFromUserAgent();
const detectedPackageManager =
packageManagerFromFlag ?? packageManagerFromUserAgent();
let actualPackageManager: PackageManager = 'npm';

if (shouldInstallDeps !== false) {
Expand Down Expand Up @@ -689,17 +692,15 @@ export async function renderProjectReady(
[
'Run',
{
command: outputContent`${outputToken.genericShellCommand(
[
project.directory === process.cwd()
? undefined
: `cd ${project.location.replace(/^\.\//, '')}`,
depsInstalled ? undefined : `${packageManager} install`,
formatPackageManagerCommand(packageManager, 'dev'),
]
.filter(Boolean)
.join(' && '),
)}`.value,
command: [
project.directory === process.cwd()
? undefined
: `cd ${project.location.replace(/^\.\//, '')}`,
depsInstalled ? undefined : `${packageManager} install`,
formatPackageManagerCommand(packageManager, 'dev'),
]
.filter(Boolean)
.join(' && '),
},
],
].filter((step): step is string[] => Boolean(step)),
Expand Down
1 change: 1 addition & 0 deletions packages/cli/src/lib/onboarding/local.ts
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ export async function setupLocalStarterTemplate(
await handleDependencies(
project.directory,
controller,
options.packageManager,
options.installDeps,
);

Expand Down
1 change: 1 addition & 0 deletions packages/cli/src/lib/onboarding/remote.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ export async function setupRemoteTemplate(
await handleDependencies(
project.directory,
controller,
options.packageManager,
options.installDeps,
);

Expand Down
Loading