podcast-dl 7.1.0 → 7.3.1

package/README.md

@@ -1,6 +1,6 @@
 # podcast-dl
 
-## A CLI for downloading podcasts with a focus on archiving.
+A CLI for downloading podcasts with a focus on archiving.
 
 ## How to Use
 
@@ -10,6 +10,8 @@
 
 `npx podcast-dl --url <PODCAST_RSS_URL>`
 
+### [More Examples](./docs/examples.md)
+
 ## Options
 
 Type values surrounded in square brackets (`[]`) can be used as used as boolean options (no argument required).
@@ -18,6 +20,7 @@ Type values surrounded in square brackets (`[]`) can be used as used as boolean
 | ------------------------ | ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | --url                    | String              | true     | URL to podcast RSS feed.                                                                                                                                                                                              |
 | --out-dir                | String              | false    | Specify output directory for episodes and metadata. Defaults to "./{{podcast_title}}". See "Templating" for more details.                                                                                             |
+| --threads                | Number              | false    | Determines the number of downloads that will happen concurrently. Default is 1.                                                                                                                                       |
 | --archive                | [String]            | false    | Download or write out items not listed in archive file. Generates archive file at path if not found. Defaults to "./{{podcast_title}}/archive.json" when used as a boolean option. See "Templating" for more details. |
 | --episode-template       | String              | false    | Template for generating episode related filenames. See "Templating" for details.                                                                                                                                      |
 | --include-meta           |                     | false    | Write out podcast metadata to JSON.                                                                                                                                                                                   |
@@ -36,7 +39,6 @@ Type values surrounded in square brackets (`[]`) can be used as used as boolean
 | --info                   |                     | false    | Print retrieved podcast info instead of downloading.                                                                                                                                                                  |
 | --list                   | [String]            | false    | Print episode list instead of downloading. Defaults to "table" when used as a boolean option. "json" is also supported.                                                                                               |
 | --exec                   | String              | false    | Execute a command after each episode is downloaded.                                                                                                                                                                   |
-| --threads                | Number              | false    | Determines the number of downloads that will happen concurrently. Default is 1.                                                                                                                                       |
 | --filter-url-tacking     |                     | false    | Attempts to extract the direct download link of an episode if detected (**experimental**).                                                                                                                            |
 | --version                |                     | false    | Output the version number.                                                                                                                                                                                            |
 | --help                   |                     | false    | Output usage information.                                                                                                                                                                                             |

package/bin/async.js

@@ -16,11 +16,13 @@ import { getArchiveFilename, getFilename } from "./naming.js";
 import {
   getEpisodeAudioUrlAndExt,
   getArchiveKey,
+  getTempPath,
   runFfmpeg,
   runExec,
   writeItemMeta,
   writeToArchive,
   getUrlEmbed,
+  getIsInArchive,
 } from "./util.js";
 
 const pipeline = promisify(stream.pipeline);
@@ -43,6 +45,11 @@ const download = async ({
     return;
   }
 
+  if (key && archive && getIsInArchive({ key, archive })) {
+    logMessage("Download exists in archive. Skipping...");
+    return;
+  }
+
   let embeddedUrl = null;
   if (filterUrlTracking) {
     logMessage("Attempting to find embedded URL...");
@@ -63,9 +70,10 @@ const download = async ({
     },
   });
 
+  const tempOutputPath = getTempPath(outputPath);
   const removeFile = () => {
-    if (fs.existsSync(outputPath)) {
-      fs.unlinkSync(outputPath);
+    if (fs.existsSync(tempOutputPath)) {
+      fs.unlinkSync(tempOutputPath);
     }
   };
 
@@ -101,14 +109,14 @@ const download = async ({
 
     await pipeline(
       got.stream(finalUrl).on("downloadProgress", onDownloadProgress),
-      fs.createWriteStream(outputPath)
+      fs.createWriteStream(tempOutputPath)
     );
   } catch (error) {
     removeFile();
     throw error;
   }
 
-  const fileSize = fs.statSync(outputPath).size;
+  const fileSize = fs.statSync(tempOutputPath).size;
 
   if (fileSize === 0) {
     removeFile();
@@ -121,13 +129,7 @@ const download = async ({
     return;
   }
 
-  if (expectedSize && !isNaN(expectedSize) && expectedSize !== fileSize) {
-    logMessage(
-      "File size differs from expected content length. Suggestion: verify file works as expected",
-      LOG_LEVELS.important
-    );
-    logMessage(`${outputPath}`, LOG_LEVELS.important);
-  }
+  fs.renameSync(tempOutputPath, outputPath);
 
   logMessage("Download complete!");
 

package/bin/bin.js

@@ -293,6 +293,24 @@ const main = async () => {
     filterUrlTracking,
   });
 
+  if (hasErrors && numEpisodesDownloaded !== targetItems.length) {
+    logMessage(
+      `\n${numEpisodesDownloaded} of ${pluralize(
+        "episode",
+        targetItems.length,
+        true
+      )} downloaded\n`
+    );
+  } else if (numEpisodesDownloaded > 0) {
+    logMessage(
+      `\nSuccessfully downloaded ${pluralize(
+        "episode",
+        numEpisodesDownloaded,
+        true
+      )}\n`
+    );
+  }
+
   if (numEpisodesDownloaded === 0) {
     process.exit(ERROR_STATUSES.nothingDownloaded);
   }

package/bin/util.js

@@ -15,6 +15,10 @@ const parser = new rssParser({
   defaultRSS: 2.0,
 });
 
+const getTempPath = (path) => {
+  return `${path}.tmp`;
+};
+
 const getArchiveKey = ({ prefix, name }) => {
   return `${prefix}-${name}`;
 };
@@ -211,22 +215,20 @@ const getItemsToDownload = ({
             }),
           });
 
-          if (!savedArchive.includes(episodeImageArchiveKey)) {
-            const episodeImageName = getFilename({
-              item,
-              feed,
-              url: episodeAudioUrl,
-              ext: episodeImageFileExt,
-              template: episodeTemplate,
-            });
-
-            const outputImagePath = path.resolve(basePath, episodeImageName);
-            item._extra_downloads.push({
-              url: episodeImageUrl,
-              outputPath: outputImagePath,
-              key: episodeImageArchiveKey,
-            });
-          }
+          const episodeImageName = getFilename({
+            item,
+            feed,
+            url: episodeAudioUrl,
+            ext: episodeImageFileExt,
+            template: episodeTemplate,
+          });
+
+          const outputImagePath = path.resolve(basePath, episodeImageName);
+          item._extra_downloads.push({
+            url: episodeImageUrl,
+            outputPath: outputImagePath,
+            key: episodeImageArchiveKey,
+          });
         }
       }
 
