reader-shell 1.0.0

package/README.md

@@ -0,0 +1,51 @@
+# 终端电子书阅读器
+
+一个基于 Node.js 的终端电子书阅读器，支持导入 epub 文件、记住阅读进度、快捷键翻页和字体颜色切换。
+
+## 功能特性
+- 支持导入 epub 电子书
+- 记住每本书的阅读进度（包括章节和章节内滚动位置）
+- 支持快捷键翻页、章节内滚动
+- 支持老板键一键隐藏内容
+- 纯终端操作，跨平台
+
+## 安装依赖
+
+```bash
+npm install
+```
+
+## 使用方法
+
+```bash
+node src/ui.js <你的电子书.epub>
+```
+
+例如：
+```bash
+node src/ui.js ./books/三体.epub
+```
+
+## 快捷键说明
+- `→` 或 `e`：下一章
+- `←` 或 `w`：上一章
+- `↑` 或 `s`：章节内向上滚动
+- `↓` 或 `d`：章节内向下滚动
+- `a`：老板键（快速隐藏/恢复内容）
+- `q` 或 `Ctrl+C`：退出阅读器
+
+## 进度存储
+- 阅读进度会自动保存在 `progress.json` 文件中，每本书独立记录。
+- 记忆内容包括：当前章节、章节内滚动位置。
+
+## 常见问题
+- **中文乱码**：已内置 HTML 实体解码和编码处理，绝大多数 epub 可正常显示中文。
+- **终端不显示中文**：请确保终端编码为 `UTF-8`，并使用支持中文的字体。
+
+## 依赖说明
+- [epub](https://www.npmjs.com/package/epub) 电子书解析
+- [blessed](https://www.npmjs.com/package/blessed) 终端 UI
+- [chalk](https://www.npmjs.com/package/chalk) 终端字体颜色
+
+## 许可协议
+MIT 

package/cli.js

@@ -0,0 +1 @@
+import './src/ui.js'

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "reader-shell",
+  "version": "1.0.0",
+  "main": "cli.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "blessed": "^0.1.81",
+    "chalk": "^5.4.1",
+    "epub": "^1.3.0"
+  }
+}

package/src/config.js

@@ -0,0 +1,18 @@
+export const config = {
+  fontColor: "white",
+  title: "node",
+  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&
+
+    Module Warning (from ./node_modules/@dcloudio/vue-cli-plugin-uni/packages/vue-loader/lib/loaders/templateLoader.js):
+    (Emitted value instead of an instance of Error) <v-uni-view v-for="label in item.label">: component lists rendered with v-for should have explicit keys. See https://vuejs.org/guide/list.html#key for more info.
+
+    @ ./src/pages/reader/index.vue?vue&type=template&id=6430da5c&scoped=true& 1:0-701 1:0-701
+    @ ./src/pages/reader/index.vue
+    @ ./src/pages.json
+    @ ./src/main.js
+    @ multi (webpack)-dev-server/client?http://localhost:8081/sockjs-node (webpack)/hot/dev-server.js ./src/main.js
+
+  `
+};

package/src/epubReader.js

@@ -0,0 +1,35 @@
+import EPub from 'epub';
+
+/**
+ * 解析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, '') + '\n\n 本章完';
+                    }
+                    loaded++;
+                    if (loaded === chapterIds.length) {
+                        resolve(chapters);
+                    }
+                });
+            });
+        });
+        epub.parse();
+    });
+}
+
+export { parseEpub };

package/src/progressStore.js

@@ -0,0 +1,42 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const STORE_PATH = path.join(__dirname, '../progress.json');
+
+function loadProgress() {
+    if (!fs.existsSync(STORE_PATH)) return {};
+    try {
+        return JSON.parse(fs.readFileSync(STORE_PATH, 'utf-8'));
+    } catch (e) {
+        return {};
+    }
+}
+
+function saveProgress(progress) {
+    fs.writeFileSync(STORE_PATH, JSON.stringify(progress, null, 2), 'utf-8');
+}
+
+function getBookProgress(bookPath) {
+    const progress = loadProgress();
+    const val = progress[bookPath];
+    if (typeof val === 'number') {
+        // 兼容旧数据
+        return { chapter: val, scroll: 0 };
+    }
+    return val || { chapter: 0, scroll: 0 };
+}
+
+function setBookProgress(bookPath, obj) {
+    const progress = loadProgress();
+    progress[bookPath] = obj;
+    saveProgress(progress);
+}
+
+export {
+    getBookProgress,
+    setBookProgress
+}; 

package/src/ui.js

@@ -0,0 +1,157 @@
+import blessed from "blessed";
+import chalk from "chalk";
+import { parseEpub } from "./epubReader.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(epubPath) {
+  const chapters = await parseEpub(epubPath);
+  const progress = getBookProgress(epubPath);
+  let currentChapter = (progress && progress.chapter) || 0;
+  let currentScroll = (progress && progress.scroll) || 0;
+
+  // 创建blessed屏幕
+  const screen = blessed.screen({
+    smartCSR: true,
+    fullUnicode: true,
+    title: config.title,
+  });
+
+  // 掩人耳目，假装在开发
+  const boss = blessed.box({
+    top: 0,
+    left: 0,
+    width: "100%",
+    height: "80%",
+    border: "none",
+    content: config.bossContent
+  });
+
+  // 章节内容框
+  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" },
+    },
+  });
+
+  // 状态栏
+  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);
+
+  function render() {
+    const colorFn = colorFns[fontColor] || chalk.white;
+    box.setContent(colorFn(chapters[currentChapter] || ""));
+    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();
+  }
+
+  function saveProgress() {
+    setBookProgress(epubPath, { chapter: currentChapter, scroll: currentScroll });
+  }
+
+  function changeChapter(chapter) {
+    currentChapter += chapter;
+    currentScroll = 0;
+    saveProgress();
+    render();
+  }
+
+  // 快捷键
+  screen.key(["right", "e"], () => {
+    if (currentChapter < chapters.length - 1) {
+      changeChapter(1)
+    }
+  });
+  screen.key(["left", "w"], () => {
+    if (currentChapter > 0) {
+      changeChapter(-1)
+    }
+  });
+  screen.key(["up", "s"], () => {
+    currentScroll--;
+    if (currentScroll < 0) {
+      changeChapter(-1)
+      return
+    }
+    render();
+  });
+  screen.key(["down", "d"], () => {
+    currentScroll++;
+    if (currentScroll > box.getScrollHeight()) {
+      changeChapter(1)
+      return
+    }
+    render();
+  });
+  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
+    }
+    render()
+  });
+  screen.key(["q", "C-c"], () => {
+    saveProgress();
+    process.exit(0);
+  });
+
+  box.on('scroll', () => {
+    saveProgress();
+  });
+
+  render();
+}
+
+// 允许命令行直接运行
+const epubPath = process.argv[2];
+if (!epubPath) {
+  console.error("用法: node src/ui.js <epub文件路径>");
+  process.exit(1);
+}
+startReader(path.resolve(epubPath));