8 stephen testatest

README.md

@@ -20,9 +20,7 @@ and this will show you the directory that node is located in on your computer if
 
 ```shell
 /Users/example/.node/bin/node
-```  
-
-//TODO add info about NPM i for all dependencies  
+```    
 
 ## How to install  
 
@@ -52,41 +50,55 @@ from ```plop$``` you can then run any of efficient plop$ commands.
 ##plop$ install  
 ```shell
 plop$ install <template_url> [options]
-````  
-####Example  
+```
+####Example of install   
 
 ```shell
 plop$ install https://github.com/PLOPdotJS/plop-test.git test
 ```  
-*<template_url>* is the github repo url for the template that you are choosing.  
+
+*template_url* is the github repo url for the template that you are choosing.  
 
 [options] is the name that you choose to give your template.  
 
+plop$ *install* will create a new plopjs template that will be stored locally in your plopjs cache directory. Once the plopjs template is installed it will be able to be accessed by any of the plop$ commands.
+
 ####Please note that if you do not name your plopjs repo on install it will default to the name of the repo.
 
-##VERY IMPORTANT ALL GITHUB REPOS MUST BE NON SSH. IT WILL ONLY WORK HTTPS.
+###VERY IMPORTANT ALL GITHUB REPOS MUST BE NON SSH. IT WILL ONLY WORK HTTPS.
+
+plop$ install also has an alias  
+
+####Example of the alias  
+
+```shell  
+plop$ i <template_url> [options]
+```  
+
 
 ##plop$ use  
 ```shell
 plop$ use <template> [options]  
 ```  
-*<template>* name of installed plopjs template.  
-```
-sample
+*template* is the name of installed plopjs template.  
+```shell
+plop$ use sample
 ```
 
 [options] path you would like the template loaded to.  
 ```
-/project
+plop$ use sample /project
 ```
 plop$ *use* will load what ever template you choose into specified directory or if no directory is named then it will default to your working directory.  
 
+For *node* projects run ```npm i``` to install all the required dependencies that are used in the plopjs template.  Not installing the dependencies will throw err and not run the plopjs template correctly.  
+
 ##plop$ init  
 ```shell
-plop$ init
+plop$ init  
 ```  
 
-using plopjs init allows a starting point to create a plop.json and start making your own plopjs template. This is your chance to be creative and customize your plopjs.  
+plopjs *init* allows a starting point to create a plop.json and start making your own plopjs template. This is your chance to be creative and customize your plopjs.  
 
 plop$ *init* prompts will walk you through making a new plop.json file. It will also make an empty README.md that you will need to populate and also an empty template directory. Make sure to make your template *INSIDE* the template directory. Any files other then the plop.json and README.md that are outside the template directory will not be included in your plopjs.  
 
@@ -119,9 +131,11 @@ Change directories into your template and start building your plopjs!
 
 Once you have your template built out you may either:  
 
-- create a new github repository on git hub and push your template
+- create a new <https://github.com/> repository on git hub and push your template.  
 or
 - git init and initialize a github repository from your working directory.  
+or  
+- use ```plop$ save``` command.   
 
 ##plop$ list  
 ```shell
@@ -131,16 +145,32 @@ plop$ *list* prints a list of plopjs templates that are saved and available on y
 
 plop$ *list* also has a shorthand alias *ls*.  
 
-Example of ls alias.  
+####Example of alias    
 
 ```shell  
 plop$ ls
 ```  
 
+##plop$ save
+
+```shell  
+plop$ save [name]
+```  
+plop$ *save* will take the existing plopjs template that you created from scratch and save locally to your plopjs cache directory. You can then use ```plop$ lsit``` to verify that your template has been saved. Now that new plopjs template will be available for any future projects.  
+
+[name] is the name you choose to name the new plopjs template you created.  
+
+*save* also has an alias *s*.  
+
+####Example of the alias  
+
+```shell
+plop$ s [name]
+```  
 
 ##plop$ delete  
 ```shell
