@dotenvx/dotenvx 0.10.0 → 0.10.2

package/README.md

@@ -359,7 +359,7 @@ More examples
   web: dotenvx run -- node index.js
   ```
 
-  <sub><a href="https://github.com/dotenvx/heroku-buildpack-dotenvx">buildpack docs</a></sub>
+  [see heroku guide](https://dotenvx.com/docs/platforms/heroku)
 
   </details>
 
@@ -430,27 +430,21 @@ More examples
 
 You can prevent `.env` files from being committed to code with this pre-commit hook.
 
-Place this in `.git/hooks/pre-commit`
-
 ```
-#!/bin/sh
-dotenvx precommit --quiet
-
-# Check dotenvx precommit exit status
-if [ $? -ne 0 ]; then
-  echo "dotenvx pre-commit failed. run [dotenvx precommit] for more information"
-  exit 1
-fi
-exit 0
+dotenvx precommit --install
 ```
 
-Make sure to make it executable.
+Run without the `--install` flag to preview output.
 
 ```
-chmod +x .git/hooks/pre-commit
+dotenvx precommit
 ```
 
-You can simulate the pre-commit hook by running `dotenvx precommit` locally.
+To ignore the pre-commit hook run your git commit with the `--no-verify` flag.
+
+```
+git commit -am "msg" --no-verify
+```
 
 ## Contributing
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.0",
+  "version": "0.10.2",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/cli/actions/precommit.js

@@ -1,20 +1,30 @@
 const fs = require('fs')
+const path = require('path')
 
 const ignore = require('ignore')
 
 const logger = require('./../../shared/logger')
+const helpers = require('./../helpers')
 
 function precommit () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  // 0. handle the --install flag
+  if (options.install) {
+    installPrecommitHook()
+    return
+  }
+
   // 1. check for .gitignore file
   if (!fs.existsSync('.gitignore')) {
-    logger.error('.gitignore missing')
-    logger.help('? add it with [touch .gitignore]')
+    logger.errorvp('.gitignore missing')
+    logger.help2('? add it with [touch .gitignore]')
     process.exit(1)
   }
 
+  // 2. check .env* files against .gitignore file
+  let warningCount = 0
   const ig = ignore().add(fs.readFileSync('.gitignore').toString())
   const files = fs.readdirSync(process.cwd())
   const dotenvFiles = files.filter(file => file.match(/^\.env(\..+)?$/))
@@ -23,33 +33,68 @@ function precommit () {
     if (ig.ignores(file)) {
       switch (file) {
         case '.env.example':
-          logger.warn(`${file} (currently ignored but should not be)`)
-          logger.help(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
+          warningCount += 1
+          logger.warnv(`${file} (currently ignored but should not be)`)
+          logger.help2(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
           break
         case '.env.vault':
-          logger.warn(`${file} (currently ignored but should not be)`)
-          logger.help(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
+          warningCount += 1
+          logger.warnv(`${file} (currently ignored but should not be)`)
+          logger.help2(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
           break
         default:
-          logger.success(file)
           break
       }
     } else {
       switch (file) {
         case '.env.example':
-          logger.success('.env.example') // should not be ignored
           break
         case '.env.vault':
-          logger.success('.env.vault') // should not be ignored
           break
         default:
-          logger.error(`${file} not properly gitignored`)
-          logger.help(`? add ${file} to .gitignore with [echo ".env*" >> .gitignore]`)
-          process.exit(1)
+          logger.errorvp(`${file} not properly gitignored`)
+          logger.help2(`? add ${file} to .gitignore with [echo ".env*" >> .gitignore]`)
+          process.exit(1) // 3.1 exit early with error code
           break
       }
     }
   })
+
+  // 3. outpout success
+  if (warningCount > 0) {
+    logger.successvp(`success (with ${helpers.pluralize('warning', warningCount)})`)
+  } else {
+    logger.successvp('success')
+  }
+}
+
+function installPrecommitHook () {
+  const hookScript = '#!/bin/sh\ndotenvx precommit\n'
+  const hookPath = path.join('.git', 'hooks', 'pre-commit')
+
+  try {
+    // Check if the pre-commit file already exists
+    if (fs.existsSync(hookPath)) {
+      // Read the existing content of the file
+      const existingContent = fs.readFileSync(hookPath, 'utf8')
+
+      // Check if 'dotenvx precommit' already exists in the file
+      if (!existingContent.includes('dotenvx precommit')) {
+        // Append 'dotenvx precommit' to the existing file
+        fs.appendFileSync(hookPath, '\n' + hookScript)
+        logger.successvp(`dotenvx precommit appended [${hookPath}]`)
+      } else {
+        logger.warnvp(`dotenvx precommit exists [${hookPath}]`)
+      }
+    } else {
+      // If the pre-commit file doesn't exist, create a new one with the hookScript
+      fs.writeFileSync(hookPath, hookScript)
+      fs.chmodSync(hookPath, '755') // Make the file executable
+      logger.successvp(`dotenvx precommit installed [${hookPath}]`)
+    }
+  } catch (err) {
+    logger.errorvp(`Failed to modify pre-commit hook: ${err.message}`)
+  }
 }
 
 module.exports = precommit

package/src/cli/actions/run.js

@@ -90,7 +90,7 @@ async function run () {
         switch (e.code) {
           // missing .env
           case 'ENOENT':
-            logger.warnv(`missing .env file (${filepath})`)
+            logger.warnv(`missing ${envFilepath} file (${filepath})`)
             logger.help(`? in development: add one with [echo "HELLO=World" > .env] and re-run [dotenvx run -- ${commandArgs.join(' ')}]`)
             logger.help('? for production: set [DOTENV_KEY] on your server and re-deploy')
             break

package/src/cli/dotenvx.js

@@ -70,6 +70,7 @@ program.command('encrypt')
 program.command('precommit')
   .description('dotenvx precommit check')
   .addHelpText('after', examples.precommit)
+  .option('-i, --install', 'install to .git/hooks/pre-commit')
   .action(require('./actions/precommit'))
 
 // dotenvx hub

package/src/cli/examples.js

@@ -54,6 +54,14 @@ Examples:
 
   \`\`\`
   $ dotenvx precommit
+  $ dotenvx precommit --install
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ dotenvx precommit
+  [dotenvx@0.10.0][precommit] success
   \`\`\`
   `
 }

package/src/shared/logger.js

@@ -10,10 +10,14 @@ const packageJson = require('./packageJson')
 
 const levels = {
   error: 0,
+  errorv: 0,
+  errorvp: 0,
   warn: 1,
   warnv: 1,
+  warnvp: 1,
   success: 2,
   successv: 2,
+  successvp: 2,
   info: 2,
   help: 2,
   help2: 2,
@@ -40,14 +44,22 @@ const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
   switch (level.toLowerCase()) {
     case 'error':
       return error(formattedMessage)
+    case 'errorv':
+      return error(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
+    case 'errorvp':
+      return error(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
     case 'warn':
       return warn(formattedMessage)
     case 'warnv':
       return warn(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
+    case 'warnvp':
+      return warn(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
     case 'success':
       return success(formattedMessage)
     case 'successv': // success with 'version'
       return successv(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
+    case 'successvp': // success with 'version' and precommit
+      return success(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
     case 'info':
       return formattedMessage
     case 'help':