Merge pull request #3 from codenamephp/main

Compatibility with registerTask()

Author: bastianschwarz

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.0](https://github.com/codenamephp/deployer.npm/tree/1.0.0) (2022-02-06)
+
+[Full Changelog](https://github.com/codenamephp/deployer.npm/compare/3ba187fd8d4c1c5ca4ce8d64c8621c9b668b25ca...1.0.0)
+
 
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

MIGRATION.md

@@ -0,0 +1,22 @@
+# Migration
+
+Contains all information needed to migrate between major versions
+
+## 1.x -> 2.x
+
+Added `\de\codenamephp\deployer\base\task\iTaskWithName` and `\de\codenamephp\deployer\base\task\iTaskWithDescription` to
+`\de\codenamephp\deployer\npm\task\run\AbstractRunTask` and `\de\codenamephp\deployer\npm\task\AbstractNpmTask` classes so if you extended those you need to
+implement those methods.
+
+Also `\de\codenamephp\deployer\npm\task\run\Generic::__construct` now has a mandatory `$taskName` parameter and an optional description parameter:
+
+```
+   public function __construct(string                $scriptName,
++                              public string         $taskName,
+                               array                 $arguments = [],
++                              public string         $taskDescription = '',
+                               iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(),
+
+```
+
+so you need to update any instantiations.

src/task/AbstractNpmTask.php

@@ -17,7 +17,8 @@
 
 namespace de\codenamephp\deployer\npm\task;
 
-use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
 use de\codenamephp\deployer\npm\command\iNpmCommandFactory;
@@ -26,9 +27,9 @@
 /**
  * Base class for npm command setting the binary to npm
  */
-abstract class AbstractNpmTask implements iTask {
+abstract class AbstractNpmTask implements iTaskWithName, iTaskWithDescription {
 
-  public function __construct(public iNpmCommandFactory $commandFactory = new WithBinaryFromDeployer(), public iRunner $runner = new WithDeployerFunctions()) {}
+  public function __construct(public iNpmCommandFactory $commandFactory = new WithBinaryFromDeployer(), public iRunner $runner = new WithDeployerFunctions()) { }
 
   /**
    * Gets the command for npm, e.g. install or run-script

src/task/install/Development.php

@@ -22,7 +22,17 @@
  */
 final class Development extends AbstractInstallTask {
 
+  public const NAME = 'npm:install:development';
+
   public function getArguments() : array {
     return ['--production=false'];
   }
+
+  public function getDescription() : string {
+    return 'Runs npm install with the --production=false flag so development dependencies will be installed.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/install/Production.php

@@ -22,7 +22,17 @@
  */
 final class Production extends AbstractInstallTask {
 
+  public const NAME = 'npm:install';
+
   public function getArguments() : array {
     return ['--production'];
   }
+
+  public function getDescription() : string {
+    return 'Runs npm install with the production flag to dev dependencies are not installed.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/run/AbstractRunTask.php

@@ -17,15 +17,16 @@
 
 namespace de\codenamephp\deployer\npm\task\run;
 
-use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
 use de\codenamephp\deployer\npm\command\run\DecorateCommandFactory;
 use de\codenamephp\deployer\npm\command\run\iNpmRunCommandFactory;
 
-abstract class AbstractRunTask implements iTask {
+abstract class AbstractRunTask implements iTaskWithName, iTaskWithDescription {
 
-  public function __construct(public iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(), public iRunner $runner = new WithDeployerFunctions()) {}
+  public function __construct(public iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(), public iRunner $runner = new WithDeployerFunctions()) { }
 
   abstract public function getScriptName() : string;
 

src/task/run/Generic.php

@@ -38,7 +38,9 @@ final class Generic extends AbstractRunTask {
    * @param iRunner $runner The runner that runs the command. Will be passed to parent.
    */
   public function __construct(string                $scriptName,
+                              public string         $taskName,
                               array                 $arguments = [],
+                              public string         $taskDescription = '',
                               iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(),
                               iRunner               $runner = new WithDeployerFunctions()) {
     parent::__construct($commandFactory, $runner);
@@ -53,4 +55,12 @@ public function getScriptName() : string {
   public function getArguments() : array {
     return $this->arguments;
   }
+
+  public function getDescription() : string {
+    return $this->taskDescription;
+  }
+
+  public function getName() : string {
+    return $this->taskName;
+  }
 }

src/task/run/build/Development.php

@@ -24,6 +24,8 @@
  */
 final class Development extends AbstractRunTask {
 
+  public const NAME = 'npm:build:development';
+
   public function getScriptName() : string {
     return 'build:development';
   }
@@ -32,4 +34,11 @@ public function getArguments() : array {
     return [];
   }
 
+  public function getDescription() : string {
+    return 'Runs the npm build script that builds the assets for development (without minifying, compression, ...).';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/run/build/Production.php

@@ -24,6 +24,8 @@
  */
 final class Production extends AbstractRunTask {
 
+  public const NAME = 'npm:build';
+
   public function getScriptName() : string {
     return 'build';
   }
@@ -32,4 +34,11 @@ public function getArguments() : array {
     return [];
   }
 
+  public function getDescription() : string {
+    return 'Runs the npm build script that builds the assets for production (with minifying, compression, ...).';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

test/task/install/DevelopmentTest.php

@@ -38,4 +38,12 @@ protected function setUp() : void {
   public function testGetArguments() : void {
     self::assertEquals(['--production=false'], $this->sut->getArguments());
   }
+
+  public function testGetName() : void {
+    self::assertEquals(Development::NAME, $this->sut->getName());
+  }
+
+  public function testGEtDescription() : void {
+    self::assertEquals('Runs npm install with the --production=false flag so development dependencies will be installed.', $this->sut->getDescription());
+  }
 }