README

Overview

Ci4RouteChecker is a CodeIgniter 4 CLI command that checks all defined routes for missing controllers, methods, and potential issues. It helps developers identify incorrect route configurations in their applications.

Requirements

CodeIgniter 4.3+
PHP 7.4+

Installation

You can install this package via Composer:

composer require louisstanley/ci4-route-checker

After installation, the command will be available for use within your CodeIgniter 4 project.

Usage

Run the following command in your project root to check all defined routes:

php spark routes:check

Features

Checks for missing controllers.
Checks for missing methods in controllers.
Detects closure-based routes (currently marked as warnings).
Identifies mismatches in method parameter counts (can be configured as a warning or error).
Displays warnings and errors in a structured format.

Configuration

Ci4RouteChecker now supports configuration via a publishable config file. You can publish the configuration file with:

php spark routes:publish-checker-config

This will create a config file at app/Config/RouteChecker.php where you can modify settings as needed.

Available Configuration Options

The published configuration file includes the following options:

<?php

namespace LouisStanley\Ci4RouteChecker\Config;

use CodeIgniter\Config\BaseConfig;

class RouteChecker extends BaseConfig
{
    /**
     * Whether to treat a parameter mismatch as an error.
     *
     * If true, a parameter mismatch will be treated as an error.
     * If false, a parameter mismatch will be treated as a warning.
     */
    public bool $treatParameterMismatchAsError = false;

    /**
     * Routes to ignore.
     *
     * @var array
     *
     * Example:
     *
     * public $ignoredRoutes = [
     *    'admin/*',
     *    'api/*',
     * ];
     */
    public array $ignoredRoutes = [];
}

GitHub Actions Integration

You can automate route checking in your CI/CD pipeline using GitHub Actions. Add the following workflow file to .github/workflows/route-check.yml:

name: Route Checker

on: [push, pull_request]

jobs:
  route-check:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.1'
          tools: composer

      - name: Install dependencies
        run: composer install --no-progress --no-suggest --prefer-dist

      - name: Run Route Checker
        run: php spark routes:check

This will automatically check routes whenever code is pushed or a pull request is created, helping to ensure that no broken routes are introduced into the project.

Output

Warnings: Highlight potential issues, such as closure routes or parameter mismatches.
Errors: Indicate invalid routes where controllers or methods are missing.
Success Message: Confirms all routes are correctly configured if no issues are found.

Example Output

Checking defined routes...
Warnings found:
- Route: /example/closure
  Warning: Closure found: /example/closure
Invalid routes found:
- Route: /missing-controller
  Error: Controller not found: App\Controllers\MissingController
- Route: /missing-method
  Error: Method not found: App\Controllers\ExampleController::missingMethod

License

This project is licensed under the MIT License.

Author

Developed by Louis Stanley.

louisstanley / ci4-route-checker

Maintainers

Details