feat: allow tools based on this one to override the default prefix

ramsey · Apr 26, 2023 · 4794690 · 4794690
1 parent a2504ed
commit 4794690
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 7 deletions.
diff --git a/src/Command/Command.php b/src/Command/Command.php
@@ -197,7 +197,7 @@ private function buildComposerExtraConfiguration(): ExtraConfiguration
 
         $commandPrefix = $config['command-prefix']
             ?? $extra['command-prefix']
-            ?? ExtraConfiguration::DEFAULT_COMMAND_PREFIX;
+            ?? $this->configuration->composerDefaultCommandPrefix;
 
         return new ExtraConfiguration(
             commandName: (string) $this->getName(),

diff --git a/src/Composer/ExtraConfiguration.php b/src/Composer/ExtraConfiguration.php
@@ -41,8 +41,6 @@
  */
 final class ExtraConfiguration
 {
-    public const DEFAULT_COMMAND_PREFIX = 'dev';
-
     /**
      * @link https://getcomposer.org/doc/articles/scripts.md#writing-custom-commands Composer's custom commands
      * @link https://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes PHP's shorthand bytes options
@@ -62,7 +60,7 @@ final class ExtraConfiguration
      */
     public function __construct(
         public readonly string $commandName,
-        public readonly string $commandPrefix = self::DEFAULT_COMMAND_PREFIX,
+        public readonly string $commandPrefix,
         public readonly array $scripts = [],
         public readonly bool $override = false,
         public readonly int | string | null $memoryLimit = null,

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -28,6 +28,7 @@
 final class Configuration
 {
     public const EXTRA_PROPERTY = 'ramsey/devtools';
+    public const DEFAULT_COMMAND_PREFIX = 'dev';
 
     public readonly Composer $composer;
     public readonly string $composerBinDir;
@@ -44,6 +45,7 @@ public function __construct(
         public readonly ProcessFactory $processFactory = new ProcessFactory(),
         public readonly Filesystem $filesystem = new Filesystem(),
         public readonly string $composerExtraProperty = self::EXTRA_PROPERTY,
+        public readonly string $composerDefaultCommandPrefix = self::DEFAULT_COMMAND_PREFIX,
     ) {
         $this->composer = $this->composerFactory->getComposer();
         $this->composerBinDir = $this->getComposerBinDir();

diff --git a/tests/Composer/ExtraConfigurationTest.php b/tests/Composer/ExtraConfigurationTest.php
@@ -12,14 +12,14 @@ class ExtraConfigurationTest extends TestCase
 {
     public function testDefaults(): void
     {
-        $extra = new ExtraConfiguration('foobar');
+        $extra = new ExtraConfiguration('foobar', 'cmd');
 
         $this->assertSame('foobar', $extra->commandName);
-        $this->assertSame('dev', $extra->commandPrefix);
+        $this->assertSame('cmd', $extra->commandPrefix);
         $this->assertSame([], $extra->scripts);
         $this->assertFalse($extra->override);
         $this->assertNull($extra->memoryLimit);
-        $this->assertSame('dev:foobar', $extra->getPrefixedCommandName());
+        $this->assertSame('cmd:foobar', $extra->getPrefixedCommandName());
     }
 
     #[TestWith(['', 'foobar'])]

diff --git a/tests/ConfigurationTest.php b/tests/ConfigurationTest.php
@@ -44,5 +44,6 @@ public function testConstructorSetsDefaultValues(): void
             $configuration->execPath,
         );
         $this->assertSame('ramsey/devtools', $configuration->composerExtraProperty);
+        $this->assertSame('dev', $configuration->composerDefaultCommandPrefix);
     }
 }