feat(okidoc-site): improve site config yaml validation

wix-incubator · Dec 5, 2019 · 9caeee1 · 9caeee1
1 parent 5274649
commit 9caeee1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/packages/okidoc-site/site/config/configSchema.js b/packages/okidoc-site/site/config/configSchema.js
@@ -18,7 +18,7 @@ const configSchema = {
     algoliaApiKey: Joi.string(),
     algoliaIndexName: Joi.string(),
     githubLink: Joi.string(),
-  }),
+  }).default({}),
   mdComponents: Joi.object({
     path: Joi.string().required(),
     externalStyles: Joi.array().items(Joi.string()),

diff --git a/packages/okidoc-site/site/getSiteConfig.js b/packages/okidoc-site/site/getSiteConfig.js
@@ -34,19 +34,20 @@ function getEnvVariables(env) {
 }
 
 function getConfig(configPath) {
+  let configRaw;
   try {
-    const config = yaml.load(configPath);
-
-    Joi.assert(
-      config,
-      configSchema,
-      `Invalid site config yaml file (${configPath}).`,
-    );
-
-    return config;
+    configRaw = yaml.load(configPath);
   } catch (e) {
-    throw new Error(`Invalid site config yaml file (${configPath})`);
+    throw new Error(
+      `Could not parse site config yaml file (${configPath}): ${e.message}`,
+    );
   }
+
+  return Joi.attempt(
+    configRaw,
+    configSchema,
+    `Invalid site config yaml file (${configPath})`,
+  );
 }
 
 const { SITE_YAML_PATH, SITE_CWD } = getEnvVariables(process.env);