Merge pull request #43 from actions/warn-unsupported-exts

Warn about unsupported file extensions after erring
actions · Nov 23, 2022 · c5a3e11 · c5a3e11
2 parents d84b272 + a069fed
commit c5a3e11
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 9 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -15772,6 +15772,8 @@ const core = __nccwpck_require__(2186)
 const { ConfigParser } = __nccwpck_require__(8395)
 const removeTrailingSlash = __nccwpck_require__(9255)
 
+const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
+
 // Return the settings to be passed to a {ConfigParser} for a given static site generator,
 // optional configuration file path, and a Pages siteUrl value to inject
 function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
@@ -15846,11 +15848,22 @@ function setPagesConfig({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
     const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl })
     new ConfigParser(settings).injectAll()
   } catch (error) {
+    const isSupportedFileExtension = SUPPORTED_FILE_EXTENSIONS.some(ext => generatorConfigFile.endsWith(ext))
+
     // Logging
-    core.warning(
-      `We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
-      error
-    )
+    if (!isSupportedFileExtension) {
+      core.warning(
+        `Unsupported configuration file extension. Currently supported extensions: ${SUPPORTED_FILE_EXTENSIONS.map(
+          ext => JSON.stringify(ext)
+        ).join(', ')}`,
+        error
+      )
+    } else {
+      core.warning(
+        `We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
+        error
+      )
+    }
   }
 }
 

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/set-pages-config.js b/src/set-pages-config.js
@@ -2,6 +2,8 @@ const core = require('@actions/core')
 const { ConfigParser } = require('./config-parser')
 const removeTrailingSlash = require('./remove-trailing-slash')
 
+const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
+
 // Return the settings to be passed to a {ConfigParser} for a given static site generator,
 // optional configuration file path, and a Pages siteUrl value to inject
 function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
@@ -76,11 +78,22 @@ function setPagesConfig({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
     const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl })
     new ConfigParser(settings).injectAll()
   } catch (error) {
+    const isSupportedFileExtension = SUPPORTED_FILE_EXTENSIONS.some(ext => generatorConfigFile.endsWith(ext))
+
     // Logging
-    core.warning(
-      `We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
-      error
-    )
+    if (!isSupportedFileExtension) {
+      core.warning(
+        `Unsupported configuration file extension. Currently supported extensions: ${SUPPORTED_FILE_EXTENSIONS.map(
+          ext => JSON.stringify(ext)
+        ).join(', ')}`,
+        error
+      )
+    } else {
+      core.warning(
+        `We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
+        error
+      )
+    }
   }
 }