comark-reading-time 0.0.0 → 0.7.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 onmax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,24 @@
 # comark-reading-time
 
-Placeholder. The first release is published from https://github.com/onmax/comark-plugins.
+[![npm version](https://comark-ui.onmax.me/badge.svg?source=npm-version&package=comark-reading-time&icon=npm)](https://npmx.dev/package/comark-reading-time)
+[![npm downloads](https://comark-ui.onmax.me/badge.svg?source=npm-downloads&package=comark-reading-time&period=month&icon=npm)](https://npmx.dev/package/comark-reading-time)
+[![license](https://comark-ui.onmax.me/badge.svg?label=license&value=MIT)](https://npmx.dev/package/comark-reading-time)
+[![docs](https://comark-ui.onmax.me/badge.svg?label=docs&value=comark-ui.onmax.me)](https://comark-ui.onmax.me/reading-time/)
+
+A document's word count and reading time, written to `meta.readingTime` while parsing. A [Comark](https://comark.dev) plugin for any renderer.
+
+```sh
+pnpm add comark comark-reading-time
+```
+
+```ts
+import { parseMarkdown } from "comark";
+import readingTime from "comark-reading-time";
+
+const { meta } = await parseMarkdown(markdown, { plugins: [readingTime({ wordsPerMinute: 200 })] });
+meta.readingTime; // { words: 1240, minutes: 7 }
+```
+
+Code blocks, frontmatter, and comments are left out; inline code counts. Chinese, Japanese, and Korean are counted by character, since they're written without spaces between words. `minutes` is rounded up, and 0 only for a document with no words. `countWords(text)` counts any string the same way.
+
+It draws nothing and has no components: show the numbers in your layout.

package/dist/index.d.mts

@@ -0,0 +1,20 @@
+//#region src/index.d.ts
+export interface ReadingTimeOptions {
+  /** How many words a reader reads a minute. Default 200. */
+  wordsPerMinute?: number;
+}
+export interface ReadingTime {
+  /** The words in the document's text, outside code blocks. Each CJK character counts as one. */
+  words: number;
+  /** `words` over the reading speed, rounded up. 0 for a document with no words. */
+  minutes: number;
+}
+export type ReadingTimeMeta = {
+  readingTime: ReadingTime;
+};
+/** Counts the words in a text: each CJK character, plus each run of other letters and digits between spaces. */
+export declare function countWords(text: string): number;
+/** Writes how long a document takes to read to `meta.readingTime`, as `{ words, minutes }`, leaving code blocks out. */
+declare const _default: import("comark").ComarkPluginFactory<ReadingTimeOptions, ReadingTimeMeta, {}>;
+//#endregion
+export { _default as default };

package/dist/index.mjs

@@ -0,0 +1,37 @@
+import { defineComarkPlugin } from "comark";
+//#region src/index.ts
+const CJK = /[\p{Script=Han}\p{Script=Hiragana}\p{Script=Katakana}\p{Script=Hangul}]/gu;
+const WORD = /[\p{L}\p{N}]/u;
+const RAW_CODE = /* @__PURE__ */ new Set([
+	"pre",
+	"script",
+	"style",
+	"textarea"
+]);
+/** The text of every node but code blocks, with a space between nodes so words in adjacent blocks stay apart. */
+function textOf(nodes, parts = []) {
+	for (const node of nodes) if (!Array.isArray(node)) parts.push(node);
+	else if (node[0] !== null && !RAW_CODE.has(node[0].toLowerCase())) {
+		const [, , ...children] = node;
+		textOf(children, parts);
+	}
+	return parts;
+}
+/** Counts the words in a text: each CJK character, plus each run of other letters and digits between spaces. */
+function countWords(text) {
+	return (text.match(CJK)?.length ?? 0) + text.replace(CJK, " ").split(/\s+/).filter((word) => WORD.test(word)).length;
+}
+/** Writes how long a document takes to read to `meta.readingTime`, as `{ words, minutes }`, leaving code blocks out. */
+var src_default = defineComarkPlugin((options = {}) => ({
+	name: "comark-reading-time",
+	post(state) {
+		const speed = options.wordsPerMinute ?? 200;
+		const words = countWords(textOf(state.tree.nodes).join(" "));
+		state.tree.meta.readingTime = {
+			words,
+			minutes: Math.ceil(words / (speed > 0 ? speed : 200))
+		};
+	}
+}));
+//#endregion
+export { countWords, src_default as default };

package/package.json

@@ -1,12 +1,50 @@
 {
   "name": "comark-reading-time",
-  "version": "0.0.0",
-  "description": "Placeholder. The first release is published from https://github.com/onmax/comark-plugins.",
+  "version": "0.7.1",
+  "description": "A document's word count and reading time in meta.readingTime, with code blocks left out and CJK counted by character. A Comark plugin.",
+  "keywords": [
+    "comark",
+    "markdown",
+    "mdc",
+    "plugin",
+    "reading-time",
+    "word-count"
+  ],
+  "homepage": "https://comark-ui.onmax.me/reading-time",
+  "bugs": "https://github.com/onmax/comark-ui/issues",
   "license": "MIT",
   "author": "onmax",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/onmax/comark-plugins.git",
+    "url": "git+https://github.com/onmax/comark-ui.git",
     "directory": "packages/reading-time"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "devDependencies": {
+    "@comark/html": "^0.8.1",
+    "comark": "^0.8.1"
+  },
+  "peerDependencies": {
+    "comark": "^0.8.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "doctor": "vite-doctor . --no-cache --max-warnings 0 --format text"
   }
-}
+}