eleventy-plugin-podcaster 2.0.0-alpha.4 → 2.0.0-alpha.6

package/README.md

@@ -1,6 +1,9 @@
 # eleventy-plugin-podcaster 🕚⚡️🎈🐀🎤📲
 
-`eleventy-plugin-podcaster` — or **Podcaster**, as we will call it from now on — is an Eleventy plugin which lets you create a podcast and its accompanying website. **Podcaster** creates the podcast feed that you submit to Apple Podcasts, Spotify or any other podcast directory. And it provides information about your podcast to your Eleventy templates. This means that you can include information about the podcast and its episodes on your podcast's website, creating pages for individual episodes, guests, topics, seasons or anything else at all.
+`eleventy-plugin-podcaster` — or **Podcaster**, as we will call it from now on — is an Eleventy plugin which lets you create a podcast and its accompanying website.
+
+- **Podcaster** creates the podcast feed that you submit to Apple Podcasts, Spotify or any other podcast directory.
+- **Podcaster** also provides information about your podcast to your Eleventy templates. This means that you can describe the podcast and its episodes on your podcast website, creating pages for individual episodes, guests, topics, seasons or anything else at all.
 
 Plenty of services exist that will host your podcast online — [Spotify][], [Acast][], [Podbean][], [Buzzsprout][], [Blubrry][]. But none of these will allow you to own your podcast's presence on the web, and none of them will give you the freedom to create a site that presents your podcast in a way that reflects its premise, tone and style.
 
@@ -44,9 +47,9 @@ Detailed and specific information about how to install and use **Podcaster** can
 
 1. **Podcaster** is an Eleventy plugin. Create an Eleventy site and install the `eleventy-plugin-podcaster` plugin in the usual way.
 2. In the data directory, create a `podcast.json` file. This will contain information about your podcast and its site — at the very least, its title, the URL of the site, a description, its language, and its category.
-3. In the input directory, create a `episodeFiles` directory and put your podcast MP3s in there.
-4. In the input directory, create a `episodePosts` directory. You will have a post for each episode, and that post will include information about the episode in its filename and front matter and will have as its content the episode description or show notes.
-5. Create pages on your site for each of your episodes using the posts in the `episodePosts` directory. You can also create index pages, topic pages, guest pages or anything you like, using the information you have supplied to **Podcaster**.
+3. In the input directory, create an `episode-files` directory and put your podcast MP3s in there.
+4. In the input directory, create an `episode-posts` directory. Here you will create a post for each episode, which will include information about the episode in its filename and front matter and which whill contain the episode description or show notes.
+5. Create pages on your site for each of your episodes using the posts in the `episode-posts` directory. And you can also create index pages, topic pages, guest pages or anything you like — all using the information you have supplied to **Podcaster** in your `podcast.json` file and your episode posts.
 6. Find a host for your site, and a CDN for your podcast episodes.
 
 > [!WARNING]

package/eleventy.config.js

@@ -7,6 +7,7 @@ import calculateEpisodeSizeAndDuration from './src/calculateEpisodeSizeAndDurati
 import calculateEpisodeFilename from './src/calculateEpisodeFilename.js'
 
 import readableFilters from './src/readableFilters.js'
+import chapters from './src/chapters.js'
 import excerpts from './src/excerpts.js'
 import drafts from './src/drafts.js'
 import pageTitle from './src/pageTitle.js'
