Switch from eslint to biome for linting and formatting
This commit is contained in:
Carter McBride
parent
5cc7a45d42
commit
7f0af2c0c1
8 changed files with 198 additions and 233 deletions
|
|
@ -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
|
||||
}
|
||||
}
|
||||
BIN
bun.lockb
BIN
bun.lockb
Binary file not shown.
9
eslint.config.js
Normal file
9
eslint.config.js
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
import globals from "globals";
|
||||
import pluginJs from "@eslint/js";
|
||||
import tseslint from "typescript-eslint";
|
||||
|
||||
export default [
|
||||
{ languageOptions: { globals: { ...globals.browser, ...globals.node } } },
|
||||
pluginJs.configs.recommended,
|
||||
...tseslint.configs.recommended,
|
||||
];
|
||||
21
package.json
21
package.json
|
|
@ -3,12 +3,13 @@
|
|||
"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": "bun src/index.js --watch",
|
||||
"clean": "rm -rf dist",
|
||||
"build": "bun src/index.js"
|
||||
"build": "bun src/index.js",
|
||||
"lint": "biome lint --write ./src",
|
||||
"format": "biome format --write ./src ./eslint.config.js"
|
||||
},
|
||||
"author": {
|
||||
"name": "George Mandis",
|
||||
|
|
@ -31,13 +32,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"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
4
src/@types/bubo.d.ts
vendored
4
src/@types/bubo.d.ts
vendored
|
|
@ -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
|
||||
|
|
|
|||
39
src/index.ts
39
src/index.ts
|
|
@ -12,8 +12,8 @@
|
|||
|
||||
import fetch from "node-fetch";
|
||||
import Parser from "rss-parser";
|
||||
import { Feeds, FeedItem } from "./@types/bubo";
|
||||
import { Response } from "node-fetch";
|
||||
import type { Feeds, FeedItem } from "./@types/bubo";
|
||||
import type { Response } from "node-fetch";
|
||||
import { render } from "./renderer.js";
|
||||
import {
|
||||
getLink,
|
||||
|
|
@ -21,9 +21,9 @@ import {
|
|||
getTimestamp,
|
||||
parseFeed,
|
||||
getFeedList,
|
||||
getBuboInfo
|
||||
getBuboInfo,
|
||||
} from "./utilities.js";
|
||||
import { writeFile } from "fs/promises";
|
||||
import { writeFile } from "node:fs/promises";
|
||||
import chalk from "chalk";
|
||||
|
||||
const buboInfo = await getBuboInfo();
|
||||
|
|
@ -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
|
||||
)}\n- ${errors.length} errors\n`
|
||||
initTime,
|
||||
)}\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
|
||||
)}\n${err}\n`
|
||||
startTime,
|
||||
)}\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++;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,15 +6,15 @@
|
|||
|
||||
import nunjucks from "nunjucks";
|
||||
const env: nunjucks.Environment = nunjucks.configure({ autoescape: true });
|
||||
import { readFile } from "fs/promises";
|
||||
import { Feeds, JSONValue } from "./@types/bubo";
|
||||
import { readFile } from "node:fs/promises";
|
||||
import type { Feeds, JSONValue } from "./@types/bubo";
|
||||
|
||||
/**
|
||||
* Global filters for my Nunjucks templates
|
||||
*/
|
||||
env.addFilter("formatDate", function (dateString): string {
|
||||
const date: Date = new Date(parseInt(dateString));
|
||||
return !isNaN(date.getTime()) ? date.toLocaleDateString() : dateString;
|
||||
env.addFilter("formatDate", (dateString): string => {
|
||||
const date: Date = new Date(Number.parseInt(dateString));
|
||||
return !Number.isNaN(date.getTime()) ? date.toLocaleDateString() : dateString;
|
||||
});
|
||||
|
||||
env.addGlobal("now", new Date().toUTCString());
|
||||
|
|
@ -28,7 +28,7 @@ const template: string = (
|
|||
const render = ({
|
||||
data,
|
||||
errors,
|
||||
info
|
||||
info,
|
||||
}: {
|
||||
data: Feeds;
|
||||
errors: unknown[];
|
||||
|
|
@ -37,7 +37,7 @@ const render = ({
|
|||
return env.renderString(template, {
|
||||
data,
|
||||
errors,
|
||||
info
|
||||
info,
|
||||
});
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -6,15 +6,15 @@
|
|||
Note: these are tightly-coupled to the template and a personal preference.
|
||||
*/
|
||||
|
||||
import { Response } from "node-fetch";
|
||||
import { readFile } from "fs/promises";
|
||||
import { FeedItem, JSONValue } from "./@types/bubo";
|
||||
import type { Response } from "node-fetch";
|
||||
import { readFile } from "node:fs/promises";
|
||||
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 =>
|
||||
keys.includes(link_value)
|
||||
const link_property: string | undefined = link_values.find((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(),
|
||||
);
|
||||
};
|
||||
|
|
|
|||
Loading…
Reference in a new issue