Skip to content

Commit

Permalink
Add shortcut keys to theme dev
Browse files Browse the repository at this point in the history
This commit adds shortcut keys to the theme dev CLI service. The keys are as follows:
e - open theme editor
t - preview your theme locally
p - preview your theme (share)
  • Loading branch information
EvilGenius13 committed Nov 20, 2024
1 parent 255b400 commit 6a9b244
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions packages/theme/src/cli/services/dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {Theme} from '@shopify/cli-kit/node/themes/types'
import {checkPortAvailability, getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
import {AbortError} from '@shopify/cli-kit/node/error'
import {openURL} from '@shopify/cli-kit/node/system'
import readline from 'readline'

const DEFAULT_HOST = '127.0.0.1'
const DEFAULT_PORT = '9292'
Expand Down Expand Up @@ -104,6 +105,33 @@ export async function dev(options: DevOptions) {
renderWarning({headline: 'Failed to open the development server.', body: error.stack ?? error.message})
})
}

readline.emitKeypressEvents(process.stdin)
if (process.stdin.isTTY) {
process.stdin.setRawMode(true)
}

process.stdin.on('keypress', (_str, key) => {
if (key.ctrl && key.name === 'c') {
process.exit()
} else if (key.name === 't') {
openURL(`http://${host}:${port}`).catch((error) => {
renderWarning({headline: 'Failed to open localhost.', body: error.stack ?? error.message})
})
} else if (key.name === 'e') {
openURL(`https://${options.store}/admin/themes/${options.theme.id}/editor`).catch((error) => {
renderWarning({headline: 'Failed to open theme editor.', body: error.stack ?? error.message})
})
} else if (key.name === 'p') {
openURL(`https://${options.store}/?preview_theme_id=${options.theme.id}`).catch((error) => {
renderWarning({headline: 'Failed to open theme preview.', body: error.stack ?? error.message})
})
} else if (key.name === 'g') {
openURL(`http://${host}:${port}/gift_cards/${options.store}/preview`).catch((error) => {
renderWarning({headline: 'Failed to open gift card preview.', body: error.stack ?? error.message})
})
}
})
}

export function renderLinks(store: string, themeId: string, host = DEFAULT_HOST, port = DEFAULT_PORT) {
Expand All @@ -113,7 +141,7 @@ export function renderLinks(store: string, themeId: string, host = DEFAULT_HOST,
body: [
{
list: {
title: {bold: 'Preview your theme'},
title: {bold: 'Preview your theme (t)'},
items: [
{
link: {
Expand All @@ -128,23 +156,23 @@ export function renderLinks(store: string, themeId: string, host = DEFAULT_HOST,
[
{
link: {
label: 'Preview your gift cards',
label: 'Preview your gift cards (g)',
url: `${localUrl}/gift_cards/[store_id]/preview`,
},
},
],
[
{
link: {
label: 'Customize your theme at the theme editor',
label: 'Customize your theme at the theme editor (e)',
url: `${remoteUrl}/admin/themes/${themeId}/editor`,
},
},
],
[
{
link: {
label: 'Share your theme preview',
label: 'Share your theme preview (p)',
url: `${remoteUrl}/?preview_theme_id=${themeId}`,
},
},
Expand Down

0 comments on commit 6a9b244

Please sign in to comment.