webring 0.0.2 → 1.0.0

package/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.0.0](https://github.com/shepherdjerred/webring/compare/v0.3.0...v1.0.0) (2024-06-03)
 
-* Initial release
+
+### ⚠ BREAKING CHANGES
+
+* add link
+
+### Documentation
+
+* add link ([1a5d327](https://github.com/shepherdjerred/webring/commit/1a5d327a002785809e84aab70b19d18dd135f78b))
+
+## [0.3.0](https://github.com/shepherdjerred/webring/compare/v0.2.0...v0.3.0) (2024-06-03)
+
+### Features
+
+- allow filename to be configurable ([cc7bb5f](https://github.com/shepherdjerred/webring/commit/cc7bb5f3139f306952d03568fc63cc9fcbfaad5e))

package/README.md

@@ -11,7 +11,7 @@ Inspired by:
 
 ## Installation
 
-```
+```bash
 npm i webring
 ```
 
@@ -19,14 +19,37 @@ npm i webring
 
 This library is meant to be used with static site generators. It is framework agnostic.
 
-### Astro
-
-### Command Line
-
-You can use this library to generate static HTML which can be included into your site using it's include mechanisms
-
-## Configuration
-
 ```typescript
-
+import { type Configuration, run } from "webring";
+
+// create a configuration object
+const config: Configuration = {
+  sources: [
+    {
+      url: "https://drewdevault.com/blog/index.xml",
+      title: "Drew DeVault",
+    },
+    {
+      url: "https://danluu.com/atom.xml",
+      title: "Dan Luu",
+    },
+    {
+      url: "https://jakelazaroff.com/rss.xml",
+      title: "Jake Lazaroff",
+    },
+  ],
+  number: 3,
+  cache_duration_minutes: 60,
+  truncate: 300,
+};
+
+// run the application
+const result = await run(config);
+
+// do something with the results
+result.map((entry) => {
+  console.log(entry);
+});
 ```
+
+I use this with Astro on my [personal website](https://github.com/shepherdjerred/sjer.red/blob/main/src/components/BlogWebring.astro#L17-L22).

package/dist/cache.js

@@ -1,6 +1,7 @@
 import * as R from "remeda";
+import { fetch } from "./fetch.js";
 export async function runWithCache(config, cache) {
-    const promises = R.pipe(config.sources, R.map((source) => fetchWithCache(source, cache, config)), R.filter((result) => result !== undefined));
+    const promises = R.pipe(config.sources, R.map((source) => fetchWithCache(source, cache, config)));
     const results = await Promise.all(promises);
     const definedResults = results.filter((result) => result !== undefined);
     const updatedCache = R.pipe(definedResults, R.map((result) => [result.source.url, { timestamp: new Date(), data: result }]), R.fromEntries());

package/dist/fetch.js

@@ -17,7 +17,7 @@ export async function fetch(source, length) {
             url: firstItem.link,
             date: new Date(firstItem.date),
             source,
-            preview: preview ? truncate(sanitizeHtml(preview), length) : undefined,
+            preview: preview ? truncate.default(sanitizeHtml(preview), length) : undefined,
         };
     }
     catch (e) {

package/dist/index.d.ts

@@ -1,2 +1,5 @@
 import { type Configuration, type Result } from "./types.js";
 export declare function run(config: Configuration): Promise<Result>;
+export * from "./types.js";
+export * from "./cache.js";
+export * from "./fetch.js";

package/dist/index.js

@@ -2,12 +2,10 @@ import { runWithCache } from "./cache.js";
 import { CacheSchema } from "./types.js";
 import fs from "fs/promises";
 export async function run(config) {
-    const cacheFilename = "cache.json";
-    const currentDir = process.cwd();
-    const fullFilename = `${currentDir}/${cacheFilename}`;
+    const cacheFilename = config.cache_file;
     let cacheObject = {};
     try {
-        const cacheFile = await fs.readFile(fullFilename);
+        const cacheFile = await fs.readFile(cacheFilename);
         cacheObject = CacheSchema.parse(JSON.parse(cacheFile.toString()));
     }
     catch (e) {
@@ -16,6 +14,9 @@ export async function run(config) {
     }
     const [result, updatedCache] = await runWithCache(config, cacheObject);
     // write the updated cache to cache.json
-    await fs.writeFile(fullFilename, JSON.stringify(updatedCache));
+    await fs.writeFile(cacheFilename, JSON.stringify(updatedCache));
     return result;
 }
+export * from "./types.js";
+export * from "./cache.js";
+export * from "./fetch.js";

package/dist/types.d.ts

@@ -22,9 +22,10 @@ declare const ConfigurationSchema: z.ZodObject<{
         url: string;
         title: string;
     }>, "many">;
-    number: z.ZodNumber;
-    cache_duration_minutes: z.ZodNumber;
-    truncate: z.ZodNumber;
+    number: z.ZodDefault<z.ZodNumber>;
+    cache_duration_minutes: z.ZodDefault<z.ZodNumber>;
+    truncate: z.ZodDefault<z.ZodNumber>;
+    cache_file: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     number: number;
     sources: {
@@ -33,14 +34,16 @@ declare const ConfigurationSchema: z.ZodObject<{
     }[];
     cache_duration_minutes: number;
     truncate: number;
+    cache_file: string;
 }, {
-    number: number;
     sources: {
         url: string;
         title: string;
     }[];
-    cache_duration_minutes: number;
-    truncate: number;
+    number?: number | undefined;
+    cache_duration_minutes?: number | undefined;
+    truncate?: number | undefined;
+    cache_file?: string | undefined;
 }>;
 export type ResultEntry = z.infer<typeof ResultEntrySchema>;
 declare const ResultEntrySchema: z.ZodObject<{

package/dist/types.js

@@ -1,13 +1,20 @@
 import { z } from "zod";
 const SourceSchema = z.object({
+    // the url of the feed
     url: z.string(),
+    // a title for the feed
     title: z.string(),
 });
 const ConfigurationSchema = z.object({
+    // list of sources to fetch
     sources: SourceSchema.array(),
-    number: z.number(),
-    cache_duration_minutes: z.number(),
-    truncate: z.number(),
+    // how many entries to return
+    number: z.number().default(3),
+    // how long to cache a results for
+    cache_duration_minutes: z.number().default(60),
+    // how many words to truncate the preview to
+    truncate: z.number().default(300),
+    cache_file: z.string().default("cache.json"),
 });
 const ResultEntrySchema = z.object({
     title: z.string(),

package/package.json

@@ -1,41 +1,51 @@
 {
   "name": "webring",
   "type": "module",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint src",
     "build": "tsc",
-    "test": ""
+    "prepare": "husky"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "remeda": "^2.0.0",
+    "remeda": "^2.0.1",
     "rss-parser": "^3.13.0",
     "sanitize-html": "^2.13.0",
     "truncate-html": "^1.1.1",
     "zod": "^3.23.8"
   },
   "devDependencies": {
-    "@eslint/js": "^9.3.0",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@eslint/js": "^9.4.0",
     "@tsconfig/node20": "^20.1.4",
     "@tsconfig/strictest": "^2.0.5",
     "@types/eslint__js": "^8.42.3",
-    "@types/node": "^20.12.13",
+    "@types/node": "^20.14.0",
     "@types/sanitize-html": "^2.11.0",
     "@typescript-eslint/eslint-plugin": "^7.11.0",
     "@typescript-eslint/parser": "^7.11.0",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.5",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.0",
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.11.0"
   },
   "lint-staged": {
-    "*.{js,jsx,ts,tsx}": "eslint --cache --fix",
+    "*.{ts,tsx}": "eslint --cache --fix",
     "*": "prettier --ignore-unknown --write"
   },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "prettier": {
+    "printWidth": 120
+  },
   "files": [
     "dist",
     "package.json",