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

Fix syntax for theme command documentation #4651

Merged
merged 1 commit into from
Oct 17, 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
5 changes: 5 additions & 0 deletions .changeset/thick-poets-brake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/cli': patch
---

Fix syntax for theme command documentation
4 changes: 2 additions & 2 deletions docs-shopify.dev/commands/examples/theme-console.example.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
theme:console
theme console

theme:console --url /products/classic-leather-jacket
theme console --url /products/classic-leather-jacket
2 changes: 1 addition & 1 deletion docs-shopify.dev/commands/examples/theme-init.example.sh
Original file line number Diff line number Diff line change
@@ -1 +1 @@
theme:init [name]
theme init [name]
4 changes: 2 additions & 2 deletions docs-shopify.dev/commands/examples/theme-push.example.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
theme:push
theme push

theme:push --unpublished --json
theme push --unpublished --json
6 changes: 3 additions & 3 deletions docs-shopify.dev/generated/generated_docs_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -4564,7 +4564,7 @@
"tabs": [
{
"title": "theme console",
"code": "theme:console\n\ntheme:console --url /products/classic-leather-jacket",
"code": "theme console\n\ntheme console --url /products/classic-leather-jacket",
"language": "bash"
}
],
Expand Down Expand Up @@ -5085,7 +5085,7 @@
"tabs": [
{
"title": "theme init",
"code": "theme:init [name]",
"code": "theme init [name]",
"language": "bash"
}
],
Expand Down Expand Up @@ -5774,7 +5774,7 @@
"tabs": [
{
"title": "theme push",
"code": "theme:push\n\ntheme:push --unpublished --json",
"code": "theme push\n\ntheme push --unpublished --json",
"language": "bash"
}
],
Expand Down
12 changes: 6 additions & 6 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,18 @@
* [`shopify plugins update`](#shopify-plugins-update)
* [`shopify search [QUERY]`](#shopify-search-query)
* [`shopify theme check`](#shopify-theme-check)
* [`shopify theme:console`](#shopify-themeconsole)
* [`shopify theme console`](#shopify-theme-console)
* [`shopify theme delete`](#shopify-theme-delete)
* [`shopify theme dev`](#shopify-theme-dev)
* [`shopify theme info`](#shopify-theme-info)
* [`shopify theme:init [name]`](#shopify-themeinit-name)
* [`shopify theme init [name]`](#shopify-theme-init-name)
* [`shopify theme language-server`](#shopify-theme-language-server)
* [`shopify theme list`](#shopify-theme-list)
* [`shopify theme open`](#shopify-theme-open)
* [`shopify theme package`](#shopify-theme-package)
* [`shopify theme publish`](#shopify-theme-publish)
* [`shopify theme pull`](#shopify-theme-pull)
* [`shopify theme:push`](#shopify-themepush)
* [`shopify theme push`](#shopify-theme-push)
* [`shopify theme rename`](#shopify-theme-rename)
* [`shopify theme share`](#shopify-theme-share)
* [`shopify upgrade`](#shopify-upgrade)
Expand Down Expand Up @@ -1702,7 +1702,7 @@ DESCRIPTION
(https://shopify.dev/docs/themes/tools/theme-check/checks)
```

## `shopify theme:console`
## `shopify theme console`

Shopify Liquid REPL (read-eval-print loop) tool

Expand Down Expand Up @@ -1892,7 +1892,7 @@ DESCRIPTION
specific theme.
```

## `shopify theme:init [name]`
## `shopify theme init [name]`

Clones a Git repository to use as a starting point for building a new theme.

Expand Down Expand Up @@ -2095,7 +2095,7 @@ DESCRIPTION
If no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.
```

## `shopify theme:push`
## `shopify theme push`

Uploads your local theme files to the connected store, overwriting the remote version if specified.

Expand Down
10 changes: 5 additions & 5 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4816,8 +4816,8 @@
"strict": true,
"summary": "Shopify Liquid REPL (read-eval-print loop) tool",
"usage": [
"theme:console",
"theme:console --url /products/classic-leather-jacket"
"theme console",
"theme console --url /products/classic-leather-jacket"
]
},
"theme:delete": {
Expand Down Expand Up @@ -5271,7 +5271,7 @@
"pluginType": "core",
"strict": true,
"summary": "Clones a Git repository to use as a starting point for building a new theme.",
"usage": "theme:init [name]"
"usage": "theme init [name]"
},
"theme:language-server": {
"aliases": [
Expand Down Expand Up @@ -5918,8 +5918,8 @@
"strict": true,
"summary": "Uploads your local theme files to the connected store, overwriting the remote version if specified.",
"usage": [
"theme:push",
"theme:push --unpublished --json"
"theme push",
"theme push --unpublished --json"
]
},
"theme:rename": {
Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/cli/commands/theme/console.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {Flags} from '@oclif/core'
export default class Console extends ThemeCommand {
static summary = 'Shopify Liquid REPL (read-eval-print loop) tool'

static usage = ['theme:console', 'theme:console --url /products/classic-leather-jacket']
static usage = ['theme console', 'theme console --url /products/classic-leather-jacket']

static descriptionWithMarkdown = `Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/cli/commands/theme/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {joinPath} from '@shopify/cli-kit/node/path'
export default class Init extends ThemeCommand {
static summary = 'Clones a Git repository to use as a starting point for building a new theme.'

static usage = 'theme:init [name]'
static usage = 'theme init [name]'

static descriptionWithMarkdown = `Clones a Git repository to your local machine to use as the starting point for building a theme.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/cli/commands/theme/push.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
export default class Push extends ThemeCommand {
static summary = 'Uploads your local theme files to the connected store, overwriting the remote version if specified.'

static usage = ['theme:push', 'theme:push --unpublished --json']
static usage = ['theme push', 'theme push --unpublished --json']

static descriptionWithMarkdown = `Uploads your local theme files to Shopify, overwriting the remote version if specified.

Expand Down