@dotenvx/dotenvx 1.21.1 → 1.22.0

package/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 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.21.1...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.22.0...main)
+
+## 1.22.0
+
+### Added
+
+* add `--pattern` argument to `ext gitignore` (`dotenvx ext gitignore --pattern .env.keys`) ([#430](https://github.com/dotenvx/dotenvx/pull/430))
+
+### Changed
+
+* clarify next steps after first time encrypting ([#430](https://github.com/dotenvx/dotenvx/pull/430))
 
 ## 1.21.1
 

package/README.md

@@ -1222,8 +1222,8 @@ More examples
   $ dotenvx encrypt
   ✔ encrypted (.env)
   ✔ key added to .env.keys (DOTENV_PRIVATE_KEY)
-  ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]
-  ℹ run [DOTENV_PRIVATE_KEY='122...0b8' dotenvx run -- yourcommand] to test decryption locally
+  ⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys
+  ⮕  next run [DOTENV_PRIVATE_KEY='122...0b8' dotenvx run -- yourcommand] to test decryption locally
   ```
 
   </details>
@@ -1238,8 +1238,8 @@ More examples
   $ dotenvx encrypt -f .env.production
   ✔ encrypted (.env.production)
   ✔ key added to .env.keys (DOTENV_PRIVATE_KEY_PRODUCTION)
-  ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]
-  ℹ run [DOTENV_PRIVATE_KEY_PRODUCTION='bff..bc4' dotenvx run -- yourcommand] to test decryption locally
+  ⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys
+  ⮕  next run [DOTENV_PRIVATE_KEY='bff...bc4' dotenvx run -- yourcommand] to test decryption locally
   ```
 
   </details>

package/package.json

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

package/src/cli/actions/encrypt.js

@@ -64,10 +64,10 @@ function encrypt () {
           logger.success(`✔ key added to .env.keys (${processedEnv.privateKeyName})`)
 
           if (!isIgnoringDotenvKeys()) {
-            logger.help2('ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]')
+            logger.help('⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys')
           }
 
-          logger.help2(`ℹ run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx run -- yourcommand] to test decryption locally`)
+          logger.help(`⮕  next run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx run -- yourcommand] to test decryption locally`)
         }
       }
     } catch (error) {

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

@@ -1,12 +1,12 @@
 const fsx = require('./../../../lib/helpers/fsx')
 
-const FORMATS = ['.env*', '!.env.vault']
+const DEFAULT_PATTERNS = ['.env*']
 const { logger } = require('./../../../shared/logger')
 
 class Generic {
-  constructor (filename, touchFile = false) {
+  constructor (filename, patterns = DEFAULT_PATTERNS, touchFile = false) {
     this.filename = filename
-    this.formats = FORMATS
+    this.patterns = patterns
     this.touchFile = touchFile
   }
 
@@ -15,10 +15,9 @@ class Generic {
   }
 
   run () {
+    const changedPatterns = []
     if (!fsx.existsSync(this.filename)) {
-      if (this.touchFile === true) {
-        logger.info(`creating ${this.filename}`)
-
+      if (this.touchFile === true && this.patterns.length > 0) {
         fsx.writeFileX(this.filename, '')
       } else {
         return
@@ -26,41 +25,63 @@ class Generic {
     }
 
     const lines = fsx.readFileX(this.filename).split(/\r?\n/)
-    this.formats.forEach(format => {
-      if (!lines.includes(format.trim())) {
-        logger.info(`appending ${format} to ${this.filename}`)
+    this.patterns.forEach(pattern => {
+      if (!lines.includes(pattern.trim())) {
+        this.append(pattern)
 
-        this.append(format)
+        changedPatterns.push(pattern.trim())
       }
     })
+
+    if (changedPatterns.length > 0) {
+      logger.success(`✔ ignored ${this.patterns} (${this.filename})`)
+    } else {
+      logger.info(`no changes (${this.filename})`)
+    }
   }
 }
 
 class Git {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .gitignore')
-    new Generic('.gitignore', true).run()
+    logger.verbose('add to .gitignore')
+    new Generic('.gitignore', this.patterns, true).run()
   }
 }
 
 class Docker {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .dockerignore (if existing)')
-    new Generic('.dockerignore').run()
+    logger.verbose('add to .dockerignore (if exists)')
+    new Generic('.dockerignore', this.patterns).run()
   }
 }
 
 class Npm {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .npmignore (if existing)')
-    new Generic('.npmignore').run()
+    logger.verbose('add to .npmignore (if existing)')
+    new Generic('.npmignore', this.patterns).run()
   }
 }
 
 class Vercel {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .vercelignore (if existing)')
-    new Generic('.vercelignore').run()
+    logger.verbose('add to .vercelignore (if existing)')
+    new Generic('.vercelignore', this.patterns).run()
   }
 }
 
@@ -68,12 +89,12 @@ function gitignore () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  new Git().run()
-  new Docker().run()
-  new Npm().run()
-  new Vercel().run()
+  const patterns = options.pattern
 
-  logger.success('done')
+  new Git(patterns).run()
+  new Docker(patterns).run()
+  new Npm(patterns).run()
+  new Vercel(patterns).run()
 }
 
 module.exports = gitignore

package/src/cli/actions/set.js

@@ -68,10 +68,10 @@ function set (key, value) {
         logger.success(`✔ key added to .env.keys (${processedEnv.privateKeyName})`)
 
         if (!isIgnoringDotenvKeys()) {
-          logger.help2('ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]')
+          logger.help('⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys')
         }
 
-        logger.help2(`ℹ run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx get ${key}] to test decryption locally`)
+        logger.help(`⮕  next run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx get ${key}] to test decryption locally`)
       }
     }
   } catch (error) {

package/src/cli/commands/ext.js

@@ -40,6 +40,7 @@ ext.command('genexample')
 ext.command('gitignore')
   .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
   .addHelpText('after', examples.gitignore)
+  .option('--pattern <patterns...>', 'pattern(s) to gitignore', ['.env*'])
   .action(require('./../actions/ext/gitignore'))
 
 // dotenvx ext prebuild

package/src/cli/examples.js

@@ -63,13 +63,14 @@ Examples:
 
   \`\`\`
   $ dotenvx ext gitignore
+  $ dotenvx ext gitignore --pattern .env.keys
   \`\`\`
 
 Try it:
 
   \`\`\`
   $ dotenvx ext gitignore
-  done
+  ✔ ignored .env* (.gitignore)
   \`\`\`
   `
 }