eleventy-plugin-podcaster 2.1.0 → 2.2.0

package/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx ava:*)"
+    ]
+  }
+}

package/eleventy.config.js

@@ -5,7 +5,7 @@ import podcastData from './src/podcastData.js'
 import episodeData from './src/episodeData.js'
 import calculateEpisodeSizeAndDuration from './src/calculateEpisodeSizeAndDuration.js'
 import calculateEpisodeFilename from './src/calculateEpisodeFilename.js'
-
+import validation from './src/validation.js'
 import readableFilters from './src/readableFilters.js'
 import chapters from './src/chapters.js'
 import excerpts from './src/excerpts.js'
@@ -23,6 +23,7 @@ export default function (eleventyConfig, options = {}) {
   eleventyConfig.addPlugin(episodeData, options)
   eleventyConfig.addPlugin(calculateEpisodeSizeAndDuration, options)
   eleventyConfig.addPlugin(calculateEpisodeFilename, options)
+  eleventyConfig.addPlugin(validation, options)
 
   // Filters
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-podcaster",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "An Eleventy plugin that allows you to create a podcast and its accompanying website",
   "main": "eleventy.config.js",
   "exports": {

package/src/podcastData.js

@@ -1,4 +1,4 @@
-export default function (eleventyConfig) {
+export default function (eleventyConfig, options = {}) {
   eleventyConfig.addGlobalData('eleventyComputed.podcast.feedPath', () => {
     return data => data.podcast.feedPath || '/feed/podcast.xml'
   })
@@ -10,10 +10,8 @@ export default function (eleventyConfig) {
   eleventyConfig.addGlobalData('eleventyComputed.podcast.episodeUrlBase', () => {
     return data => {
       if (data.podcast.episodeUrlBase) return data.podcast.episodeUrlBase
-      let siteUrl
-      try {
-        siteUrl = data.podcast.siteUrl || data.site.url
-      } catch (e) {
+      const siteUrl = data.podcast.siteUrl || data.site?.url
+      if (!siteUrl && !options.validation) {
         console.error('[eleventy-plugin-podcaster] No site URL found. Please set `siteUrl` in your podcast data.')
       }
       return URL.parse('episodes/', siteUrl)

package/src/podcastFeed.js

@@ -5,7 +5,7 @@ import isEpisodePost from './isEpisodePost.js'
 
 export default function (eleventyConfig, options = {}) {
   if (!('addTemplate' in eleventyConfig)) {
-    console.error('[eleventy-plugin-podcasting] Eleventy plugin compatibility: Virtual Templates are required for this plugin — please use Eleventy v3.0 or newer.')
+    console.error('[podcaster] Eleventy plugin compatibility: Virtual Templates are required for this plugin — please use Eleventy v3.0 or newer.')
   }
 
   const podcastFeedPath = path.join(import.meta.dirname, './podcastFeed.njk')

package/src/podcastFeed.njk

@@ -29,8 +29,10 @@ eleventyAllowMissingExtension: true
     {%- else %}
     <itunes:category text="{{ podcast.category }}" />
     {%- endif %}
-    {% if podcast.explicit !== undefined %}
-    <itunes:explicit>{{ podcast.explicit }}</itunes:explicit>
+    {% if podcast.explicit == true %}
+    <itunes:explicit>true</itunes:explicit>
+    {% else %}
+    <itunes:explicit>false</itunes:explicit>
     {% endif -%}
     <itunes:author>{{ podcast.author }}</itunes:author>
     {%- if podcast.type %}

package/src/validation.js

@@ -0,0 +1,62 @@
+import isEpisodePost from './isEpisodePost.js'
+
+function warn (message) {
+  console.warn(`[podcaster] ${message}`)
+}
+
+function warnOrThrow (message) {
+  if (process.env.ELEVENTY_RUN_MODE === 'build') {
+    throw new Error(`[podcaster] ${message}`)
+  } else {
+    console.warn(`[podcaster] ${message}`)
+  }
+}
+
+export default function (eleventyConfig, options = {}) {
+  eleventyConfig.addGlobalData('eleventyDataSchema', () => {
+    return (data) => {
+      if (!options.validation) return
+
+      // podcast data
+
+      if (!(data.podcast.siteUrl || data.site?.url)) {
+        warnOrThrow('Site URL is required')
+      }
+      if (!data.podcast.title) {
+        warnOrThrow('Podcast title is required')
+      }
+      if (!data.podcast.description) {
+        warnOrThrow('Podcast description is required')
+      }
+      if (!data.podcast.language) {
+        warnOrThrow('Podcast language is required')
+      }
+      if (!data.podcast.category) {
+        warnOrThrow('Podcast category is required')
+      }
+      if (!data.podcast.author) {
+        warnOrThrow('Podcast author is required')
+      }
+
+      // episode data
+
+      if (isEpisodePost(data, options)) {
+        if (!data.title) {
+          warnOrThrow(`Episode title is required (${data.page.inputPath})`)
+        }
+        if (!data.episode.filename) {
+          warnOrThrow(`Episode filename is required (${data.page.inputPath})`)
+        }
+        if (!data.episode.size) {
+          warnOrThrow(`Episode size is required (${data.page.inputPath})`)
+        }
+        if (!data.episode.episodeNumber) {
+          warn(`Episode number is recommended (${data.page.inputPath})`)
+        }
+        if (!data.episode.duration) {
+          warn(`Episode duration is recommended (${data.page.inputPath})`)
+        }
+      }
+    }
+  })
+}