Type Config
File match .shopware-project.yml .shopware-project.yaml .shopware-project.local.yml .shopware-project.local.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/shopware-cli-project-store-configuration/latest.json
Source https://raw.githubusercontent.com/shopware/shopware-cli/main/shopware-project-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: Config

Definitions

Config object
include string[]
url string

The URL of the Shopware instance

compatibility_date string

Controls date-based compatibility behavior, formatted as YYYY-MM-DD.

format=date
build object
15 nested properties
disable_asset_copy boolean

When enabled, the assets will not be copied to the public folder

remove_extension_assets boolean

When enabled, the assets of extensions will be removed from the extension public folder. (Requires Shopware 6.5.2.0)

keep_extension_source boolean

When enabled, the extensions source code will be keep in the final build

keep_source_maps boolean

When enabled, the source maps will not be removed from the final build

cleanup_paths string[]

Paths to delete for the final build

browserslist string

Browserslist configuration for the Storefront build

exclude_extensions string[]

Extensions to exclude from the build

disable_storefront_build boolean

When enabled, the storefront build will be skipped

force_extension_build ConfigBuildExtension[]

Extensions to force build for, even if they have compiled files

force_admin_build boolean

When enabled, the shopware admin will be built

keep_node_modules string[]

Keep following node_modules in the final build

mjml object

ConfigBuildMJML defines the configuration for MJML email template compilation.

2 nested properties
enabled boolean

Whether to enable MJML compilation

search_paths string[]

Directories to search for MJML files

asset_caching boolean

When enabled, built assets are cached locally and restored on subsequent builds when sources haven't changed

hooks object

ConfigBuildHooks defines hooks to run at specific points during CI builds.

6 nested properties
pre string[]

Commands to run before anything runs

post string[]

Commands to run after everything completes

pre-composer string[]

Commands to run before composer install

post-composer string[]

Commands to run after composer install

pre-assets string[]

Commands to run before asset build

post-assets string[]

Commands to run after asset build

Shopware bundles to include in builds (alternative to composer.json extra.shopware-bundles)

admin_api object
5 nested properties
client_id string

Client ID of integration

client_secret string

Client Secret of integration

username string

Username of admin user

password string

Password of admin user

disable_ssl_check boolean

Disable SSL certificate check

dump object
4 nested properties
rewrite Record<string, object>

Allows to rewrite single columns, perfect for GDPR compliance

nodata string[]

Only export the schema of these tables

ignore string[]

Ignore these tables from export

where Record<string, string>

Add an where condition to that table, schema is table name as key, and where statement as value

deployment object
5 nested properties
hooks object
6 nested properties
pre string
post string
pre-install string
post-install string
pre-update string
post-update string
store object
1 nested properties
license-domain string
cache object
1 nested properties
always_clear boolean
extension-management object

The extension management of the deployment

5 nested properties
enabled boolean
exclude string[]
overrides Record<string, object>
force_updates string[]
force-update string[]
one-time-tasks object[]
validation object

ConfigValidation is used to configure the project validation.

2 nested properties

Ignore items from the validation.

image_proxy object
1 nested properties
url string

The URL of the upstream server to proxy requests to when files are not found locally

disable_composer_scripts boolean

When enabled, composer scripts will be disabled during CI builds

disable_composer_install boolean

When enabled, composer install will be skipped during CI builds

ConfigAdminApi object
client_id string

Client ID of integration

client_secret string

Client Secret of integration

username string

Username of admin user

password string

Password of admin user

disable_ssl_check boolean

Disable SSL certificate check

ConfigBuild object
disable_asset_copy boolean

When enabled, the assets will not be copied to the public folder

remove_extension_assets boolean

When enabled, the assets of extensions will be removed from the extension public folder. (Requires Shopware 6.5.2.0)

keep_extension_source boolean

When enabled, the extensions source code will be keep in the final build

keep_source_maps boolean

When enabled, the source maps will not be removed from the final build

cleanup_paths string[]

Paths to delete for the final build

browserslist string

Browserslist configuration for the Storefront build

exclude_extensions string[]

Extensions to exclude from the build

disable_storefront_build boolean

When enabled, the storefront build will be skipped

force_extension_build ConfigBuildExtension[]

Extensions to force build for, even if they have compiled files

force_admin_build boolean

When enabled, the shopware admin will be built

keep_node_modules string[]

Keep following node_modules in the final build

mjml object

ConfigBuildMJML defines the configuration for MJML email template compilation.

2 nested properties
enabled boolean

Whether to enable MJML compilation

search_paths string[]

Directories to search for MJML files

asset_caching boolean

When enabled, built assets are cached locally and restored on subsequent builds when sources haven't changed

hooks object

ConfigBuildHooks defines hooks to run at specific points during CI builds.

6 nested properties
pre string[]

Commands to run before anything runs

post string[]

Commands to run after everything completes

pre-composer string[]

Commands to run before composer install

post-composer string[]

Commands to run after composer install

pre-assets string[]

Commands to run before asset build

post-assets string[]

Commands to run after asset build

Shopware bundles to include in builds (alternative to composer.json extra.shopware-bundles)

ConfigBuildExtension object

ConfigBuildExtension defines the configuration for forcing extension builds.

name string required

Name of the extension

ConfigBuildHooks object

ConfigBuildHooks defines hooks to run at specific points during CI builds.

pre string[]

Commands to run before anything runs

post string[]

Commands to run after everything completes

pre-composer string[]

Commands to run before composer install

post-composer string[]

Commands to run after composer install

pre-assets string[]

Commands to run before asset build

post-assets string[]

Commands to run after asset build

ConfigBuildMJML object

ConfigBuildMJML defines the configuration for MJML email template compilation.

enabled boolean

Whether to enable MJML compilation

search_paths string[]

Directories to search for MJML files

ConfigDeployment object
hooks object
6 nested properties
pre string
post string
pre-install string
post-install string
pre-update string
post-update string
store object
1 nested properties
license-domain string
cache object
1 nested properties
always_clear boolean
extension-management object

The extension management of the deployment

5 nested properties
enabled boolean
exclude string[]
overrides Record<string, object>
force_updates string[]
force-update string[]
one-time-tasks object[]
ConfigDeploymentOverrides Record<string, object>
ConfigDump object
rewrite Record<string, object>

Allows to rewrite single columns, perfect for GDPR compliance

nodata string[]

Only export the schema of these tables

ignore string[]

Ignore these tables from export

where Record<string, string>

Add an where condition to that table, schema is table name as key, and where statement as value

ConfigImageProxy object
url string

The URL of the upstream server to proxy requests to when files are not found locally

ConfigProjectBundle object

ConfigProjectBundle defines a project-level Shopware bundle.

path string required

Relative path from project root to the bundle directory

name string

Optional override for the bundle name; defaults to the directory basename

ConfigValidation object

ConfigValidation is used to configure the project validation.

Ignore items from the validation.

ConfigValidationIgnoreExtension object
name string

The name of the extension to ignore.

ConfigValidationIgnoreItem object

ConfigValidationIgnoreItem is used to ignore items from the validation.

identifier string

The identifier of the item to ignore.

path string

The path of the item to ignore.

message string

The message of the item to ignore.