Runtime: Add --no-minify flag

yannoff · yannoff · commit 889aa83ccc59 · 2025-10-24T12:33:18.000+02:00
diff --git a/README.md b/README.md
@@ -50,6 +50,7 @@ Name /  Shorthand   |  Type | Description
 `--file`, `-f`      | multi | Adds a single file to the archive                                                                                                                                                       |n
 `--dir`,  `-d`      | multi | Adds a sources directory to the archive<br/>_Possible dir spec formats:<br/>- `$dir` => include all files in directory<br/>- `$dir:$extension` => filter files on a specific extension_ |n
 `--meta`, `-m`      | multi | Adds a metadata to the archive<br/>_Metadata must be specified in the `$key:$value` format_                                                                                             |n
+`--no-minify`, `-n` | flag  | Don't minify PHP source files<br/>_Useful for debugging the compiled executable in case of runtime errors_                                                                              |n
 `--shebang-less`    | flag  | Produce a stub deprived of the shebang directive<br/>_Useful when the phar is meant to be included instead of being executed directly_                                                  |n
 `--quiet`, `-q`     | flag  | Reduce output messages amount: set verbosity level to `INFO` instead of default `DEBUG`                                                                                                 |n
 
diff --git a/src/Command/Compile.php b/src/Command/Compile.php
@@ -46,6 +46,7 @@ public function configure()
             ->addOption('output', 'o', Option::VALUE, 'Set the compiled archive output name')
             ->addOption('banner', 'b', Option::VALUE, 'Load legal notice from the given banner file')
             ->addOption('shebang-less', '', Option::FLAG, 'Produce a stub deprived of the shebang directive')
+            ->addOption('no-minify', 'n', Option::FLAG, "Don't minify php source files")
             // Global options
             ->addOption('quiet', 'q', Option::FLAG, 'Set output verbosity level to INFO instead of DEBUG')
         ;
@@ -66,14 +67,15 @@ public function execute()
         $output = $this->require('output');
 
         $shebang = (!$this->getOption('shebang-less'));
+        $min = (!$this->getOption('no-minify'));
 
         $quiet = $this->getOption('quiet');
         $this->setVerbosity($quiet ? Verbosity::INFO : Verbosity::DEBUG);
 
         $this
-            ->initBuilder($main)
-            ->addFiles($files)
-            ->addDirectories($dirs)
+            ->initBuilder($main, $min)
+            ->addFiles($files, $min)
+            ->addDirectories($dirs, $min)
             ->setNotice($banner)
             ->addMetadata($meta)
             ->publish($output, $shebang)
@@ -85,15 +87,16 @@ public function execute()
      * Creates & store the Phar builder instance
      *
      * @param string $main The main entrypoint script
+     * @param bool   $min  Toggle PHP files minifying
      *
      * @return self
      */
-    protected function initBuilder(string $main): self
+    protected function initBuilder(string $main, bool $min): self
     {
         $this->info('Initializing Phar builder...');
         $this->builder = PharBuilder::create($main);
         $this->info('Adding stub entrypoint script contents...');
-        $this->addFile($main);
+        $this->addFile($main, $min);
 
         return $this;
     }
@@ -103,15 +106,16 @@ protected function initBuilder(string $main): self
      *
      * @param string  $directory  The directory to scan for contents
      * @param ?string $extensions Filter on extension, may be "php" or "(php|phtml)"
+     * @param bool    $min        Toggle PHP files minifying (defaults: true)
      *
      * @return int The number of added files
      */
-    protected function addDirectory(string $directory, string $extensions = null): int
+    protected function addDirectory(string $directory, string $extensions = null, bool $min = true): int
     {
         $filter = ($extensions) ? sprintf('/\.%s$/', $extensions) : '';
         $files = Directory::find($directory, $filter);
 
-        array_walk($files, function ($file) { $this->addFile($file); });
+        array_walk($files, function ($file) use ($min) { $this->addFile($file, $min); });
 
         return count($files);
     }
@@ -120,17 +124,18 @@ protected function addDirectory(string $directory, string $extensions = null): i
      * Add a single file to the archive builder
      *
      * @param string $file A relative or absolute file path
+     * @param bool   $min  Toggle PHP files minifying
      *
      */
