configorama 0.6.9 → 0.6.10

package/src/resolvers/valueFromCron.js

@@ -245,6 +245,8 @@ Examples:
 module.exports = {
   type: 'cron',
   prefix: 'cron',
+  syntax: '${cron(expression)}',
+  description: 'Resolves cron expressions. Examples: ${cron("every 5 minutes"}, ${cron("weekdays")}, ${cron("at 9:30")}',
   match: cronRefSyntax,
   resolver: getValueFromCron,
   // Export the parser for testing

package/src/resolvers/valueFromEnv.js

@@ -24,6 +24,8 @@ Example: \${env:MY_ENV_VAR}
 
 module.exports = {
   type: 'env',
+  syntax: '${env:ENV_VAR}',
+  description: 'Resolves environment variables. Examples: ${env:MY_ENV_VAR}, ${env:MY_ENV_VAR_TWO, "fallbackValue"}',
   match: envRefSyntax,
   resolver: getValueFromEnv
 }

package/src/resolvers/valueFromEnv.test.js

@@ -0,0 +1,78 @@
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const { resolver } = require('./valueFromEnv')
+
+test('Resolves existing environment variable', async () => {
+  process.env.TEST_ENV_VAR = 'test-value-123'
+  const result = await resolver('env:TEST_ENV_VAR')
+  assert.is(result, 'test-value-123')
+  delete process.env.TEST_ENV_VAR
+})
+
+test('Returns undefined for non-existent environment variable', async () => {
+  const result = await resolver('env:NON_EXISTENT_VAR_XYZ')
+  assert.is(result, undefined)
+})
+
+test('Throws error for empty environment variable name', async () => {
+  try {
+    await resolver('env:')
+    assert.unreachable('Should have thrown an error')
+  } catch (error) {
+    assert.ok(error.message.includes('Invalid variable syntax'))
+    assert.ok(error.message.includes('must have a key path'))
+  }
+})
+
+test('Resolves environment variable with underscore', async () => {
+  process.env.MY_TEST_VAR = 'underscore-value'
+  const result = await resolver('env:MY_TEST_VAR')
+  assert.is(result, 'underscore-value')
+  delete process.env.MY_TEST_VAR
+})
+
+test('Resolves environment variable with numbers', async () => {
+  process.env.VAR123 = 'numeric-value'
+  const result = await resolver('env:VAR123')
+  assert.is(result, 'numeric-value')
+  delete process.env.VAR123
+})
+
+test('Resolves environment variable with mixed case', async () => {
+  process.env.MixedCaseVar = 'mixed-case-value'
+  const result = await resolver('env:MixedCaseVar')
+  assert.is(result, 'mixed-case-value')
+  delete process.env.MixedCaseVar
+})
+
+test('Returns Promise that resolves to value', async () => {
+  process.env.PROMISE_TEST = 'promise-value'
+  const promise = resolver('env:PROMISE_TEST')
+  assert.ok(promise instanceof Promise)
+  const result = await promise
+  assert.is(result, 'promise-value')
+  delete process.env.PROMISE_TEST
+})
+
+test('Handles environment variable with special characters in value', async () => {
+  process.env.SPECIAL_VAR = 'value-with-special-chars-!@#$%'
+  const result = await resolver('env:SPECIAL_VAR')
+  assert.is(result, 'value-with-special-chars-!@#$%')
+  delete process.env.SPECIAL_VAR
+})
+
+test('Handles empty string environment variable value', async () => {
+  process.env.EMPTY_VAR = ''
+  const result = await resolver('env:EMPTY_VAR')
+  assert.is(result, '')
+  delete process.env.EMPTY_VAR
+})
+
+test('Handles numeric environment variable value', async () => {
+  process.env.NUMERIC_VAR = '12345'
+  const result = await resolver('env:NUMERIC_VAR')
+  assert.is(result, '12345')
+  delete process.env.NUMERIC_VAR
+})
+
+test.run()

package/src/resolvers/valueFromEval.js

@@ -32,6 +32,7 @@ async function getValueFromEval(variableString) {
 
 module.exports = {
   type: 'eval',
+  description: '${eval(expression)} - Evaluates mathematical expressions',
   match: evalRefSyntax,
   resolver: getValueFromEval
 }

package/src/resolvers/valueFromGit.js

@@ -41,6 +41,19 @@ async function _exec(cmd, options = { timeout: 1000 }) {
 }
 */
 
+const GIT_KEYS = {
+  repo: 'repo',
+  name: 'name',
+  org: 'org',
+  dir: 'dir',
+  url: 'url',
+  sha: 'sha',
+  commit: 'commit',
+  branch: 'branch',
+  message: 'message',
+  tag: 'tag',
+}
+
 function createResolver(cwd) {
   async function _getValueFromGit(variableString) {
     const variable = variableString.split(`${GIT_PREFIX}:`)[1]
@@ -69,7 +82,7 @@ function createResolver(cwd) {
 
     switch (normalizedVar) {
       // Repo owner/name
-      case 'repo':
+      case GIT_KEYS.repo:
       case 'repository':
       case 'reposlug':
       case 'repo-slug':
@@ -78,13 +91,13 @@ function createResolver(cwd) {
         value = parseda.full_name
         break;
       // Repo name
-      case 'name':
+      case GIT_KEYS.name:
       case 'reponame': // repoName
       case 'repo-name':
         value = await _exec('basename `git rev-parse --show-toplevel`')
         break;
       // Repo org or owner
-      case 'org':
+      case GIT_KEYS.org:
       case 'owner':
       case 'organization':
       case 'repoowner': // repoOwner
@@ -94,7 +107,7 @@ function createResolver(cwd) {
         value = parsed.organization || parsed.owner
         break;
       // Repo name
-      case 'dir':
+      case GIT_KEYS.dir:
       case 'directory':
       case 'dirpath': // dirPath
       case 'dir-path':
@@ -108,7 +121,7 @@ function createResolver(cwd) {
         }
         break;
       // Repo url
-      case 'url':
+      case GIT_KEYS.url:
       case 'repourl': // repoUrl
       case 'repo-url':
         value = await getGitRemote()
@@ -123,7 +136,7 @@ function createResolver(cwd) {
         }
         break
       // Current commit full sha
-      case 'commit':
+      case GIT_KEYS.commit:
       case 'commitsha':
       case 'commit-sha':
       case 'commithash':
@@ -135,7 +148,7 @@ function createResolver(cwd) {
         }
         break
       // Branches
-      case 'branch':
+      case GIT_KEYS.branch:
       case 'branchname':
       case 'branch-name':
       case 'currentbranch': // currentBranch
@@ -147,8 +160,8 @@ function createResolver(cwd) {
         }
         break
       // Commit msg
+      case GIT_KEYS.message:
       case 'msg':
-      case 'message':
       case 'commitmessage': // commitMessage
       case 'commit-message':
       case 'commitmsg': // commitMsg
@@ -160,7 +173,7 @@ function createResolver(cwd) {
         }
         break;
       // Git tags
-      case 'tag':
+      case GIT_KEYS.tag:
       case 'describe':
         try {
           value = await _exec('git describe --always')
@@ -318,6 +331,8 @@ module.exports = function createGitResolver(cwd) {
   return {
     type: 'git',
     prefix: 'git',
+    syntax: '${git:valueType}',
+    description: `Resolves Git variables. Available valueTypes: ${Object.values(GIT_KEYS).join(', ')}`,
     match: gitVariableSyntax,
     resolver: createResolver(cwd)
   }

package/src/resolvers/valueFromNumber.js

@@ -11,6 +11,7 @@ function getValueFromNumber(variableString) {
 
 module.exports = {
   type: 'number',
+  internal: true,
   match: isNumberVariable,
   resolver: getValueFromNumber
 }

package/src/resolvers/valueFromOptions.js

@@ -15,6 +15,8 @@ function getValueFromOptions(variableString, options) {
 module.exports = {
   type: 'options',
   prefix: 'opt',
+  syntax: '${opt:flagName}',
+  description: 'Resolves CLI option flags. Examples: ${opt:stage}, ${opt:other, "fallbackValue"}',
   match: optRefSyntax,
   resolver: getValueFromOptions
 }

package/src/resolvers/valueFromString.js

@@ -8,6 +8,7 @@ function getValueFromString(variableString) {
 
 module.exports = {
   type: 'string',
+  internal: true,
   match: stringRefSyntax,
   resolver: getValueFromString
 }

package/src/sync.js

@@ -5,10 +5,10 @@ const getFullPath = require('./utils/getFullFilePath')
 const enrichMetadata = require('./utils/enrichMetadata')
 
 /**
- * Force syncronous invocation of async API
+ * Force synchronous invocation of async API
  */
-module.exports = function configoramaSync(varSrcs = []) {
-  const customVariableSources = varSrcs.map((varSrc) => {
+module.exports = function configoramaSync(variableSources = []) {
+  const customVariableSources = variableSources.map((varSrc) => {
     if (!varSrc.match || typeof varSrc.match !== 'string') {
       throw new Error('Variable source must be string for .sync usage')
     }
@@ -33,6 +33,7 @@ module.exports = function configoramaSync(varSrcs = []) {
     }
 
     return {
+      type: varSrc.type,
       /* Create regex in sync context */
       match: RegExp(varSrc.match, 'g'),
       resolver: resolverFunction
@@ -53,7 +54,15 @@ module.exports = function configoramaSync(varSrcs = []) {
       const metadata = instance.collectVariableMetadata()
 
       // Enrich metadata with resolution tracking data collected during execution
-      const enrichedMetadata = enrichMetadata(metadata, instance.resolutionTracking, instance.variableSyntax)
+      const enrichedMetadata = enrichMetadata(
+        metadata,
+        instance.resolutionTracking,
+        instance.variableSyntax,
+        instance.fileRefsFound,
+        instance.originalConfig,
+        instance.configFilePath,
+        Object.keys(instance.filters)
+      )
 
       return {
         config: result,

package/src/utils/cleanVariable.js

@@ -1,4 +1,5 @@
 const { findNestedVariables } = require('./find-nested-variables')
+const { functionRegex } = require('./regex')
 
 const DEBUG = false
 /**
@@ -9,7 +10,6 @@ const DEBUG = false
  */
 
 const fileRefSyntax = RegExp(/^file\((~?[a-zA-Z0-9._\-\/,'" ]+?)\)/g)
-const funcRegex = /(\w+)\s*\(((?:[^()]+)*)?\s*\)\s*/
 module.exports = function cleanVariable(
   match, 
   variableSyntax, 
@@ -42,7 +42,7 @@ module.exports = function cleanVariable(
       console.log('index', index)
       console.log('nestedVar', nestedVar)
       console.log('nestedVar[index]', nestedVar[index])
-      varToClean = lastMatch.varString.replace(/__VAR_(\d+)__/g, nestedVar[index].fullMatch)
+      varToClean = lastMatch.varString.replace(/__VAR_(\d+)__/g, nestedVar[index].varMatch)
       return varToClean
     }
   }
@@ -67,7 +67,7 @@ module.exports = function cleanVariable(
   }
 
   // Support for function matches that dont need space alterations
-  if (!clean.match(fileRefSyntax) && funcRegex.exec(clean)) {
+  if (!clean.match(fileRefSyntax) && functionRegex.exec(clean)) {
     return clean
   }