From 8f5a956844ed69ded3a9b6480d3372635b2e97be Mon Sep 17 00:00:00 2001
From: Todd Bluhm <toddbluhm@gmail.com>
Date: Tue, 3 Dec 2024 05:59:31 -0900
Subject: [PATCH] fix(parse-env-file): fix strip comments per PR #333
---
dist/parse-env-file.js | 10 ++--------
src/parse-env-file.ts | 10 ++--------
test/parse-env-file.spec.ts | 5 +++++
3 files changed, 9 insertions(+), 16 deletions(-)
diff --git a/dist/parse-env-file.js b/dist/parse-env-file.js
index 457b661..007aa5a 100644
--- a/dist/parse-env-file.js
+++ b/dist/parse-env-file.js
@@ -85,14 +85,8 @@ export function parseEnvVars(envString) {
* Strips out comments from env file string
*/
export function stripComments(envString) {
- const commentsRegex = /(^#.*$)/gim;
- let match = commentsRegex.exec(envString);
- let newString = envString;
- while (match != null) {
- newString = newString.replace(match[1], '');
- match = commentsRegex.exec(envString);
- }
- return newString;
+ const commentsRegex = /(^\s*#.*$)/gim;
+ return envString.replace(commentsRegex, '');
}
/**
* Strips out newlines from env file string
diff --git a/src/parse-env-file.ts b/src/parse-env-file.ts
index b0fb1a2..3c2cb46 100644
--- a/src/parse-env-file.ts
+++ b/src/parse-env-file.ts
@@ -94,14 +94,8 @@ export function parseEnvVars(envString: string): Environment {
* Strips out comments from env file string
*/
export function stripComments(envString: string): string {
- const commentsRegex = /(^#.*$)/gim
- let match = commentsRegex.exec(envString)
- let newString = envString
- while (match != null) {
- newString = newString.replace(match[1], '')
- match = commentsRegex.exec(envString)
- }
- return newString
+ const commentsRegex = /(^\s*#.*$)/gim
+ return envString.replace(commentsRegex, '')
}
/**
diff --git a/test/parse-env-file.spec.ts b/test/parse-env-file.spec.ts
index 4478d7a..6ca7c87 100644
--- a/test/parse-env-file.spec.ts
+++ b/test/parse-env-file.spec.ts
@@ -16,6 +16,11 @@ describe('stripComments', (): void => {
const envString = stripComments('#BOB=COOL\nNODE_ENV=dev\nANSWER=42 AND COUNTING\n#AnotherComment\n')
assert(envString === '\nNODE_ENV=dev\nANSWER=42 AND COUNTING\n\n')
})
+
+ it('should not strip out #s from values', (): void => {
+ const envString = stripComments('#\nBOB=COMMENT#ELL\n#\nNODE_ENV=dev\nANSWER=42 AND COUNTING\n#AnotherComment\n')
+ assert(envString === '\nBOB=COMMENT#ELL\n\nNODE_ENV=dev\nANSWER=42 AND COUNTING\n\n', envString)
+ })
})
describe('parseEnvVars', (): void => {