-    protected function addFile(string $file)
+    protected function addFile(string $file, bool $min)
     {
         $fullpath = $this->fullpath($file);
 
         $this->debug('+ ' . $file, 'grey');
 
         // Only minify pure PHP source files, other files such as
         // code templates for instance, should be left as-is
-        $minify = (pathinfo($file, PATHINFO_EXTENSION) === 'php');
+        $minify = (pathinfo($file, PATHINFO_EXTENSION) === 'php') && $min;
 
         $this->builder->addFile($fullpath, $file, $minify);
     }
@@ -139,18 +144,19 @@ protected function addFile(string $file)
      * Add a list of directory specifications to the archive builder
      *
      * @param string[] $dirs A list of specs in the form "$dir" or "$dir:$extension"
+     * @param bool     $min  Toggle PHP files minifying
      *
      * @return self
      */
-    protected function addDirectories(array $dirs): self
+    protected function addDirectories(array $dirs, bool $min): self
     {
         foreach ($dirs as $spec) {
             list($directory, $extensions) = explode(':', $spec);
 
             $wildcard = $extensions ? "*.$extensions" : 'all';
             $this->info("Scanning directory <strong>$directory</strong> for <strong>$wildcard</strong> files...");
 
-            $count = $this->addDirectory($directory, $extensions);
+            $count = $this->addDirectory($directory, $extensions, $min);
 
             $this->info("Added {$count} files.", 'grey');
         }
@@ -162,14 +168,15 @@ protected function addDirectories(array $dirs): self
      * Add a list of single files to the archive builder
      *
      * @param string[] $files A list of relative or absolute file paths
+     * @param bool     $min   Toggle PHP files minifying
      *
      * @return self
      */
-    protected function addFiles(array $files): self
+    protected function addFiles(array $files, bool $min): self
     {
         foreach ($files as $file) {
             $this->info("Adding single file <strong>$file</strong>...");
-            $this->addFile($file);
+            $this->addFile($file, $min);
         }
 
         return $this;

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ public function configure()`
`46`	`46`	`->addOption('output', 'o', Option::VALUE, 'Set the compiled archive output name')`
`47`	`47`	`->addOption('banner', 'b', Option::VALUE, 'Load legal notice from the given banner file')`
`48`	`48`	`->addOption('shebang-less', '', Option::FLAG, 'Produce a stub deprived of the shebang directive')`
	`49`	`+ ->addOption('no-minify', 'n', Option::FLAG, "Don't minify php source files")`
`49`	`50`	`// Global options`
`50`	`51`	`->addOption('quiet', 'q', Option::FLAG, 'Set output verbosity level to INFO instead of DEBUG')`
`51`	`52`	`;`
`@@ -66,14 +67,15 @@ public function execute()`
`66`	`67`	`$output = $this->require('output');`
`67`	`68`
`68`	`69`	`$shebang = (!$this->getOption('shebang-less'));`
	`70`	`+ $min = (!$this->getOption('no-minify'));`
`69`	`71`
`70`	`72`	`$quiet = $this->getOption('quiet');`
`71`	`73`	`$this->setVerbosity($quiet ? Verbosity::INFO : Verbosity::DEBUG);`
`72`	`74`
`73`	`75`	`$this`
`74`		`- ->initBuilder($main)`
`75`		`- ->addFiles($files)`
`76`		`- ->addDirectories($dirs)`
	`76`	`+ ->initBuilder($main, $min)`
	`77`	`+ ->addFiles($files, $min)`
	`78`	`+ ->addDirectories($dirs, $min)`
`77`	`79`	`->setNotice($banner)`
`78`	`80`	`->addMetadata($meta)`
`79`	`81`	`->publish($output, $shebang)`
`@@ -85,15 +87,16 @@ public function execute()`
`85`	`87`	`* Creates & store the Phar builder instance`
`86`	`88`	`*`
`87`	`89`	`* @param string $main The main entrypoint script`
	`90`	`+ * @param bool $min Toggle PHP files minifying`
`88`	`91`	`*`
`89`	`92`	`* @return self`
`90`	`93`	`*/`
`91`		`- protected function initBuilder(string $main): self`
	`94`	`+ protected function initBuilder(string $main, bool $min): self`
`92`	`95`	`{`
`93`	`96`	`$this->info('Initializing Phar builder...');`
`94`	`97`	`$this->builder = PharBuilder::create($main);`
`95`	`98`	`$this->info('Adding stub entrypoint script contents...');`
`96`		`- $this->addFile($main);`
	`99`	`+ $this->addFile($main, $min);`
`97`	`100`
`98`	`101`	`return $this;`
`99`	`102`	`}`
`@@ -103,15 +106,16 @@ protected function initBuilder(string $main): self`
`103`	`106`	`*`
`104`	`107`	`* @param string $directory The directory to scan for contents`
`105`	`108`	`* @param ?string $extensions Filter on extension, may be "php" or "(php\|phtml)"`
	`109`	`+ * @param bool $min Toggle PHP files minifying (defaults: true)`
`106`	`110`	`*`
`107`	`111`	`* @return int The number of added files`
`108`	`112`	`*/`
`109`		`- protected function addDirectory(string $directory, string $extensions = null): int`
	`113`	`+ protected function addDirectory(string $directory, string $extensions = null, bool $min = true): int`
`110`	`114`	`{`
`111`	`115`	`$filter = ($extensions) ? sprintf('/\.%s$/', $extensions) : '';`
`112`	`116`	`$files = Directory::find($directory, $filter);`
`113`	`117`
`114`		`- array_walk($files, function ($file) { $this->addFile($file); });`
	`118`	`+ array_walk($files, function ($file) use ($min) { $this->addFile($file, $min); });`
`115`	`119`
`116`	`120`	`return count($files);`
`117`	`121`	`}`
`@@ -120,17 +124,18 @@ protected function addDirectory(string $directory, string $extensions = null): i`
`120`	`124`	`* Add a single file to the archive builder`
`121`	`125`	`*`
`122`	`126`	`* @param string $file A relative or absolute file path`
	`127`	`+ * @param bool $min Toggle PHP files minifying`
`123`	`128`	`*`
`124`	`129`	`*/`
`125`		`- protected function addFile(string $file)`
	`130`	`+ protected function addFile(string $file, bool $min)`
`126`	`131`	`{`
`127`	`132`	`$fullpath = $this->fullpath($file);`
`128`	`133`
`129`	`134`	`$this->debug('+ ' . $file, 'grey');`
`130`	`135`
`131`	`136`	`// Only minify pure PHP source files, other files such as`
`132`	`137`	`// code templates for instance, should be left as-is`
`133`		`- $minify = (pathinfo($file, PATHINFO_EXTENSION) === 'php');`
	`138`	`+ $minify = (pathinfo($file, PATHINFO_EXTENSION) === 'php') && $min;`
`134`	`139`
`135`	`140`	`$this->builder->addFile($fullpath, $file, $minify);`
`136`	`141`	`}`
`@@ -139,18 +144,19 @@ protected function addFile(string $file)`
`139`	`144`	`* Add a list of directory specifications to the archive builder`
`140`	`145`	`*`
`141`	`146`	`* @param string[] $dirs A list of specs in the form "$dir" or "$dir:$extension"`
	`147`	`+ * @param bool $min Toggle PHP files minifying`
`142`	`148`	`*`
`143`	`149`	`* @return self`
`144`	`150`	`*/`
`145`		`- protected function addDirectories(array $dirs): self`
	`151`	`+ protected function addDirectories(array $dirs, bool $min): self`
`146`	`152`	`{`
`147`	`153`	`foreach ($dirs as $spec) {`
`148`	`154`	`list($directory, $extensions) = explode(':', $spec);`
`149`	`155`
`150`	`156`	`$wildcard = $extensions ? "*.$extensions" : 'all';`
`151`	`157`	`$this->info("Scanning directory <strong>$directory</strong> for <strong>$wildcard</strong> files...");`
`152`	`158`
`153`		`- $count = $this->addDirectory($directory, $extensions);`
	`159`	`+ $count = $this->addDirectory($directory, $extensions, $min);`
`154`	`160`
`155`	`161`	`$this->info("Added {$count} files.", 'grey');`
`156`	`162`	`}`
`@@ -162,14 +168,15 @@ protected function addDirectories(array $dirs): self`
`162`	`168`	`* Add a list of single files to the archive builder`
`163`	`169`	`*`
`164`	`170`	`* @param string[] $files A list of relative or absolute file paths`
	`171`	`+ * @param bool $min Toggle PHP files minifying`
`165`	`172`	`*`
`166`	`173`	`* @return self`
`167`	`174`	`*/`
`168`		`- protected function addFiles(array $files): self`
	`175`	`+ protected function addFiles(array $files, bool $min): self`
`169`	`176`	`{`
`170`	`177`	`foreach ($files as $file) {`
`171`	`178`	`$this->info("Adding single file <strong>$file</strong>...");`
`172`		`- $this->addFile($file);`
	`179`	`+ $this->addFile($file, $min);`
`173`	`180`	`}`
`174`	`181`
`175`	`182`	`return $this;`