@znemz/cfn-include 2.1.10 → 2.1.11

package/README.md

@@ -1201,6 +1201,28 @@ If an AWS pseudo-parameter is not set via environment variables, it falls back t
 **Error handling:**
 If a reference cannot be resolved, `Fn::RefNow` will throw an error. Ensure all referenced parameters and variables are available via inject, scope, or environment variables.
 
+**CLI Options for Fn::RefNow:**
+
+The `cfn-include` command provides CLI options to control how unresolved references are handled:
+
+- `--ref-now-ignore-missing`: Do not fail if a `Fn::RefNow` reference cannot be resolved. Instead, the reference will be returned in AWS CloudFormation's standard `Ref` syntax (e.g., `{ Ref: 'UnresolvedRef' }`), allowing CloudFormation to resolve it at stack creation time.
+- `--ref-now-ignores <names>`: Comma-separated list of reference names to ignore if not found. These references will be returned in `Ref` syntax instead of throwing an error.
+
+**Example usage:**
+
+```bash
+# Ignore all unresolved references
+cfn-include template.yaml --ref-now-ignore-missing
+
+# Ignore specific reference names
+cfn-include template.yaml --ref-now-ignores "OptionalRef1,OptionalRef2"
+
+# Combine both options
+cfn-include template.yaml --ref-now-ignore-missing --ref-now-ignores "SpecificRef"
+```
+
+This is useful for templates that reference CloudFormation parameters or other resources that may not be available at template processing time but will be available at stack creation time.
+
 ## Fn::ApplyTags
 
 See [ApplyTags test file](t/tests/applyTags.yml).

package/bin/cli.js

@@ -88,6 +88,14 @@ const { env } = process;
        
       desc: `console log out include options in recurse step`,
     },
+    'ref-now-ignore-missing': {
+      boolean: true,
+      desc: 'do not fail if Fn::RefNow reference cannot be resolved',
+    },
+    'ref-now-ignores': {
+      string: true,
+      desc: 'comma-separated list of reference names to ignore if not found',
+    },
     version: {
       boolean: true,
       desc: 'print version and exit',
@@ -102,6 +110,9 @@ const { env } = process;
 // make enable an array
 opts.enable = opts.enable.split(',');
 
+// Parse ref-now-ignores into an array
+const refNowIgnores = opts['ref-now-ignores'] ? opts['ref-now-ignores'].split(',').map(s => s.trim()) : [];
+
 let promise;
 if (opts.path) {
   let location;
@@ -115,6 +126,8 @@ if (opts.path) {
     doEval: opts.enable.includes('eval'),
     inject: opts.inject,
     doLog: opts.doLog,
+    refNowIgnoreMissing: opts['ref-now-ignore-missing'],
+    refNowIgnores: refNowIgnores,
   });
 } else {
   promise = new Promise((resolve, reject) => {
@@ -142,6 +155,8 @@ if (opts.path) {
       doEval: opts.enable.includes('eval'),
       inject: opts.inject,
       doLog: opts.doLog,
+      refNowIgnoreMissing: opts['ref-now-ignore-missing'],
+      refNowIgnores: refNowIgnores,
     }).catch((err) => console.error(err));
   });
 }

package/index.js

@@ -484,6 +484,11 @@ async function recurse({ base, scope, cft, ...opts }) {
       return recurse({ base, scope, cft: cft['Fn::RefNow'], ...opts }).then((logicalName) => {
         let refName = logicalName;
 
+        // Check if this ref name is in the ignores list
+        if (opts.refNowIgnores && opts.refNowIgnores.includes(refName)) {
+          return { Ref: refName };
+        }
+
         // Merge AWS pseudo-parameters with inject and scope variables
         const allRefs = {
           ...getAwsPseudoParameters(),
@@ -497,7 +502,12 @@ async function recurse({ base, scope, cft, ...opts }) {
           return allRefs[refName];
         }
 
-        // If not found, throw an error
+        // If not found and refNowIgnoreMissing is true, return Ref syntax; otherwise throw error
+        if (opts.refNowIgnoreMissing) {
+          return { Ref: refName };
+        }
+
+        // Default behavior: throw an error (backward compatible)
         throw new Error(`Unable to resolve Ref for logical name: ${refName}`);
       });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@znemz/cfn-include",
-  "version": "2.1.10",
+  "version": "2.1.11",
   "description": "Preprocessor for CloudFormation templates with support for loops and flexible include statements",
   "keywords": [
     "aws",