fix: improved git auto commit

Author: Guillaume Chau

packages/@nodepack/cli/src/lib/PluginAddJob.js

@@ -35,6 +35,7 @@ module.exports = class PluginAddJob {
     const maintenance = new Maintenance({
       cwd,
       cliOptions,
+      skipCommit: true,
       skipPreInstall: true,
       before: async ({ pkg, plugins, shouldCommitState, isTestOrDebug }) => {
         // Plugins
@@ -53,7 +54,7 @@ module.exports = class PluginAddJob {
             plugins.push(packageName)
           }
         } else if ((!alreadyInPkg || cliOptions.forceInstall) && !cliOptions.noInstall) {
-          await shouldCommitState()
+          await shouldCommitState(`[nodepack] before add ${packageName}`)
           log()
           log(`📦  Installing ${chalk.cyan(packageName)}...`)
           log()
@@ -70,7 +71,8 @@ module.exports = class PluginAddJob {
           process.exit(1)
         }
       },
-      after: async maintenance => {
+      after: async ({ shouldCommitState }) => {
+        await shouldCommitState(`[nodepack] after add ${packageName}`)
         log(`🎉  Successfully added ${chalk.yellow(packageName)}.`)
       },
     })

packages/@nodepack/cli/src/lib/PluginUpgradeJob.js

@@ -61,6 +61,7 @@ module.exports = class PluginUpgradeJob {
     const maintenance = new Maintenance({
       cwd,
       cliOptions,
+      skipCommit: true,
       skipPreInstall: true,
       before: async ({ pkg, shouldCommitState, installDeps, isTestOrDebug }) => {
         logWithSpinner(`🔄`, `Checking for plugin updates...`)
@@ -115,17 +116,18 @@ module.exports = class PluginUpgradeJob {
             }))
           }
 
-          if (queuedUpdates.length) {
+          const count = queuedUpdates.length
+          if (count) {
             if (!cliOptions.yes) {
               const { confirm } = await inquirer.prompt([{
                 name: 'confirm',
                 type: 'confirm',
-                message: `Confirm ${queuedUpdates.length} plugin update${queuedUpdates.length > 1 ? 's' : ''}?`,
+                message: `Confirm ${count} plugin update${count > 1 ? 's' : ''}?`,
               }])
               if (!confirm) process.exit()
             }
 
-            await shouldCommitState()
+            await shouldCommitState(`[nodepack] before update ${count} plugin${count > 1 ? 's' : ''}`)
 
             for (const update of queuedUpdates) {
               pkg[update.info.dependencyType][update.info.id] = update.version
@@ -135,11 +137,15 @@ module.exports = class PluginUpgradeJob {
             if (!isTestOrDebug) {
               await installDeps(`📦  Updating packages...`)
             }
+          } else {
+            log(`${chalk.green('✔')}  No plugin updates applied.`)
+            process.exit()
           }
         }
       },
-      after: async maintenance => {
+      after: async ({ shouldCommitState }) => {
         const count = queuedUpdates.length
+        await shouldCommitState(`[nodepack] after update ${chalk.yellow(`${count} plugin${count > 1 ? 's' : ''}`)}`)
         log(`🎉  Successfully upgraded ${chalk.yellow(`${count} plugin${count > 1 ? 's' : ''}`)}.`)
       },
     })

packages/@nodepack/cli/src/lib/ProjectCreateJob.js

@@ -128,7 +128,7 @@ module.exports = class ProjectCreateJob {
         // initial commit
         let gitCommitSuccess = true
         if (shouldInitGit) {
-          gitCommitSuccess = await commitOnGit(cliOptions, isTestOrDebug)
+          gitCommitSuccess = await commitOnGit(cliOptions, isTestOrDebug, `[nodepack] create project`)
         }
         stopSpinner()
 

packages/@nodepack/maintenance/src/lib/Maintenance.js

@@ -100,7 +100,7 @@ class Maintenance {
     })
     const { migrations } = await migrator.prepare()
     if (migrations.length) {
-      await this.shouldCommitState()
+      await this.shouldCommitState(`[nodepack] before app migration`)
       log(`🚀  Migrating app code...`)
       const { migrationCount, allOptions } = await migrator.migrate(this.preset)
       log(`📝  ${migrationCount} app migration${migrationCount > 1 ? 's' : ''} applied!`)
@@ -110,6 +110,7 @@ class Maintenance {
 
       // install additional deps (injected by migrations)
       await this.installDeps(`📦  Installing additional dependencies...`)
+      await this.shouldCommitState(`[nodepack] after app migration`)
     }
 
     // TODO Env Migrations
@@ -125,14 +126,15 @@ class Maintenance {
 
   /**
    * Should be called each time the project is about to be modified.
+   * @param {string} defaultMessage
    */
-  async shouldCommitState () {
+  async shouldCommitState (defaultMessage) {
     if (this.preCommitAttempted || this.skipCommit) return
     // Commit app code before installing a new plugin
     // in case it modify files
     const shouldCommitState = await shouldUseGit(this.cwd, this.cliOptions)
     if (shouldCommitState) {
-      const result = await commitOnGit(this.cliOptions, this.isTestOrDebug)
+      const result = await commitOnGit(this.cliOptions, this.isTestOrDebug, defaultMessage)
       if (!result) {
         // Commit failed confirmation
         const answers = await inquirer.prompt([

packages/@nodepack/utils/src/git.js

@@ -3,17 +3,18 @@ const { hasGit, hasProjectGit } = require('./env')
 /**
  * @param {any} cliOptions
  * @param {boolean} isTestOrDebug
+ * @param {string} defaultMessage
  * @returns {Promise.<boolean>} Git commit success
  */
-exports.commitOnGit = async function (cliOptions, isTestOrDebug) {
+exports.commitOnGit = async function (cliOptions, isTestOrDebug, defaultMessage) {
   const { run } = this
   let success = true
   await run('git add -A')
   if (isTestOrDebug) {
     await run('git', ['config', 'user.name', 'test'])
     await run('git', ['config', 'user.email', 'test@test.com'])
   }
-  const msg = typeof cliOptions.git === 'string' ? cliOptions.git : 'init'
+  const msg = typeof cliOptions.git === 'string' ? cliOptions.git : defaultMessage
   try {
     await run('git', ['commit', '-m', msg])
   } catch (e) {