ylsideas/feature-flags

A Laravel package for handling feature flags

v2.6.0 2024-05-28 05:43 UTC

Requires

• php: ^8.2
• illuminate/contracts: 11.*|10.*

Requires (Dev)

• composer/semver: ^3.0
• larastan/larastan: ^2.0|^1.0
• laravel/pint: ^1.0
• nunomaduro/collision: ^8.0|^7.8|^6.0
• orchestra/testbench: ^9.0|^8.0|^7.0
• pestphp/pest: ^1.21|^2.34
• pestphp/pest-plugin-arch: ^2.6
• pestphp/pest-plugin-laravel: ^1.1|^2.3
• phpstan/extension-installer: ^1.1
• phpstan/phpdoc-parser: ^1.15
• phpstan/phpstan-deprecation-rules: ^1.0
• rector/rector: ^1.0

MIT

• Peter Fox

• feature-flags
• ylsideas

README

A Feature flag is at times referred to as a feature toggle or feature switch. Ultimately it's a coding strategy to be used along with source control to make it easier to continuously integrate and deploy. The idea of the flags works by essentially safe guarding sections of code from executing if a feature flag isn't in a switched on state.

This package aims to make implementing such flags across your application a great deal easier by providing solutions that work with not only your code but your routes, blade files, task scheduling and validations.

The Feature flagging dashboard for Laravel

In late 2022 we decided to start work on a dashboard that will work on top of all the awesomeness that Feature flags for Laravel gives you. Right now you can join the waiting list.

How adding feature flags looks with this package

It's pretty simple, you can start of with just simple calls to check if a flag's state is on or off.

Features::accessible('my-feature') // returns true or false

One of the unique features of this package is that it integrates heavily into Laravel by allowing you to configure different things such as access to route, schedule tasks or modifying the query builder.

To get a full understanding, it's best to read the docs.

Upgrading

This project is currently at version 2 and is somewhat different to version 1. If you are using Laravel 9 and PHP8 you should aim to use version 2. Version 1 is no longer supported. There is an upgrade guide for moving from version 1 to version 2.

Installation

You can install the package via composer:

composer require ylsideas/feature-flags:^2.0

Once installed you should publish the config with the following command.

php artisan vendor:publish --provider="YlsIdeas\FeatureFlags\FeatureFlagsServiceProvider" --tag=config

You can customise the features.php config in a number of ways.

Documentation

For the complete documentation, visit https://feature-flags.docs.ylsideas.co/.

Package Development

If you wish to develop new features for this package you may run the tests using the following command.

composer test

Make sure any code you work on is linted as well.

composer lint

and that the code doesn't introduce errors with PHPStan.

composer analyse

Please make sure you follow the Pull Request template for all proposed changes. Ignoring it will mean the PR will be ignored.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Peter Fox
• All Contributors

License

The MIT License (MIT). Please see License File for more information.