-plop$ delete
+plop$ delete [name]
 ```   
 plop$ *delete* will delete any plopjs that is saved on your local client.
 
@@ -180,6 +210,7 @@ plop$ *help* will bring up a list of plop$ commands and options.
 - gulp-mocha
 - mocha  
 
+
 ## Development Team  
 
  *Chris Perez* <https://github.com/ckperez>  

lib/delete.js

@@ -3,12 +3,15 @@
 const fs = require('fs-extra');
 
 const del = function(args, callback){
-  let template_path = process.env.HOME + '/.config/plop/' + args.template_name;
-  fs.remove(template_path, (err)=>{
-    if (err) return new Error('Deletion Failure');
-  });
+  let template_path;
+  for (var i = 0; i < args.template_name.length; i++){
+    template_path = process.env.HOME + '/.config/plop/' + args.template_name[i];
+    fs.remove(template_path, (err)=>{
+      if (err) this.log(new Error('Deletion failure.'));
+    });
+  }
+  this.log(args.template_name.length > 1 ? 'Plop templates deleted.' : 'Plop template deleted.');
   callback();
 };
-//rimraf or dell
 
 module.exports = exports = del;

lib/init.js

@@ -19,7 +19,7 @@ const init = function(args, callback){
           for (var i = 0; i < newPlop.length; i++){
             this.log(newPlop[i]);
           }
-          this.log('\nChange directories into your template and start building your plop!');
+          this.log('\nChange directories into your template and start building your plop template!');
         });
       });
     });

lib/install.js

@@ -1,16 +1,26 @@
 'use strict';
 
 const GIT = require('nodegit');
+const fs = require('fs-extra');
 
 const install = function(args, callback){
   let template = args.template_repo_url;
   let default_name = template.split('/').pop().slice(0, -4);
   let rename = args.rename || default_name;
-  GIT.Clone(template, process.env.HOME + '/.config/plop/' + rename)
+  fs.mkdirsSync(process.env.HOME + '/.config/plop/');
+  let existingPlops = fs.readdirSync(process.env.HOME + '/.config/plop/');
+  if (existingPlops.indexOf(rename) == -1) {
+    GIT.Clone(template, process.env.HOME + '/.config/plop/' + rename)
+    .then((repo) => {
+      if (repo) this.log(`Files have been plopped into ~/.config/plop/${rename}.`);
+    })
     .catch((err)=>{
-      console.error('Failed to install template');
+      this.log(new Error(err));
       return err;
     });
+  } else {
+    this.log(new Error(`Failed to install plop template because ~/.config/plop/${rename} already exists.\nPlease try again with different name.`));
+  }
   callback();
 };
 

lib/list.js

@@ -4,8 +4,8 @@ const fs = require('fs-extra');
 
 const list = function(args, callback){
   fs.readdir(process.env.HOME + '/.config/plop/', (err, files)=>{
-    if (err) return new Error('Failed to find templates');
-    if (files.length < 1) console.error('You have no templates saved locally');
+    if (err) this.log(new Error('Failed to find templates.'));
+    if (files.length < 1) this.log(new Error('You have no templates saved locally.'));
     for (var i = 0; i < files.length; i++){
       this.log(files[i]);
     }

lib/save.js

@@ -7,15 +7,16 @@ const save = function(args, callback){
   let full_WD = process.env.PWD;
   let short_WD = full_WD.split('/').pop();
   if (short_WD === 'template'){
-    this.log('Exit the plop CLI and `cd ..` out of template.\nYou will want to save your whole template directory, your README.md, and your plop.json.\nCan\'t do that from here!');
+    this.log(new Error('Exit the plop CLI and `cd ..` out of template.\nYou will want to save your whole template directory, your README.md, and your plop.json.\nCan\'t do that from here!'));
     template_warning = true;
   }
   let plop_name = args.name || short_WD;
   let contents = fs.readdirSync('./');
   if (contents.indexOf('plop.json') == -1 && !template_warning){
-    this.log('You are not saving a valid plop template. Verify your working directory.');
+    this.log(new Error('You are not saving a valid plop template. Verify your working directory.'));
   } else if (contents.indexOf('plop.json') != -1) {
     fs.copy('./', process.env.HOME + '/.config/plop/' + plop_name + '/');
+    this.log('New plop template successfully saved.');
   }
   callback();
 };

lib/use.js

@@ -6,8 +6,13 @@ const use = function(args, callback){
   let template_name = args.template_name;
   let template_path = process.env.HOME + '/.config/plop/' + template_name + '/template';
   let destination_path = args.destination_path || './';
+  let existingPlops = fs.readdirSync(process.env.HOME + '/.config/plop/');
+  if (existingPlops.indexOf(template_name) === -1) {
+    this.log(new Error(`${template_name} does not exist.\nUse 'list' to see existing plop templates.`));
+  }
   fs.copy(template_path, destination_path, (err)=>{
-    if (err) return new Error('Failed to copy template to your project.');
+    if (err) return new Error('Failed to copy plop template to your project.');
+    this.log('You now have a new plop template in your project.');
   });
   callback();
 };

package.json

@@ -1,45 +1,46 @@
 {
-    "name": "plopjs",
-    "version": "0.2.0",
-    "description": "Cloud-based storage for organization-level boilerplate code",
-    "preferGlobal": true,
-    "main": "plop.js",
-    "directories": {
-        "test": "test"
-    },
-    "scripts": {
-        "test": "./node_modules/mocha/bin/mocha",
-        "start": "node plop.js",
-        "lint": "./node_modules/eslint/bin/eslint.js *"
-    },
-    "bin": {
-        "plop": "./plop.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/PLOPdotJS/plopjs.git"
-    },
-    "author": {
-        "name": "Chris Perez <chris.k.perez@gmail.com>",
-        "name": "Dan Stineback <dstineback@gmail.com",
-        "name": "Stephen Schroder <schrode50@gmail.com>"
-    },
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/PLOPdotJS/plopjs/issues"
-    },
-    "homepage": "https://github.com/PLOPdotJS/plopjs#readme",
-    "dependencies": {
-        "fs-extra": "^0.30.0",
-        "nodegit": "^0.13.1",
-        "vorpal": "^1.11.1"
-    },
-    "devDependencies": {
-        "chai": "^3.5.0",
-        "eslint": "^2.11.1",
-        "gulp": "^3.9.1",
-        "gulp-eslint": "^2.0.0",
-        "gulp-mocha": "^2.2.0",
-        "mocha": "^2.5.3"
-    }
+  "name": "plopjs",
+  "version": "0.2.0",
+  "description": "Cloud-based storage for organization-level boilerplate code",
+  "preferGlobal": true,
+  "main": "plop.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "./node_modules/mocha/bin/mocha",
+    "start": "node plop.js",
+    "lint": "./node_modules/eslint/bin/eslint.js *"
+  },
+  "bin": {
+    "plop": "./plop.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PLOPdotJS/plopjs.git"
+  },
+  "author": {
+    "name": "Stephen Schroder <schrode50@gmail.com>",
+    "name": "Chris Perez <chris.k.perez@gmail.com>",
+    "name": "Dan Stineback <dstineback@gmail.com>"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/PLOPdotJS/plopjs/issues"
+  },
+  "homepage": "https://github.com/PLOPdotJS/plopjs#readme",
+  "dependencies": {
+    "fs-extra": "^0.30.0",
+    "nodegit": "^0.13.1",
+    "vorpal": "^1.11.1",
+    "vorpal-autocomplete-fs": "0.0.3"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "eslint": "^2.11.1",
+    "gulp": "^3.9.1",
+    "gulp-eslint": "^2.0.0",
+    "gulp-mocha": "^2.2.0",
+    "mocha": "^2.5.3"
+  }
 }

plop.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
 'use strict';
 
-const vorpal = require('vorpal')();
+const Plop = require('vorpal')();
 
-vorpal.delimiter('plop$').show();
+const fsAutocomplete = require('vorpal-autocomplete-fs');
 
+Plop.delimiter('plop$').show();
 
 const use = require(__dirname + '/lib/use');
 const install = require(__dirname + '/lib/install');
@@ -13,25 +14,26 @@ const list = require(__dirname + '/lib/list');
 const init = require(__dirname + '/lib/init');
 const save = require(__dirname + '/lib/save');
 
-
-vorpal.command('install [template_repo_url] [rename]', 'clones a plop template from github into your ~/.config/plop/ directory. Can also use `i`.')
+Plop.command('install [template_repo_url] [rename]', 'clones a plop template from github into your ~/.config/plop/ directory. Can also use `i`.')
   .action(install).alias('i');
 
-vorpal.command('use [template_name] [destination_path]', 'copies a plop template (by filename) you have saved into your working directory.')
-  .action(use);
+Plop.command('use [template_name] [destination_path]', 'copies a plop template (by filename) you have saved into your working directory.')
+  .action(use).autocomplete(fsAutocomplete());
 
-vorpal.command('delete [template_name]', 'removes a locally saved plop template.')
-    .action(del);
+Plop.command('delete [template_name...]', 'removes a locally saved plop template.')
+  .action(del).autocomplete(fsAutocomplete());
 
-vorpal.command('list', 'displays a list of templates saved locally. Can also use `ls`.')
-    .action(list).alias('ls');
+Plop.command('list', 'displays a list of templates saved locally. Can also use `ls`.')
+  .action(list).alias('ls');
 
-vorpal.command('init [template_name]', 'walks you through building a plop template.')
+Plop.command('init', 'walks you through building a plop template.')
   .action(init);
 
-vorpal.command('save [name]', 'saves a locally created plop template to your ~/.config/plop/ directory. Can also use `s`.')
+Plop.command('save [name]', 'saves a locally created plop template to your ~/.config/plop/ directory. Can also use `s`.')
   .action(save).alias('s');
 
-const exit = vorpal.find('exit');
+const exit = Plop.find('exit');
 exit.alias('k').alias('q');
 exit.description('exits the plop CLI. Can also use `k` or `q`.');
+
+module.exports = exports = Plop;