Merge branch 'release/v0.28.10'

Author: holtwick

package.json

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

src/common/schema/export-swift.ts

@@ -7,6 +7,7 @@ declare module './schema' {
   interface TypeProps {
     swiftName?: string
     swiftProtocol?: string
+    swiftDesc?: string
   }
 }
 

src/common/schema/parse-args.ts

@@ -80,8 +80,9 @@ export function helpSchemaArgs<T>(schema: Type<T>): string {
     if (schema.type !== 'boolean')
       s += `=${schema.type}`
     lines.push(s)
-    if (schema._props?.argDesc)
-      lines.push(`  ${schema._props?.argDesc}`)
+    const desc = schema._props?.argDesc ?? schema._props?.desc
+    if (desc)
+      lines.push(`  ${desc}`)
   })
 
   return lines.join('\n')

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

@@ -34,8 +34,8 @@ describe('env.spec', () => {
 
   it('parse prefix', async () => {
     const schema = object({
-      ServiceName: string().default('generic'),
-      servicePort: number().default(80),
+      ServiceName: string().default('generic').props({ desc: 'The name of the service' }),
+      servicePort: number().default(80).props({ desc: 'The port of the service' }),
       ServiceFlag: boolean().default(true),
     })
 
@@ -55,9 +55,14 @@ describe('env.spec', () => {
     `)
 
     expect(stringFromSchemaEnv(schema, 'APP_', true)).toMatchInlineSnapshot(`
-      "# APP_SERVICE_NAME=generic
+      "# The name of the service
+      # APP_SERVICE_NAME=generic
+
+      # The port of the service
       # APP_SERVICE_PORT=80
-      # APP_SERVICE_FLAG=true"
+
+      # APP_SERVICE_FLAG=true
+      "
     `)
   })
 })

src/common/schema/parse-env.ts

@@ -5,11 +5,11 @@ import { valueToBoolean, valueToBooleanNotFalse, valueToInteger } from '../data/
 import { objectFilter, objectMap } from '../data/object'
 import { isSchemaObjectFlat } from './utils'
 
-// declare module './types' {
-//   interface TypeProps {
-//     argShort?: string
-//   }
-// }
+declare module './schema' {
+  interface TypeProps {
+    envDesc?: string
+  }
+}
 
 // eslint-disable-next-line node/prefer-global/process
 export function parseSchemaEnv<T>(schema: Type<T>, env: any = process?.env ?? {}, prefix = ''): T {
@@ -41,7 +41,14 @@ export function stringFromSchemaEnv<T>(schema: Type<T>, prefix = '', commentOut
   assert(isSchemaObjectFlat(schema), 'schema should be a flat object')
   const lines: string[] = []
   objectMap(schema._object!, (key, schema) => {
+    const desc = schema._props?.envDesc ?? schema._props?.desc
+    if (desc) {
+      desc.trim().split('\n').forEach((line: string) => {
+        lines.push(`# ${line.trim()}`)
+      })
+    }
     lines.push(`${commentOut ? '# ' : ''}${prefix + fromCamelCase(key, '_').toUpperCase()}=${schema._default ?? ''}`)
+    lines.push('')
   }) as T
   return lines.join('\n')
 }

src/common/schema/schema.ts

@@ -4,6 +4,7 @@ import { isArray, isBoolean, isFunction, isInteger, isNumber, isObject, isString
 import { first } from '../data/utils'
 
 export interface TypeProps {
+  desc?: string
 }
 
 // export interface TypeAssert {