Weave Code
Phpspec Skip Example Extension Laravel Package
akeneo/phpspec-skip-example-extension
A phpspec extension from Akeneo that lets you skip selected examples in your specs, so you can temporarily disable tests without deleting or commenting them out. Handy for work-in-progress specs and known failures during refactoring.
akeneo/phpspec-skip-example-extension adds support for skipping individual phpspec examples instead of deleting or commenting out test code. Mark an example with a skip annotation and phpspec reports it as skipped while leaving the rest of your spec untouched—useful for temporarily disabling flaky or unfinished examples and restoring them later.
- Skip examples via a simple annotation, no code removal
- Keeps specs intact and version-controlled
- Integrates as a standard phpspec extension
- Installs quickly with Composer
- Reports skipped examples clearly in output
Frequently asked questions about Phpspec Skip Example Extension
- What is akeneo/phpspec-skip-example-extension used for?
- It is a PhpSpec extension that lets you mark individual examples as skipped through an annotation, so they are reported as skipped instead of executed. It is useful for temporarily disabling flaky or unfinished specs without deleting them or breaking the suite. It is not a Laravel package and only applies where PhpSpec is the spec runner.
- How do I install akeneo/phpspec-skip-example-extension?
- Install it as a development dependency with composer require --dev akeneo/phpspec-skip-example-extension. Then register the extension under extensions in your phpspec.yml and annotate the examples you want skipped. Pin the exact version and check Composer constraints against your PHP and phpspec/phpspec versions.
- Do I need to configure anything in phpspec.yml?
- Yes. The package hooks into PhpSpec's extension lifecycle, so it must be registered under the extensions key in phpspec.yml before annotations are honored. There is no Laravel config publishing or service provider. Keep the registration limited to the CI job or package that actually uses PhpSpec.
- Does this package work with Laravel?
- It can work in a Laravel codebase only if that codebase already uses PhpSpec, because it is a PhpSpec extension with no Laravel service provider, facade, or framework coupling. A standard Laravel app using PHPUnit or Pest has no architectural seam for it. Do not introduce PhpSpec solely to use this extension.
- Which Laravel versions are supported?
- There is no Laravel-specific version support; Laravel compatibility is indirect and depends on the project's PHP and PhpSpec versions. The package is dev-only and framework-agnostic, so the Laravel major version itself is not the constraint. Validate it in the exact CI job where PhpSpec runs rather than assuming support from the Laravel version.
- Which PHP and PhpSpec versions does it support?
- The last release was 2021-06-04, so do not assume support for current PHP 8.2 or 8.3 or the latest PhpSpec without checking Composer constraints. Pin the exact package version and test on the lowest and highest PHP runtimes you support. Because dependents are zero, expect to be an early adopter and validate extension registration and annotation parsing explicitly.
- How do I mark an example as skipped?
- Add the package's skip annotation to the individual PhpSpec example you want disabled, following the exact syntax in its README. PhpSpec should then report that example as skipped rather than executing it. Check annotation typos carefully, because an unsupported or misspelled annotation may silently fail to skip or skip more than intended.
- Can I use this extension with PHPUnit or Pest?
- No. It hooks into PhpSpec's extension and example-runner lifecycle, so it does not apply to PHPUnit or Pest test suites. Use PHPUnit's markTestSkipped or Pest's skip mechanisms in Laravel projects that use those runners.
- What alternatives exist for skipping tests in Laravel?
- For PHPUnit use markTestSkipped, and for Pest use its native skip support. In PhpSpec, prefer native pending-exception patterns or spec-level exclusion in CI if per-example annotations are not required. This extension is only worth adding when you specifically need PhpSpec per-example skip annotations and already run PhpSpec.
- Is akeneo/phpspec-skip-example-extension actively maintained?
- Maintenance appears minimal: the last release was 2021-06-04, stars are low, dependents are zero, and it is single-vendor Akeneo with PhpSpec itself having limited momentum. It is dev-only, so production security exposure is minimal, but upgrade risk is real when PHP or PhpSpec changes. Budget for a fork or internal patch and document an exit path to PHPUnit, Pest, or a small in-repo PhpSpec extension.
Weaver
How can I help you explore Laravel packages today?