muqsit/preprocessor

PHP library to ready code for production

dev-master 2024-06-15 02:48 UTC

Requires

• php: ^8.1
• nikic/php-parser: 5.0.*
• php-parallel-lint/php-console-color: ^1.0
• phpstan/phpstan: 1.11.*
• symfony/filesystem: ~6.4.0

Requires (Dev)

• phpunit/phpunit: ^10.3
• pocketmine/pocketmine-mp: 5.6.0

LGPL-3.0-only

README

Comment out debug code before pushing it to production.

Quick Start

Installing

Install the library using composer:

composer require muqsit/preprocessor:dev-master

Preprocessing a list of PHP files

require_once "src/proxy/Client.php";
require_once "src/proxy/Server.php";
require_once "src/proxy/Logger.php";

use muqsit\preprocessor\PreProcessor;
use proxy\Logger;

PreProcessor::fromPaths(["src/proxy/Client.php", "src/proxy/Server.php", "src/proxy/Logger.php"]) // files to preprocess
	->commentOut(Logger::class, "debug")
	->export("./preprocessed-src"); // preprocessed files written to ./preprocessed-src folder

Result:

final class Client{

	/** @var Logger */
	private $logger;

	public function onLogin(){
-		$this->logger->debug("Client logged in");
+		/* $this->logger->debug("Client logged in ") */;
	}
}

Preprocessing a directory of PHP files

require "vendor/autoload.php";

use muqsit\preprocessor\PreProcessor;
use pocketmine\entity\Entity;
use pocketmine\Player;
use pocketmine\utils\Utils;

PreProcessor::fromDirectory("./src") // searches for .php files recursively
	->commentOut(Logger::class, "debug")
	->commentOut(Utils::class, "testValidInstance")
	->commentOut(Utils::class, "validateCallableSignature")
	->commentOut(Client::class, "debugClientStatus")
	->export("./preprocessed-src");

Result:

final class Player extends Client implements LoggerHolder{

	public function onJoin() : void{
-		$this->getLogger()->debug("Player {$this->getUUID()} joined");
+		/* $this->getLogger()->debug("Player {$this->getUUID()} joined") */;

-		$this->sendMessage("You joined the server"); $this->debugClientStatus();
+		$this->sendMessage("You joined the server"); /* $this->debugClientStatus() */;
	}

	public function registerQuitListener(Closure $listener) : void{
-		Utils::validateCallableSignature(function(Player $player) : void{}, $listener);
+		/* Utils::validateCallableSignature(function(Player $player) : void{}, $listener) */;
	}
}

Libraries Used

• nikic/PHP-Parser - Reading and writing nodes using the formatting-preservation functionality
• phpstan/phpstan - Determinig type of variables, properties, methods etc within the scope