Initialize repository (#1)

* Convert to bun

* Write "deploy to pages" action

* Remove unneeded steps and files

* Switch from eslint to biome for linting and formatting

* Combine lint and format commands

* Add feeds

* Remove Atom feed

* Add time to feed display

* Work on the github pages workflow

.eslintrc.json

@@ -1,50 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "indent": [
-            "error",
-            2
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "double"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "no-trailing-spaces": [
-            2,
-            {
-                "skipBlankLines": false
-            }
-        ],
-        "no-multiple-empty-lines": [
-            "error",
-            {
-                "max": 2,
-                "maxEOF": 1
-            }
-        ],
-        "@typescript-eslint/no-var-requires": 0
-    }
-}

.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: georgemandis
-patreon: #
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: #

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -0,0 +1,35 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Build feed
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 */6 * * *" # At minute 0 past every 6th hour.
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Bun
+      uses: oven-sh/setup-bun@v1
+      with:
+        bun-version: latest
+    - run: bun install --frozen-lockfile
+    - run: bun run build
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: public/
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

config/feeds.json

@@ -1,23 +1,87 @@
 {
-  "Developer News": [
+	"Comics": [
-    "https://hacks.mozilla.org/feed/",
+		"http://www.catanacomics.com/rss",
-    "https://web.dev/feed.xml",
+		"http://feeds.feedburner.com/InvisibleBread",
-    "https://v8.dev/blog.atom",
+		"https://hejibits.com/rss#_=_",
-    "https://alistapart.com/main/feed/",
+		"http://www.hrwiki.org/wiki/Special:Updates",
-    "https://css-tricks.com/feed/",
+		"http://rockpapercynic.tumblr.com/rss"
-    "https://dev.to/feed",
-    "https://changelog.com/feed"
 	],
-  "Blogs": [
+	"Podcasts": [
-    "https://george.mand.is/feed.xml",
+		"https://lilyandsam.show/feed",
-    "https://joy.recurse.com/feed.atom"
+		"https://technosapiens.substack.com/feed"
 	],
-  "My GitHub Projects": [
+	"Friends and Family": [
-    "https://github.com/georgemandis.atom",
+		"https://www.goodreads.com/review/list_rss/132710826?shelf=read",
-    "https://github.com/georgemandis/bubo-rss/releases.atom",
+		"https://jgm23333.wixsite.com/my-site/blog-feed.xml",
-    "https://github.com/georgemandis/konami-js/releases.atom",
+		"https://joekhoury.blog/feed/",
-    "https://github.com/georgemandis/konami-js/commits/main.atom",
+		"https://social.warnick.me/users/sam.rss"
-    "https://github.com/javascriptforartists/cheer-me-up-and-sing-me-a-song/commits/master.atom",
+	],
-    "https://github.com/georgemandis/circuit-playground-midi-multi-tool/commits/master.atom"
+	"Games": [
+		"https://www.nomanssky.com/news/feed/",
+		"https://www.lexaloffle.com/bbs/feed.php?uid=1",
+		"https://www.factorio.com/blog/rss",
+		"https://kill-the-newsletter.com/feeds/pghhn8aaf264tukg.xml",
+		"http://www.suppermariobroth.com/rss",
+		"http://unknownworlds.com/subnautica/feed/",
+		"https://store.steampowered.com/feeds/news/app/1675200/?cc=US&l=english"
+	],
+	"Finance": [
+		"http://feeds.feedburner.com/MrMoneyMustache",
+		"http://feeds.feedburner.com/DoctorOfCredit",
+		"https://kill-the-newsletter.com/feeds/tgor1vrwcf3f0uyo.xml",
+		"https://kill-the-newsletter.com/feeds/5q4gs79dfh32yr3h.xml"
+	],
+	"News": [
+		"http://www.economist.com/rss/the_world_this_week_rss.xml",
+		"https://newsroom.churchofjesuschrist.org/rss",
+		"http://feeds.feedburner.com/LdsChurchGrowth",
+		"https://www.sltrib.com/arc/outboundfeeds/news/?outputType=xml",
+		"https://www.ksl.com/rss/news/news_utah",
+		"https://www.readtangle.com/posts/rss/"
+	],
+	"Parenting": [
+		"https://technosapiens.substack.com/feed",
+		"https://parentdata.org/feed/"
+	],
+	"Fashion": [
+		"http://www.heddels.com/feed/",
+		"http://putthison.com/rss",
+		"https://articlesofinterest.substack.com/feed",
+		"https://dappered.com/feed/",
+		"https://dieworkwear.com/feed/",
+		"http://fromsqualortoballer.com/rss",
+		"https://fabricateurialist.substack.com/feed"
+	],
+	"Products": [
+		"https://jellyfin.org/index.xml",
+		"https://gitlab.com/CalcProgrammer1/OpenRGB/-/tags?format=atom",
+		"http://feeds.feedburner.com/psblog",
+		"https://matrix.org/blog/feed/",
+		"https://brave.com/feed/",
+		"https://bitwarden.com/blog/feed.xml"
+	],
+	"Humor": [
+		"https://kill-the-newsletter.com/feeds/d90ng280lhh3p2nq.xml",
+		"http://www.altuniversebyu.com/feed/",
+		"https://aiweirdness.com/rss",
+		"http://mcmansionhell.tumblr.com/rss"
+	],
+	"Other": [
+		"https://kill-the-newsletter.com/feeds/400aiwxy5ox6ao0d.xml",
+		"http://brandonsanderson.com/feed/",
+		"https://kill-the-newsletter.com/feeds/j3c4wngg2hpjmdt8.xml",
+		"https://astralcodexten.substack.com/feed/"
+	],
+	"Tech News": [
+		"https://samwarnick.com/feed.rss",
+		"http://feeds.feedburner.com/CssTricks",
+		"http://chriscoyier.net/feed/",
+		"https://jenniferdaniel.substack.com/feed/",
+		"http://www.gamingonlinux.com/article_rss.php",
+		"http://www.theverge.com/rss/full.xml"
+	],
+	"Emulation": [
+		"http://melonds.kuribo64.net/rss.php",
+		"https://dolphin-emu.org/blog/feeds/"
 	]
 }

config/template.html

@@ -1,13 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
+
+<head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta http-equiv="X-UA-Compatible" content="ie=edge" />
   <title>🦉 Bubo Reader</title>
   <link rel="stylesheet" href="/style.css" />
-  </head>
+</head>
-  <body>
+
+<body>
   <h1>🦉 Bubo Reader</h1>
 
   {% for group, feeds in data %}
@@ -21,13 +23,8 @@
     <ul>
       {% for item in feed.items %}
       <li>
-          {{ item.timestamp | formatDate }} -
+        {{ item.timestamp | formatDate }} @ {{ item.timestamp | formatTime }}—
-          <a
+        <a href="{{ item.link }}" target="_blank" rel="noopener norefferer nofollow">{{ item.title }}</a>
-            href="{{ item.link }}"
-            target="_blank"
-            rel="noopener norefferer nofollow"
-            >{{ item.title }}</a
-          >
       </li>
       {% endfor %}
     </ul>
@@ -47,10 +44,10 @@
   <p>Last updated {{ now }}.</p>
   <p>
     Powered by
-      <a href="https://github.com/georgemandis/bubo-rss"
+    <a href="https://github.com/georgemandis/bubo-rss">Bubo Reader (v{{ info.version }})</a>, a project by <a
-        >Bubo Reader (v{{ info.version }})</a
+      href="https://george.mand.is">George Mandis</a>. ❤️
-      >, a project by <a href="https://george.mand.is">George Mandis</a>. ❤️
     <a href="{{ info.funding.url }}">Sponsor on GitHub</a>
   </p>
-  </body>
+</body>
+
 </html>

eslint.config.js

@@ -0,0 +1,9 @@
+import pluginJs from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default [
+	{ languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+	pluginJs.configs.recommended,
+	...tseslint.configs.recommended,
+];

netlify.toml

@@ -1,4 +0,0 @@
-[build]  
-  command = "npm run build:bubo"
-  publish = "./public/"
-

package.json

@@ -3,14 +3,12 @@
   "version": "2.0.2",
   "description": "A simple but effective feed reader (RSS, JSON)",
   "homepage": "https://github.com/georgemandis/bubo-rss",
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "type": "module",
   "scripts": {
-    "dev": "tsc --watch",
     "clean": "rm -rf dist",
-    "build": "tsc",
+    "build": "bun src/index.ts",
-    "bubo": "node dist/index.js",
+    "check": "biome check --write ./{src,config,public} ./eslint.config.js"
-    "build:bubo": "tsc && node dist/index.js"
   },
   "author": {
     "name": "George Mandis",
@@ -33,13 +31,15 @@
     "rss-parser": "^3.13.0"
   },
   "devDependencies": {
-    "@types/node": "^20.2.5",
+    "@biomejs/biome": "^1.8.1",
+    "@types/bun": "latest",
     "@types/nunjucks": "^3.2.2",
     "@types/xml2js": "^0.4.11",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
-    "eslint": "^8.42.0",
     "tslib": "^2.5.3",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.3",
-  }
+    "typescript-eslint": "^7.13.1"
+  },
+  "trustedDependencies": [
+    "@biomejs/biome"
+  ]
 }

src/@types/bubo.d.ts

@@ -1,9 +1,9 @@
 export interface Feeds {
-  [key: string]: object[]
+	[key: string]: object[];
 }
 export interface FeedItem {
 	[key: string]: string | number | Date | FeedItem[];
-  items: FeedItem[]
+	items: FeedItem[];
 }
 
 //NEW WAY

src/index.ts

@@ -10,21 +10,21 @@
  * Licensed under the MIT License (http://opensource.org/licenses/MIT)
  */
 
+import { writeFile } from "node:fs/promises";
+import chalk from "chalk";
 import fetch from "node-fetch";
+import type { Response } from "node-fetch";
 import Parser from "rss-parser";
-import { Feeds, FeedItem } from "./@types/bubo";
+import type { FeedItem, Feeds } from "./@types/bubo";
-import { Response } from "node-fetch";
 import { render } from "./renderer.js";
 import {
-  getLink,
+	getBuboInfo,
-  getTitle,
-  getTimestamp,
-  parseFeed,
 	getFeedList,
-  getBuboInfo
+	getLink,
+	getTimestamp,
+	getTitle,
+	parseFeed,
 } from "./utilities.js";
-import { writeFile } from "fs/promises";
-import chalk from "chalk";
 
 const buboInfo = await getBuboInfo();
 const parser = new Parser();
@@ -49,7 +49,7 @@ const benchmark = (startTime: number) =>
  *  - MAX_CONNECTION = max number of fetches to contain in a batch
  *  - DELAY_MS = the delay in milliseconds between batches
  */
-const MAX_CONNECTIONS = Infinity;
+const MAX_CONNECTIONS = Number.POSITIVE_INFINITY;
 const DELAY_MS = 850;
 
 const error = chalk.bold.red;
@@ -76,15 +76,15 @@ const finishBuild: () => void = async () => {
 	const output = render({
 		data: contentFromAllFeeds,
 		errors: errors,
-    info: buboInfo
+		info: buboInfo,
 	});
 
 	// write the output to public/index.html
 	await writeFile("./public/index.html", output);
 	process.stdout.write(
 		`\nFinished writing to output:\n- ${feedListLength} feeds in ${benchmark(
-      initTime
+			initTime,
-    )}\n- ${errors.length} errors\n`
+		)}\n- ${errors.length} errors\n`,
 	);
 };
 
@@ -99,7 +99,7 @@ const processFeed =
 	({
 		group,
 		feed,
-    startTime
+		startTime,
 	}: {
 		group: string;
 		feed: string;
@@ -120,21 +120,21 @@ const processFeed =
 			contents.link = getLink(contents);
 
 			// try to normalize date attribute naming
-        contents?.items?.forEach(item => {
+			for (const item of contents.items) {
 				item.timestamp = getTimestamp(item);
 				item.title = getTitle(item);
 				item.link = getLink(item);
-        });
+			}
 
 			contentFromAllFeeds[group].push(contents as object);
 			process.stdout.write(
-          `${success("Successfully fetched:")} ${feed} - ${benchmark(startTime)}\n`
+				`${success("Successfully fetched:")} ${feed} - ${benchmark(startTime)}\n`,
 			);
 		} catch (err) {
 			process.stdout.write(
 				`${error("Error processing:")} ${feed} - ${benchmark(
-            startTime
+					startTime,
-          )}\n${err}\n`
+				)}\n${err}\n`,
 			);
 			errors.push(`Error processing: ${feed}\n\t${err}`);
 		}
@@ -151,19 +151,22 @@ const processFeeds = () => {
 
 		for (const feed of feeds) {
 			const startTime = Date.now();
-      setTimeout(() => {
+			setTimeout(
+				() => {
 					process.stdout.write(`Fetching: ${feed}...\n`);
 
 					fetch(feed)
 						.then(processFeed({ group, feed, startTime }))
-          .catch(err => {
+						.catch((err) => {
 							process.stdout.write(
-              error(`Error fetching ${feed} ${benchmark(startTime)}\n`)
+								error(`Error fetching ${feed} ${benchmark(startTime)}\n`),
 							);
 							errors.push(`Error fetching ${feed} ${err.toString()}\n`);
 							finishBuild();
 						});
-      }, (idx % (feedListLength / MAX_CONNECTIONS)) * DELAY_MS);
+				},
+				(idx % (feedListLength / MAX_CONNECTIONS)) * DELAY_MS,
+			);
 			idx++;
 		}
 	}

src/renderer.ts

@@ -6,15 +6,20 @@
 
 import nunjucks from "nunjucks";
 const env: nunjucks.Environment = nunjucks.configure({ autoescape: true });
-import { readFile } from "fs/promises";
+import { readFile } from "node:fs/promises";
-import { Feeds, JSONValue } from "./@types/bubo";
+import type { Feeds, JSONValue } from "./@types/bubo";
 
 /**
  * Global filters for my Nunjucks templates
  */
-env.addFilter("formatDate", function (dateString): string {
+env.addFilter("formatDate", (dateString): string => {
-  const date: Date = new Date(parseInt(dateString));
+	const date: Date = new Date(Number.parseInt(dateString));
-  return !isNaN(date.getTime()) ? date.toLocaleDateString() : dateString;
+	return !Number.isNaN(date.getTime()) ? date.toLocaleDateString() : dateString;
+});
+
+env.addFilter("formatTime", (dateString): string => {
+	const date: Date = new Date(Number.parseInt(dateString));
+	return !Number.isNaN(date.getTime()) ? date.toLocaleTimeString() : dateString;
 });
 
 env.addGlobal("now", new Date().toUTCString());
@@ -28,7 +33,7 @@ const template: string = (
 const render = ({
 	data,
 	errors,
-  info
+	info,
 }: {
 	data: Feeds;
 	errors: unknown[];
@@ -37,7 +42,7 @@ const render = ({
 	return env.renderString(template, {
 		data,
 		errors,
-    info
+		info,
 	});
 };
 

src/utilities.ts

@@ -6,15 +6,15 @@
 	Note: these are tightly-coupled to the template and a personal preference.
 */
 
-import { Response } from "node-fetch";
+import { readFile } from "node:fs/promises";
-import { readFile } from "fs/promises";
+import type { Response } from "node-fetch";
-import { FeedItem, JSONValue } from "./@types/bubo";
+import type { FeedItem, JSONValue } from "./@types/bubo";
 
 export const getLink = (obj: FeedItem): string => {
 	const link_values: string[] = ["link", "url", "guid", "home_page_url"];
 	const keys: string[] = Object.keys(obj);
-  const link_property: string | undefined = link_values.find(link_value =>
+	const link_property: string | undefined = link_values.find((link_value) =>
-    keys.includes(link_value)
+		keys.includes(link_value),
 	);
 	return link_property ? (obj[link_property] as string) : "";
 };
@@ -27,7 +27,7 @@ export const getTitle = (obj: FeedItem): string => {
 
 	// if title is empty for some reason, fall back on url or link
 	const title_property: string | undefined = title_values.find(
-    title_value => keys.includes(title_value) && obj[title_value]
+		(title_value) => keys.includes(title_value) && obj[title_value],
 	);
 	return title_property ? (obj[title_property] as string) : "";
 };
@@ -41,7 +41,7 @@ export const getTimestamp = (obj: FeedItem): string => {
 		obj.date_published
 	).toString();
 	const timestamp: number = new Date(dateString).getTime();
-  return isNaN(timestamp) ? dateString : timestamp.toString();
+	return Number.isNaN(timestamp) ? dateString : timestamp.toString();
 };
 
 // parse RSS/XML or JSON feeds
@@ -51,26 +51,26 @@ export async function parseFeed(response: Response): Promise<JSONValue> {
 	if (!contentType) return {};
 
 	const rssFeed = [contentType]
-    .map(item =>
+		.map((item) =>
 			[
 				"application/atom+xml",
 				"application/rss+xml",
 				"application/xml",
 				"text/xml",
-        "text/html" // this is kind of a gamble
+				"text/html", // this is kind of a gamble
 			].includes(item)
 				? response.text()
-        : false
+				: false,
 		)
-    .filter(_ => _)[0];
+		.filter((_) => _)[0];
 
 	const jsonFeed = [contentType]
-    .map(item =>
+		.map((item) =>
 			["application/json", "application/feed+json"].includes(item)
 				? (response.json() as Promise<JSONValue>)
-        : false
+				: false,
 		)
-    .filter(_ => _)[0];
+		.filter((_) => _)[0];
 
 	return (rssFeed && rssFeed) || (jsonFeed && jsonFeed) || {};
 }
@@ -79,12 +79,12 @@ export const getFeedList = async (): Promise<JSONValue> => {
 	return JSON.parse(
 		(
 			await readFile(new URL("../config/feeds.json", import.meta.url))
-    ).toString()
+		).toString(),
 	);
 };
 
 export const getBuboInfo = async (): Promise<JSONValue> => {
 	return JSON.parse(
-    (await readFile(new URL("../package.json", import.meta.url))).toString()
+		(await readFile(new URL("../package.json", import.meta.url))).toString(),
 	);
 };