PHPackages                             on3n3o/extended-route-list - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. on3n3o/extended-route-list

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

on3n3o/extended-route-list
==========================

This package extends default Laravel command route:list to include docblocks @see @author @version @access @param @return. Provides config file to setup what columns, how, and when to show.

01PHP

Since Jan 29Pushed 4y ago1 watchersCompare

[ Source](https://github.com/on3n3o/extended-route-list)[ Packagist](https://packagist.org/packages/on3n3o/extended-route-list)[ RSS](/packages/on3n3o-extended-route-list/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Extended Route List for Laravel
===============================

[](#extended-route-list-for-laravel)

This package extends default command `route:list` to include docblocks `@see @author @version @access @param @return`. Provides config file to setup what columns, how, and when to show.

Example
=======

[](#example)

Declared index function with docblock information inside `AppleController`

```
/**
 * Display a listing of all apples that currently logged in user has in his basket.
 *
 * @see https://docs.localhost/api/resources/apples.html#index
 * @since v.1.0
 * @access public
 *
 * @return \Illuminate\Http\JsonResponse
 */
public function index()
{
    return ApplesResource::collection(auth()->user()->apples()->paginate());
}
```

the web.php route only contains normal route

```
Route::resource('/apples', AppleController::class);
```

```
php artisan route:list --path=apples
```

will return

```
+--------+-----------+---------------------+----------------+-------------------------+------------+--------------------------------------------------------+
| Domain | Method    | URI                 | Name           | Action                  | Middleware | See                                                    |
+--------+-----------+---------------------+----------------+-------------------------+------------+--------------------------------------------------------+
|        | GET|HEAD  | apples              | apples.index   | AppleController@index   | web        | https://docs.localhost/api/resources/apples.html#index |
|        | POST      | apples              | apples.store   | AppleController@store   | web        |                                                        |
|        | GET|HEAD  | apples/create       | apples.create  | AppleController@create  | web        |                                                        |
|        | GET|HEAD  | apples/{apple}      | apples.show    | AppleController@show    | web        |                                                        |
|        | PUT|PATCH | apples/{apple}      | apples.update  | AppleController@update  | web        |                                                        |
|        | DELETE    | apples/{apple}      | apples.destroy | AppleController@destroy | web        |                                                        |
|        | GET|HEAD  | apples/{apple}/edit | apples.edit    | AppleController@edit    | web        |                                                        |
+--------+-----------+---------------------+----------------+-------------------------+------------+--------------------------------------------------------+

```

Installation
============

[](#installation)

```
composer require on3n3o/extended-route-list
```

Publish config file or use .env variables
-----------------------------------------

[](#publish-config-file-or-use-env-variables)

The file will be located in `config/extended-route-list.php`

```
php artisan vendor:publish --provider="On3n3o\\ExtendedRouteList\\ExtendedRouteListServiceProvider"
```

Or you can use `.env` variables

```
EXT_ROUTE_LIST_ACTION_FORMAT="short" # short or full
EXT_ROUTE_LIST_MIDDLEWARE_FORMAT="short" # short or full
EXT_ROUTE_LIST_MIDDLEWARE_LINESTYLE="single" # single or multi
EXT_ROUTE_LIST_JSON_DROP_COLUMN_IF_EMPTY=true # if used `--json` in command and column returns null or [] then drop it form output
EXT_ROUTE_LIST_JSON_OPTIONS=192 #CHECK THIS IF SHOULD BE INTEGER VALUE https://www.php.net/manual/en/json.constants.php

```

> If you want to show all columns you can use `--all-columns` or `-a`

> If you want to show compact columns you can use `--compact` or `-c`

> If you need to export to json use `--json`

Customization of columns
------------------------

[](#customization-of-columns)

To customize your column layout or wich should when be displayed you NEED to publish config.

Available docblock signatures
-----------------------------

[](#available-docblock-signatures)

```
/**
 * Class HomeController

 * @package App\Http\Controllers
 * @author  Marcin Maciejewski
 * @version v.1.2
 * @since   v.0.9
 * @access public
 * @link https://example.org/home
 * @see https://docs.localhost/api/HomeController
 * @see https://laravel.com/docs/8.x/controllers
 * @example api.get(`/home`)
 * @deprecated true
 *
 * @todo Better description
 * @todo Better description for class name
 * @fixme Better description for testing
 *
 * @inheritdoc parent::__construct()
 * @license MIT
 * @fixme now
 */
class HomeController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @uses auth()->user()
     * @see https://laravel.com/docs/5.4/controllers#method-index
     * @since v.1.0
     * @access public
     *
     * @param \Illuminate\Http\Request
     *
     * @return \Illuminate\Http\Response
     *
     * @throws \Exception
     */
    public function index(Request $request)
    {
        //
    }
```

Setting up unusual docblock signatures
--------------------------------------

[](#setting-up-unusual-docblock-signatures)

To do this you need to publish config and change inside `config/extended-route-list.php` where 'signature' is your new docblock signature.

```
return [
    ...
    'casts' => [
        ...
        'signature' => [
            'column_name' => 'signature',
            'tags' => ['@signature1', '@sig1'],
            'linestyle' => 'single'
        ]
    ],
    ...
    'columns' => [
        ...
        'Signature',
    ],
    'normal_columns' => [
        ...
        'Signature',
    ],
    // if you want to show in compact columns add whats below
    'compact_columns' => [
        ...
        'Signature',
    ],
    // if you want to show in all columns add whats below
    'all_columns' => [
        ...
        'Signature',
    ]

];
```

###  Health Score

14

—

LowBetter than 1% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity27

Early-stage or recently created project

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/8138489?v=4)[inż. Marcin Maciejewski](/maintainers/on3n3o)[@on3n3o](https://github.com/on3n3o)

### Embed Badge

![Health badge](/badges/on3n3o-extended-route-list/health.svg)

```
[![Health](https://phpackages.com/badges/on3n3o-extended-route-list/health.svg)](https://phpackages.com/packages/on3n3o-extended-route-list)
```

###  Alternatives

[maestroerror/laragent

Power of AI Agents in your Laravel project

639142.5k](/packages/maestroerror-laragent)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
