reader-shell 1.0.4 → 1.0.6

package/README.md

@@ -1,11 +1,13 @@
 # 终端电子书阅读器
 
-一个基于 Node.js 的终端电子书阅读器，支持导入 epub 文件、记住阅读进度、快捷键翻页。
+一个基于 Node.js 和 Ink 的全屏终端电子书阅读器，支持导入 epub/txt 文件、记住阅读进度、快捷键翻页。
 
 ![reader-shell-demo.gif?raw=true](https://cdn.jsdelivr.net/gh/jichangee/gallery@master/imgur/reader-shell-demo.gif?raw=true)
 
 ## 功能特性
-- 支持导入 epub 电子书
+- 支持导入 epub、txt 电子书
+- Codex CLI 风格的全屏阅读界面
+- 根据终端尺寸自动调整正文宽度和页高
 - 记住每本书的阅读进度（包括章节和章节内滚动位置）
 - 支持快捷键翻页、章节内滚动
 - 支持老板键一键隐藏内容
@@ -13,6 +15,8 @@
 
 ## 安装依赖
 
+需要 Node.js 22.6 或更高版本。
+
 ```bash
 npm install
 ```
@@ -33,6 +37,9 @@ node src/ui.js ./books/三体.epub
 - `←` 或 `w`：上一章
 - `↑` 或 `s`：章节内向上滚动
 - `↓` 或 `d`：章节内向下滚动
+- `PageUp` / `PageDown`：整页滚动
+- `Home` / `End`：跳到章节开头/结尾
+- `Space`：向下翻页
 - `a`：老板键（快速隐藏/恢复内容）
 - `q` 或 `Ctrl+C`：退出阅读器
 
@@ -46,8 +53,8 @@ node src/ui.js ./books/三体.epub
 
 ## 依赖说明
 - [epub](https://www.npmjs.com/package/epub) 电子书解析
-- [blessed](https://www.npmjs.com/package/blessed) 终端 UI
-- [chalk](https://www.npmjs.com/package/chalk) 终端字体颜色
+- [Ink](https://www.npmjs.com/package/ink) 终端 UI
+- [React](https://www.npmjs.com/package/react) 组件与状态管理
 
 ## 许可协议
 MIT 

package/cli.js

@@ -6,4 +6,9 @@ if (!filePath) {
   console.error('用法: reader-shell <文件路径>');
   process.exit(1);
 }
-startReader(path.resolve(filePath));
+try {
+  await startReader(path.resolve(filePath));
+} catch (error) {
+  console.error(error instanceof Error ? error.message : error);
+  process.exitCode = 1;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reader-shell",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "cli.js",
   "type": "module",
   "scripts": {
@@ -10,13 +10,21 @@
   "author": "",
   "license": "ISC",
   "description": "",
+  "files": [
+    "cli.js",
+    "src"
+  ],
+  "engines": {
+    "node": ">=22.6.0"
+  },
   "dependencies": {
-    "blessed": "^0.1.81",
-    "chalk": "^5.4.1",
-    "epub": "^1.3.0",
-    "iconv-lite": "^0.7.0"
+    "epub": "^2.1.1",
+    "iconv-lite": "^0.7.0",
+    "ink": "^7.1.1",
+    "react": "^19.3.0",
+    "wrap-ansi": "^10.0.2"
   },
   "bin": {
-    "reader-shell": "./cli.js"
+    "reader-shell": "cli.js"
   }
 }

package/src/config.js

@@ -1,6 +1,10 @@
 export const config = {
-  fontColor: "white",
-  title: "node",
+  readingWidth: 88,
+  colors: {
+    accent: "cyan",
+    border: "gray",
+    text: "white",
+  },
   bossContent: ` @ multi (webpack)-dev-server/client?http://localhost:8081/sockjs-node (webpack)/hot/dev-server.js ./src/main.js
 
     warning  in ./src/pages/reader/index.vue?vue&type=template&id=6430da5c&scoped=true&
@@ -15,4 +19,4 @@ export const config = {
     @ multi (webpack)-dev-server/client?http://localhost:8081/sockjs-node (webpack)/hot/dev-server.js ./src/main.js
 
   `
-};
+};

package/src/epubReader.js

@@ -1,35 +1,61 @@
 import EPub from 'epub';
 
+function decodeHtmlEntities(text) {
+    const entities = {
+        amp: '&',
+        apos: "'",
+        gt: '>',
+        lt: '<',
+        nbsp: ' ',
+        quot: '"'
+    };
+
+    return text.replace(/&(#(?:x[0-9a-f]+|\d+)|[a-z]+);/gi, (match, entity) => {
+        if (entity[0] === '#') {
+            const isHex = entity[1].toLowerCase() === 'x';
+            const value = Number.parseInt(entity.slice(isHex ? 2 : 1), isHex ? 16 : 10);
+            return Number.isNaN(value) || value > 0x10FFFF
+                ? match
+                : String.fromCodePoint(value);
+        }
+
+        return entities[entity.toLowerCase()] ?? match;
+    });
+}
+
+function htmlToReadableText(html) {
+    const text = html
+        .replace(/<(script|style)[^>]*>[\s\S]*?<\/\1>/gi, '')
+        .replace(/<br\s*\/?\s*>/gi, '\n')
+        .replace(/<\/(?:p|div|section|article|blockquote|h[1-6]|li)>/gi, '\n\n')
+        .replace(/<li[^>]*>/gi, '• ')
+        .replace(/<[^>]+>/g, '');
+
+    return decodeHtmlEntities(text)
+        .replace(/\r\n?/g, '\n')
+        .replace(/[ \t]+\n/g, '\n')
+        .replace(/\n[ \t]+/g, '\n')
+        .replace(/\n{3,}/g, '\n\n')
+        .trim();
+}
+
 /**
  * 解析epub文件，返回章节文本数组
  * @param {string} epubPath epub文件路径
  * @returns {Promise<string[]>} 章节文本数组
  */
-function parseEpub(epubPath) {
-    return new Promise((resolve, reject) => {
-        const epub = new EPub(epubPath);
-        epub.on('error', reject);
-        epub.on('end', function() {
-            const chapterIds = epub.flow.map(ch => ch.id);
-            const chapters = [];
-            let loaded = 0;
-            chapterIds.forEach((id, idx) => {
-                epub.getChapterRaw(id, (err, data) => {
-                    if (err) {
-                        chapters[idx] = '';
-                    } else {
-                        let text = data.toString('utf-8');
-                        chapters[idx] = text.replace(/<[^>]+>/g, '').replace(/\r\n/g, '');
-                    }
-                    loaded++;
-                    if (loaded === chapterIds.length) {
-                        resolve(chapters);
-                    }
-                });
-            });
-        });
-        epub.parse();
-    });
+async function parseEpub(epubPath) {
+    const epub = new EPub(epubPath);
+    await epub.parse();
+
+    return Promise.all(epub.flow.map(async ({ id }) => {
+        try {
+            const text = await epub.getChapterRaw(id);
+            return htmlToReadableText(text);
+        } catch {
+            return '';
+        }
+    }));
 }
 
 export { parseEpub };

package/src/txtReader.js

@@ -150,7 +150,9 @@ function parseTxt(txtPath) {
             chapters = chapters.map(chapter => {
                 return chapter
                     .replace(/\r\n/g, '\n')  // 统一换行符
-                    .replace(/\n{3,}/g, '\n\n')  // 去除多余的空行
+                    .replace(/[ \t]+\n/g, '\n')  // 去除行尾空白
+                    .replace(/\n[ \t]+/g, '\n')  // 去除空行中的空白
+                    .replace(/\n{3,}/g, '\n\n')  // 合并过多的空行
                     .trim();
             }).filter(chapter => chapter.length > 0);
 
@@ -161,4 +163,4 @@ function parseTxt(txtPath) {
     });
 }
 
-export { parseTxt, detectEncoding, readFileWithCorrectEncoding };
+export { parseTxt, detectEncoding, readFileWithCorrectEncoding };

package/src/ui.js

@@ -1,179 +1,274 @@
-import blessed from "blessed";
-import chalk from "chalk";
+import path from "path";
+import { pathToFileURL } from "url";
+import React, { useEffect, useMemo, useState } from "react";
+import { Box, Text, render, useApp, useInput, useWindowSize } from "ink";
+import wrapAnsi from "wrap-ansi";
 import { parseEpub } from "./epubReader.js";
 import { parseTxt } from "./txtReader.js";
-import path from "path";
 import { getBookProgress, setBookProgress } from "./progressStore.js";
 import { config } from "./config.js";
-import fs from 'fs';
-
-// 默认字体颜色
-let fontColor = config.fontColor;
-const colorFns = {
-  white: chalk.white,
-  green: chalk.green,
-  cyan: chalk.cyan,
-  magenta: chalk.magenta,
-  yellow: chalk.yellow,
-};
 
-async function startReader(filePath) {
-  const ext = path.extname(filePath).toLowerCase();
-  let chapters;
+const h = React.createElement;
 
-  if (ext === '.epub') {
-    chapters = await parseEpub(filePath);
-  } else if (ext === '.txt') {
-    chapters = await parseTxt(filePath);
-  } else {
-    throw new Error(`不支持的文件格式: ${ext}`);
-  }
+function formatChapterParagraphs(content) {
+  const lines = content
+    .replace(/\r\n?/g, "\n")
+    .split("\n")
+    .map((line) => line.trim())
+    .filter(Boolean);
 
-  const progress = getBookProgress(filePath);
-  let currentChapter = (progress && progress.chapter) || 0;
-  let currentScroll = (progress && progress.scroll) || 0;
+  return lines.map((line, index) => {
+    const isHeading = /^第[一二三四五六七八九十百千万零〇0-9]+[章节卷部篇回]/.test(line)
+      || index === 0 && line.length <= 30;
 
-  // 创建blessed屏幕
-  const screen = blessed.screen({
-    smartCSR: true,
-    fullUnicode: true,
-    title: config.title,
+    return {
+      text: isHeading ? line : `　　${line}`,
+      isHeading,
+    };
   });
+}
 
-  // 掩人耳目，假装在开发
-  const boss = blessed.box({
-    top: 0,
-    left: 0,
-    width: "100%",
-    height: "70%",
-    border: "none",
-    content: config.bossContent
-  });
+function buildDisplayLines(content, width) {
+  const result = [];
 
-  // 章节内容框
-  const box = blessed.box({
-    top: "70%",
-    left: 0,
-    width: "300",
-    height: "30%",
-    tags: true,
-    scrollable: true,
-    alwaysScroll: true,
-    keys: true,
-    focused: true,
-    mouse: true,
-    vi: true,
-    border: "none",
-    style: {
-      fg: fontColor,
-      border: { fg: "cyan" },
-    },
-  });
+  for (const paragraph of formatChapterParagraphs(content)) {
+    const wrappedLines = wrapAnsi(paragraph.text, width, {
+      hard: true,
+      trim: false,
+      wordWrap: true,
+    }).split("\n");
 
-  // 状态栏
-  const status = blessed.box({
-    bottom: 0,
-    left: 0,
-    width: "100%",
-    height: "10%",
-    tags: true,
-    style: { fg: fontColor },
-  });
-  screen.append(boss);
-  screen.append(box);
-  screen.append(status);
+    result.push(...wrappedLines.map((text) => ({
+      text,
+      isHeading: paragraph.isHeading,
+    })));
+    result.push({ text: "", isHeading: false });
+  }
+
+  if (result.length > 0) {
+    result.pop();
+  }
+
+  return result;
+}
+
+function ProgressBar({ value, width }) {
+  const safeValue = Math.max(0, Math.min(1, value));
+  const completed = Math.round(width * safeValue);
+
+  return h(Text, null,
+    h(Text, { color: config.colors.accent }, "━".repeat(completed)),
+    h(Text, { dimColor: true }, "─".repeat(width - completed)),
+  );
+}
 
-  // 用于跟踪当前显示的章节，避免重复设置相同内容
-  let lastDisplayedChapter = -1;
+function BossView({ rows }) {
+  const visibleContent = config.bossContent
+    .trim()
+    .split("\n")
+    .slice(0, Math.max(1, rows - 3))
+    .join("\n");
 
-  function render(forceContentRefresh = false) {
-    const colorFn = colorFns[fontColor] || chalk.white;
+  return h(Box, {
+    height: rows,
+    flexDirection: "column",
+    paddingX: 2,
+    paddingTop: 1,
+  },
+  h(Text, { color: "yellow" }, visibleContent),
+  h(Box, { marginTop: 1 }, h(Text, { dimColor: true }, "Press a to return")),
+  );
+}
+
+function ReaderApp({ chapters, filePath, initialProgress }) {
+  const { exit } = useApp();
+  const { columns, rows } = useWindowSize();
+  const [chapter, setChapter] = useState(() => Math.min(
+    Math.max(initialProgress?.chapter ?? 0, 0),
+    Math.max(chapters.length - 1, 0),
+  ));
+  const [scroll, setScroll] = useState(() => Math.max(initialProgress?.scroll ?? 0, 0));
+  const [isDisguised, setIsDisguised] = useState(false);
+
+  const panelWidth = Math.min(config.readingWidth + 6, Math.max(20, columns - 2));
+  const contentWidth = Math.max(12, panelWidth - 6);
+  const viewportHeight = Math.max(3, rows - 9);
+  const lines = useMemo(
+    () => buildDisplayLines(chapters[chapter] || "", contentWidth),
+    [chapter, chapters, contentWidth],
+  );
+  const maxScroll = Math.max(0, lines.length - viewportHeight);
+  const safeScroll = Math.min(scroll, maxScroll);
+  const visibleLines = lines.slice(safeScroll, safeScroll + viewportHeight);
+  const progress = chapters.length === 0
+    ? 0
+    : (chapter + (maxScroll === 0 ? 1 : safeScroll / maxScroll)) / chapters.length;
+  const progressWidth = Math.max(8, Math.min(28, panelWidth - 22));
 
-    // 只有当章节改变或强制刷新时才重新设置内容
-    if (forceContentRefresh || lastDisplayedChapter !== currentChapter) {
-      box.setContent(colorFn(chapters[currentChapter] || ""));
-      lastDisplayedChapter = currentChapter;
+  useEffect(() => {
+    if (scroll > maxScroll) {
+      setScroll(maxScroll);
     }
+  }, [maxScroll, scroll]);
 
-    status.setContent(
-      `progress: ${currentScroll}/${box.getScrollHeight()}  |  chapter: ${currentChapter + 1}/${
-        chapters.length
-      }  |  ←/w:prev →/e:next ↑/s:up ↓/d:down a:boss q:exit`
-    );
-    // 恢复滚动位置
-    box.setScroll(currentScroll);
-    screen.render();
-  }
+  useEffect(() => {
+    setBookProgress(filePath, { chapter, scroll: safeScroll });
+  }, [chapter, filePath, safeScroll]);
 
-  function saveProgress() {
-    setBookProgress(filePath, { chapter: currentChapter, scroll: currentScroll });
+  function changeChapter(offset) {
+    setChapter((current) => Math.min(Math.max(current + offset, 0), chapters.length - 1));
+    setScroll(0);
   }
 
-  function changeChapter(chapter) {
-    currentChapter += chapter;
-    currentScroll = 0;
-    saveProgress();
-    render(true); // 切换章节时强制刷新内容
+  function moveScroll(offset) {
+    setScroll((current) => Math.min(Math.max(current + offset, 0), maxScroll));
   }
 
-  // 快捷键
-  screen.key(["right", "e"], () => {
-    if (currentChapter < chapters.length - 1) {
-      changeChapter(1)
-    }
-  });
-  screen.key(["left", "w"], () => {
-    if (currentChapter > 0) {
-      changeChapter(-1)
+  useInput((input, key) => {
+    if (input === "q") {
+      setBookProgress(filePath, { chapter, scroll: safeScroll });
+      exit();
+      return;
     }
-  });
-  screen.key(["up", "s"], () => {
-    currentScroll--;
-    if (currentScroll < 0) {
-      changeChapter(-1)
-      return
+
+    if (input === "a") {
+      setIsDisguised((value) => !value);
+      return;
     }
-    render(true);
-  });
-  screen.key(["down", "d"], () => {
-    currentScroll++;
-    if (currentScroll > box.getScrollHeight()) {
-      changeChapter(1)
-      return
+
+    if (isDisguised) {
+      return;
     }
-    render(true);
-  });
-  screen.key(["a"], () => {
-    // 老板键
-    if (box.height === 0) {
-      boss.height = '80%'
-      box.height = '30%'
-      status.height = '10%'
-    } else {
-      boss.height = '100%'
-      box.height = 0
-      status.height = 0
+
+    if (key.leftArrow || input === "w") {
+      changeChapter(-1);
+    } else if (key.rightArrow || input === "e") {
+      changeChapter(1);
+    } else if (key.upArrow || input === "s") {
+      if (safeScroll === 0 && chapter > 0) {
+        changeChapter(-1);
+      } else {
+        moveScroll(-1);
+      }
+    } else if (key.downArrow || input === "d") {
+      if (safeScroll === maxScroll && chapter < chapters.length - 1) {
+        changeChapter(1);
+      } else {
+        moveScroll(1);
+      }
+    } else if (key.pageUp) {
+      moveScroll(-(viewportHeight - 1));
+    } else if (key.pageDown || input === " ") {
+      moveScroll(viewportHeight - 1);
+    } else if (key.home) {
+      setScroll(0);
+    } else if (key.end) {
+      setScroll(maxScroll);
     }
-    render(false) // 老板键切换时不强制刷新内容
   });
-  screen.key(["q", "C-c"], () => {
-    saveProgress();
-    process.exit(0);
+
+  if (isDisguised) {
+    return h(BossView, { rows });
+  }
+
+  const lineNodes = Array.from({ length: viewportHeight }, (_, index) => {
+    const line = visibleLines[index];
+    return h(Text, {
+      key: safeScroll + index,
+      bold: line?.isHeading,
+      color: line?.isHeading ? config.colors.accent : config.colors.text,
+      wrap: "truncate-end",
+    }, line?.text || " ");
   });
 
-  box.on('scroll', () => {
-    saveProgress();
+  return h(Box, {
+    width: columns,
+    height: rows,
+    flexDirection: "column",
+    paddingX: columns > 40 ? 1 : 0,
+  },
+  h(Box, {
+    width: panelWidth,
+    alignSelf: "center",
+    justifyContent: "space-between",
+  },
+  h(Text, { wrap: "truncate-middle" },
+    h(Text, { bold: true, color: config.colors.accent }, "reader-shell"),
+    h(Text, { dimColor: true }, `  ${path.basename(filePath)}`),
+  ),
+  h(Text, { dimColor: true, wrap: "truncate-end" }, `${chapter + 1} / ${chapters.length}`),
+  ),
+  h(Box, {
+    width: panelWidth,
+    height: viewportHeight + 4,
+    alignSelf: "center",
+    flexDirection: "column",
+    borderStyle: "round",
+    borderColor: config.colors.border,
+    paddingX: 2,
+    paddingY: 1,
+    marginTop: 1,
+  }, ...lineNodes),
+  h(Box, {
+    width: panelWidth,
+    alignSelf: "center",
+    justifyContent: "space-between",
+    marginTop: 1,
+  },
+  h(Box, null,
+    h(ProgressBar, { value: progress, width: progressWidth }),
+    h(Text, { dimColor: true }, `  ${Math.round(progress * 100)}%`),
+  ),
+  h(Text, { dimColor: true }, `${safeScroll + 1} / ${Math.max(lines.length, 1)}`),
+  ),
+  h(Box, { width: panelWidth, alignSelf: "center" },
+    h(Text, { dimColor: true, wrap: "truncate-end" }, "↑↓ scroll  PgUp/PgDn page  ←→ chapter  a hide  q quit"),
+  ),
+  );
+}
+
+async function loadChapters(filePath) {
+  const ext = path.extname(filePath).toLowerCase();
+
+  if (ext === ".epub") {
+    return parseEpub(filePath);
+  }
+
+  if (ext === ".txt") {
+    return parseTxt(filePath);
+  }
+
+  throw new Error(`不支持的文件格式: ${ext}`);
+}
+
+async function startReader(filePath) {
+  const loadedChapters = await loadChapters(filePath);
+  const chapters = loadedChapters.length > 0
+    ? loadedChapters
+    : ["（没有可显示的内容）"];
+  const instance = render(h(ReaderApp, {
+    chapters,
+    filePath,
+    initialProgress: getBookProgress(filePath),
+  }), {
+    alternateScreen: true,
+    incrementalRendering: true,
   });
 
-  render(true); // 初始渲染时强制设置内容
+  return instance.waitUntilExit();
 }
 
-// 允许命令行直接运行
-const filePath = process.argv[2];
-if (!filePath) {
-  console.error("用法: node src/ui.js <文件路径>");
-  process.exit(1);
+const isDirectRun = process.argv[1]
+  && import.meta.url === pathToFileURL(path.resolve(process.argv[1])).href;
+
+if (isDirectRun) {
+  const filePath = process.argv[2];
+  if (!filePath) {
+    console.error("用法: node src/ui.js <文件路径>");
+    process.exitCode = 1;
+  } else {
+    await startReader(path.resolve(filePath));
+  }
 }
-startReader(path.resolve(filePath));
 
-export { startReader };
+export { buildDisplayLines, formatChapterParagraphs, startReader };

package/.claude/settings.local.json

@@ -1,14 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(git add:*)",
-      "Bash(git commit:*)",
-      "Bash(git push:*)",
-      "Bash(node:*)",
-      "Bash(timeout:*)",
-      "Read(//Users/xuejichang/Documents/book/**)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}