osmianski/not-implemented

A simple library that helps to never forget unimplemented parts of the application.

v0.1.0 2023-03-28 19:33 UTC

Requires

• php: >=8.1

MIT

• Vladislav Osmianskij

• NotImplemented

README

A simple library that helps to never forget unimplemented parts of the application.

Installation

Add the Composer package to your project using the following command:

composer require osmianski/not-implemented

Usage

Have you even forgotten to return to a comment like this one?

function foo(?Bar $bar): void {
    // TODO: handle nulls
    ...
}

Previously, I had those, too.

Not anymore.

I found that throwing the NotImplemented exception instead of a mere comment makes you to pay off this bit of technical debt right away:

use Osmianski\Exceptions\NotImplemented;
...

function foo(?Bar $bar): void {
    if (!$bar) {
        throw new NotImplemented();        
    }
    
    ...
}

Only recently, I have found a really nice feature in PhpStorm called Exception Breakpoints. The idea is that whenever a specified exception is thrown, the debugger stops at the line that throws the exception.

And it's a perfect match for the NotImplemented exception. After configuring it, the debugger stops anytime when the execution hits a feature, or a special case, that is not implemented yet.

Configure it in Run -> View Breakpoints by pressing + -> PHP Exception Breakpoints, entering the full exception class name, and pressing OK:

License

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