Improve error message when reading invalid YAML file.

2026-08-28 13:34:24 +00:00 · 2019-09-11 21:42:44 +02:00
parent 17f1a865b4
commit d53e1330f5
2 changed files with 44 additions and 1 deletions
@@ -2,7 +2,23 @@ const yaml = require('js-yaml');
 const fs = require('fs');

 function read(file) {
-    return yaml.safeLoad(fs.readFileSync(file, 'utf8'));
+    try {
+        return yaml.safeLoad(fs.readFileSync(file, 'utf8'));
+    } catch (error) {
+        if (error.name === 'YAMLException') {
+            error.message =
+                `\n\n\n` +
+                `\t====================================================================\n` +
+                `\tYour YAML file '${file}' is invalid\n` +
+                `\tUse e.g. https://jsonformatter.org/yaml-validator to find and fix the issue.\n` +
+                `\t====================================================================\n` +
+                `\n\n` +
+                error.message;
+        }
+
+
+        throw error;
+    }
 }

 function readIfExists(file) {