configorama 0.6.14 → 0.6.16

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "configorama",
-  "version": "0.6.14",
+  "version": "0.6.16",
   "description": "Variable support for configuration files",
   "main": "src/index.js",
   "types": "index.d.ts",
+  "exports": {
+    ".": "./src/index.js",
+    "./parse-file": "./src/utils/parsing/parse.js"
+  },
   "files": [
     "cli.js",
     "src",

package/src/main.js

@@ -549,13 +549,12 @@ class Configorama {
 
     // If we have a file path but no config yet, parse it now
     if (this.configFilePath && !this.config) {
-      let configObject = await parseFileContents(
-        this.originalString,
-        this.configFileType,
-        this.configFilePath,
-        this.variableSyntax,
-        this.opts
-      )
+      let configObject = await parseFileContents({
+        contents: this.originalString,
+        filePath: this.configFilePath,
+        varRegex: this.variableSyntax,
+        dynamicArgs: this.opts.dynamicArgs
+      })
       this.configFileContents = ''
       if (VERBOSE || showFoundVariables || this.opts.returnPreResolvedVariableDetails || SETUP_MODE) {
         this.configFileContents = fs.readFileSync(this.configFilePath, 'utf8')

package/src/utils/parsing/parse.js

@@ -1,3 +1,6 @@
+// Parses config file contents based on file extension
+const fs = require('fs')
+const path = require('path')
 const YAML = require('../../parsers/yaml')
 const TOML = require('../../parsers/toml')
 const INI = require('../../parsers/ini')
@@ -6,26 +9,34 @@ const { executeTypeScriptFileSync } = require('../../parsers/typescript')
 const { executeESMFileSync } = require('../../parsers/esm')
 const cloudFormationSchema = require('./cloudformationSchema')
 
+const DEFAULT_VAR_SYNTAX = '\\${((?!AWS|stageVariables)[ ~:a-zA-Z0-9=+!@#%*<>?._\'",|\\-\\/\\(\\)\\\\]+?)}'
+
+/**
+ * @typedef {Object} ParseOptions
+ * @property {string} contents - Raw file contents to parse
+ * @property {string} filePath - Full file path (used for extension detection and error messages)
+ * @property {RegExp} [varRegex] - Variable syntax regex (defaults to configorama syntax)
+ * @property {Object|Function} [dynamicArgs] - Arguments passed to JS/TS function exports
+ */
+
 /**
  * Parse file contents based on file extension
- * @param {string} fileContents - Raw file contents to parse
- * @param {string} fileType - File extension (.yml, .yaml, .json, etc)
- * @param {string} filePath - Full file path (used for error messages)
- * @param {RegExp} varRegex - Variable syntax regex
- * @param {Object} opts - Additional options
+ * @param {ParseOptions} options
  * @returns {Object} Parsed configuration object
  */
-function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}) {
+function parseFileContents({ contents, filePath, varRegex, dynamicArgs }) {
+  const fileType = path.extname(filePath)
+  const regex = varRegex || new RegExp(DEFAULT_VAR_SYNTAX, 'g')
   let configObject
 
   if (fileType.match(/\.(yml|yaml)/i)) {
     try {
-      const ymlText = YAML.preProcess(fileContents, varRegex)
+      const ymlText = YAML.preProcess(contents, regex)
       configObject = YAML.parse(ymlText)
     } catch (err) {
       // Attempt to fix cloudformation refs
       if (err.message.match(/YAMLException/)) {
-        const ymlText = YAML.preProcess(fileContents, varRegex)
+        const ymlText = YAML.preProcess(contents, regex)
         const result = YAML.load(ymlText, {
           filename: filePath,
           schema: cloudFormationSchema.schema,
@@ -37,11 +48,11 @@ function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}
       }
     }
   } else if (fileType.match(/\.(toml|tml)/i)) {
-    configObject = TOML.parse(fileContents)
+    configObject = TOML.parse(contents)
   } else if (fileType.match(/\.(ini)/i)) {
-    configObject = INI.parse(fileContents)
+    configObject = INI.parse(contents)
   } else if (fileType.match(/\.(json|json5)/i)) {
-    configObject = JSON5.parse(fileContents)
+    configObject = JSON5.parse(contents)
   // TODO detect js syntax and use appropriate parser
   } else if (fileType.match(/\.(js|cjs)/i)) {
     let jsFile
@@ -50,7 +61,7 @@ function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}
       if (typeof jsFile !== 'function') {
         configObject = jsFile
       } else {
-        let jsArgs = opts.dynamicArgs || {}
+        let jsArgs = dynamicArgs || {}
         if (jsArgs && typeof jsArgs === 'function') {
           jsArgs = jsArgs()
         }
@@ -62,27 +73,27 @@ function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}
     }
   } else if (fileType.match(/\.(ts|tsx|mts|cts)/i)) {
     try {
-      let jsArgs = opts.dynamicArgs || {}
+      let jsArgs = dynamicArgs || {}
       if (jsArgs && typeof jsArgs === 'function') {
         jsArgs = jsArgs()
       }
-      configObject = executeTypeScriptFileSync(filePath, opts)
+      configObject = executeTypeScriptFileSync(filePath, { dynamicArgs })
       if (configObject.config) {
         configObject = (typeof configObject.config === 'function') ? configObject.config(jsArgs) : configObject.config
       } else if (configObject.default) {
         configObject = (typeof configObject.default === 'function') ? configObject.default(jsArgs) : configObject.default
       }
-      // console.log('parseFileContents configObject', configObject, opts)
+      // console.log('parseFileContents configObject', configObject)
     } catch (err) {
       throw new Error(`Failed to execute TypeScript file ${filePath}: ${err.message}`)
     }
   } else if (fileType.match(/\.(mjs|esm)/i)) {
     try {
-      let jsArgs = opts.dynamicArgs || {}
+      let jsArgs = dynamicArgs || {}
       if (jsArgs && typeof jsArgs === 'function') {
         jsArgs = jsArgs()
       }
-      configObject = executeESMFileSync(filePath, opts)
+      configObject = executeESMFileSync(filePath, { dynamicArgs })
       if (configObject.config) {
         configObject = (typeof configObject.config === 'function') ? configObject.config(jsArgs) : configObject.config
       } else if (configObject.default) {
@@ -90,7 +101,7 @@ function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}
       } else if (typeof configObject === 'function') {
         configObject = configObject(jsArgs)
       }
-      // console.log('parseFileContents ESM configObject', configObject, opts)
+      // console.log('parseFileContents ESM configObject', configObject)
     } catch (err) {
       throw new Error(`Failed to execute ESM file ${filePath}: ${err.message}`)
     }
@@ -99,6 +110,29 @@ function parseFileContents(fileContents, fileType, filePath, varRegex, opts = {}
   return configObject
 }
 
+/**
+ * @typedef {Object} ParseFileOptions
+ * @property {RegExp} [varRegex] - Variable syntax regex (defaults to configorama syntax)
+ * @property {Object|Function} [dynamicArgs] - Arguments passed to JS/TS function exports
+ */
+
+/**
+ * Read and parse a config file
+ * @param {string} filePath - Path to the config file
+ * @param {ParseFileOptions} [opts]
+ * @returns {Object} Parsed configuration object
+ */
+function parseFile(filePath, opts = {}) {
+  const contents = fs.readFileSync(filePath, 'utf8')
+  return parseFileContents({
+    contents,
+    filePath,
+    varRegex: opts.varRegex,
+    dynamicArgs: opts.dynamicArgs
+  })
+}
+
 module.exports = {
-  parseFileContents
-} 
+  parseFileContents,
+  parseFile
+}