theme checkcommand
Calls and runs Theme Check to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. Learn more about the checks that Theme Check runs.
Anchor to flagsFlags
The following flags are available for the theme check
command:
- Anchor to --fail-level <value>--fail-level <value>stringenv: SHOPIFY_FLAG_FAIL_LEVEL
Minimum severity for exit with error code
- Anchor to --init--initenv: SHOPIFY_FLAG_INIT
Generate a .theme-check.yml file
- Anchor to --list--listenv: SHOPIFY_FLAG_LIST
List enabled checks
- Anchor to --no-color--no-colorenv: SHOPIFY_FLAG_NO_COLOR
Disable color output.
- Anchor to --path <value>--path <value>stringenv: SHOPIFY_FLAG_PATH
The path where you want to run the command. Defaults to the current working directory.
- Anchor to --print--printenv: SHOPIFY_FLAG_PRINT
Output active config to STDOUT
- Anchor to --verbose--verboseenv: SHOPIFY_FLAG_VERBOSE
Increase the verbosity of the output.
- Anchor to -a, --auto-correct-a, --auto-correctenv: SHOPIFY_FLAG_AUTO_CORRECT
Automatically fix offenses
- Anchor to -C, --config <value>-C, --config <value>stringenv: SHOPIFY_FLAG_CONFIG
Use the config provided, overriding .theme-check.yml if present Supports all theme-check: config values, e.g., theme-check:theme-app-extension, theme-check:recommended, theme-check:all For backwards compatibility, :theme_app_extension is also supported
- Anchor to -e, --environment <value>-e, --environment <value>stringenv: SHOPIFY_FLAG_ENVIRONMENT
The environment to apply to the current command.
- Anchor to -o, --output <value>-o, --output <value>stringenv: SHOPIFY_FLAG_OUTPUT
The output format to use
- Anchor to -v, --version-v, --versionenv: SHOPIFY_FLAG_VERSION
Print Theme Check version
themecheck
- --fail-level <value>
Minimum severity for exit with error code
string
- --init
Generate a .theme-check.yml file
""
- --list
List enabled checks
""
- --no-color
Disable color output.
""
- --path <value>
The path where you want to run the command. Defaults to the current working directory.
string
- --print
Output active config to STDOUT
""
- --verbose
Increase the verbosity of the output.
""
- -a, --auto-correct
Automatically fix offenses
""
- -C, --config <value>
Use the config provided, overriding .theme-check.yml if present Supports all theme-check: config values, e.g., theme-check:theme-app-extension, theme-check:recommended, theme-check:all For backwards compatibility, :theme_app_extension is also supported
string
- -e, --environment <value>
The environment to apply to the current command.
string
- -o, --output <value>
The output format to use
string
- -v, --version
Print Theme Check version
""
export interface themecheck {
/**
* Automatically fix offenses
* @environment SHOPIFY_FLAG_AUTO_CORRECT
*/
'-a, --auto-correct'?: ''
/**
* Use the config provided, overriding .theme-check.yml if present
Supports all theme-check: config values, e.g., theme-check:theme-app-extension,
theme-check:recommended, theme-check:all
For backwards compatibility, :theme_app_extension is also supported
* @environment SHOPIFY_FLAG_CONFIG
*/
'-C, --config <value>'?: string
/**
* The environment to apply to the current command.
* @environment SHOPIFY_FLAG_ENVIRONMENT
*/
'-e, --environment <value>'?: string
/**
* Minimum severity for exit with error code
* @environment SHOPIFY_FLAG_FAIL_LEVEL
*/
'--fail-level <value>'?: string
/**
* Generate a .theme-check.yml file
* @environment SHOPIFY_FLAG_INIT
*/
'--init'?: ''
/**
* List enabled checks
* @environment SHOPIFY_FLAG_LIST
*/
'--list'?: ''
/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''
/**
* The output format to use
* @environment SHOPIFY_FLAG_OUTPUT
*/
'-o, --output <value>'?: string
/**
* The path where you want to run the command. Defaults to the current working directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string
/**
* Output active config to STDOUT
* @environment SHOPIFY_FLAG_PRINT
*/
'--print'?: ''
/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
/**
* Print Theme Check version
* @environment SHOPIFY_FLAG_VERSION
*/
'-v, --version'?: ''
}
Theme check
examples
theme check
theme check
shopify theme check [flags]