node-red-contrib-config-files 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.2.1] - 2026-01-31
+### Changed
+- If directory `configDir` doesn't exist or is not accessible: Instead of throwing a node error, a node warning is created. This warning may appear in the “Debug Messages” sidebar.
+
 ## [0.2.0] - 2026-01-30
 ### Added
 - If directory `configDir` doesn't exist or is not accessible, a node error is throw. This error can be received with a `catch` node, for example.

package/HELP.md

@@ -1,21 +1,22 @@
 Read and merge configuration files (JSON). 
-   
+
 ### Inputs
- 
+
 Directory and filename extension used to search for configuration 
 files can be configured using the node properties and/or with the 
 input message.
-   
+
 : configDir (string)     : Directory with config files. Absolute or relative path, default: `/config`. Input message `msg.configDir` overwrites the node property.
 : configFileExt (string) : Filename extension for config files, default: `.json`. Input message `msg.configFileExt` overwrites the node property.
-   
+
 ### Outputs
-   
+
 : payload (object) : Merged content from config files.
+: configFiles []   : Paths to config files found, empty array if no files were found.
 
 ### Details
 The node pproperty `defaultConfig` can be used to define configuration 
-values that are missing in the configuration files.
+values that are used when they are missing in the configuration files.
 
 The `configDir` is searched non-recursively for configuration files using 
 the filename extension `configFilePattern`.

package/README.md

@@ -1,9 +1,12 @@
 # node-red-contrib-config-files 
