bakgul/file-history

This is a helper package, and it can't be used independently. Its purpose is to log the changes of files when they are created/deleted/updated through the commands shipped with the packages, which are part of Packagified Laravel. So this package can't track the changes made manually.

Maintainers

Details

github.com/bulentAkgul/file-history

Source

Issues

Installs: 84

Dependents: 8

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

v4.0.2 2023-02-22 17:15 UTC

Requires

MIT 494e4c7d52cc2273d792299924e2458c7c78bc14

  • Bulent Akgul <bulent.akgul.woop@me.com>

This package is auto-updated.

Last update: 2024-05-22 20:20:02 UTC

README

This is a helper package, to keep/undo/redo file history when files are created/deleted/updated via console commands of my other packages.

That being said, I don't see any reason not be able to use it outside console independantely. But I've never tried it.

Installation

sail composer require bakgul/file-history --dev

Optionally, you can publish package's config file

sail artisan vendor:publish --tag=file-history

Commands

This package contains 3 console commands. They are quite self-explanatory and don't expect any arguments or options.

sail artisan file-history:delete

sail artisan file-history:redo

sail artisan file-history:undo

Usage

First, you should use HasHistory trait on command file and call $this->logFile(); in handle() method. This will generate a history file to use during current command's lifecycle.

Then you should execute the following code before you create/update/delete a file/folder:

use Bakgul\FileHistory\FileHistory;

FileHistory::set(
    path: 'path to file',
    isDir: true/false,
    isCreated: true/false
);

License

This is open-sourced software licensed under the MIT license.