@@ -291,34 +293,24 @@ const logItemsList = ({
 
 const writeFeedMeta = ({ outputPath, feed, key, archive, override }) => {
   if (key && archive && getIsInArchive({ key, archive })) {
-    logMessage("Feed metadata exists in archive. Skipping write...");
+    logMessage("Feed metadata exists in archive. Skipping...");
     return;
   }
 
-  const title = feed.title || null;
-  const description = feed.description || null;
-  const link = feed.link || null;
-  const feedUrl = feed.feedUrl || null;
-  const managingEditor = feed.managingEditor || null;
+  const output = {};
+  ["title", "description", "link", "feedUrl", "managingEditor"].forEach(
+    (key) => {
+      if (feed[key]) {
+        output[key] = feed[key];
+      }
+    }
+  );
 
   try {
     if (override || !fs.existsSync(outputPath)) {
-      fs.writeFileSync(
-        outputPath,
-        JSON.stringify(
-          {
-            title,
-            description,
-            link,
-            feedUrl,
-            managingEditor,
-          },
-          null,
-          4
-        )
-      );
+      fs.writeFileSync(outputPath, JSON.stringify(output, null, 4));
     } else {
-      logMessage("Feed metadata exists locally. Skipping write...");
+      logMessage("Feed metadata exists locally. Skipping...");
     }
 
     if (key && archive && !getIsInArchive({ key, archive })) {
@@ -344,36 +336,22 @@ const writeItemMeta = ({
   override,
 }) => {
   if (key && archive && getIsInArchive({ key, archive })) {
-    logMessage(
-      `${marker} | Episode metadata exists in archive. Skipping write...`
-    );
+    logMessage(`${marker} | Episode metadata exists in archive. Skipping...`);
     return;
   }
 
-  const title = item.title || null;
-  const descriptionText = item.contentSnippet || null;
-  const pubDate = item.pubDate || null;
-  const creator = item.creator || null;
+  const output = {};
+  ["title", "contentSnippet", "pubDate", "creator"].forEach((key) => {
+    if (item[key]) {
+      output[key] = item[key];
+    }
+  });
 
   try {
     if (override || !fs.existsSync(outputPath)) {
-      fs.writeFileSync(
-        outputPath,
-        JSON.stringify(
-          {
-            title,
-            pubDate,
-            creator,
-            descriptionText,
-          },
-          null,
-          4
-        )
-      );
+      fs.writeFileSync(outputPath, JSON.stringify(output, null, 4));
     } else {
-      logMessage(
-        `${marker} | Episode metadata exists locally. Skipping write...`
-      );
+      logMessage(`${marker} | Episode metadata exists locally. Skipping...`);
     }
 
     if (key && archive && !getIsInArchive({ key, archive })) {
@@ -569,6 +547,7 @@ export {
   getFeed,
   getImageUrl,
   getItemsToDownload,
+  getTempPath,
   getUrlExt,
   getUrlEmbed,
   logFeedInfo,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "podcast-dl",
-  "version": "7.1.0",
+  "version": "7.3.1",
   "description": "A CLI for downloading podcasts.",
   "type": "module",
   "bin": "./bin/bin.js",