@dotenvx/dotenvx 0.9.0 → 0.10.1

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Scott Motte
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -426,6 +426,26 @@ More examples
 * [dotenvx/docs](https://dotenvx.com/docs)
 * [quickstart guide](https://dotenvx.com/docs/quickstart)
 
+## Pre-commit
+
+You can prevent `.env` files from being committed to code with this pre-commit hook.
+
+```
+dotenvx precommit --install
+```
+
+Run without the `--install` flag to preview output.
+
+```
+dotenvx precommit
+```
+
+To ignore the pre-commit hook run your git commit with the `--no-verify` flag.
+
+```
+git commit -am "msg" --no-verify
+```
+
 ## Contributing
 
 You can fork this repo and create [pull requests](https://github.com/dotenvx/dotenvx/pulls) or if you have questions or feedback:

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.9.0",
+  "version": "0.10.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -31,11 +31,12 @@
     "commander": "^11.1.0",
     "conf": "^10.2.0",
     "dotenv": "^16.3.1",
+    "execa": "^5.1.1",
+    "ignore": "^5.3.0",
     "open": "^8.4.2",
     "ora": "^5.4.1",
     "qrcode-terminal": "^0.12.0",
     "update-notifier": "^5.1.0",
-    "execa": "^5.1.1",
     "winston": "^3.11.0",
     "xxhashjs": "^0.2.2"
   },

package/src/cli/actions/encrypt.js

@@ -4,6 +4,7 @@ const main = require('./../../lib/main')
 const logger = require('./../../shared/logger')
 const helpers = require('./../helpers')
 const createSpinner = require('./../../shared/createSpinner')
+const { AppendToIgnores } = require('./../ignores')
 
 const spinner = createSpinner('encrypting')
 
@@ -11,6 +12,8 @@ const spinner = createSpinner('encrypting')
 const ENCODING = 'utf8'
 
 async function encrypt () {
+  new AppendToIgnores().run()
+
   spinner.start()
   await helpers.sleep(500) // better dx
 

package/src/cli/actions/precommit.js

@@ -0,0 +1,100 @@
+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.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(\..+)?$/))
+  dotenvFiles.forEach(file => {
+    // check if that file is being ignored
+    if (ig.ignores(file)) {
+      switch (file) {
+        case '.env.example':
+          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':
+          warningCount += 1
+          logger.warnv(`${file} (currently ignored but should not be)`)
+          logger.help2(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
+          break
+        default:
+          break
+      }
+    } else {
+      switch (file) {
+        case '.env.example':
+          break
+        case '.env.vault':
+          break
+        default:
+          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

@@ -2,10 +2,13 @@ const fs = require('fs')
 const logger = require('./../../shared/logger')
 const helpers = require('./../helpers')
 const main = require('./../../lib/main')
+const { AppendToIgnores } = require('./../ignores')
 
 const ENCODING = 'utf8'
 
 async function run () {
+  new AppendToIgnores().run()
+
   const commandArgs = this.args
   logger.debug(`process command [${commandArgs.join(' ')}]`)
 

package/src/cli/dotenvx.js

@@ -7,7 +7,6 @@ const program = new Command()
 const logger = require('./../shared/logger')
 const helpers = require('./helpers')
 const examples = require('./examples')
-const { AppendToIgnores } = require('./ignores')
 const packageJson = require('./../shared/packageJson')
 
 // once a day check for any updates
@@ -23,8 +22,6 @@ program
   .option('-v, --verbose', 'sets log level to verbose')
   .option('-d, --debug', 'sets log level to debug')
   .hook('preAction', (thisCommand, actionCommand) => {
-    new AppendToIgnores().run()
-
     const options = thisCommand.opts()
 
     if (options.logLevel) {
@@ -69,6 +66,13 @@ program.command('encrypt')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', helpers.findEnvFiles('./'))
   .action(require('./actions/encrypt'))
 
+// dotenvx precommit
+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
 program.addCommand(require('./commands/hub'))
 

package/src/cli/examples.js

@@ -48,7 +48,26 @@ Try it:
   `
 }
 
+const precommit = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx precommit
+  $ dotenvx precommit --install
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ dotenvx precommit
+  [dotenvx@0.10.0][precommit] success
+  \`\`\`
+  `
+}
+
 module.exports = {
   run,
-  encrypt
+  encrypt,
+  precommit
 }

package/src/shared/createSpinner.js

@@ -7,6 +7,8 @@ const createSpinner = function (initialMessage = '') {
   return {
     start: (message) => spinner.start(message),
     succeed: (message) => spinner.succeed(chalk.keyword('green')(message)),
+    warn: (message) => spinner.warn(chalk.keyword('orangered')(message)),
+    info: (message) => spinner.info(chalk.keyword('blue')(message)),
     done: (message) => spinner.succeed(message),
     fail: (message) => spinner.fail(chalk.bold.red(message))
   }

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':