Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
CLI: Automatically setup Storefront API key during init (#13724)
Damian Legawiec916d5c002b1f
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.mdindex c1613c6854..95ecfb046d 100644--- a/packages/cli/CHANGELOG.md+++ b/packages/cli/CHANGELOG.md@@ -1,5 +1,11 @@# @spree/cli+## 2.0.0-beta.5++### Patch Changes++- Automatically update storefront `.env.local` with the real API key during `spree init`+## 2.0.0-beta.4### Patch Changesdiff --git a/packages/cli/package.json b/packages/cli/package.jsonindex f22673a773..e8e13c595d 100644--- a/packages/cli/package.json+++ b/packages/cli/package.json@@ -1,6 +1,6 @@{"name": "@spree/cli",- "version": "2.0.0-beta.4",+ "version": "2.0.0-beta.5","description": "CLI for managing Spree Commerce projects","type": "module","bin": {diff --git a/packages/cli/src/commands/init.ts b/packages/cli/src/commands/init.tsindex e50e804bb7..0757ddb22e 100644--- a/packages/cli/src/commands/init.ts+++ b/packages/cli/src/commands/init.ts@@ -3,6 +3,8 @@ import * as p from '@clack/prompts'import pc from 'picocolors'import { execaCommand } from 'execa'import { platform } from 'node:os'+import fs from 'node:fs'+import path from 'node:path'import { detectProject } from '../context.js'import { dockerCompose, rakeTask, streamLogs } from '../docker.js'import { DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD } from '../constants.js'@@ -37,6 +39,7 @@ export function registerInitCommand(program: Command): void {s.start('Configuring API key...')const apiKey = await fetchApiKey(ctx.projectDir)+ updateStorefrontEnv(ctx.projectDir, apiKey)s.stop(`API key: ${pc.cyan(apiKey)}`)if (flags.sampleData) {@@ -97,6 +100,14 @@ async function fetchApiKey(projectDir: string): Promise<string> {return match[0]}+export function updateStorefrontEnv(projectDir: string, apiKey: string): void {+ const envPath = path.join(projectDir, 'apps', 'storefront', '.env.local')+ if (!fs.existsSync(envPath)) return++ const content = fs.readFileSync(envPath, 'utf-8')+ fs.writeFileSync(envPath, content.replace(/SPREE_PUBLISHABLE_KEY=.*/, `SPREE_PUBLISHABLE_KEY=${apiKey}`))+}+async function openBrowser(url: string): Promise<void> {const os = platform()const cmd = os === 'darwin' ? 'open' : os === 'win32' ? 'start' : 'xdg-open'diff --git a/packages/cli/tests/init.test.ts b/packages/cli/tests/init.test.tsnew file mode 100644index 0000000000..fe4e19497c--- /dev/null+++ b/packages/cli/tests/init.test.ts@@ -0,0 +1,74 @@+import { describe, it, expect, afterEach } from 'vitest'+import fs from 'node:fs'+import path from 'node:path'+import os from 'node:os'+import { updateStorefrontEnv } from '../src/commands/init'++describe('updateStorefrontEnv', () => {+ const tempDirs: string[] = []++ function makeTempDir(): string {+ const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'spree-cli-init-test-'))+ tempDirs.push(dir)+ return dir+ }++ afterEach(() => {+ for (const dir of tempDirs) {+ fs.rmSync(dir, { recursive: true, force: true })+ }+ tempDirs.length = 0+ })++ it('replaces placeholder key with real API key', () => {+ const dir = makeTempDir()+ const envPath = path.join(dir, 'apps', 'storefront')+ fs.mkdirSync(envPath, { recursive: true })+ fs.writeFileSync(+ path.join(envPath, '.env.local'),+ 'SPREE_API_URL=http://localhost:3000\nSPREE_PUBLISHABLE_KEY=pk_REPLACE_ME_AFTER_DOCKER_START\n',+ )++ updateStorefrontEnv(dir, 'pk_test_abc123')++ const content = fs.readFileSync(path.join(envPath, '.env.local'), 'utf-8')+ expect(content).toContain('SPREE_PUBLISHABLE_KEY=pk_test_abc123')+ expect(content).not.toContain('pk_REPLACE_ME_AFTER_DOCKER_START')+ })++ it('replaces any existing key value', () => {+ const dir = makeTempDir()+ const envPath = path.join(dir, 'apps', 'storefront')+ fs.mkdirSync(envPath, { recursive: true })+ fs.writeFileSync(+ path.join(envPath, '.env.local'),+ 'SPREE_API_URL=http://localhost:3000\nSPREE_PUBLISHABLE_KEY=pk_old_key\n',+ )++ updateStorefrontEnv(dir, 'pk_new_key')++ const content = fs.readFileSync(path.join(envPath, '.env.local'), 'utf-8')+ expect(content).toContain('SPREE_PUBLISHABLE_KEY=pk_new_key')+ })++ it('preserves other env variables', () => {+ const dir = makeTempDir()+ const envPath = path.join(dir, 'apps', 'storefront')+ fs.mkdirSync(envPath, { recursive: true })+ fs.writeFileSync(+ path.join(envPath, '.env.local'),+ 'SPREE_API_URL=http://localhost:4567\nSPREE_PUBLISHABLE_KEY=pk_REPLACE_ME_AFTER_DOCKER_START\n',+ )++ updateStorefrontEnv(dir, 'pk_real_key')++ const content = fs.readFileSync(path.join(envPath, '.env.local'), 'utf-8')+ expect(content).toContain('SPREE_API_URL=http://localhost:4567')+ expect(content).toContain('SPREE_PUBLISHABLE_KEY=pk_real_key')+ })++ it('does nothing when .env.local does not exist', () => {+ const dir = makeTempDir()+ expect(() => updateStorefrontEnv(dir, 'pk_test')).not.toThrow()+ })+})diff --git a/packages/create-spree-app/CHANGELOG.md b/packages/create-spree-app/CHANGELOG.mdindex ec1474113b..fadfab7b80 100644--- a/packages/create-spree-app/CHANGELOG.md+++ b/packages/create-spree-app/CHANGELOG.md@@ -1,5 +1,11 @@# create-spree-app+## 0.3.3++### Patch Changes++- Bump `@spree/cli` dependency to `2.0.0-beta.5`+## 0.3.2### Patch Changesdiff --git a/packages/create-spree-app/package.json b/packages/create-spree-app/package.jsonindex e2f88efab6..91627dc827 100644--- a/packages/create-spree-app/package.json+++ b/packages/create-spree-app/package.json@@ -1,6 +1,6 @@{"name": "create-spree-app",- "version": "0.3.2",+ "version": "0.3.3","description": "Create a new Spree Commerce project with a single command","type": "module","bin": "./dist/index.js",diff --git a/packages/create-spree-app/src/templates/package-json.ts b/packages/create-spree-app/src/templates/package-json.tsindex b60df7146d..744357f02c 100644--- a/packages/create-spree-app/src/templates/package-json.ts+++ b/packages/create-spree-app/src/templates/package-json.ts@@ -14,7 +14,7 @@ export function rootPackageJsonContent(name: string): string {console: 'spree console',},dependencies: {- '@spree/cli': '2.0.0-beta.4',+ '@spree/cli': '2.0.0-beta.5',},}