random-word-wikipedia 1.1.0 → 2.1.0

package/cli.js

@@ -1,41 +1,42 @@
 #!/usr/bin/env node
 
-import meow from "meow";
-import randomWordWikipedia from "./index.js";
-
-const cli = meow(
-	`
-	Usage
-	  $ random-word-wikipedia [lang=en]
-
-	Options
-	  -n 10 or less [Default: 1]
-
-	Examples
-	  $ random-word-wikipedia
-		YuruYuri
-
-	  $ random-word-wikipedia ja -n 3
-		バダインジャラン砂漠
-		内野 (印西市)
-		PAC-MAN 256
-
-`,
-	{
-		importMeta: import.meta,
-		flags: {
-			n: {
-				type: "number"
-			}
-		}
+import { parseArgs } from "node:util";
+import randomWordWikipedia from "./lib/esm/index.js";
+
+const help = `
+  Usage
+    $ random-word-wikipedia [lang=en]
+
+  Options
+    -n  Number of words, 10 or less [Default: 1]
+
+  Examples
+    $ random-word-wikipedia
+    $ random-word-wikipedia ja -n 3
+`;
+
+const { values, positionals } = parseArgs({
+	allowPositionals: true,
+	options: {
+		n: { type: "string", short: "n" },
+		help: { type: "boolean", short: "h" }
 	}
-);
+});
+
+if (values.help) {
+	console.log(help);
+	process.exit(0);
+}
+
+const lang = positionals[0];
+const n = values.n === undefined ? 1 : Number(values.n);
 
-randomWordWikipedia(cli.input[0], cli.flags.n || 1)
+randomWordWikipedia(lang, n)
 	.then((res) => {
 		console.log(res.join("\n"));
 	})
 	.catch((err) => {
-		console.error("Error: err.message");
+		console.error(`Error: ${err.message}`);
 		console.error("$ random-word-wikipedia --help");
+		process.exit(1);
 	});

package/lib/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const randomWordWikipedia = async (lang = "en", n = 1) => {
+    if (typeof lang !== "string") {
+        throw new TypeError(`Expected a string, got ${typeof lang}`);
+    }
+    if (n <= 0 || n > 10) {
+        throw new TypeError(`Expected a -n (1 - 10), got ${n}`);
+    }
+    // rnlimit: API limit 10 or less
+    const url = `https://${lang}.wikipedia.org/w/api.php?format=json&action=query&list=random&rnnamespace=0&rnlimit=${n}`;
+    const res = await fetch(url);
+    const data = (await res.json());
+    const words = data.query.random;
+    return words.slice(-n).map((v) => v.title);
+};
+exports.default = randomWordWikipedia;

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/esm/index.js

@@ -0,0 +1,15 @@
+const randomWordWikipedia = async (lang = "en", n = 1) => {
+    if (typeof lang !== "string") {
+        throw new TypeError(`Expected a string, got ${typeof lang}`);
+    }
+    if (n <= 0 || n > 10) {
+        throw new TypeError(`Expected a -n (1 - 10), got ${n}`);
+    }
+    // rnlimit: API limit 10 or less
+    const url = `https://${lang}.wikipedia.org/w/api.php?format=json&action=query&list=random&rnnamespace=0&rnlimit=${n}`;
+    const res = await fetch(url);
+    const data = (await res.json());
+    const words = data.query.random;
+    return words.slice(-n).map((v) => v.title);
+};
+export default randomWordWikipedia;

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+declare const randomWordWikipedia: (lang?: string, n?: number) => Promise<string[]>;
+export default randomWordWikipedia;

package/package.json

@@ -1,31 +1,33 @@
 {
 	"name": "random-word-wikipedia",
 	"description": "Get random word from wikipedia random page",
-	"version": "1.1.0",
+	"version": "2.1.0",
 	"author": {
 		"name": "elzup",
 		"email": "guild0105@gmail.com",
 		"url": "https://anozon.me"
 	},
 	"type": "module",
+	"main": "lib/cjs/index.js",
+	"module": "lib/esm/index.js",
+	"types": "lib/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./lib/types/index.d.ts",
+			"import": "./lib/esm/index.js",
+			"require": "./lib/cjs/index.js"
+		}
+	},
 	"bin": {
 		"random-word-wikipedia": "./cli.js"
 	},
-	"dependencies": {
-		"es6-promise": "4.2.8",
-		"fetch-mock": "9.11.0",
-		"isomorphic-fetch": "3.0.0",
-		"meow": "10.1.2"
-	},
-	"devDependencies": {
-		"ava": "3.15.0"
-	},
+	"sideEffects": false,
 	"engines": {
-		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+		"node": ">=22"
 	},
 	"files": [
-		"cli.js",
-		"index.js"
+		"lib/",
+		"cli.js"
 	],
 	"keywords": [
 		"cli",
@@ -37,7 +39,19 @@
 	"license": "MIT",
 	"repository": "elzup/random-word-wikipedia",
 	"scripts": {
-		"test": "ava",
-		"cli": "node cli.js"
+		"clean": "rimraf lib",
+		"build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:types",
+		"build:cjs": "tsc --module commonjs --outDir lib/cjs && echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json",
+		"build:esm": "tsc --module esnext --outDir lib/esm",
+		"build:types": "tsc --declaration --emitDeclarationOnly --outDir lib/types",
+		"pretest": "npm run build",
+		"test": "node --test",
+		"cli": "node cli.js",
+		"prepublishOnly": "npm test"
+	},
+	"devDependencies": {
+		"@types/node": "^24.0.0",
+		"rimraf": "^6.0.0",
+		"typescript": "^5.6.0"
 	}
 }

