Merge pull request #7 from runcommand/arbitrary-path

Support specifying a custom artifact path

Author: danielbachhuber

README.md

@@ -10,7 +10,7 @@ Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contr
 ## Using
 
 ~~~
-wp dist-archive <path> [--format=<format>]
+wp dist-archive <path> [<target>] [--format=<format>]
 ~~~
 
 For a plugin in a directory 'wp-content/plugins/hello-world', this command
@@ -36,6 +36,9 @@ script in each project.
 	<path>
 		Path to the project that includes a .distignore file.
 
+	[<target>]
+		Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
+
 	[--format=<format>]
 		Choose the format for the archive.
 		---

command.php

@@ -30,6 +30,9 @@
  * <path>
  * : Path to the project that includes a .distignore file.
  *
+ * [<target>]
+ * : Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
+ *
  * [--format=<format>]
  * : Choose the format for the archive.
  * ---
@@ -44,6 +47,15 @@
 $dist_archive_command = function( $args, $assoc_args ) {
 
 	list( $path ) = $args;
+	if ( isset( $args[1] ) ) {
+		$archive_file = $args[1];
+		$info = pathinfo( $archive_file );
+		if ( '.' === $info['dirname'] ) {
+			$archive_file  = getcwd() . '/' . $info['basename'];
+		}
+	} else {
+		$archive_file = null;
+	}
 	$path = rtrim( realpath( $path ), '/' );
 	if ( ! is_dir( $path ) ) {
 		WP_CLI::error( 'Provided path is not a directory.' );
@@ -78,7 +90,9 @@
 	}
 
 	if ( 'zip' === $assoc_args['format'] ) {
-		$archive_file = $archive_base . $version . '.zip';
+		if ( is_null( $archive_file ) ) {
+			$archive_file = dirname( $path ) . '/' . $archive_base . $version . '.zip';
+		}
 		$excludes = implode( ' --exclude ', $ignored_files );
 		if ( ! empty( $excludes ) ) {
 			$excludes = ' --exclude ' . $excludes;
@@ -88,7 +102,8 @@
 		WP_CLI::debug( "Running: {$cmd}", 'dist-archive' );
 		$ret = WP_CLI::launch( escapeshellcmd( $cmd ), false, true );
 		if ( 0 === $ret->return_code ) {
-			WP_CLI::success( "Created {$archive_file}" );
+			$filename = pathinfo( $archive_file, PATHINFO_BASENAME );
+			WP_CLI::success( "Created {$filename}" );
 		} else {
 			$error = $ret->stderr ? $ret->stderr : $ret->stdout;
 			WP_CLI::error( $error );

features/dist-archive.feature

@@ -20,3 +20,20 @@ Feature: Generate a distribution archive of a project
     And the wp-content/plugins/hello-world/hello-world.php file should exist
     And the wp-content/plugins/hello-world/.travis.yml file should not exist
     And the wp-content/plugins/hello-world/bin directory should not exist
+
+  Scenario: Generate a ZIP archive to a custom path
+    Given a WP install
+
+    When I run `wp scaffold plugin hello-world`
+    Then the wp-content/plugins/hello-world directory should exist
+    And the wp-content/plugins/hello-world/hello-world.php file should exist
+    And the wp-content/plugins/hello-world/.travis.yml file should exist
+    And the wp-content/plugins/hello-world/bin directory should exist
+
+    When I run `wp dist-archive wp-content/plugins/hello-world hello-world.zip`
+    Then STDOUT should be:
+      """
+      Success: Created hello-world.zip
+      """
+    And the hello-world.zip file should exist
+    And the wp-content/plugins/hello-world.0.1.0.zip file should not exist