bugfix: check for path was broken, more README

Author: JohannesHoppe

README.md

@@ -30,7 +30,7 @@ By default, a deployment builder **shall** compile in `production` mode, but it
 
 Discussion: https://github.com/angular-schule/ngx-deploy-starter/issues/1
 
-### 2. A deployment builder should have an interactive prompts after the "ng add".
+### 2. A deployment builder should have an interactive prompt after the "ng add".
 
 To make it easier for the end user to get started, a deployment builder **should** ask for all the mandatory questions immediately after the `ng add`.
 The data should be persisted in the `angular.json` file.

src/README.md

@@ -2,6 +2,12 @@
 
 **Deploy your Angular app to the file system directly from the Angular CLI! 🚀**
 
+> **Warning:**  
+> This is a sample project that helps you to implement your own deployment builder (`ng deploy`) for the Angular CLI.
+> The actual "deployment" is only a simple copy to another folder in the file system.
+>
+>**Learn more at
+> https://github.com/angular-schule/ngx-deploy-starter**
 
 ## Usage
 
@@ -38,7 +44,7 @@ Same as `ng build --configuration=XXX`.
 
 #### --target-dir
  * __optional__
- * Default: `~/example-folder` (string)
+ * Default: `/example-folder` (string)
  * Example:
     * `ng deploy` -- App is "deployed" to the example folder (if existing)
     * `ng deploy --target-/var/www/html` -- App is "deployed" to another folder

src/engine/engine.ts

@@ -3,16 +3,14 @@ import * as fse from 'fs-extra';
 
 import { Schema } from '../deploy/schema';
 
-// TODO: add your deploy code here!
+// TODO: add your deployment code here!
 export async function run(dir: string, options: Schema, logger: logging.LoggerApi) {
 
   try {
 
-    if (!options.targetDir) {
-      throw new Error('Please provide a target directory!');
-    }
+    options.targetDir = options.targetDir || '/example-folder';
 
-    if (await !fse.pathExists(options.targetDir)) {
+    if (!await fse.pathExists(options.targetDir)) {
       throw new Error(`Target directory ${ options.targetDir } does not exist!`);
     }
 

src/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ngx-deploy-starter",
   "version": "0.0.1",
-  "description": "Deployment from the Angular CLI to the file system",
+  "description": "Deployment from the Angular CLI to the file system. This is a sample project that helps you to implement your own deployment builder (ng deploy) for the Angular CLI.",
   "main": "index.js",
   "scripts": {
     "build": "rimraf dist && json2ts deploy/schema.json > deploy/schema.d.ts && tsc && copyfiles README.md builders.json collection.json package.json ngx-deploy-starter deploy/schema.json dist",
@@ -22,9 +22,12 @@
     "ng-deploy"
   ],
   "author": {
-    "name": "John Doe",
-    "email": "[email protected]"
+    "name": "Johannes Hoppe",
+    "email": "[email protected]"
   },
+  "contributors": [
+    "Minko Gechev <[email protected]>"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/angular-schule/ngx-deploy-starter/issues"