puzlink 0.1.0 → 0.1.1

package/README.md

@@ -6,9 +6,40 @@ Inspired by cosmologicon's [puzlink](https://github.com/cosmologicon/puzlink), r
 
 ## Usage
 
-...browser...
+Install with `npm install puzlink`. This is an ESM only library.
 
-...evals...
+```ts
+import { Puzlink } from "puzlink";
+
+const puzlink = await Puzlink.download();
+
+puzlink.link(`
+  BATED, TANK, BUSINESS, ETC, OVER, ELVIS, CAR, COW, MARS, PARIS, AIRLINES
+`);
+// {
+//   name: "10/11 can insert h",
+//   score: 30.8,
+//   description: [
+//     "bated insert h = bathed",
+//     "tank insert h = thank",
+//     "etc insert h = etch",
+//     "over insert h = hover",
+//     "elvis insert h = elvish",
+//     "car insert h = char",
+//     "cow insert h = chow",
+//     "mars insert h = marsh",
+//     "paris insert h = parish, pharis",
+//     "airlines insert h = hairlines"
+//   ],
+// },
+// ...
+```
+
+## Why?
+
+puzlink used to be online on [puz.link](https://puz.link/), but the website has been down for maintenance for a while now. While I've used the library locally, nothing can beat the convenience of a web app. I'm a believer in client-side solving tools, so I wanted to make it run client-side too; that's partly why I wrote [cromulence](https://blog.cjquines.com/post/cromulence/) a year ago.
+
+Collective.jl is a huge design influence. I liked the idea of applying the binomial distribution to boolean word properties, which I used for computing many linker probabilities. A lot of the test cases in `scripts/evals` are from Collective.jl too.
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puzlink",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Tool to find patterns among sets of words",
   "keywords": [
     "puzzles"

package/src/index.ts

@@ -1,3 +1,3 @@
 export { parse } from "./parse.js";
-export { Puzlink } from "./puzlink.js";
+export { download, Puzlink } from "./puzlink.js";
 export type { Link, LinkOptions } from "./puzlink.js";

package/src/parse.ts

@@ -1,3 +1,5 @@
+// This is in a separate file for tree-shaking reasons.
+
 /**
  * Parse an input to a list of slugs.
  *
@@ -6,6 +8,7 @@
  */
 export function parse(words: string | readonly string[]): string[] {
   if (typeof words === "string") {
+    words = words.trim();
     if (words.includes("\n")) {
       words = words.split("\n");
     } else if (words.includes(",")) {

package/src/puzlink.ts

@@ -59,6 +59,11 @@ export type LinkOptions = {
   ordered?: boolean;
 };
 
+/** Create a Puzlink instance by downloading the cromulence wordlist. */
+export async function download(): Promise<Puzlink> {
+  return new Puzlink(await loadWordlist());
+}
+
 export class Puzlink {
   linkers: Linker[];
 
@@ -66,10 +71,8 @@ export class Puzlink {
     this.linkers = allLinkers(new Wordlist(wordlist));
   }
 
-  /** Create a Puzlink instance by downloading the cromulence wordlist. */
-  static async download(): Promise<Puzlink> {
-    return new Puzlink(await loadWordlist());
-  }
+  static download = download;
+  static parse = parse;
 
   private *linkLazy(
     slugs: string[],