-[Node-Red](https://nodered.org/) node for reading and merging configuration files with JSON content. The output returns the resulting configuration object.
+[Node-Red](https://nodered.org/) node for reading and merging configuration files with JSON content. The output returns 
+the resulting configuration object.
 
-Directory and filename extension used to search for configuration files can be configured using the node properties and/or with the input message.
+Directory and filename extension used to search for configuration files can be configured using the node properties and/or 
+with the input message.
 
-The files are sorted by their file names and merged in this order. The `defaultConfig` property can be used to define configuration values that are missing in the files.
+The files are sorted by their file names and merged in this order. The `defaultConfig` can be used to define configuration 
+values that are used when they are missing in the configuration files.
 
 If no configuration files are found, the `defaultConfig` is returned.
 
@@ -11,10 +14,11 @@ The node status displays one of the following two messages:
 - Found {count} config files in '{configDir}' with extension '{configFileExt}'
 - No config files found in '{configDir}' with extension '{configFileExt}' -> using default config
 
-If directory `configDir` doesn't exist or is not accessible, a node error is throw. This error can be received with a `catch` node, for example.
-
-If no file was found with `configFileExt`, a node warning is created. This warning may appear in the “Debug Messages” sidebar.
+If directory `configDir` doesn't exist or is not accessible or if no file was found with `configFileExt`, a node warning 
+is created. This warning may appear in the “Debug Messages” sidebar.
 
 ## Internals
-- This custom node is created from a subflow.
+- This custom node was created from a subflow.
 - It uses `lodash.merge()` to merge the `defaultConfig` with the contents of the files found.
+- Some debug information is written by the node using `node.debug()`. To view these messages, set the logging level 
+in `settings.js` to at least `debug`.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-config-files",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "Read and merge configuration files (JSON).",
     "main": "install.js",
     "scripts": {

package/subflow.json

@@ -2,7 +2,7 @@
     "id": "ec796389903c1d0f",
     "type": "subflow",
     "name": "config-files",
-    "info": "Read and merge configuration files (JSON).\n\n### Inputs\n \nDirectory and filename extension used to search for configuration \nfiles can be configured using the node properties and/or with the \ninput message.\n   \n: configDir (string)     : Directory with config files. Absolute or relative path, default: `/config`. Input message `msg.configDir` overwrites the node property.\n: configFileExt (string) : Filename extension for config files, default: `.json`. Input message `msg.configFileExt` overwrites the node property.\n   \n### Outputs\n   \n: payload (object) : Merged content from config files.\n\n### Details\nThe node pproperty `defaultConfig` can be used to define configuration \nvalues that are missing in the configuration files.\n\nThe `configDir` is searched non-recursively for configuration files using \nthe filename extension `configFilePattern`.\nThe files are sorted by their file names and merged in this order. \n\nThe content of the `defaultConfig` property and the configuration files \nmust by valid JSON.\n\n### References\n\n- [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code",
+    "info": "Read and merge configuration files (JSON). \n\n### Inputs\n\nDirectory and filename extension used to search for configuration \nfiles can be configured using the node properties and/or with the \ninput message.\n\n: configDir (string)     : Directory with config files. Absolute or relative path, default: `/config`. Input message `msg.configDir` overwrites the node property.\n: configFileExt (string) : Filename extension for config files, default: `.json`. Input message `msg.configFileExt` overwrites the node property.\n\n### Outputs\n\n: payload (object) : Merged content from config files.\n: configFiles []   : Paths to config files found, empty array if no files were found.\n\n### Details\nThe node pproperty `defaultConfig` can be used to define configuration \nvalues that are used when they are missing in the configuration files.\n\nThe `configDir` is searched non-recursively for configuration files using \nthe filename extension `configFilePattern`.\nThe files are sorted by their file names and merged in this order. \n\nThe content of the `defaultConfig` property and the configuration files \nmust by valid JSON.\n\n### References\n\n- [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code",
     "category": "",
     "in": [
         {
@@ -17,16 +17,19 @@
     ],
     "out": [
         {
-            "x": 660,
-            "y": 300,
+            "x": 740,
+            "y": 400,
             "wires": [
                 {
                     "id": "86c429715975c781",
                     "port": 0
+                },
+                {
+                    "id": "efa7ea24e8224b84",
+                    "port": 0
                 }
             ]
-        }
-    ],
+        }    ],
     "env": [
         {
             "name": "configDir",
@@ -48,7 +51,7 @@
         "module": "node-red-contrib-config-files",
         "type": "config-files",
         "desc": "Read and merge configuration files (JSON).",
-        "version": "0.2.0",
+        "version": "0.2.1",
         "author": "Peter Schären <peter.schaeren@gmail.com>",
         "keywords": "node-red,config-files,config,json",
         "license": "MIT"
@@ -56,8 +59,8 @@
     "color": "#b0c2ba",
     "icon": "node-red/parser-json.svg",
     "status": {
-        "x": 660,
-        "y": 140,
+        "x": 740,
+        "y": 160,
         "wires": [
             {
                 "id": "73c98834cb90c714",
@@ -79,7 +82,7 @@
             "encoding": "utf8",
             "allProps": false,
             "x": 200,
-            "y": 300,
+            "y": 280,
             "wires": [
                 [
                     "f3c260d6c082e422"
@@ -98,8 +101,8 @@
             "stream": false,
             "addname": "",
             "property": "payload",
-            "x": 390,
-            "y": 260,
+            "x": 510,
+            "y": 240,
             "wires": [
                 [
                     "7f1816d008fa2b70",
@@ -116,7 +119,7 @@
             "action": "obj",
             "pretty": false,
             "x": 230,
-            "y": 340,
+            "y": 320,
             "wires": [
                 [
                     "86c429715975c781",
@@ -137,8 +140,8 @@
             "msgKeyType": "elem",
             "seqKey": "payload",
             "seqKeyType": "msg",
-            "x": 190,
-            "y": 260,
+            "x": 370,
+            "y": 240,
             "wires": [
                 [
                     "bebafe14f9cc467b"
@@ -170,23 +173,20 @@
             "type": "function",
             "z": "ec796389903c1d0f",
             "name": "node status",
-            "func": "const count = Array.isArray(msg.payload) ? msg.payload.length : 0;\nlet errorMsg = null;\n\nlet statusText = '';\nif (count > 0) {\n    statusText = `Found ${count} config files in '${msg.configDir}' with extension '${msg.configFileExt}'`;\n}\nelse {\n    statusText = `No config files found in '${msg.configDir}' with extension '${msg.configFileExt}' -> using default config`;\n    errorMsg = { payload: statusText };\n}\nconst statusMsg = { payload: { fill: \"blue\", shape: \"ring\", text: statusText } };\n\nmsg.configFiles = msg.payload;\n\nreturn [msg, statusMsg, errorMsg];\n",
-            "outputs": 3,
+            "func": "const count = Array.isArray(msg.payload) ? msg.payload.length : 0;\n\nlet statusText = '';\nif (count > 0) {\n    statusText = `Found ${count} config files in '${msg.configDir}' with extension '${msg.configFileExt}'`;\n}\nelse {\n    statusText = `No config files found in '${msg.configDir}' with extension '${msg.configFileExt}' -> using default config`;\n}\nconst statusMsg = { payload: { fill: \"blue\", shape: \"ring\", text: statusText } };\n\nmsg.configFiles = msg.payload;\n\nreturn [msg, statusMsg];\n",
+            "outputs": 2,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
             "x": 210,
-            "y": 180,
+            "y": 160,
             "wires": [
                 [
-                    "e2a872db2d9086e6"
+                    "6a7545e5271cd1fa"
                 ],
-                [],
-                [
-                    "cdec17dcc5a199ab"
-                ]
+                []
             ]
         },
         {
@@ -194,8 +194,8 @@
             "type": "function",
             "z": "ec796389903c1d0f",
             "name": "find files",
-            "func": "const dir = msg.configDir;\nconst ext = msg.configFileExt\n\nlet error = null;\n\n// ---------------------------------------------------------------------------------------\n\nasync function findFiles(dir, ext) {\n    try {\n        await fs.promises.access(dir);  // throws if not accessible (e.g., doesn't exist)\n        let filenames = await fs.promises.readdir(dir);\n        filenames = filenames.filter(f => path.extname(f) === ext);\n\n        const filepaths = filenames.map(f => path.join(dir, f));\n        return filepaths;\n\n    } catch (err) {\n        error = `Directory not accessible: ${err.message}`;\n        console.error('Directory not accessible:', err.message);\n        return [];\n    }\n}\n\n// ---------------------------------------------------------------------------------------\n\nnode.log(`Searching files in directory '${dir}' with filename extension '${ext}' ...`);\n\nconst filepaths = await findFiles(dir, ext);\n\nnode.log(`Files found:`);\n\nfor (let fp of filepaths) {\n    node.log(`    ${fp}`);\n}\n\nmsg.payload = filepaths;\nconst errorMsg = error ? { payload: error } : null;\nreturn [msg, errorMsg];\n",
-            "outputs": 2,
+            "func": "const dir = msg.configDir;\nconst ext = msg.configFileExt\n\n// ---------------------------------------------------------------------------------------\n\nasync function findFiles(dir, ext) {\n    try {\n        // Check if directory exists and is accessible\n        await fs.promises.access(dir);\n\n        // Find files\n        let filenames = await fs.promises.readdir(dir);\n        filenames = filenames.filter(f => path.extname(f) === ext);\n\n        // Prepend configDir to filenames\n        const filepaths = filenames.map(f => path.join(dir, f));\n        return filepaths ?? [];\n\n    } catch (err) {\n        node.warn(`Directory not found or not accessible: ${dir}`);\n        return [];\n    }\n}\n\n// ---------------------------------------------------------------------------------------\n\nnode.debug(`Searching files in directory '${dir}' filename extension '${ext}' ...`);\n\nconst filepaths = await findFiles(dir, ext);\n\n// log\nif (filepaths.length > 0) {\n    node.debug(`${filepaths.length} files found:`);\n    for (let fp of filepaths) {\n        node.debug(`    ${fp}`);\n    }\n}\nelse  {\n    node.warn(`No config files found in '${dir}' with extension '${ext}' -> using default config`);\n}\n\nmsg.payload = filepaths;\nreturn msg;\n",
+            "outputs": 1,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
@@ -215,34 +215,15 @@
             "wires": [
                 [
                     "73c98834cb90c714"
-                ],
-                [
-                    "aa017e7a5d0c867e"
                 ]
             ]
         },
-        {
-            "id": "cdec17dcc5a199ab",
-            "type": "function",
-            "z": "ec796389903c1d0f",
-            "name": "throw warning",
-            "func": "node.warn(msg?.payload);\n",
-            "outputs": 0,
-            "timeout": 0,
-            "noerr": 0,
-            "initialize": "",
-            "finalize": "",
-            "libs": [],
-            "x": 420,
-            "y": 160,
-            "wires": []
-        },
         {
             "id": "86c429715975c781",
             "type": "function",
             "z": "ec796389903c1d0f",
             "name": "merge configs",
-            "func": "// const _t = global.get('libTracer');\n// _t.init(node, msg, flow.get('enableTracer')); \n\nlet config = flow.get('mergedConfig');\n\nconfig = lodash.merge(config, msg.payload);\n// _t.trace(node, msg, 'config', lodash.cloneDeep(config));\n\n\n// Last config file read?\nif (msg.parts.index == msg.parts.count - 1) {\n    msg.topic = 'config';\n    msg.payload = config;\n    delete msg.parts;\n    delete msg.filename;\n\n    node.log(`Merged ALL configs:\\n ${JSON.stringify(msg.payload, null, 2)}`);\n    return msg;\n}\n",
+            "func": "// const _t = global.get('libTracer');\n// _t.init(node, msg, flow.get('enableTracer')); \n\nlet config = flow.get('mergedConfig');\n\nconfig = lodash.merge(config, msg.payload);\n// _t.trace(node, msg, 'config', lodash.cloneDeep(config));\n\n\n// Last config file read?\nif (msg.parts.index == msg.parts.count - 1) {\n    msg.topic = 'config';\n    msg.payload = config;\n    delete msg.parts;\n    delete msg.filename;\n\n    node.debug(`Merged ALL configs:\\n ${JSON.stringify(msg.payload, null, 2)}`);\n    return msg;\n}\n",
             "outputs": 1,
             "timeout": 0,
             "noerr": 0,
@@ -255,51 +236,80 @@
                 }
             ],
             "x": 220,
-            "y": 420,
+            "y": 400,
             "wires": [
                 []
             ]
         },
         {
-            "id": "aa017e7a5d0c867e",
+            "id": "7f1816d008fa2b70",
             "type": "function",
             "z": "ec796389903c1d0f",
-            "name": "throw error",
-            "func": "node.error(msg?.payload, msg);\n",
+            "name": "log",
+            "func": "node.debug(`Reading file '${msg.payload}' ...`)\nreturn msg;",
             "outputs": 0,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
-            "x": 410,
-            "y": 120,
+            "x": 650,
+            "y": 240,
             "wires": []
         },
         {
-            "id": "7f1816d008fa2b70",
+            "id": "8639805af947d0c3",
             "type": "function",
             "z": "ec796389903c1d0f",
             "name": "log",
-            "func": "node.log(`Reading file '${msg.payload}' ...`)\nreturn msg;",
-            "outputs": 1,
+            "func": "node.debug(`Config read from '${msg.filename}':\\n${JSON.stringify(msg.payload, null, 2)}`)\nreturn msg;",
+            "outputs": 0,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
-            "x": 570,
-            "y": 260,
+            "x": 650,
+            "y": 320,
+            "wires": []
+        },
+        {
+            "id": "6a7545e5271cd1fa",
+            "type": "switch",
+            "z": "ec796389903c1d0f",
+            "name": "files found",
+            "property": "payload.length",
+            "propertyType": "msg",
+            "rules": [
+                {
+                    "t": "gt",
+                    "v": "0",
+                    "vt": "str"
+                },
+                {
+                    "t": "else"
+                }
+            ],
+            "checkall": "true",
+            "repair": false,
+            "outputs": 2,
+            "x": 210,
+            "y": 240,
             "wires": [
-                []
+                [
+                    "e2a872db2d9086e6"
+                ],
+                [
+                    "efa7ea24e8224b84"
+                ]
             ]
         },
         {
-            "id": "8639805af947d0c3",
+            "id": "efa7ea24e8224b84",
             "type": "function",
             "z": "ec796389903c1d0f",
-            "name": "log",
-            "func": "node.log(`Config read from '${msg.filename}':\\n${JSON.stringify(msg.payload, null, 2)}`)\nreturn msg;",
+            "name": "defaultConfig",
+            "func": "const defaultConfig = env.get('defaultConfig') ?? {};\n\nmsg.payload = defaultConfig;\nreturn msg;\n",
             "outputs": 1,
             "timeout": 0,
             "noerr": 0,
@@ -307,10 +317,10 @@
             "finalize": "",
             "libs": [],
             "x": 570,
-            "y": 340,
+            "y": 380,
             "wires": [
                 []
             ]
         }
-    ]
+   ]
 }