@dotenvx/dotenvx 1.11.0 → 1.11.2

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 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.11.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.11.2...main)
+
+## 1.11.2
+
+### Added
+
+* detect encoding when reading `.env*` file on `run/get` ([#359](https://github.com/dotenvx/dotenvx/pull/359))
+
+## 1.11.1
+
+### Changed
+
+* support encryption of `export KEY` variables and preserve `#!shebangs` ([#357](https://github.com/dotenvx/dotenvx/pull/357))
 
 ## 1.11.0
 

package/README.md

@@ -256,7 +256,7 @@ More examples
   ```sh
   $ dotnet new console -n HelloWorld -o HelloWorld
   $ cd HelloWorld
-  $ echo "HELLO=World" > .env
+  $ echo "HELLO=World" | Out-File -FilePath .env -Encoding utf8
   $ echo 'Console.WriteLine($"Hello {Environment.GetEnvironmentVariable("HELLO")}");' > Program.cs
 
   $ dotenvx run -- dotnet run

package/package.json

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

package/src/cli/actions/get.js

@@ -5,7 +5,9 @@ const conventions = require('./../../lib/helpers/conventions')
 const main = require('./../../lib/main')
 
 function get (key) {
-  logger.debug(`key: ${key}`)
+  if (key) {
+    logger.debug(`key: ${key}`)
+  }
 
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)

package/src/lib/helpers/detectEncoding.js

@@ -0,0 +1,28 @@
+const fs = require('fs')
+
+function detectEncoding (filepath) {
+  const buffer = fs.readFileSync(filepath)
+
+  // check for UTF-16LE BOM (Byte Order Mark)
+  if (buffer.length >= 2 && buffer[0] === 0xFF && buffer[1] === 0xFE) {
+    return 'utf16le'
+  }
+
+  /* c8 ignore start */
+  // check for UTF-8 BOM
+  if (buffer.length >= 3 && buffer[0] === 0xEF && buffer[1] === 0xBB && buffer[2] === 0xBF) {
+    return 'utf8'
+  }
+
+  // Check if the file is entirely US-ASCII (0x00 - 0x7F), which is valid UTF-8
+  for (let i = 0; i < buffer.length; i++) {
+    if (buffer[i] > 0x7F) {
+      break
+    }
+  }
+  /* c8 ignore stop */
+
+  return 'utf8'
+}
+
+module.exports = detectEncoding

package/src/lib/helpers/findOrCreatePublicKey.js

@@ -39,6 +39,14 @@ function findOrCreatePublicKey (envFilepath, envKeysFilepath) {
     }
   }
 
+  // preserve shebang
+  const [firstLine, ...remainingLines] = envSrc.split('\n')
+  let firstLinePreserved = ''
+  if (firstLine.startsWith('#!')) {
+    firstLinePreserved = firstLine + '\n'
+    envSrc = remainingLines.join('\n')
+  }
+
   // generate key pair
   const { publicKey, privateKey } = keyPair(existingPrivateKey)
 
@@ -66,7 +74,7 @@ function findOrCreatePublicKey (envFilepath, envKeysFilepath) {
     ''
   ].join('\n')
 
-  envSrc = `${prependPublicKey}\n${envSrc}`
+  envSrc = `${firstLinePreserved}${prependPublicKey}\n${envSrc}`
   keysSrc = keysSrc.length > 1 ? keysSrc : `${firstTimeKeysSrc}\n`
 
   let privateKeyAdded = false

package/src/lib/helpers/replace.js

@@ -7,13 +7,15 @@ function replace (src, key, value) {
   const parsed = dotenv.parse(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
     const regex = new RegExp(
-      // Match the key at the start of a line or following a newline
-      `(^|\\n)${key}\\s*=\\s*` +
+      // Match the key at the start of a line, following a newline, or prefaced by export
+      `(^|\\n)\\s*(export\\s+)?${key}\\s*=\\s*` +
+      // `(^|\\n)${key}\\s*=\\s*` +
       // Non-capturing group to handle different types of quotations and unquoted values
       '(?:' +
         '(["\'`])' + // Match an opening quote
         '.*?' + // Non-greedy match for any characters within quotes
-        '\\2' + // Match the corresponding closing quote
+        // '\\2' + // Match the corresponding closing quote
+        '\\3' + // Match the corresponding closing quote
       '|' +
         // Match unquoted values; account for escaped newlines
         '(?:[^#\\n\\\\]|\\\\.)*' + // Use non-capturing group for any character except #, newline, or backslash, or any escaped character
@@ -21,7 +23,7 @@ function replace (src, key, value) {
       'gs' // Global and dotAll mode to treat string as single line
     )
 
-    output = src.replace(regex, `$1${formatted}`)
+    output = src.replace(regex, `$1$2${formatted}`)
   } else {
     // append
     if (src.endsWith('\n')) {

package/src/lib/services/run.js

@@ -15,6 +15,7 @@ const parseDecryptEvalExpand = require('./../helpers/parseDecryptEvalExpand')
 const parseEnvironmentFromDotenvKey = require('./../helpers/parseEnvironmentFromDotenvKey')
 const smartDotenvPrivateKey = require('./../helpers/smartDotenvPrivateKey')
 const guessPrivateKeyFilename = require('./../helpers/guessPrivateKeyFilename')
+const detectEncoding = require('./../helpers/detectEncoding')
 
 class Run {
   constructor (envs = [], overload = false, DOTENV_KEY = '', processEnv = process.env) {
@@ -89,7 +90,8 @@ class Run {
 
     const filepath = path.resolve(envFilepath)
     try {
-      const src = fs.readFileSync(filepath, { encoding: ENCODING })
+      const encoding = detectEncoding(filepath)
+      const src = fs.readFileSync(filepath, { encoding })
       this.readableFilepaths.add(envFilepath)
 
       // if DOTENV_PRIVATE_KEY_* already set in process.env then use it