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
import * as p from '@clack/prompts'
import { type Command, InvalidArgumentError } from 'commander'
import pc from 'picocolors'
import { MIGRATE, MIGRATE_STATUS, rollbackCommand } from '../backend.js'
import { detectProject } from '../context.js'
import { warnDeprecated } from '../deprecation.js'
import { dockerComposeExecOrRun } from '../docker.js'
export function registerMigrateCommand(program: Command): void {
program
.command('migrate')
.description('Install pending Spree migrations, then run them')
.argument('[args...]')
.allowUnknownOption(true)
.passThroughOptions(true)
.action(async (args: string[]) => {
if (args.length > 0) {
warnDeprecated(
`spree migrate ${args.join(' ')}`,
`spree migrate, or spree exec bin/rails db:migrate ${args.join(' ')}`,
)
}
const ctx = detectProject()
// The migration tasks are silent when there's nothing to do, which
// leaves the operator wondering whether anything ran.
console.log(`\n${pc.bold('→ Installing + running pending Spree migrations...')}`)
await dockerComposeExecOrRun([...MIGRATE, ...args], ctx.projectDir, {
edgeHint: 'the edge boot installs and runs pending migrations itself',
})
p.note(
`Run ${pc.bold('spree migrate:status')} to inspect the migration log.`,
'Migrations up to date',
)
})
program
.command('migrate:rollback')
.description('Roll back the last migration (`--steps n` to roll back n)')
.option('--steps <n>', 'number of migrations to roll back', parseSteps)
.argument('[args...]')
// No passThroughOptions: --steps must be read wherever it appears, even
// after a raw `STEP=2` left over from the deprecated form.
.allowUnknownOption(true)
.action(async (rawArgs: string[], flags: { steps?: number }) => {
// An explicit --steps wins over a raw STEP=, so the two never both reach the backend.
const args = flags.steps ? rawArgs.filter((arg) => !arg.startsWith('STEP=')) : rawArgs
if (args.length > 0) {
const step = args.length === 1 && args[0].startsWith('STEP=') ? args[0] : undefined
warnDeprecated(
`spree migrate:rollback ${args.join(' ')}`,
step
? `spree migrate:rollback --steps ${step.slice('STEP='.length)}`
: `spree exec bin/rails db:rollback ${args.join(' ')}`,
)
}
const ctx = detectProject()
await dockerComposeExecOrRun(rollbackCommand(flags.steps, args), ctx.projectDir)
})
program
.command('migrate:status')
.description('Show which migrations have run')
.action(async () => {
const ctx = detectProject()
await dockerComposeExecOrRun(MIGRATE_STATUS, ctx.projectDir)
})
}
function parseSteps(value: string): number {
const steps = Number(value)
if (!Number.isInteger(steps) || steps < 1) {
throw new InvalidArgumentError(`must be a positive whole number, got "${value}"`)
}
return steps
}