move and repair git spec/tools

Author: begin-again

src/common/git-tools.js

@@ -2,8 +2,8 @@
  * @module Git-Tools
  */
 const { execSync } = require('child_process');
-const { writeFileSync, mkdirSync, readdirSync, lstatSync, copyFileSync, existsSync } = require('fs');
-const { join } = require('path');
+const fs = require('node:fs');
+const { join } = require('node:path');
 const randomize = require('randomatic');
 const { createTempFolder } = require('./temp');
 const git = require('simple-git');
@@ -14,7 +14,7 @@ const commitLength = 20;
  * initializes and empty git repository
  * into a temp folder within the base temp folder
  *
- * @param {String} nameOfFileToCommit - name
+ * @param {string} nameOfFileToCommit - name
  */
 const createRepo = async (nameOfFileToCommit = '') => {
     const path = createTempFolder();
@@ -30,46 +30,52 @@ const createRepo = async (nameOfFileToCommit = '') => {
 };
 const createBareRepo = createRepo;
 
-// mkdirSync, readdirSync, lstatSync, copyFileSync
 /**
  * Copy folder recursively
  *
  * @private
- * @param {String} src
- * @param {String} dest
+ * @param {string} src
+ * @param {string} dest
+ * @returns {Promise}
  */
-const copyFolder = (src, dest) => {
-    if(!existsSync(dest)) {
-        mkdirSync(dest);
-    }
-    readdirSync(src).map(file => {
-        if(lstatSync(join(src, file)).isFile()) {
-            copyFileSync(join(src, file), join(dest, file));
-        }
-        else {
-            copyFolder(join(src, file), join(dest, file));
+async function copyFolder(src, dest) {
+    try {
+        await fs.promises.mkdir(dest, { recursive: true });
+
+        const entries = await fs.promises.readdir(src, { withFileTypes: true });
+
+        for(const entry of entries) {
+            const srcPath = join(src, entry.name);
+            const destPath = join(dest, entry.name);
+
+            entry.isDirectory() ?
+                await copyFolder(srcPath, destPath) :
+                await fs.promises.copyFile(srcPath, destPath);
         }
-    });
-};
+    }
+    catch (error) {
+        console.error('An error occurred:', error);
+    }
+}
 
 /**
  * Replicates a repository
  *
- * @param {String} repoPath
- * @returns {String} path to new repo
+ * @param {string} repoPath
+ * @returns {Promise<string>} path to new repo
  */
-const duplicateRepo = (repoPath) => {
+const duplicateRepo = async (repoPath) => {
     const newPath = createTempFolder();
-    copyFolder(repoPath, newPath);
+    await copyFolder(repoPath, newPath);
     return newPath;
 };
 
 /**
  * Adds remote from src to target repo
  *
- * @param {String} srcRepoPath
- * @param {String} targetRepoPath
- * @param {String} remoteName
+ * @param {string} srcRepoPath
+ * @param {string} targetRepoPath
+ * @param {string} remoteName
  * @return {Promise}
  */
 const addRemote = (srcRepoPath, targetRepoPath, remoteName = 'origin') => {
@@ -79,8 +85,8 @@ const addRemote = (srcRepoPath, targetRepoPath, remoteName = 'origin') => {
 /**
  * adds a file to a git repository
  *
- * @param {String} repoPath
- * @param {String} name
+ * @param {string} repoPath
+ * @param {string} name
  * @param {object} options stage: boolean, commit: boolean
  * @returns {Promise<void>} options stage: boolean, commit: boolean
  */
@@ -89,7 +95,7 @@ const addFileToRepo = async (repoPath, name, options = { stage: false, commit: f
     if(options.branch) {
         await repo.checkout(options.branch, { '-q': true, 'b': true });
     }
-    writeFileSync(join(repoPath, name), '');
+    await fs.promises.writeFile(join(repoPath, name), '');
     if(options.stage) {
         await repo.add(name);
         if(options.commit) {
@@ -101,7 +107,7 @@ const addFileToRepo = async (repoPath, name, options = { stage: false, commit: f
 /**
  * Check if repo has untracked or uncommitted changes
  *
- * @param {String} repoPath to repository
+ * @param {string} repoPath to repository
  * @returns {Promise<Boolean>}
  */
 const isDirty = async (repoPath) => {
@@ -114,8 +120,8 @@ const isDirty = async (repoPath) => {
 /**
  * Retrieve current branch
  *
- * @param {String} repoPath
- * @returns {Promise<String>} branch name
+ * @param {string} repoPath
+ * @returns {Promise<string>} branch name
  */
 const currentBranch = async (repoPath) => {
     try {
@@ -130,9 +136,9 @@ const currentBranch = async (repoPath) => {
 /**
  * Push local to remote
  *
- * @param {String} repoPath
- * @param {String} remote
- * @param {String} branch
+ * @param {string} repoPath
+ * @param {string} remote
+ * @param {string} branch
  * @returns {Promise<string>} branch
  */
 const push = (repoPath, remote = 'origin', branch = 'all') => {
@@ -146,10 +152,10 @@ const push = (repoPath, remote = 'origin', branch = 'all') => {
 /**
  * Pull from remote
  *
- * @param {String} repoPath
- * @param {String} remote
- * @param {String} branch
- * @returns {Promise<String>}
+ * @param {string} repoPath
+ * @param {string} remote
+ * @param {string} branch
+ * @returns {Promise<string>}
  */
 const pull = (repoPath, remote = 'origin', branch = 'master') => {
     return git(repoPath).pull(remote, branch, { '-q': true });
@@ -158,7 +164,7 @@ const pull = (repoPath, remote = 'origin', branch = 'master') => {
 /**
  * Fetch remotes quietly
  *
- * @param {String} repoPath
+ * @param {string} repoPath
  */
 const fetchRemotes = (repoPath) => {
     return git(repoPath).fetch({ '--quiet': true, '--all': true });
@@ -167,35 +173,45 @@ const fetchRemotes = (repoPath) => {
 /**
  * Create new local commit
  *
- * @param {String} repoPath
- * @param {String | null} fileName - optional file name
- * @param {String} branch - optional
- * @returns {Promise<String>} log subject
+ * @param {string} repoPath
+ * @param {string | null} fileName - optional file name
+ * @param {string} branch - optional
+ * @returns {Promise<string>} log subject
  */
 const addCommit = async (repoPath, fileName, branch) => {
     const repo = git(repoPath);
-    const _name = fileName || randomize('Aa0', commitLength);
-    writeFileSync(join(repoPath, _name), '');
+
     if(branch) {
-        await repo.checkout(branch, { '-q': true, 'b': true });
+        // create a new branch with simple-git
+        await repo.branch([ branch, 'HEAD' ]);
+        await repo.checkout(branch, { '-q': true });
     }
 
-    return repo.add(_name).commit(`${_name}`)
-        .log().latest.message;
+    const _name = fileName || randomize('Aa0', commitLength);
+    await fs.promises.writeFile(join(repoPath, _name), '');
+
+    try {
+        const result = await repo.add(_name).commit(`${_name}`)
+            .log();
+        return result?.latest?.message;
+    }
+    catch (err) {
+        console.log('wtf');
+    }
 };
 
 /**
  * Create new local commit with message
  *
- * @param {String} repoPath
- * @param {String} message
- * @param {String} branch - optional
- * @returns {Promise<String>} log subject
+ * @param {string} repoPath
+ * @param {string} message
+ * @param {string} branch - optional
+ * @returns {Promise<string>} log subject
  */
 const addCommitWithMessage = async (repoPath, message, branch) => {
     const repo = git(repoPath);
     const _name = randomize('Aa0', commitLength);
-    writeFileSync(join(repoPath, _name), '');
+    await fs.promises.writeFile(join(repoPath, _name), '');
     if(branch) {
         await repo.checkout(branch, { '-q': true, 'b': true });
     }
@@ -207,9 +223,9 @@ const addCommitWithMessage = async (repoPath, message, branch) => {
 /**
  * Delete file from repository
  *
- * @param {String} repoPath
- * @param {String} name
- * @returns {Promise<String>} name
+ * @param {string} repoPath
+ * @param {string} name
+ * @returns {Promise<string>} name
  */
 const deleteFile = (repoPath, name) => {
     return git(repoPath).rm(name)
@@ -220,8 +236,8 @@ const deleteFile = (repoPath, name) => {
 /**
  * Returns branch log
  *
- * @param {String} repoPath
- * @param {String} branch
+ * @param {string} repoPath
+ * @param {string} branch
  * @returns {Array}
  */
 const log = (repoPath, branch = 'master') => {

src/common/git.js

@@ -3,8 +3,8 @@ const git = require('simple-git');
 /**
  * Determines if repo has any commits on current branch
  *
- * @param {String} repo - path to repository
- * @returns {Object} as Promise
+ * @param {string} repo - path to repository
+ * @returns {Promise<object>} as Promise
  * @returns o.repo - same as repo
  * @returns o.error - truthy if no commits
   */
@@ -23,8 +23,8 @@ const hasCommits = async (repo) => {
 /**
  * Retrieves branch name from local repo
  *
- * @param  {String} pathToProject
- * @returns {Promise} branch name
+ * @param  {string} pathToProject
+ * @returns {Promise<string>} branch name
  */
 const currentBranch = async (pathToProject) => {
     try {
@@ -40,8 +40,8 @@ const currentBranch = async (pathToProject) => {
 /**
  * Retrieves commit hash of local head
  *
- * @param  {String} pathToProject [description]
- * @returns {String}
+ * @param  {string} pathToProject [description]
+ * @returns {Promise<string>}
  */
 const currentHash = (pathToProject) => {
     return git(pathToProject).revparse({ 'HEAD': true });
@@ -50,7 +50,7 @@ const currentHash = (pathToProject) => {
 /**
  * Updates local refs by performing a fetch
  *
- * @param  {String} repoPath
+ * @param  {string} repoPath
  * @return {Promise}
  */
 const gitFetch = (repoPath) => {
@@ -60,9 +60,9 @@ const gitFetch = (repoPath) => {
 /**
  * Counts number of commits a branch has which is not on master
  *
- * @param {String} repoPath
- * @param {String} branch
- * @param {Boolean} isTotal
+ * @param {string} repoPath
+ * @param {string} branch
+ * @param {boolean} isTotal
  * @returns {Promise} number of commits
  */
 const commitsDiff = async (repoPath, branch = 'master', isTotal = false) => {
@@ -83,8 +83,8 @@ const commitsDiff = async (repoPath, branch = 'master', isTotal = false) => {
  * Calculate ahead and behind commits counts
  *
  * @private
- * @param {Array} results
- * @returns {Object} { ahead: Integer, behind: Integer }
+ * @param {array} results
+ * @returns {{ahead:number, behind:number}} { ahead: Integer, behind: Integer }
  */
 const diffResult = (results) => {
     const ahead = results[1];
@@ -95,7 +95,7 @@ const diffResult = (results) => {
 /**
  * Count commits which differ between origin and local
  *
- * @param  {String} repoPath
+ * @param  {string} repoPath
  * @returns {Promise} { ahead: Integer, behind: Integer }
  */
 const commitDiffCounts = (repoPath) => {
@@ -118,8 +118,8 @@ const commitDiffCounts = (repoPath) => {
 /**
  * Check status for un-committed changes including untracked files
  *
- * @param  {String} repoPath - resolved path to repository
- * @return {Promise<Boolean>} true is dirty
+ * @param  {string} repoPath - resolved path to repository
+ * @return {Promise<boolean>} true is dirty
  */
 const isDirty = async (repoPath) => {
     const status = await git(repoPath).status();
@@ -131,8 +131,8 @@ const isDirty = async (repoPath) => {
 /**
  * Obtain log message of HEAD
  *
- * @param {String} repoPath
- * @param {Object} logger
+ * @param {string} repoPath
+ * @param {object} logger
  * @returns {Promise} standard out
  */
 const headLog = async (repoPath, logger) => {