this is now a single executable, removes angular-cli addon functionality

see angular/angular-cli#3695
closes  #1

Author: JohannesHoppe

README.md

@@ -7,18 +7,19 @@
 
 <hr>
 
-Angular CLI addon. Publish to any gh-pages branch on GitHub (or any other branch on any other remote).  
+This __was__ an angular CLI addon (until they [removed addon support](https://github.com/angular/angular-cli/pull/3695)).
+Now it's just a wrapper around [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
+
+Publish to any gh-pages branch on GitHub (or any other branch on any other remote).  
 Made for Travis-CI. Brought to you by the [angular-buch.com](https://angular-buch.com/) team! 
 
 ## About
 
-This is similar to the normal `github-pages:deploy` command.
+This script is similar to the normal `github-pages:deploy` command.
 But by design, the command is limited to the `gh-pages` branch of the same repository.
 
-In contrast to this, the [angular-buch/angular-cli-ghpages](https://github.com/angular-buch/angular-cli-ghpages) addon is able to push to any branch on any repository. It's made on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
-__This addon works great on [Travis-CI](https://travis-ci.org/).__ No git credentials must be set up in before. Specific environment variables of Travis-CI are evaluated, too. You will like it!
-
-angular-cli-ghpages was sucessfully tested against __`angular-cli@1.0.0-beta.22-1`__. 
+In contrast to this, the [angular-buch/angular-cli-ghpages](https://github.com/angular-buch/angular-cli-ghpages) script is able to push to any branch on any repository. It's made on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
+__This script works great on [Travis-CI](https://travis-ci.org/).__ No git credentials must be set up in before. Specific environment variables of Travis-CI are evaluated, too. You will like it!
 
 
 ## Installation & Setup
@@ -27,24 +28,29 @@ This addon has the following prerequisites:
 
 - Node.js 4.x
 - Git 1.7.6 or higher
-- Angular project created via [angular-cli](https://github.com/angular/angular-cli)
+- Optional: Angular project created via [angular-cli](https://github.com/angular/angular-cli)
 
 To install this addon run the following command:
 
 ```sh
-cd <your-angular-cli-project>
-npm install angular-cli-ghpages --save-dev 
+npm i -g angular-cli-ghpages
 ```
 
 ## Usage
 
-Execute `ng ghpages` in order to deploy the project with a build from `dist` folder.
+Execute `angular-cli-ghpages` in order to deploy the project with a build from `dist` folder.
 Note: you have to create the folder in before (e.g. `ng build --prod`)
 
 Usage:
 
 ```sh
-ng ghpages [OPTIONS]
+angular-cli-ghpages [OPTIONS]
+```
+
+there is also a shorter `ngh` command available
+
+```sh
+ngh [OPTIONS]
 ```
 
 ## Options
@@ -64,7 +70,7 @@ Some handy additional text is always added, if the environment variable `process
 
 Example:
 ```sh
-ng ghpages --message="What could possibly go wrong?"
+angular-cli-ghpages --message="What could possibly go wrong?"
 ```
 
 
@@ -116,7 +122,7 @@ For your convenience, the addon will recognize the [environment variable](https:
 In example, the following command runs [on our Travis-CI](https://travis-ci.org/angular-buch/book-monkey2):
 
 ```sh
-ng ghpages --repo=https://GH_TOKEN@github.com/organisation/your-repo.git --name="Displayed Username" --email=mail@example.orf
+angular-cli-ghpages --repo=https://GH_TOKEN@github.com/organisation/your-repo.git --name="Displayed Username" --email=mail@example.orf
 ```
 > You have to treat the GH_TOKEN as secure as a password!
 

bin/angular-cli-ghpages

@@ -0,0 +1,18 @@
+var index = require('../index'),
+  pjson = require('../package.json'),
+  program = require('commander');
+
+program
+  .version(pjson.version)
+  .description(pjson.description)
+  .option('-d, --dir <dir>', 'Directory for all published sources, relative to the project-root. Most probably no change is required here.', 'dist')
+  .option('-r, --repo <repo>', 'The commit message to include with the build, must be wrapped in quotes.')
+  .option('-m, --message <message>', 'The commit message, must be wrapped in quotes.', 'Auto-generated commit')
+  .option('-b, --branch <branch>', 'The git branch to push your pages to.', 'gh-pages')
+  .option('-n, --name <name>', 'The git user-name which is associated with this commit.')
+  .option('-e, --email <email>', 'The git user-email which is associated with this commit')
+  .option('-x, --silent', 'Suppress console logging. This option should be used if the repository URL or other information passed to git commands is sensitive! Default: true')
+  .option('-t, --dotfiles', 'Includes dotfiles by default. When set to `false` files starting with `.` are ignored. Default: true')
+  .parse(process.argv);
+
+index.run(program);

deploy.js

@@ -1,9 +1,70 @@
-module.exports = {
-  name: 'angular-cli-ghpages',
+var path = require('path'),
+  fs = require('fs'),
+  ghpages = require('gh-pages'),
+  denodeify = require('denodeify');
 
-  includedCommands: function() {
-    return {
-      'ghpages': require('./deploy'),
-    };
+exports.run = function (options) {
+
+  options = options || {};
+
+  if (options.silent === undefined) {
+    options.silent = true;
+  }
+
+  if (options.dotfiles === undefined) {
+    options.dotfiles = true;
+  }
+
+  if (options['name'] && options['email']) {
+    options.user = {
+      name: options['name'],
+      email: options['email']
+    }
+  };
+
+  // gh-pages: forwards messages to console
+  options.logger = function (message) { console.log(message + "\n"); }
+
+  var dir = path.join(process.cwd(), options.dir);
+
+  if (process.env.TRAVIS) {
+    options.message += '\n\n' +
+      'Triggered by commit: https://github.com/' + process.env.TRAVIS_REPO_SLUG + '/commit/' + process.env.TRAVIS_COMMIT + '\n' +
+      'Travis build: https://travis-ci.org/' + process.env.TRAVIS_REPO_SLUG + '/builds/' + process.env.TRAVIS_BUILD_ID;
+  }
+
+  // for your convenience - here you can hack credentials into the repository URL
+  if (process.env.GH_TOKEN && options.repo) {
+    options.repo = options.repo.replace('GH_TOKEN', process.env.GH_TOKEN);
+  }
+
+  // always clean the cache directory.
+  // avoids "Error: Remote url mismatch."
+  ghpages.clean();
+
+  var access = publish = denodeify(fs.access);
+  var publish = denodeify(ghpages.publish);
+
+  function go() {
+    return Promise.resolve();
   }
+
+  return go()
+    .then(function () {
+      return access(dir, fs.F_OK)
+    })
+    .catch(function (error) {
+      console.error('Dist folder does not exist. Check the dir --dir parameter or build the project first!\n');
+      return Promise.reject(error);
+    })
+    .then(function () {
+      return publish(dir, options)
+    })
+    .then(function () {
+      console.log('Successfully published!\n');
+    })
+    .catch(function (error) {
+      console.error('An error occurred!\n');
+      return Promise.reject(error);
+    });
 };

index.js

@@ -1,7 +1,12 @@
 {
   "name": "angular-cli-ghpages",
-  "version": "0.3.3",
-  "description": "Angular CLI addon. Publish to any gh-pages branch on GitHub (or any other branch on any other remote).",
+  "version": "0.4.0",
+  "description": "Wrapper around gh-pages, made for angular-cli users. Publish to any gh-pages branch on GitHub (or any other branch on any other remote).",
+  "main": "index.js",
+  "bin": {
+    "angular-cli-ghpages": "bin/angular-cli-ghpages",
+    "ngh": "bin/angular-cli-ghpages"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/angular-buch/angular-cli-ghpages.git"
@@ -13,28 +18,11 @@
     "name": "Angular-Buch Team",
     "email": "team@angular2buch.de"
   },
-  "maintainers": [
-    {
-      "name": "johanneshoppe",
-      "email": "johannes.hoppe@haushoppe-its.de"
-    },
-    {
-      "name": "fmalcher",
-      "email": "mail@ferdinand-malcher.de"
-    },
-    {
-      "name": "d-koppenhagen",
-      "email": "mail@d-koppenhagen.de"
-    },
-    {
-      "name": "gregonnet",
-      "email": "gregor.woiwode@gmail.com"
-    }
-  ],
   "license": "MIT",
   "dependencies": {
-    "gh-pages": "^0.11.0",
-    "denodeify": "^1.2.1"
+    "gh-pages": "~0.12.0",
+    "denodeify": "~1.2.1",
+    "commander": "~2.9.0"
   },
-  "keywords": ["ember-addon", "angular2", "angular-cli", "git", "github pages", "gh-pages", "ghpages", "angular-cli-ghpages", "angular-cli-github-pages"]
+  "keywords": ["angular2", "angular-cli", "git", "github pages", "gh-pages", "ghpages", "angular-cli-ghpages", "angular-cli-github-pages"]
 }