Giter VIP home page Giter VIP logo

laravel-autodiscovery-lock's Introduction

Laravel autodiscovery lock

This package allows you to monitor the autodiscovery of your Laravel application. By running the supplied command in the post-autoload-dump event, you can generate a file that contains all the autodiscovered packages. This file can then be used to check for unacknowledged autodiscoveries.

Installation

First use composer to install the package using the following command

composer require goedemiddag/laravel-autodiscovery-lock

This will register a command in your application. To use this command, you need to add it to the post-autoload-dump event in your composer.json file right under the package:discover function laravel has already registered there. It should look something like this:

{
    "scripts": {
        "post-autoload-dump": [
            "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
            "@php artisan package:discover --ansi",
            "@php artisan autodiscovery:generate-lock"
        ]
    }
}

Usage

The package has two main usages. Generating a lock file to keep track of the autodiscoveries and checking for unacknowledged autodiscoveries,
and Verifying that your lock file and autodiscovered packages are in sync.

Generating the lock file

To generate the first autodiscovery lock file, run the following command:

php artisan autodiscovery:generate-lock

This will generate a file called autodiscovery.lock in the root of your project. This file contains all the autodiscovered packages and which providers / aliases they provide. After generating and committing this file, and registering the above command in the composer.json scripts you should be set for automatic updates each time composer installs or updates a package, or dumps the autoload in general.

Verifying the lock file

Validating the lock file allows you to make sure installed packages did not change their autodiscoveries without you knowing. To validate the lock file, run the following command:

php artisan autodiscovery:verify-lock

If there is a difference between the lock and the autodiscovered packages, the command will exit with a non-zero exit code. This allows you to use this command in your CI/CD pipeline with ease. Just run the command in the pipeline for your Pull Requests, and/or run the command in your build pipeline.

Pipeline examples

TBD

Contributing

Found a bug or want to add a new feature? Great! There are also many other ways to make meaningful contributions such as reviewing outstanding pull requests and writing documentation. Even opening an issue for a bug you found is appreciated.

If you would like to contribute code, please see our contributing guide

Credits

laravel-autodiscovery-lock's People

Contributors

benno6194 avatar dvdheiden avatar niekkeijzer avatar silvano-a avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

laravel-autodiscovery-lock's Issues

Add license file

Right now MIT is specified in composer.json, to remove ambiguity a "proper" license file should be added

Require-dev packages are included in the autodiscovery.lock

Describe the bug

Whenever composer is ran with dev packages included, the service providers and facades of these dev packages are included in the autodiscover.lock. This should not be the case, since this will always give a mismatch on locked items when ran in a build pipeline.

To Reproduce

Steps to reproduce the behavior:

  1. require a package with --dev,
  2. Run the script to generate the autodiscovery.lock

Expected behavior

packages installed with require-dev should be ommited. a notice should be displayed on screen when --require-dev is added to the composer install script notifying the user that autodiscovery.lock will ommit all packages in the require-dev area.

update actions to check code style

Right now we have configured php-cs-fixer, but we don't actually check if it has been run on pr. Adding a check to the actions would ensure the code style stays up to date.

PHP 7.4 support should be dropped

As of today, November 29th, php 7.4 is no longer supported. We should create a new major where we drop php 7.4 and make use of all the new features of PHP.
We can retain version 1.0 for projects yet to upgrade to PHP 8.x

Laravel 10 support

Is your feature request related to a problem? Please describe.

We need Laravel 10 support

Describe the solution you'd like

Laraevl 10 support

Versions

  • Laravel Version: 10.x

Replace collections with Value Objects

Collections right now are very generic, and only used for their formatting functions.
This should be done in a Value Object. This will have multiple advantages.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.