refactor: stick to best practices

Author: jamesgeorge007

src/commands/init.js

@@ -1,11 +1,12 @@
 'use strict';
 
 const chalk = require('chalk');
-const { execSync } = require('child_process');
+const { shellSync } = require('execa');
 const fs = require('fs');
 const inquirer = require('inquirer');
 const showBanner = require('node-banner');
 const open = require('open');
+const ora = require('ora');
 
 // GitHub workflow helper methods.
 const {
@@ -44,6 +45,12 @@ const showInstructions = () => {
   console.log(chalk.cyan.bold(` 2. teachcode fetchtask`));
 };
 
+/**
+ * Opens up the default browser with information concerning
+ * access token creation as required
+ * @returns {Promise<void>}
+ */
+
 const promptAccessTokenCreation = async () => {
   const instructionsUrl =
     'https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line';
@@ -87,13 +94,10 @@ const initTasks = async () => {
     console.log(
       chalk.redBright(
         `  It seems that there is already a ${chalk.yellow(
-          'Teach-Code-solutions',
+          'teachcode-solutions',
         )} directory or ${chalk.yellow('config.json')} file existing in path`,
       ),
     );
-    console.log();
-    console.log(chalk.redBright('  Exiting!!'));
-    console.log();
     process.exit(1);
   }
 
@@ -133,9 +137,10 @@ const initTasks = async () => {
     ...userConfig,
     learningTrack: learningTrackOfChoice,
     userName,
-    keys: userConfig.keys.push(key),
   };
 
+  userConfig.keys.push(key);
+
   // Prompt for GitHub username.
   await initializeGHWorkFlow();
 
@@ -146,17 +151,22 @@ const initTasks = async () => {
     await promptAccessTokenCreation();
     await createRepository();
 
-    execSync(`mkdir -p teachcode-solutions`);
+    shellSync(`mkdir teachcode-solutions`);
     fs.writeFileSync(
-      `teachcode-solutions/config.json`,
+      'teachcode-solutions/config.json',
       JSON.stringify(userConfig, null, 2),
     );
-
-    process.chdir('teachcode-solutions');
     await configureLocalRepo();
   } else {
-    // Clone the remote repository
-    await cloneRepository();
+    const spinner = ora('Fetching user progress').start();
+    try {
+      // Clone the remote repository
+      await cloneRepository();
+    } catch (err) {
+      spinner.fail('Something went wrong');
+      throw err;
+    }
+    spinner.stop();
   }
   showInstructions();
 };

src/commands/keys.js

@@ -17,13 +17,13 @@ const showKeys = async () => {
   );
   console.log();
 
-  if (!fs.existsSync(`${process.cwd()}/config.json`)) {
+  if (!fs.existsSync(`./config.json`)) {
     console.log(chalk.red("Config file doesn't exist!"));
     console.log();
     process.exit(1);
   }
 
-  let userConfig = fs.readFileSync(process.cwd() + '/config.json', 'utf8');
+  let userConfig = fs.readFileSync('./config.json', 'utf8');
   const { keys, userName, taskCount } = JSON.parse(userConfig);
 
   console.log();

src/commands/submit.js

@@ -186,9 +186,7 @@ const submitTask = async () => {
     process.exit(1);
   }
 
-  userConfig = JSON.parse(
-    fs.readFileSync(process.cwd() + '/config.json', 'utf8'),
-  );
+  userConfig = JSON.parse(fs.readFileSync('./config.json', 'utf8'));
   let { userName, userSubmittedFiles, learningTrack, taskCount } = userConfig;
 
   if (learningTrack === 'Python') {

src/commands/tasks.js

@@ -22,15 +22,15 @@ const fetchTask = async key => {
   let exercises;
   let fileName;
 
-  if (!fs.existsSync(process.cwd() + '/config.json')) {
+  if (!fs.existsSync('./config.json')) {
     console.log(
       chalk.red.bold(
         ' Make sure that you are within the teachcode-solutions directory!',
       ),
     );
     console.log();
     console.log(
-      chalk.cyan.bold('\tcd teachcode-solutions may resolve the issue!'),
+      chalk.cyan.bold(' cd teachcode-solutions may resolve the issue!'),
     );
     console.log();
     process.exit(1);

src/utils/github.js

@@ -4,6 +4,7 @@ const axios = require('axios');
 const chalk = require('chalk');
 const execa = require('execa');
 const inquirer = require('inquirer');
+const ora = require('ora');
 
 const validate = require('./validate');
 
@@ -29,6 +30,9 @@ const initializeGHWorkFlow = async () => {
 
   // Check if it is a valid username
   if (!(await checkIfValidUser())) {
+    console.log();
+    console.log(chalk.red.bold(` ${userName} isn't a valid GitHub username`));
+    console.log();
     await initializeGHWorkFlow();
   }
 };
@@ -114,10 +118,12 @@ const configureLocalRepo = async () => {
   const repoUrl = `https://github.com/${GHUserName}/teachcode-solutions`;
 
   // Initialize an empty git repo.
-  await execa.shell('git init');
+  await execa.shell('git init', { cwd: 'teachcode-solutions' });
 
   // Set the remote url.
-  await execa.shell(`git remote add origin ${repoUrl}`);
+  await execa.shell(`git remote add origin ${repoUrl}`, {
+    cwd: 'teachcode-solutions',
+  });
 };
 
 /**
@@ -139,7 +145,14 @@ const makeLocalCommit = async taskCount => {
  */
 
 const pushToRemote = async () => {
-  await execa.shell('git push origin master');
+  const spinner = ora('Pushing to GitHub').start();
+  try {
+    await execa.shell('git push origin master');
+  } catch (err) {
+    spinner.fail('Something went wrong');
+    throw err;
+  }
+  spinner.succeed('Saved user progress');
 };
 
 module.exports = {