package/readme.md

@@ -1,69 +1,79 @@
-# random-word-wikipedia [![Node.js CI](https://github.com/elzup/random-word-wikipedia/actions/workflows/node.js.yml/badge.svg)](https://github.com/elzup/random-word-wikipedia/actions/workflows/node.js.yml)
+# random-word-wikipedia
 
-> Get random word from wikipedia random page
+[![npm](https://img.shields.io/npm/v/random-word-wikipedia.svg)](https://www.npmjs.com/package/random-word-wikipedia)
+[![Node.js CI](https://github.com/elzup/random-word-wikipedia/actions/workflows/node.js.yml/badge.svg)](https://github.com/elzup/random-word-wikipedia/actions/workflows/node.js.yml)
+
+> Get a random word (article title) from Wikipedia's random page.
+
+- 🪶 **Zero runtime dependencies** — uses the platform `fetch`, nothing else
+- 📦 **ESM + CommonJS** with bundled **TypeScript types**, for Node.js `>= 22`
+- 🌍 **Any language** — pass a Wikipedia language code (`en`, `ja`, …)
 
 ## Install
 
-```
-$ npm install random-word-wikipedia
+```sh
+npm install random-word-wikipedia
 ```
 
 ## Usage
 
 ```js
-const randomWordWikipedia = require("random-word-wikipedia");
+import randomWordWikipedia from "random-word-wikipedia";
 
-randomWordWikipedia().then(console.log);
-//=> [ 'Saxifraga spathularis' ]
+await randomWordWikipedia();
+//=> ['Saxifraga spathularis']
 
-randomWordWikipedia("ja", 2).then(console.log);
-//=> [ 'ジョン・イサーク・ブリケ', '月は闇夜に隠るが如く' ]
+await randomWordWikipedia("ja", 2);
+//=> ['ジョン・イサーク・ブリケ', '月は闇夜に隠るが如く']
 ```
 
-## API
-
-### randomWordWikipedia([lang, n])
+CommonJS (note the `.default`):
 
-#### options
+```js
+const randomWordWikipedia = require("random-word-wikipedia").default;
 
-##### lang
+randomWordWikipedia().then(console.log);
+```
 
-Type: `string`<br>
-Default: `en`
+## API
 
-wikipedia lang string.
+### `randomWordWikipedia(lang?, n?)`
 
-##### n
+Returns `Promise<string[]>` — an array of random article titles.
 
-Type: `number` 1 - 10<br>
-Default: 1
+| Param  | Type     | Default | Description                                  |
+| ------ | -------- | ------- | -------------------------------------------- |
+| `lang` | `string` | `"en"`  | Wikipedia language code (e.g. `en`, `ja`).   |
+| `n`    | `number` | `1`     | How many words to return. Must be `1`–`10`.  |
 
-number of word.
+Throws a `TypeError` if `lang` is not a string or `n` is outside `1`–`10`.
 
 ## CLI
 
-```
-$ npm install --global random-word-wikipedia
+```sh
+npm install --global random-word-wikipedia
 ```
 
-```
-$ random-word-wikipedia --help
+```console
+$ random-word-wikipedia
+Mapania caudata
+
+$ random-word-wikipedia ja -n 3
+バダインジャラン砂漠
+内野 (印西市)
+PAC-MAN 256
 
-	Usage
-	  $ random-word-wikipedia [lang]
+$ random-word-wikipedia --help
 
-	Options
-	  -n 10 or less [Default: 1]
+  Usage
+    $ random-word-wikipedia [lang=en]
 
-	Examples
-	  $ random-word-wikipedia
-		YuruYuri
+  Options
+    -n  Number of words, 10 or less [Default: 1]
 
-	  $ random-word-wikipedia ja -n 4
-		バダインジャラン砂漠
-		ゆるゆり
-		内野 (印西市)
-		PAC-MAN 256
+  Examples
+    $ random-word-wikipedia
+    $ random-word-wikipedia ja -n 3
 ```
 
 ## License

package/index.js

@@ -1,28 +0,0 @@
-import "isomorphic-fetch";
-import promise from "es6-promise";
-promise.polyfill();
-
-const randomWordWikipedia = (lang, n = 1) => {
-	return new Promise(function (resolve, reject) {
-		lang = lang || "en";
-		if (typeof lang !== "string") {
-			throw new TypeError(`Expected a string, got ${typeof lang}`);
-		}
-
-		if (n <= 0 || n > 10) {
-			throw new TypeError(`Expected a -n (1 - 10), got ${n}`);
-		}
-
-		// rnlimit: API limit 10 or less
-		const url = `https://${lang}.wikipedia.org/w/api.php?format=json&action=query&list=random&rnnamespace=0&rnlimit=${n}`;
-
-		const res = fetch(url)
-			.then((res) => res.json())
-			.then((data) => {
-				const words = data.query.random;
-				resolve(words.slice(-n).map((v) => v.title));
-			});
-	});
-};
-
-export default randomWordWikipedia;