new option: --dry-run which gives detailed information about what would happen without doing anything

Author: JohannesHoppe

README.md

@@ -163,6 +163,16 @@ The command includes dotfiles by default (e.g `.htaccess` will be committed)
 With `--no-dotfiles` files starting with `.` are ignored.
 
 
+
+#### <a id="dry-run">--dry-run</a>
+ * __optional__
+ * Default: `undefined`
+ * Example:
+    * `ngh` -- Normal behaviour: Changes are applied.
+    * `ngh --dry-run` -- No changes are applied at all.
+
+Run through without making any changes. This can be very usefull, because it outputs what would happend without doing anything.
+
 ## Extra
 
 For your convenience, the command will recognize the [environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) `GH_TOKEN` and will replace this pattern in the `--repo` string. Please __do NOT disable the silent mode__ if you have any credentials in the repository URL! Read more about [Github tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).

bin/angular-cli-ghpages

@@ -15,6 +15,7 @@ program
   .option('-e, --email <email>', 'The git user-email which is associated with this commit')
   .option('-S, --no-silent', 'Logging is in silent mode by default. The option enables extended console logging. Keep this untouched if the repository URL or other information passed to git commands is sensitive!')
   .option('-T, --no-dotfiles', 'Includes dotfiles by default. When set files starting with `.` are ignored.')
+  .option('--dry-run', 'For testing: Run through without making any changes.')
   .parse(process.argv);
 
 index.run(program)

index.js

@@ -7,13 +7,14 @@ exports.run = function (options) {
 
   options = options || {};
 
-  //console.log('SILENT:', options.silent);
-  //console.log('DOTFILES:', options.dotfiles);
+  if (options.dryRun) {
+    console.log('*** Dry-run: No changes are applied at all. ***')
+  }
 
-  if (options['name'] && options['email']) {
+  if (options.name && options.email) {
     options.user = {
-      name: options['name'],
-      email: options['email']
+      name: options.name,
+      email: options.email
     }
   };
 
@@ -35,7 +36,11 @@ exports.run = function (options) {
 
   // always clean the cache directory.
   // avoids "Error: Remote url mismatch."
-  ghpages.clean();
+  if (!options.dryRun) {
+    ghpages.clean();
+  } else {
+    console.info('Dry-run / SKIPPED: cleaning of the cache directory');
+  }
 
   var access = publish = denodeify(fs.access);
   var publish = denodeify(ghpages.publish);
@@ -53,7 +58,20 @@ exports.run = function (options) {
       return Promise.reject(error);
     })
     .then(function () {
-      return publish(dir, options)
+      if (!options.dryRun) {
+        return publish(dir, options)
+      } else {
+        console.info('Dry-run / SKIPPED: publishing to "' + dir+ '" with the following options:', {
+          dir: dir,
+          repo: options.repo || 'undefined: current working directory (which must be a git repo in this case) will be used to commit & push',
+          message: options.message,
+          branch: options.branch,
+          user: options.user || 'undefined: local or gloabl git username & email properties will be taken',
+          noSilent: options.noSilent || 'undefined: logging is in silent mode by default',
+          noDotfiles: options.noDotfiles || 'undefined: dotfiles are included by default',
+          dryRun: options.dryRun
+        });
+      }
     })
     .then(function () {
       console.log('Successfully published!\n');