configorama 0.9.8 → 0.9.12

package/README.md

@@ -16,6 +16,7 @@ Configorama extends your configuration with a powerful variable system. It resol
 - Git references
 - Cron values
 - Eval expressions
+- If/conditional expressions
 - Async/sync JS functions
 - Filters (experimental)
 - Functions (experimental)
@@ -45,6 +46,7 @@ See [tests](https://github.com/DavidWells/configorama/tree/master/tests) for mor
   - [Git references](#git-references)
   - [Cron Values](#cron-values)
   - [Eval expressions](#eval-expressions)
+  - [If expressions](#if-expressions)
   - [Filters (experimental)](#filters-experimental)
   - [Functions (experimental)](#functions-experimental)
   - [More Examples](#more-examples)
@@ -150,6 +152,7 @@ console.log(result.resolutionHistory) // Step-by-step resolution for each path
 | git      | ${git:value}          | Git data               |
 | cron     | ${cron(expr)}         | Cron expressions       |
 | eval     | ${eval(expr)}         | Math/logic expressions |
+| if       | ${if(expr)}           | Conditional expressions |
 
 ### Environment variables
 
@@ -715,6 +718,85 @@ strictEqual: ${eval("foo" === "foo")} # true
 complex: ${eval((10 + 5) * 2)}        # 30
 ```
 
+### If expressions
+
+Conditional expressions using ternary syntax. This is an alias for `eval` with a more intuitive name for conditionals.
+
+```yml
+# Basic ternary (condition ? "yes" : "no")
+status: ${if((5 > 3) ? "yes" : "no")}           # "yes"
+
+# With variables
+threshold: 50
+value: 75
+result: ${if((${self:value} > ${self:threshold}) ? "above" : "below")}  # "above"
+
+# Nested ternary (if/else if/else)
+score: 85
+grade: ${if((${self:score} >= 90) ? "A" : (${self:score} >= 80) ? "B" : "C")}  # "B"
+
+# Boolean result (no ternary needed)
+isValid: ${if(${self:value} > 0)}               # true
+
+# Logical operators
+enabled: true
+count: 5
+canProceed: ${if(${self:enabled} && ${self:count} > 0)}  # true
+```
+
+**Supported operators:**
+
+| Category | Operators |
+|----------|-----------|
+| Comparison | `==` `!=` `===` `!==` `>` `<` `>=` `<=` |
+| Logical | `&&` `\|\|` `!` |
+| Nullish | `??` |
+| Ternary | `condition ? "yes" : "no"` |
+
+**Serverless deployment examples:**
+
+```yml
+service: my-service
+
+provider:
+  name: aws
+  stage: ${opt:stage, 'dev'}
+  region: ${opt:region, 'us-east-1'}
+
+custom:
+  # Different memory by stage
+  memorySize: '${ if( ${provider.stage} === "prod" ) ? 1024 : 512 }'
+
+  # Different log retention by stage
+  logRetention: ${if(("${provider.stage}" === "prod") ? 30 : 7)}
+
+  # Enable features per environment
+  enableDebugEndpoints: ${if("${provider.stage}" !== "prod")}
+  enableMetrics: ${if("${provider.stage}" === "prod")}
+
+  # Regional settings
+  replicaCount: ${if(("${provider.region}" === "us-east-1") ? 3 : 1)}
+
+  # Conditional IAM role (use predefined role in prod, inline in dev)
+  useExternalRole: ${if("${provider.stage}" === "prod")}
+  role: ${if((${custom.useExternalRole}) ? "arn:aws:iam::123:role/prod-role" : null)}
+
+functions:
+  api:
+    handler: handler.api
+    memorySize: ${custom.memorySize}
+
+  # Debug function - only deployed in non-prod
+  debug:
+    handler: handler.debug
+    enabled: ${custom.enableDebugEndpoints}
+
+  # Metrics processor - only in prod
+  metricsProcessor:
+    handler: handler.metrics
+    enabled: ${custom.enableMetrics}
+```
+
 ### Filters (experimental)
 
 Pipe resolved values through transformation functions like case conversion.
@@ -818,6 +900,7 @@ The `source` property defines how the config wizard handles each variable type:
 | `${git:branch}` | `readonly` | Git repository data |
 | `${cron(expr)}` | `readonly` | Cron expression conversion |
 | `${eval(expr)}` | `readonly` | Math/logic evaluation |
+| `${if(expr)}` | `readonly` | Conditional expressions |
 
 ## Options
 

package/index.d.ts

@@ -1,10 +1,7 @@
 // Type definitions for configorama
 // Project: https://github.com/DavidWells/configorama
 
-// Re-export variable validation types
-export * from './src/types'
-
-export interface ConfigoramaSettings {
+interface ConfigoramaSettings {
   /** Options to populate for ${opt:xyz}. These could be CLI flags */
   options?: Record<string, any>
   /** Regex of variable syntax */
@@ -64,7 +61,7 @@ export interface ConfigoramaSettings {
   filePathOverrides?: Record<string, string>
 }
 
-export interface ConfigoramaResult<T = any> {
+interface ConfigoramaResult<T = any> {
   /** The variable syntax pattern used */
   variableSyntax: RegExp
   /** Map of variable types found */
@@ -83,7 +80,7 @@ export interface ConfigoramaResult<T = any> {
  * Context passed to JS/TS/ESM config file functions
  * Used when config files export a function: `export default function(ctx) { ... }`
  */
-export interface ConfigContext<T = any> {
+interface ConfigContext<T = any> {
   /** The original unresolved configuration object */
   originalConfig: T
   /** The current (partially resolved) configuration object */
@@ -104,28 +101,40 @@ declare function configorama<T = any>(
   settings: ConfigoramaSettings & { returnMetadata: true }
 ): Promise<ConfigoramaResult<T>>
 
-export default configorama
-
-/** Configorama sync API */
-export function sync<T = any>(
-  configPathOrObject: string | object,
-  settings?: ConfigoramaSettings
-): T
-
-/** Analyze config variables without resolving them */
-export function analyze(
-  configPathOrObject: string | object,
-  settings?: ConfigoramaSettings
-): Promise<any>
-
-/** Format utilities for parsing various config formats */
-export const format: {
-  yaml: any
-  json: any
-  toml: any
-  ini: any
-  hcl: any
+declare namespace configorama {
+  // Re-export types for consumers
+  export { ConfigoramaSettings, ConfigoramaResult, ConfigContext }
+
+  /** Configorama sync API */
+  export function sync<T = any>(
+    configPathOrObject: string | object,
+    settings?: ConfigoramaSettings
+  ): T
+
+  /** Analyze config variables without resolving them */
+  export function analyze(
+    configPathOrObject: string | object,
+    settings?: ConfigoramaSettings
+  ): Promise<any>
+
+  /** Format utilities for parsing various config formats */
+  export const format: {
+    yaml: any
+    json: any
+    toml: any
+    ini: any
+    hcl: any
+  }
+
+  /** The Configorama class for advanced usage */
+  export const Configorama: any
+
+  /** Build variable syntax regex */
+  export function buildVariableSyntax(
+    prefix?: string,
+    suffix?: string,
+    excludePatterns?: string[]
+  ): string
 }
 
-/** The Configorama class for advanced usage */
-export const Configorama: any
+export = configorama

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configorama",
-  "version": "0.9.8",
+  "version": "0.9.12",
   "description": "Variable support for configuration files",
   "main": "src/index.js",
   "types": "index.d.ts",