README

Sync Laravel Policies into Spatie permissions using deterministic names (configurable):

• posts.view_any
• posts.view
• posts.create
• posts.update
• posts.delete

This is a tiny, UI-agnostic package intended to be reused by admin panels (VortexPanel, Filament, Nova, ...).

Requirements

• PHP 8.1+
• Laravel 10+
• spatie/laravel-permission

Installation

composer require vortexpanel/policy-permission-sync

Publish config:

php artisan vendor:publish --tag=policy-permission-sync-config

Configuration

Edit config/policy-permission-sync.php.

The most reliable setup is to explicitly scan your policies directory:

'policy_paths' => [
    app_path('Policies'),
],

Customize permission naming

By default, permissions are created using a dot-style pattern:

'naming' => [
    'prefix' => '',
    'pattern' => '{resource}.{ability}',
],

You can change it to any pattern containing {resource} and {ability}:

// posts:view_any
'pattern' => '{resource}:{ability}',

// view_any:posts
'pattern' => '{ability}:{resource}',

// admin.posts.view_any
'prefix' => 'admin.',
'pattern' => '{resource}.{ability}',

Notes:

• If you use --prune, the package scopes pruning by extracting {resource} back from permission names using this same pattern. If your pattern doesn't include {resource}, pruning can't be scoped.

If your policies live in a custom directory/namespace, set the mapping:

'policy_paths' => [
    app_path('Domain/Blog/Policies'),
],

'policy_path_namespace_map' => [
    app_path('Domain/Blog/Policies') => 'App\\Domain\\Blog\\Policies',
],

Usage

Preview changes (no DB writes):

php artisan permissions:sync-policies --dry-run

Apply changes:

php artisan permissions:sync-policies

Prune stale permissions (opt-in):

php artisan permissions:sync-policies --prune

Target specific guards:

php artisan permissions:sync-policies --guards=web,api

Filter resources:

php artisan permissions:sync-policies --only=posts,users
php artisan permissions:sync-policies --except=audits

Show per-permission actions:

php artisan permissions:sync-policies --details
# or use artisan verbosity:
php artisan permissions:sync-policies -v

Development & Tests (inside this package repo)

If you see PDOException: could not find driver, your PHP CLI is missing the SQLite extension.

Ubuntu/WSL:

sudo apt-get update
sudo apt-get install -y php-sqlite3
php -m | grep -i sqlite

Then:

composer install
composer test
composer analyse

Testing in a real Laravel app (manual)

1. Install spatie/laravel-permission and run its migrations.

2. Create a policy, e.g. app/Policies/PostPolicy.php with methods like viewAny, view, create, update, delete.

3. Ensure your config scans the right directory:

'policy_paths' => [app_path('Policies')],

1. Run:

php artisan permissions:sync-policies

Then check the permissions table.

License

MIT