From 97b0421540c5698c235d5d8947fda06f734a04d5 Mon Sep 17 00:00:00 2001 From: "shopware-docs-updater[bot]" <313750211+shopware-docs-updater[bot]@users.noreply.github.com> Date: Wed, 30 Sep 2026 13:46:59 +0000 Subject: [PATCH] docs: rename sw-cli checker references to builtin Reflects shopware/shopware-cli#1627, which renamed the built-in extension validation checker from 'sw-cli' to 'builtin'. The old name remains accepted as a legacy alias for --only/--exclude but now emits a deprecation warning. --- products/tools/cli/automatic-refactoring.md | 2 +- products/tools/cli/index.md | 2 +- products/tools/cli/validation.md | 18 +++++++++++------- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/products/tools/cli/automatic-refactoring.md b/products/tools/cli/automatic-refactoring.md index 1809bf4af2..a54a4f1d30 100644 --- a/products/tools/cli/automatic-refactoring.md +++ b/products/tools/cli/automatic-refactoring.md @@ -49,7 +49,7 @@ The Administration Twig migrations are implemented as individual fixers under [` Other registered tools do not modify files in `fix` mode: - `php-cs-fixer` and `prettier` are used for [formatting](./formatter.md). -- `phpstan`, `storefront-twig`, and `sw-cli` report findings during [validation](./validation.md). +- `phpstan`, `storefront-twig`, and `builtin` report findings during [validation](./validation.md). Selecting one of these tools with `fix --only` therefore does not modify anything. diff --git a/products/tools/cli/index.md b/products/tools/cli/index.md index 22e9c97c54..213e712194 100644 --- a/products/tools/cli/index.md +++ b/products/tools/cli/index.md @@ -30,7 +30,7 @@ The Shopware CLI binary itself does not require PHP or Node.js for every command - **Composer** when the CLI prepares PHP verifier dependencies or resolves project/extension dependencies - **npm** when the CLI prepares its JavaScript verifier dependencies -Basic `extension validate` uses the built-in `sw-cli` checks and does not require a local PHP or Node.js runtime. The [Docker images](installation.md#docker-image) include the verifier runtime dependencies and are recommended for consistent validation, refactoring, and formatting environments. +Basic `extension validate` uses the built-in `builtin` checks and does not require a local PHP or Node.js runtime. The [Docker images](installation.md#docker-image) include the verifier runtime dependencies and are recommended for consistent validation, refactoring, and formatting environments. When you use the Docker-based development environment, run Composer and PHP tools inside the web container rather than on the host. See [Running Composer, PHP, and npm](../../../guides/development/dev-environment.md#running-composer-php-and-npm). diff --git a/products/tools/cli/validation.md b/products/tools/cli/validation.md index 78899e1343..a4c0d16a79 100644 --- a/products/tools/cli/validation.md +++ b/products/tools/cli/validation.md @@ -13,11 +13,15 @@ Validation covers technical criteria that can be automated, such as metadata, pa Validation has two modes: -- **Basic (default)**: Runs the built-in `sw-cli` checks, including metadata, icon, snippets, PHP linting, and packaging-related checks. It does not require a locally installed PHP or Node.js runtime. +- **Basic (default)**: Runs the built-in `builtin` checks, including metadata, icon, snippets, PHP linting, and packaging-related checks. It does not require a locally installed PHP or Node.js runtime. - **Full (`--full`)**: Runs the basic checks plus validation tools such as PHPStan, ESLint, Stylelint, and the Administration and Storefront Twig linters. :::warning -`--only` does not enable full validation. Without `--full`, `extension validate` runs only the built-in `sw-cli` checks. For example, `extension validate --only phpstan` does not run PHPStan; use `extension validate --full --only phpstan`. +`--only` does not enable full validation. Without `--full`, `extension validate` runs only the built-in `builtin` checks. For example, `extension validate --only phpstan` does not run PHPStan; use `extension validate --full --only phpstan`. +::: + +:::info +The built-in checker was previously named `sw-cli`. That name is still accepted by `--only` and `--exclude` as a legacy alias, but it now prints a deprecation warning. Use `builtin` in new commands and configuration. ::: ### Recommended setup: Docker @@ -55,7 +59,7 @@ For day-to-day development, validate the source directory. Before uploading a re ## What is validated in basic mode? -Basic mode runs the `sw-cli` tool. It includes checks such as the following; this list is not exhaustive. The identifier in brackets is the value you can use in [validation ignores](#validation-ignores). +Basic mode runs the `builtin` tool. It includes checks such as the following; this list is not exhaustive. The identifier in brackets is the value you can use in [validation ignores](#validation-ignores). Metadata and extension structure checks include: @@ -144,7 +148,7 @@ With `--full`, `extension validate` calls the validation check implemented by ea | Tool | Reports in `validate` | Rewrites in `fix` | Formats in `format` | Notes | | ----------------- | --------------------- | ----------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `sw-cli` | ✅ (extensions only) | — | — | Extension metadata, snippets, structure, packaging. Returns immediately for a project, so **projects get no metadata validation** | +| `builtin` | ✅ (extensions only) | — | — | Extension metadata, snippets, structure, packaging. Returns immediately for a project, so **projects get no metadata validation**. Legacy alias: `sw-cli` | | `phpstan` | ✅ | — | — | PHP static analysis; skipped for apps (no `composer.json`) | | `eslint` | ✅ | ✅ | — | JavaScript, Vue, TypeScript with Shopware-specific rules | | `stylelint` | ✅ | ✅ | — | CSS/SCSS with Shopware standards | @@ -161,8 +165,8 @@ Every tool is registered for all three verbs, but the unmarked combinations abov | Command | Tools that do work | | ------------------------------------- | --------------------------------------------------------------------------- | -| `extension validate` | `sw-cli`, `phpstan`, `eslint`, `stylelint`, `admin-twig`, `storefront-twig` | -| `project validate` | the same, minus `sw-cli` | +| `extension validate` | `builtin`, `phpstan`, `eslint`, `stylelint`, `admin-twig`, `storefront-twig` | +| `project validate` | the same, minus `builtin` | | `extension fix` / `project fix` | `rector`, `admin-twig`, `eslint`, `stylelint`, `symfony-xml` | | `extension format` / `project format` | `admin-twig`, `php-cs-fixer`, `prettier` | @@ -319,7 +323,7 @@ shopware-cli project validate /path/to/your/project `project validate` gathers local extension source directories and configured bundles and runs the registered validation tools against them. Composer-managed extensions resolved under `vendor/` are skipped. Project-level validation settings are read from `.config/shopware-project.yml` under `validation`. :::warning -`project validate` does not run extension metadata and packaging validation for every contained extension. The `sw-cli` verifier only runs with a single-extension context. Run `extension validate` for an individual extension when you also need its Composer or manifest metadata, icon, snippet, and package checks. +`project validate` does not run extension metadata and packaging validation for every contained extension. The `builtin` verifier only runs with a single-extension context. Run `extension validate` for an individual extension when you also need its Composer or manifest metadata, icon, snippet, and package checks. ::: If you omit the path, `project validate` discovers the nearest Shopware project by walking up from the current directory. A directory is recognized when its Composer metadata references `shopware/core` and `bin/console` exists; `PROJECT_ROOT` overrides this discovery.