Skip to content

Commit 43efeae

Browse files
committed
MQE-1959: Static-checks command can be configured
1 parent b1a100c commit 43efeae

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

docs/commands/mftf.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -463,18 +463,39 @@ The example parameters are taken from the `etc/config/.env.example` file.
463463

464464
### `static-checks`
465465

466-
Runs all MFTF static-checks on the test codebase that MFTF is currently attached to.
466+
Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to.
467+
If no script name argument is specified, all existing static check scripts will run.
467468

468-
#### Existing static checks
469+
#### Usage
469470

470-
* Test Dependency: Checks that test dependencies do not violate Magento module's composer dependencies.
471+
```bash
472+
vendor/bin/mftf static-checks [<names>]...
473+
```
471474

472-
#### Usage
475+
#### Examples
476+
477+
To check what existing static check scripts are available
478+
479+
```bash
480+
vendor/bin/mftf static-checks --help
481+
```
482+
483+
To run all existing static check scripts
473484

474485
```bash
475486
vendor/bin/mftf static-checks
476487
```
477488

489+
To run specific static check scripts
490+
491+
```bash
492+
vendor/bin/mftf static-checks testDependencies
493+
```
494+
495+
#### Existing static checks
496+
497+
* Test Dependency: Checks that test dependencies do not violate Magento module's composer dependencies.
498+
478499
### `upgrade:tests`
479500

480501
Applies all the MFTF major version upgrade scripts to test components in the given path (`test.xml`, `data.xml`, etc).

0 commit comments

Comments
 (0)