Merge branch 'release/v0.28.12'

Author: holtwick

package.json

@@ -1,7 +1,7 @@
 {
   "name": "zeed",
   "type": "module",
-  "version": "0.28.11",
+  "version": "0.28.12",
   "packageManager": "pnpm@10.11.0",
   "description": "🌱 Simple foundation library",
   "author": {

src/common/schema/parse-env.spec.ts

@@ -34,9 +34,10 @@ describe('env.spec', () => {
 
   it('parse prefix', async () => {
     const schema = object({
-      ServiceName: string().default('generic').props({ desc: 'The name of the service' }),
+      ServiceName: string().default('generic').props({ desc: 'The name of the service\n  Multi Line  \n\n ' }),
       servicePort: number().default(80).props({ desc: 'The port of the service' }),
       ServiceFlag: boolean().default(true),
+      serviceDummy: string().default('dummy').props({ desc: 'Dummy value', envPrivate: true }),
     })
 
     const r = parseSchemaEnv(schema, {
@@ -50,18 +51,20 @@ describe('env.spec', () => {
       Object {
         "ServiceFlag": true,
         "ServiceName": "generic",
+        "serviceDummy": "dummy",
         "servicePort": 9999,
       }
     `)
 
-    expect(stringFromSchemaEnv(schema, 'APP_', true)).toMatchInlineSnapshot(`
+    expect(stringFromSchemaEnv(schema, 'APP_', false)).toMatchInlineSnapshot(`
       "# The name of the service
-      # APP_SERVICE_NAME=generic
+      # Multi Line
+      APP_SERVICE_NAME=generic
 
       # The port of the service
-      # APP_SERVICE_PORT=80
+      APP_SERVICE_PORT=80
 
-      # APP_SERVICE_FLAG=true
+      APP_SERVICE_FLAG=true
       "
     `)
   })

src/common/schema/parse-env.ts

@@ -8,6 +8,7 @@ import { isSchemaObjectFlat } from './utils'
 declare module './schema' {
   interface TypeProps {
     envDesc?: string
+    envPrivate?: boolean // will not be documented
   }
 }
 
@@ -37,10 +38,12 @@ export function parseSchemaEnv<T>(schema: Type<T>, env: any = process?.env ?? {}
   }) as T
 }
 
-export function stringFromSchemaEnv<T>(schema: Type<T>, prefix = '', commentOut = false): string {
+export function stringFromSchemaEnv<T>(schema: Type<T>, prefix = '', commentOut = false, showPrivate = false): string {
   assert(isSchemaObjectFlat(schema), 'schema should be a flat object')
   const lines: string[] = []
   objectMap(schema._object!, (key, schema) => {
+    if (schema._props?.envPrivate && !showPrivate)
+      return
     const desc = schema._props?.envDesc ?? schema._props?.desc
     if (desc) {
       desc.trim().split('\n').forEach((line: string) => {

src/node/env.spec.ts

@@ -1,4 +1,4 @@
-import { getEnvVariableRelaxed, setupEnv } from './env'
+import { getEnvVariableRelaxed, parseEnvString, parseEnvStringAlt, setupEnv } from './env'
 
 describe('eNV', () => {
   it('should respect both files', () => {
@@ -28,4 +28,82 @@ describe('eNV', () => {
     expect(getEnvVariableRelaxed('APROP', env)).toEqual('4')
     expect(getEnvVariableRelaxed('unknown', env)).toEqual(undefined)
   })
+
+  it('should parse a complex Docker .env file', () => {
+    const envSample = `
+      # This is a comment
+      VAR1=unquotedValue
+      VAR2= "double quoted value"
+      VAR3 = 'single quoted value'
+      VAR4=unquotedValue # inline comment
+      VAR5=unquotedValue#not a comment
+      VAR6="double quoted # not a comment"
+      VAR7="double quoted value" # comment
+      VAR8='$OTHER'
+      VAR9='\${OTHER}'
+      VAR10='Let\'s go!'
+      VAR11="{"hello": \"json\"}"
+      VAR12="some\tvalue"
+      VAR13='some\tvalue'
+      VAR14=some\tvalue
+      `
+
+    expect(envSample).toMatchInlineSnapshot(`
+      "
+            # This is a comment
+            VAR1=unquotedValue
+            VAR2= "double quoted value"
+            VAR3 = 'single quoted value'
+            VAR4=unquotedValue # inline comment
+            VAR5=unquotedValue#not a comment
+            VAR6="double quoted # not a comment"
+            VAR7="double quoted value" # comment
+            VAR8='$OTHER'
+            VAR9='\${OTHER}'
+            VAR10='Let's go!'
+            VAR11="{"hello": "json"}"
+            VAR12="some	value"
+            VAR13='some	value'
+            VAR14=some	value
+            "
+    `)
+
+    expect(parseEnvString(envSample)).toMatchInlineSnapshot(`
+      Object {
+        "VAR1": "unquotedValue",
+        "VAR10": "Let's go!",
+        "VAR11": "{"hello": "json"}",
+        "VAR12": "some	value",
+        "VAR13": "some	value",
+        "VAR14": "some	value",
+        "VAR2": "double quoted value",
+        "VAR3": "single quoted value",
+        "VAR4": "unquotedValue # inline comment",
+        "VAR5": "unquotedValue#not a comment",
+        "VAR6": "double quoted # not a comment",
+        "VAR7": ""double quoted value" # comment",
+        "VAR8": "$OTHER",
+        "VAR9": "\${OTHER}",
+      }
+    `)
+
+    expect(parseEnvStringAlt(envSample)).toMatchInlineSnapshot(`
+      Object {
+        "VAR1": "unquotedValue",
+        "VAR10": "Let's go!",
+        "VAR11": "{"hello": "json"}",
+        "VAR12": "some	value",
+        "VAR13": "some	value",
+        "VAR14": "some	value",
+        "VAR2": "double quoted value",
+        "VAR3": "single quoted value",
+        "VAR4": "unquotedValue",
+        "VAR5": "unquotedValue",
+        "VAR6": "double quoted # not a comment",
+        "VAR7": "double quoted value",
+        "VAR8": "$OTHER",
+        "VAR9": "\${OTHER}",
+      }
+    `)
+  })
 })

src/node/env.ts

@@ -21,8 +21,51 @@ interface EnvOptions {
   mode?: string
 }
 
+// BSD-2-Clause License from here https://github.com/motdotla/dotenv/blob/master/lib/main.js#L12
+// eslint-disable-next-line regexp/no-super-linear-backtracking
+const LINE = /^\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?$/gm
+
+// https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/#env-file-syntax
+export function parseEnvStringAlt(src: string): Record<string, string> {
+  const obj: Record<string, string> = {}
+
+  // Convert buffer to string
+  let lines = src.toString()
+
+  // Convert line breaks to same format
+  lines = lines.replace(/\r\n?/g, '\n')
+
+  let match
+  // eslint-disable-next-line no-cond-assign
+  while ((match = LINE.exec(lines)) != null) {
+    const key = match[1]
+
+    // Default undefined or null to empty string
+    let value = (match[2] || '')
+
+    // Remove whitespace
+    value = value.trim()
+
+    // Check if double quoted
+    const maybeQuote = value[0]
+
+    // Remove surrounding quotes
+    value = value.replace(/^(['"`])([\s\S]*)\1$/gm, '$2')
+
+    // Expand newlines if double quoted
+    if (maybeQuote === '"') {
+      value = value.replace(/\\n/g, '\n')
+      value = value.replace(/\\r/g, '\r')
+    }
+
+    // Add to object
+    obj[key] = value
+  }
+
+  return obj
+}
 // Parses src into an Object
-function parse(src: string, _options: EnvOptions = {}) {
+export function parseEnvString(src: string) {
   const obj: Record<string, string> = {}
 
   // convert Buffers before splitting into lines and processing
@@ -109,7 +152,7 @@ export function setupEnv(options: EnvOptions = {}) {
 
     function envOf(name: string) {
       return fs.existsSync(name)
-        ? parse(fs.readFileSync(name, { encoding }), { debug })
+        ? parseEnvStringAlt(fs.readFileSync(name, { encoding }))
         : {}
     }