Validation for paths using homedir

Author: nmicht

src/auth/index.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
-const path = require('path');
 
 const settings = require('../settings');
+const utils = require('../utils');
 
 /**
  * Get the Github token from the auth file
@@ -11,7 +11,7 @@ const settings = require('../settings');
 async function getToken(jsonPath = '') {
   let auth = {};
   const authPath = jsonPath || settings.authPath;
-  const authFile = path.resolve(authPath);
+  const authFile = utils.resolvePath(authPath);
 
   try {
     auth = JSON.parse(fs.readFileSync(authFile, 'utf8'));
@@ -35,7 +35,7 @@ async function getToken(jsonPath = '') {
 async function updateToken(token, jsonPath = '') {
   let auth = {};
   const authPath = jsonPath || settings.authPath;
-  const authFile = path.resolve(authPath);
+  const authFile = utils.resolvePath(authPath);
 
   try {
     auth = JSON.parse(fs.readFileSync(authFile, 'utf8'));

src/index.js

@@ -10,9 +10,14 @@ const gitHandler = require('./gitHandler');
 const githubHandler = require('./githubHandler');
 const questionnaire = require('./questionnaire');
 
-async function myPackage() {
+async function run() {
   // First arg = path
-  const destPath = path.resolve(process.argv[2]);
+  let destPath = process.argv[2];
+  if (!destPath) {
+    throw new Error('A path for the new project is required');
+  }
+
+  destPath = utils.resolvePath(destPath);
   const projectFolder = utils.normalizeName(destPath);
   const templatePath = path.join(__dirname, '..', 'template');
 
@@ -23,14 +28,6 @@ async function myPackage() {
     throw new Error(`The project folder '${destPath} already exists. You need to specify a different path.`);
   }
 
-  // Create folder
-  try {
-    fs.mkdirSync(destPath);
-  } catch (error) {
-    console.error('The folder project was not created. See details on the log');
-    throw error;
-  }
-
   // Questionnaire for the options
   const answers = await questionnaire.run(projectFolder);
 
@@ -39,6 +36,14 @@ async function myPackage() {
     path: destPath,
   });
 
+  // Create folder
+  try {
+    fs.mkdirSync(destPath);
+  } catch (error) {
+    console.error('The folder project was not created');
+    throw error;
+  }
+
   // Create project object
   const project = new Project(answers);
 
@@ -126,4 +131,4 @@ async function myPackage() {
   }
 }
 
-myPackage();
+run();

src/questionnaire/index.js

@@ -10,8 +10,11 @@ async function run(name) {
     resp.hasRemote = !!resp.git.url;
   } else {
     Object.assign(resp, await questions.getAuthFile());
+
     const token = await auth.getToken(resp.authPath);
+
     Object.assign(resp, await questions.getAuthToken(token));
+
     if (resp.token) {
       if (resp.token !== token && await auth.confirmUpdateToken()) {
         auth.updateToken(resp.token, settings.authPath);
@@ -21,10 +24,6 @@ async function run(name) {
     }
   }
 
-  if (resp.useTesting) {
-    Object.assign(resp, await questions.getTestingDetails());
-  }
-
   return resp;
 }
 

src/questionnaire/questions.js

@@ -1,6 +1,8 @@
 const inquirer = require('inquirer');
+const fs = require('fs');
 
 const settings = require('../settings');
+const utils = require('../utils');
 
 async function getProjectDetails(name) {
   return inquirer.prompt([
@@ -71,15 +73,16 @@ async function getProjectDetails(name) {
     },
 
     {
-      type: 'confirm',
-      name: 'useGithub',
-      message: 'Would you like to create a GitHub repository?',
+      type: 'checkbox',
+      name: 'testPackages',
+      message: 'Which test packages do you want to include?',
+      choices: settings.testingPkgs,
     },
 
     {
       type: 'confirm',
-      name: 'useTesting',
-      message: 'Would you like to include testing?',
+      name: 'useGithub',
+      message: 'Would you like to create a GitHub repository?',
     },
   ]);
 }
@@ -102,24 +105,20 @@ async function getGitRemoteDetails() {
   ]);
 }
 
-async function getTestingDetails() {
-  return inquirer.prompt([
-    {
-      type: 'checkbox',
-      name: 'testPackages',
-      message: 'Which test packages do you want to include?',
-      choices: settings.testingPkgs,
-    },
-  ]);
-}
-
 async function getAuthFile() {
   return inquirer.prompt([
     {
       type: 'input',
       name: 'authPath',
       message: 'What is the path for the auth.json file?',
       default: settings.authPath,
+      validate: (ans) => {
+        const path = utils.resolvePath(ans);
+        if (path && fs.existsSync(path)) {
+          return true;
+        }
+        return 'You should introduce a real path for the auth.json';
+      },
     },
   ]);
 }
@@ -148,7 +147,6 @@ async function confirmUpdateToken() {
 module.exports = {
   getProjectDetails,
   getGitRemoteDetails,
-  getTestingDetails,
   getAuthFile,
   getAuthToken,
   confirmUpdateToken,

src/utils/index.js

@@ -1,6 +1,19 @@
 const { exec, spawn } = require('child_process');
 const fs = require('fs');
 const path = require('path');
+const os = require('os');
+
+/**
+ * Resolve a path even if is using shell specific for home
+ * @param  {String} oPath The path to resolve
+ * @return {String}       The resolved path
+ */
+function resolvePath(oPath) {
+  let fPath = '';
+  fPath = oPath.replace('~', os.homedir());
+  fPath = path.resolve(fPath);
+  return fPath;
+}
 
 /**
  * Replace a string using a given dictionary
@@ -31,8 +44,8 @@ function normalizeName(filepath) {
  * @param  {String} [destPath='../new'] The destination path
  */
 function copyDirRecursive(currentPath = './', destPath = '../new') {
-  let dest = path.resolve(destPath);
-  let current = path.resolve(currentPath);
+  let dest = resolvePath(destPath);
+  let current = resolvePath(currentPath);
 
   // Create the dest folder
   if (!fs.existsSync(dest)) {
@@ -43,8 +56,8 @@ function copyDirRecursive(currentPath = './', destPath = '../new') {
   // Read files in folder
   let files = fs.readdirSync(current);
   for(file of files) {
-    src = path.resolve(path.join(current, file));
-    dest = path.resolve(path.join(destPath, file));
+    src = resolvePath(path.join(current, file));
+    dest = resolvePath(path.join(destPath, file));
 
     if (fs.lstatSync(src).isDirectory()) {
       // Recursive copy for folders
@@ -58,10 +71,10 @@ function copyDirRecursive(currentPath = './', destPath = '../new') {
 }
 
 function deleteDirRecursive(folderPath) {
-  const dirPath = path.resolve(folderPath);
+  const dirPath = resolvePath(folderPath);
   if (fs.existsSync(dirPath)) {
     fs.readdirSync(dirPath).forEach((file) => {
-      const curPath = path.resolve(path.join(dirPath, file));
+      const curPath = resolvePath(path.join(dirPath, file));
       if (fs.lstatSync(curPath).isDirectory()) { // recurse
         deleteDirRecursive(curPath);
       } else { // delete file
@@ -128,4 +141,5 @@ module.exports = {
   execp,
   spawnp,
   normalizeName,
+  resolvePath,
 };