@dotenvx/dotenvx 1.31.2 → 1.32.0

package/CHANGELOG.md

@@ -2,7 +2,27 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.31.2...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.32.0...main)
+
+## [1.32.0](https://github.com/dotenvx/dotenvx/compare/v1.31.3...v1.32.0)
+
+### Added
+
+* add encrypted check support for `ext prebuild` ([#501](https://github.com/dotenvx/dotenvx/pull/501))
+
+### Changed
+
+* modify `ext precommit` to check git modified state as well as git staged state - useful for using `dotenvx ext precommit` without the `--install` flag in automated scripts and ci. ([#499](https://github.com/dotenvx/dotenvx/pull/499))
+
+### Removed
+
+* remove internal logger methods `errorvp, errorvpb, warnv, warnvp, warnvpb, successvp, successvpb, help2` ([#501](https://github.com/dotenvx/dotenvx/pull/501))
+
+## [1.31.3](https://github.com/dotenvx/dotenvx/compare/v1.31.2...v1.31.3)
+
+### Changed
+
+* adjust wingetcreate to use powershell when parsing version
 
 ## [1.31.2](https://github.com/dotenvx/dotenvx/compare/v1.31.1...v1.31.2)
 

package/package.json

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

package/src/cli/actions/ext/prebuild.js

@@ -1,64 +1,32 @@
-const fsx = require('./../../../lib/helpers/fsx')
-
-const ignore = require('ignore')
-
 const { logger } = require('./../../../shared/logger')
-const pluralize = require('./../../../lib/helpers/pluralize')
+
+const Prebuild = require('./../../../lib/services/prebuild')
 
 function prebuild () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  // 1. check for .dockerignore file
-  if (!fsx.existsSync('.dockerignore')) {
-    logger.errorvpb('.dockerignore missing')
-    logger.help2('? add it with [touch .dockerignore]')
-    process.exit(1)
-    return
-  }
+  try {
+    const {
+      successMessage,
+      warnings
+    } = new Prebuild(options).run()
 
-  // 2. check .env* files against .dockerignore file
-  let warningCount = 0
-  const ig = ignore().add(fsx.readFileX('.dockerignore'))
-  const files = fsx.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 .dockerignore with [echo "!${file}" >> .dockerignore]`)
-          break
-        case '.env.vault':
-          warningCount += 1
-          logger.warnv(`${file} (currently ignored but should not be)`)
-          logger.help2(`? add !${file} to .dockerignore with [echo "!${file}" >> .dockerignore]`)
-          break
-        default:
-          break
-      }
-    } else {
-      switch (file) {
-        case '.env.example':
-          break
-        case '.env.vault':
-          break
-        default:
-          logger.errorvpb(`${file} not properly dockerignored`)
-          logger.help2(`? add ${file} to .dockerignore with [echo ".env*" >> .dockerignore]`)
-          process.exit(1) // 3.1 exit early with error code
-          break
+    for (const warning of warnings) {
+      logger.warn(warning.message)
+      if (warning.help) {
+        logger.help(warning.help)
       }
     }
-  })
 
-  // 3. outpout success
-  if (warningCount > 0) {
-    logger.successvpb(`success (with ${pluralize('warning', warningCount)})`)
-  } else {
-    logger.successvpb('success')
+    logger.success(successMessage)
+  } catch (error) {
+    logger.error(error.message)
+    if (error.help) {
+      logger.help(error.help)
+    }
+
+    process.exit(1)
   }
 }
 

package/src/cli/actions/ext/precommit.js

@@ -13,15 +13,15 @@ function precommit () {
     } = new Precommit(options).run()
 
     for (const warning of warnings) {
-      logger.warnv(warning.message)
+      logger.warn(warning.message)
       if (warning.help) {
         logger.help(warning.help)
       }
     }
 
-    logger.successvp(successMessage)
+    logger.success(successMessage)
   } catch (error) {
-    logger.errorvp(error.message)
+    logger.error(error.message)
     if (error.help) {
       logger.help(error.help)
     }

package/src/cli/actions/ext/scan.js

@@ -12,7 +12,7 @@ function scan () {
   } catch (error) {
     console.error('gitleaks: command not found')
     logger.help('? install gitleaks:      [brew install gitleaks]')
-    logger.help2('? other install options: [https://github.com/gitleaks/gitleaks]')
+    logger.help('? other install options: [https://github.com/gitleaks/gitleaks]')
     process.exit(1)
     return
   }

package/src/lib/main.d.ts

@@ -140,20 +140,12 @@ export interface DotenvConfigOptions {
   logLevel?:
     | 'error'
     | 'errorv'
-    | 'errorvp'
-    | 'errorvpb'
     | 'errornocolor'
     | 'warn'
-    | 'warnv'
-    | 'warnvp'
-    | 'warnvpb'
     | 'success'
     | 'successv'
-    | 'successvp'
-    | 'successvpb'
     | 'info'
     | 'help'
-    | 'help2'
     | 'http'
     | 'verbose'
     | 'debug'

package/src/lib/services/prebuild.js

@@ -0,0 +1,81 @@
+/* istanbul ignore file */
+const fsx = require('./../helpers/fsx')
+const ignore = require('ignore')
+
+const Ls = require('../services/ls')
+
+const isFullyEncrypted = require('./../helpers/isFullyEncrypted')
+const packageJson = require('./../helpers/packageJson')
+const MISSING_DOCKERIGNORE = '.env.keys' // by default only ignore .env.keys. all other .env* files COULD be included - as long as they are encrypted
+
+class Prebuild {
+  constructor () {
+    this.excludeEnvFile = ['test/**', 'tests/**', 'spec/**', 'specs/**', 'pytest/**', 'test_suite/**']
+  }
+
+  run () {
+    let count = 0
+    const warnings = []
+    let dockerignore = MISSING_DOCKERIGNORE
+
+    // 1. check for .dockerignore file
+    if (!fsx.existsSync('.dockerignore')) {
+      const warning = new Error(`[dotenvx@${packageJson.version}][prebuild] .dockerignore missing`)
+      warnings.push(warning)
+    } else {
+      dockerignore = fsx.readFileX('.dockerignore')
+    }
+
+    // 2. check .env* files against .dockerignore file
+    const ig = ignore().add(dockerignore)
+    const lsService = new Ls(process.cwd(), undefined, this.excludeEnvFile)
+    const dotenvFiles = lsService.run()
+    dotenvFiles.forEach(file => {
+      count += 1
+
+      // check if that file is being ignored
+      if (ig.ignores(file)) {
+        if (file === '.env.example' || file === '.env.vault') {
+          const warning = new Error(`[dotenvx@${packageJson.version}][prebuild] ${file} (currently ignored but should not be)`)
+          warning.help = `[dotenvx@${packageJson.version}][prebuild] ⮕  run [dotenvx ext gitignore --pattern !${file}]`
+          warnings.push(warning)
+        }
+      } else {
+        if (file !== '.env.example' && file !== '.env.vault') {
+          const src = fsx.readFileX(file)
+          const encrypted = isFullyEncrypted(src)
+
+          // if contents are encrypted don't raise an error
+          if (!encrypted) {
+            let errorMsg = `[dotenvx@${packageJson.version}][prebuild] ${file} not protected (encrypted or dockerignored)`
+            let errorHelp = `[dotenvx@${packageJson.version}][prebuild] ⮕  run [dotenvx encrypt -f ${file}] or [dotenvx ext gitignore --pattern ${file}]`
+            if (file.includes('.env.keys')) {
+              errorMsg = `[dotenvx@${packageJson.version}][prebuild] ${file} not protected (dockerignored)`
+              errorHelp = `[dotenvx@${packageJson.version}][prebuild] ⮕  run [dotenvx ext gitignore --pattern ${file}]`
+            }
+
+            const error = new Error(errorMsg)
+            error.help = errorHelp
+            throw error
+          }
+        }
+      }
+    })
+
+    let successMessage = `[dotenvx@${packageJson.version}][prebuild] .env files (${count}) protected (encrypted or dockerignored)`
+
+    if (count === 0) {
+      successMessage = `[dotenvx@${packageJson.version}][prebuild] zero .env files`
+    }
+    if (warnings.length > 0) {
+      successMessage += ` with warnings (${warnings.length})`
+    }
+
+    return {
+      successMessage,
+      warnings
+    }
+  }
+}
+
+module.exports = Prebuild

package/src/lib/services/precommit.js

@@ -5,6 +5,7 @@ const ignore = require('ignore')
 const Ls = require('../services/ls')
 
 const isFullyEncrypted = require('./../helpers/isFullyEncrypted')
+const packageJson = require('./../helpers/packageJson')
 const InstallPrecommitHook = require('./../helpers/installPrecommitHook')
 const childProcess = require('child_process')
 const MISSING_GITIGNORE = '.env.keys' // by default only ignore .env.keys. all other .env* files COULD be included - as long as they are encrypted
@@ -32,8 +33,7 @@ class Precommit {
 
       // 1. check for .gitignore file
       if (!fsx.existsSync('.gitignore')) {
-        const warning = new Error('.gitignore missing')
-        warning.help = '? add it with [touch .gitignore]'
+        const warning = new Error(`[dotenvx@${packageJson.version}][precommit] .gitignore missing`)
         warnings.push(warning)
       } else {
         gitignore = fsx.readFileX('.gitignore')
@@ -51,8 +51,8 @@ class Precommit {
           // check if that file is being ignored
           if (ig.ignores(file)) {
             if (file === '.env.example' || file === '.env.vault') {
-              const warning = new Error(`${file} (currently ignored but should not be)`)
-              warning.help = `? add !${file} to .gitignore [echo "!${file}" >> .gitignore]`
+              const warning = new Error(`[dotenvx@${packageJson.version}][precommit] ${file} (currently ignored but should not be)`)
+              warning.help = `[dotenvx@${packageJson.version}][precommit] ⮕  run [dotenvx ext gitignore --pattern !${file}]`
               warnings.push(warning)
             }
           } else {
@@ -62,8 +62,15 @@ class Precommit {
 
               // if contents are encrypted don't raise an error
               if (!encrypted) {
-                const error = new Error(`${file} not protected (encrypted or gitignored)`)
-                error.help = `? encrypt it [dotenvx encrypt -f ${file}] or gitignore it [echo "${file}" >> .gitignore]`
+                let errorMsg = `[dotenvx@${packageJson.version}][precommit] ${file} not protected (encrypted or gitignored)`
+                let errorHelp = `[dotenvx@${packageJson.version}][precommit] ⮕  run [dotenvx encrypt -f ${file}] or [dotenvx ext gitignore --pattern ${file}]`
+                if (file.includes('.env.keys')) {
+                  errorMsg = `[dotenvx@${packageJson.version}][precommit] ${file} not protected (gitignored)`
+                  errorHelp = `[dotenvx@${packageJson.version}][precommit] ⮕  run [dotenvx ext gitignore --pattern ${file}]`
+                }
+
+                const error = new Error(errorMsg)
+                error.help = errorHelp
                 throw error
               }
             }
@@ -71,9 +78,9 @@ class Precommit {
         }
       })
 
-      let successMessage = `.env files (${count}) protected (encrypted or gitignored)`
+      let successMessage = `[dotenvx@${packageJson.version}][precommit] .env files (${count}) protected (encrypted or gitignored)`
       if (count === 0) {
-        successMessage = 'zero .env files'
+        successMessage = `[dotenvx@${packageJson.version}][precommit] zero .env files`
       }
       if (warnings.length > 0) {
         successMessage += ` with warnings (${warnings.length})`
@@ -88,7 +95,7 @@ class Precommit {
 
   _isFileToBeCommitted (filePath) {
     try {
-      const output = childProcess.execSync('git diff --cached --name-only').toString()
+      const output = childProcess.execSync('git diff HEAD --name-only').toString()
       const files = output.split('\n')
 
       return files.includes(filePath)

package/src/shared/logger.js

@@ -4,20 +4,12 @@ const { getColor, bold } = require('./colors')
 const levels = {
   error: 0,
   errorv: 0,
-  errorvp: 0,
-  errorvpb: 0,
   errornocolor: 0,
   warn: 1,
-  warnv: 1,
-  warnvp: 1,
-  warnvpb: 1,
   success: 2,
   successv: 2,
-  successvp: 2,
-  successvpb: 2,
   info: 2,
   help: 2,
-  help2: 2,
   blank: 2,
   verbose: 4,
   debug: 5,
@@ -29,7 +21,6 @@ const warn = getColor('orangered')
 const success = getColor('green')
 const successv = getColor('olive') // yellow-ish tint that 'looks' like dotenv
 const help = getColor('dodgerblue')
-const help2 = getColor('gray')
 const verbose = getColor('plum')
 const debug = getColor('plum')
 
@@ -55,38 +46,22 @@ function formatMessage (level, message) {
       return error(formattedMessage)
     case 'errorv':
       return error(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
-    case 'errorvp':
-      return error(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
-    case 'errorvpb':
-      return error(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     case 'errornocolor':
       return formattedMessage
     // warns
     case 'warn':
       return warn(formattedMessage)
-    case 'warnv':
-      return warn(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
-    case 'warnvp':
-      return warn(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
-    case 'warnvpb':
-      return warn(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     // successes
     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 'successvpb': // success with 'version' and precommit
-      return success(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     // info
     case 'info':
       return formattedMessage
     // help
     case 'help':
       return help(formattedMessage)
-    case 'help2':
-      return help2(formattedMessage)
     // verbose
     case 'verbose':
       return verbose(formattedMessage)
@@ -106,24 +81,16 @@ const logger = {
   // errors
   error: (msg) => log('error', msg),
   errorv: (msg) => log('errorv', msg),
-  errorvp: (msg) => log('errorvp', msg),
-  errorvpb: (msg) => log('errorvpb', msg),
   errornocolor: (msg) => log('errornocolor', msg),
   // warns
   warn: (msg) => log('warn', msg),
-  warnv: (msg) => log('warnv', msg),
-  warnvp: (msg) => log('warnvp', msg),
-  warnvpb: (msg) => log('warnvpb', msg),
   // success
   success: (msg) => log('success', msg),
   successv: (msg) => log('successv', msg),
-  successvp: (msg) => log('successvp', msg),
-  successvpb: (msg) => log('successvpb', msg),
   // info
   info: (msg) => log('info', msg),
   // help
   help: (msg) => log('help', msg),
-  help2: (msg) => log('help2', msg),
   // verbose
   verbose: (msg) => log('verbose', msg),
   // debug