@@ -26,6 +27,7 @@ export default function (eleventyConfig, options = {}) {
   // Filters
 
   eleventyConfig.addPlugin(readableFilters, options)
+  eleventyConfig.addPlugin(chapters, options)
 
   // Optional features
 

package/package.json

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

package/src/calculateEpisodeSizeAndDuration.js

@@ -1,4 +1,5 @@
-import { Duration, DateTime } from 'luxon'
+import { DateTime } from 'luxon'
+import readableDuration from './readableDuration.js'
 import path from 'node:path'
 import { existsSync } from 'node:fs'
 import { readdir, stat, writeFile } from 'node:fs/promises'
@@ -11,29 +12,6 @@ import isEpisodePost from './isEpisodePost.js'
 const isAudioFile = episodeFilename => episodeFilename.endsWith('.mp3') ||
                     episodeFilename.endsWith('.m4a')
 
-const convertSecondsToReadableDuration = seconds =>
-  Duration.fromMillis(seconds * 1000)
-    .shiftTo('days', 'hours', 'minutes', 'seconds')
-    .toHuman()
-
-const convertReadableDurationToSeconds = duration => {
-  const durationPattern = /^(?:(?<hours>\d+):)?(?<minutes>\d{1,2}):(?<seconds>\d{2}(?:\.\d+)?)$/
-
-  let match
-  if (duration?.match) {
-    match = duration.match(durationPattern)
-  }
-
-  if (match) {
-    const hours = isNaN(parseInt(match.groups.hours))
-      ? 0
-      : parseInt(match.groups.hours)
-    const minutes = parseInt(match.groups.minutes)
-    const seconds = parseFloat(match.groups.seconds)
-    return hours * 3600 + minutes * 60 + seconds
-  }
-}
-
 async function readEpisodeDataLocally (episodeFilesDirectory) {
   const episodes = await readdir(episodeFilesDirectory)
   const episodeData = {}
@@ -62,7 +40,7 @@ function calculatePodcastData (episodeData) {
 
 function reportPodcastData (podcastData) {
   const { numberOfEpisodes, totalSize, totalDuration } = podcastData
-  console.log(`\u001b[33m${numberOfEpisodes} episodes; ${hr.fromBytes(totalSize)}; ${convertSecondsToReadableDuration(totalDuration)}.\u001b[0m`)
+  console.log(`\u001b[33m${numberOfEpisodes} episodes; ${hr.fromBytes(totalSize)}; ${readableDuration.convertFromSeconds(totalDuration)}.\u001b[0m`)
 }
 
 async function writePodcastDataLocally (episodeData, podcastData, directories) {
@@ -164,6 +142,7 @@ export default function (eleventyConfig, options = {}) {
   let firstRun = true
   eleventyConfig.on('eleventy.before', async ({ directories }) => {
     if (!firstRun || process.env.SKIP_EPISODE_CALCULATIONS === 'true') return
+
     firstRun = false
 
     const episodeFilesDirectory = options.episodeFilesDirectory
@@ -195,7 +174,7 @@ export default function (eleventyConfig, options = {}) {
   eleventyConfig.addGlobalData('eleventyComputed.episode.duration', () => {
     return data => {
       if (data.episode.duration) {
-        const convertedReadableDuration = convertReadableDurationToSeconds(data.episode.duration)
+        const convertedReadableDuration = readableDuration.convertToSeconds(data.episode.duration)
         return convertedReadableDuration ?? data.episode.duration
       }
 

package/src/chapters.js

@@ -0,0 +1,13 @@
+import readableDuration from './readableDuration.js'
+
+export default (eleventyConfig, options = {}) => {
+  eleventyConfig.addFilter('normalizeChaptersData', (data) => {
+    const result = data.map(x => {
+      if (x.startTime) {
+        x.startTime = readableDuration.convertToSeconds(x.startTime) ?? x.startTime
+      }
+      return x
+    })
+    return JSON.stringify(result, null, 2)
+  })
+}

package/src/chapters.njk

@@ -0,0 +1,9 @@
+---
+pagination:
+  data: collections.episodePostWithChapters
+  size: 1
+  alias: episodePost
+permalink: "{{ episodePost.page.url }}/chapters.json"
+---
+
+{{ episodePost.data.episode.chapters | normalizeChaptersData | safe }}

package/src/podcastFeed.js

@@ -9,7 +9,6 @@ export default function (eleventyConfig, options = {}) {
   }
 
   const podcastFeedPath = path.join(import.meta.dirname, './podcastFeed.njk')
-
   eleventyConfig.addTemplate('feed.njk', readFileSync(podcastFeedPath), {
     eleventyExcludeFromCollections: true,
     eleventyImport: {
@@ -17,6 +16,14 @@ export default function (eleventyConfig, options = {}) {
     }
   })
 
+  const chaptersPath = path.join(import.meta.dirname, './chapters.njk')
+  eleventyConfig.addTemplate('chapters.njk', readFileSync(chaptersPath), {
+    eleventyExcludeFromCollections: true,
+    eleventyImport: {
+      collections: ['episodePostWithChapters']
+    }
+  })
+
   eleventyConfig.addPlugin(rssPlugin, {
     posthtmlRenderOptions: {
       closingSingleTag: 'default' // opt-out of <img/>-style XHTML single tags
@@ -24,6 +31,22 @@ export default function (eleventyConfig, options = {}) {
   })
 
   eleventyConfig.addCollection('episodePost', (collectionApi) => {
-    return collectionApi.getAll().filter(item => isEpisodePost(item.data, options))
+    return collectionApi
+      .getAll()
+      .filter(item => isEpisodePost(item.data, options))
+      // sort order explicit: presence of template data files disrupts it otherwise
+      .sort((a, b) => a.date - b.date)
+  })
+
+  // included for backward compatibility, will be deprecated in 3.0
+  eleventyConfig.addCollection('podcastEpisode', (collectionApi) => {
+    return collectionApi
+      .getAll()
+      .filter(item => isEpisodePost(item.data, options))
+      .sort((a, b) => a.date - b.date)
+  })
+
+  eleventyConfig.addCollection('episodePostWithChapters', (collectionApi) => {
+    return collectionApi.getAll().filter(item => isEpisodePost(item.data, options) && item.data.episode?.chapters)
   })
 }

package/src/podcastFeed.njk

@@ -60,6 +60,10 @@ eleventyAllowMissingExtension: true
       <guid isPermaLink="true">{{ post.url | htmlBaseUrl(siteUrl) }}</guid>
       {% endif -%}
       <pubDate>{{ post.date | dateToRfc3339 }}</pubDate>
+      {%- if post.data.episode.chapters %}
+      <podcast:chapters url="{{ [post.url, 'chapters.json'] | join('/') | htmlBaseUrl(siteUrl) }}"
+        type="application/json+chapters" />
+      {% endif -%}
       {% if podcast.episodeDescriptionTemplate %}
       {%- set episodeDescription -%}
       {% include podcast.episodeDescriptionTemplate %}

package/src/readableDuration.js

@@ -0,0 +1,26 @@
+import { Duration } from 'luxon'
+
+export default {
+  convertFromSeconds (seconds) {
+    return Duration.fromMillis(seconds * 1000)
+      .shiftTo('days', 'hours', 'minutes', 'seconds')
+      .toHuman()
+  },
+  convertToSeconds (duration) {
+    const durationPattern = /^(?:(?<hours>\d+):)?(?<minutes>\d{1,2}):(?<seconds>\d{2}(?:\.\d+)?)$/
+
+    let match
+    if (duration?.match) {
+      match = duration.match(durationPattern)
+    }
+
+    if (match) {
+      const hours = isNaN(parseInt(match.groups.hours))
+        ? 0
+        : parseInt(match.groups.hours)
+      const minutes = parseInt(match.groups.minutes)
+      const seconds = parseFloat(match.groups.seconds)
+      return hours * 3600 + minutes * 60 + seconds
+    }
+  }
+}

package/.env

@@ -1,5 +0,0 @@
-BUCKET_SECRET_KEY="GiBsTUbU7VwKdSZGZKvYb47i87lWjkUXRH1Edd+I2KQ"
-BUCKET_ACCESS_KEY="DO801WKX4LJP3Y9DWE2H"
-BUCKET_ENDPOINT="https://sfo3.digitaloceanspaces.com"
-BUCKET_REGION="us-east-1"
-BUCKET_NAME="startlingbarbarabain"

package/ava.config.js

@@ -1,3 +0,0 @@
-export default {
-  files: ['test/**/*', '!test/v1']
-}