Merge pull request #21 from pjlamb12/filename-config

Filename Set from Config
notiz-dev · Dec 2, 2020 · 520be1a · 520be1a
2 parents e00bc68 + 24449b4
commit 520be1a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/plugins/rss/README.md b/plugins/rss/README.md
@@ -10,6 +10,8 @@ The rss feed is available at:
 - your-domain.de/feed.atom
 - your-domain.de/feed.xml
 
+To change the filename of the feed, use the `filename` attribute in your rss.config.json file, as seen below. The default value is feed, but you can change it to whatever you'd like.
+
 > **Breaking Change** introduced in Version 1.0.0 with changing the plugin type from `render` to `routeDiscoveryDone`. This has the major benefit of only generating the RSS Feed once per run instead of after each page render.
 
 ## 📦 Installation
@@ -53,9 +55,11 @@ Create a `rss.config.json` in your root with the following properties:
   "favicon": "https://you-domain.com/favicon.png",
   "copyright": "2020 your-domain.com",
   "generator": "Page description",
+  "filename": "feed",
   "feedLinks": {
+    "atom": "https://your-domain.com/feed.atom",
     "json": "https://your-domain.com/feed.json",
-    "atom": "https://your-domain.com/feed.atom"
+    "xml": "https://your-domain.com/feed.xml"
   },
   "outDir": "./dist/static",
   "categories": ["Categories", "of", "your", "choice"],

diff --git a/plugins/rss/src/rss.js b/plugins/rss/src/rss.js
@@ -7,6 +7,7 @@ const { log, logError, yellow } = require('@scullyio/scully');
 const configFile = readFileSync(`${process.cwd()}/rss.config.json`, 'utf8');
 const config = JSON.parse(configFile.toString());
 const blogPostRouteSlug = config.blogPostRouteSlug || '/blog';
+const filename = config.filename || 'feed';
 const feed = new Feed(config);
 
 config.categories.forEach((cat) => {
@@ -42,12 +43,12 @@ const rssPlugin = (routes) => {
     feed.addItem(item);
   });
   try {
-    writeFileSync(join(config.outDir || '', 'feed.xml'), feed.rss2());
-    log(`✅ Created ${yellow(config.outDir + '/feed.xml')}`);
-    writeFileSync(join(config.outDir || '', 'feed.atom'), feed.atom1());
-    log(`✅ Created ${yellow(config.outDir + '/feed.atom')}`);
-    writeFileSync(join(config.outDir || '', 'feed.json'), feed.json1());
-    log(`✅ Created ${yellow(config.outDir + '/feed.json')}`);
+    writeFileSync(join(config.outDir || '', `${filename}.xml`), feed.rss2());
+    log(`✅ Created ${yellow(config.outDir + `/${filename}.xml`)}`);
+    writeFileSync(join(config.outDir || '', `${filename}.atom`), feed.atom1());
+    log(`✅ Created ${yellow(config.outDir + `/${filename}.atom`)}`);
+    writeFileSync(join(config.outDir || '', `${filename}.json`), feed.json1());
+    log(`✅ Created ${yellow(config.outDir + `/${filename}.json`)}`);
   } catch (error) {
     logError('❌ Failed to create RSS feed. Error:', error);
     throw error;

diff --git a/rss.config.json b/rss.config.json
@@ -8,9 +8,11 @@
   "favicon": "https://notiz.dev/favicon.png",
   "copyright": "2020 notiz.dev",
   "generator": "Weeklyish Articles about Web Development",
+  "filename": "feed",
   "feedLinks": {
+    "atom": "https://notiz.dev/feed.atom",
     "json": "https://notiz.dev/feed.json",
-    "atom": "https://notiz.dev/feed.atom"
+    "xml": "https://notiz.dev/feed.xml"
   },
   "outDir": "./dist/static",
   "categories": ["Web Development", "Blog", "Angular", "node"]