gwe-engine 3.2.0

package/README.md

@@ -0,0 +1,265 @@
+# GWE - Generic Web-novel Engine 网文追读力引擎
+
+> 「读者手指划到你的正文，只有3秒决定要不要看下去。不是三章，是三秒。」
+
+GWE 是一个专为中文网文设计的**质量检测与评分引擎**。它通过7维雷达评分、26项质量规则、身体锚点检测，帮你写出不被划走的网文。
+
+- **零依赖**：纯 TypeScript 实现，无 NLP 库、无模型依赖、可在浏览器和 Node.js 运行
+- **7维评分**：身体反应/感官信号/动作推进/情绪张力/信息推进/转折密度/章末钩子
+- **26条规则**：覆盖开篇3秒、假钩子、AI水文、套路反应、水词填充等常见问题
+- **锚点三级制**：套路反应（×0.2）、普通反应（×1.0）、高质量生理反应（×1.8）
+- **22个配置节点**：平台（起点/番茄/七猫/晋江）、题材（仙侠/都市/科幻/悬疑）、风格（节奏/视角/修辞/语调）等细粒度调优
+- **12个内置预设**：从起点仙侠到番茄都市，开箱即用
+
+## 快速开始
+
+### CLI 命令行（推荐用于批量检测）
+
+```bash
+# 安装
+npm install -g gwe-engine
+
+# 检测一个章节
+gwe check chapter.txt
+
+# 从标准输入读取
+cat chapter.txt | gwe -
+
+# JSON 输出（用于程序集成）
+gwe --json chapter.txt > report.json
+```
+
+输出示例：
+
+```
+  GWE V3.2.0 网文追读力检测  chapter.txt
+
+  综合得分: 84.7分  (通过)  字数: 388字  ⚠  及格
+
+  ─── 7维雷达评分 ───
+  身体反应    ██████████████░░░░░░  73
+  感官信号    ████████████████████ 100
+  动作推进    ████████████████████ 100
+  情绪张力    ████████████████████ 100
+  信息推进    ████████████████████ 100
+  转折密度    ████████████████████ 100
+  章末钩子    ███████████████░░░░░  78
+
+  ─── 违规项 (0 error, 1 warning, 2 info) ───
+
+  ⚠ [连续对话过多] 有 5 句连续对话未穿插动作/描写，上限为 4 句
+      → 在对话之间插入角色的动作、表情或环境描写
+
+  ℹ [视觉描写占比过高] 视觉描写占比 54%，上限为 45%
+      → 减少纯视觉描写，加入其他感官体验
+
+  ℹ [比喻过多] 全文比喻密度千字5.2个，超过5个/千字
+```
+
+### 代码调用（Node.js / 浏览器）
+
+```typescript
+import { createEngineWithKB, MockProvider } from 'gwe-engine';
+
+// 创建引擎实例（自动加载所有内置知识库）
+const { engine } = createEngineWithKB(new MockProvider());
+
+// 检测章节文本
+const result = engine.check(chapterText);
+
+console.log(`得分: ${result.score}`);
+console.log(`通过: ${result.passed}`);
+console.log(`7维评分:`, result.radarScores);
+console.log(`违规项:`, result.violations);
+```
+
+### 配合 LLM 使用（AI写作）
+
+```typescript
+import { createEngineWithKB, OpenAICompatibleProvider } from 'gwe-engine';
+
+const provider = new OpenAICompatibleProvider({
+  apiKey: 'your-api-key',
+  baseURL: 'https://api.deepseek.com/v1',
+  model: 'deepseek-chat',
+});
+
+const { engine } = createEngineWithKB(provider);
+
+// 选择预设（番茄都市风格）
+engine.selectPreset('preset_urban_tomato');
+
+// 生成章节
+const stream = await engine.writeChapter({
+  outline: '主角获得系统，第一次使用就遇到危机',
+  previousChapter: '...',
+  onDelta: (text) => process.stdout.write(text),
+});
+```
+
+## 评分说明
+
+| 分数区间 | 等级 | 说明 |
+|---------|------|------|
+| ≥90分 | 🏆 优秀 | 对标一线热门网文，追读力极强 |
+| ≥85分 | ✅ 良好 | 达到发布标准，读者留存率高 |
+| ≥75分 | ⚠ 及格 | 有明显问题，需要修改 |
+| ≥60分 | ⚠ 较差 | 较多问题，建议重写关键段落 |
+| <60分 | ✗ 不达标 | 质量不合格，读者会直接划走 |
+
+## 对比测试
+
+我们用 GWE 对三类文本进行了盲测：
+
+| 文本类型 | 字数 | 综合得分 | 身体反应 | 感官信号 | 动作推进 | 情绪张力 | 信息推进 | 转折密度 | 章末钩子 | 违规数 |
+|---------|------|---------|---------|---------|---------|---------|---------|---------|---------|-------|
+| 追读力风格（矿工式） | 388字 | **84.7** | 73 | 100 | 100 | 100 | 100 | 100 | 78 | 3 |
+| 经典套路开头（系统流） | 372字 | **84.4** | 92 | 100 | 100 | 83 | 100 | 99 | 68 | 3 |
+| AI写景水文 | 391字 | **57** | 73 | 90 | 97 | 77 | 61 | 53 | 68 | 9 |
+
+### 检测效果对比
+
+**AI写景水文（57分，9项违规）被精准识别的问题：**
+- ⚠ 开篇首句49字，太长，读者扫一眼就划走
+- ⚠ 开篇写景/背景开头，浪费黄金3秒
+- ⚠ 连续比喻过密（"宛如泼墨山水画""如水的月光"）
+- ⚠ 空洞成语堆砌（连绵起伏、美不胜收、波光粼粼）
+- ⚠ 填充词过多（"仿佛""不禁""淡淡"）
+- ℹ 短句占比不足（目标40%，实际21%）
+- ℹ 视觉描写占比过高（58%，上限45%）
+
+**矿工式追读文（84.7分）：**
+- 首句"疼。"仅1字，直接切入身体感受
+- 全程无空泛写景，信息密度极高
+- 章末断裂钩子"是红色。"制造强悬念
+- 唯一的问题是短篇片段的锚点密度稍低
+
+## 7维雷达评分体系
+
+GWE 从7个维度评估网文的追读力：
+
+| 维度 | 核心问题 | 评分依据 |
+|------|---------|---------|
+| **身体反应** | 读者有没有"感受到痛"？ | 身体锚点密度、质量分级、千字锚点数 |
+| **感官信号** | 五感有没有被调动？ | 视觉/听觉/触觉/嗅觉/味觉词频 |
+| **动作推进** | 故事有没有在动？ | 动作动词密度、对话标签、静态描写比例 |
+| **情绪张力** | 有没有让人心跳加速？ | 情绪词、紧迫感、反差、冲突信号 |
+| **信息推进** | 有没有在给新信息？ | 新名词/新概念出现频率，信息量增量 |
+| **转折密度** | 有没有意外？ | 转折词、认知颠覆、反转信号频率 |
+| **章末钩子** | 读者会不会点下一章？ | 最后100字的新信息密度、悬念质量 |
+
+## 26条检测规则
+
+GWE 内置26条检测规则，覆盖网文写作的核心陷阱：
+
+**Error级（必须修改）：**
+- 开篇300字内出现写景/回忆/背景交代
+- 连续3句以上空洞描写无动作
+- 假钩子（"一股神秘气息""不祥的预感"）
+- 连续对话超过上限未穿插动作
+
+**Warning级（建议修改）：**
+- 首句超过20字
+- 填充词密度过高
+- 锚点数量不足
+- AI套路反应（"瞳孔一缩""叹了口气"）
+- 比喻密度过高
+- 成语堆砌代替具体描写
+- 连续段落过长
+- 对话标签重复
+- 视觉描写占比过高
+- 连续对话未穿插动作
+- 开篇用环境/背景词开头
+
+**Info级（优化建议）：**
+- 短句占比不足
+- 平均段长过长
+- 对话占比异常
+- 五感分布不均
+- 比喻密度偏高
+
+## 22个配置节点
+
+| 节点 | 选项数 | 说明 |
+|------|-------|------|
+| 平台适配 | 7 | 起点/番茄/七猫/飞卢/晋江/新媒体/通用 |
+| 题材词库 | 11 | 仙侠/都市/科幻/悬疑/历史/军事/电竞/恐怖/日常/奇幻/通用 |
+| 视角 | 6 | 一/三人称 × 过去/现在时 × 有限/全知 |
+| 目标字数 | 5 | 1500/2200/3000/4000/自定义 |
+| 段落密度 | 3 | 低/中/高 |
+| 句长节奏 | 4 | 短句/中句/长短混合/长句 |
+| 锚点密度 | 4 | 稀疏/标准/密集/极端 |
+| 开头力度 | 3 | 弱/中/强冲击 |
+| 结尾钩子 | 3 | 柔和/悬念/断裂 |
+| 信息密度 | 3 | 悠闲/平衡/快速 |
+| 情绪风格 | 3 | Show/Tell/混合 |
+| 对话风格 | 4 | 极简/自然/风格化/话痨 |
+| 描写风格 | 4 | 白描/极简/感官/诗意 |
+| 战斗风格 | 4 | 氛围/细节/心理/结果 |
+| 修辞风格 | 4 | 平实/比喻/华丽/写意 |
+| 语调 | 7 | 严肃/冷硬/痞气/古风/口语/俏皮/冷峻 |
+| 反转频率 | 3 | 稀疏/标准/密集 |
+| 回报频率 | 3 | 每章/每3章/稀疏 |
+| 水词过滤 | 4 | 宽松/标准/严格/网文专用 |
+| 检测严格度 | 3 | 宽松/标准/严格 |
+| AI续写长度 | 4 | 短/中/长/超长 |
+| AI创造性 | 3 | 保守/平衡/大胆 |
+
+## 12个内置预设
+
+- `preset_xianxia_qidian` - 起点仙侠
+- `preset_xianxia_tomato` - 番茄仙侠
+- `preset_urban_tomato` - 番茄都市
+- `preset_urban_jinjiang` - 晋江言情
+- `preset_fantasy` - 西方奇幻
+- `preset_scifi_hardcore` - 硬核科幻
+- `preset_mystery` - 悬疑推理
+- `preset_horror` - 恐怖灵异
+- `preset_historical` - 历史穿越
+- `preset_esports` - 电竞竞技
+- `preset_daily` - 日常治愈
+- `preset_miner` - 矿工式强追读（最高强度）
+
+## 架构
+
+```
+gwe-engine/
+├── src/
+│   ├── index.ts           # 统一出口
+│   ├── types.ts           # 类型定义 + 默认阈值/权重
+│   ├── gwe-engine.ts      # 引擎主类（GWEEngine）
+│   ├── checker.ts         # 文本检测器（26条规则）
+│   ├── radar.ts           # 7维雷达评分
+│   ├── anchor-detector.ts # 身体锚点检测（三级质量分级）
+│   ├── filler-words.ts    # 填充词检测
+│   ├── config-merger.ts   # 配置合并器
+│   ├── node-registry.ts   # 22个节点注册表
+│   ├── validator.ts       # 冲突/依赖验证
+│   ├── prompt-builder.ts  # LLM提示词构建（9种任务模板）
+│   ├── llm-provider.ts    # LLM抽象层（OpenAI兼容/Mock）
+│   ├── kb-loader.ts       # 知识库加载（静态导入）
+│   ├── cli.ts             # 命令行工具
+│   └── kb/                # 知识库数据
+│       ├── nodes/         # 22个节点 × 选项KB（85个.kb.json）
+│       ├── presets/       # 12个内置预设
+│       ├── base-vocab.json
+│       ├── base-fillers.json
+│       └── base-prompt.ts
+└── dist/                  # 构建产物
+```
+
+## 为什么不是大模型？
+
+GWE 不依赖任何大语言模型。它的检测逻辑全部基于规则和词表，这意味着：
+
+1. **速度极快**：检测一个3000字章节 < 10ms，大模型需要3-10秒
+2. **零成本**：不需要API key，不需要GPU，离线可用
+3. **一致性**：同样的文本永远得到同样的分数，不会因模型版本变化而波动
+4. **可解释**：每个评分维度和违规项都有明确原因和修改建议
+5. **可定制**：22个配置节点 + 自定义词表，适配任何风格
+
+大模型擅长生成，GWE擅长评判。两者配合使用效果最佳：大模型写初稿，GWE做质检，迭代到分数达标再发布。
+
+## License
+
+MIT

package/README_EN.md

@@ -0,0 +1,126 @@
+# GWE - Generic Web-novel Engine
+
+> "When a reader's finger scrolls to your text, you have 3 seconds to hook them. Not 3 chapters. 3 seconds."
+
+GWE is a **quality analysis and scoring engine** purpose-built for Chinese web novels (网文). It uses 7-dimensional radar scoring, 26 quality rules, and body-reaction anchor detection to help you write prose that readers won't scroll past.
+
+- **Zero dependencies**: Pure TypeScript. No NLP libraries, no model dependencies. Runs in browser and Node.js.
+- **7-dimension scoring**: Body Reaction / Sensory Signal / Action / Emotion / Info Advance / Twist Frequency / Chapter Hook
+- **26 quality rules**: Covers 3-second opening, fake hooks, AI slop, cliché reactions, filler words, and more
+- **Anchor quality tiers**: Cliché reaction (×0.2), normal reaction (×1.0), quality physiological reaction (×1.8)
+- **22 configuration nodes**: Platform (Qidian/Tomato/Qimao/Jinjiang), genre (xianxia/urban/scifi/mystery), style (pacing/POV/rhetoric/tone)
+- **12 built-in presets**: From Qidian xianxia to Tomato urban, ready to use out of the box
+
+## Quick Start
+
+### CLI
+
+```bash
+npm install -g gwe-engine
+
+# Check a chapter file
+gwe check chapter.txt
+
+# Read from stdin
+cat chapter.txt | gwe -
+
+# JSON output for programmatic use
+gwe --json chapter.txt > report.json
+```
+
+### Library Usage (Node.js / Browser)
+
+```typescript
+import { createEngineWithKB, MockProvider } from 'gwe-engine';
+
+const { engine } = createEngineWithKB(new MockProvider());
+const result = engine.check(chapterText);
+
+console.log(`Score: ${result.score}`);
+console.log(`Passed: ${result.passed}`);
+console.log(`Radar scores:`, result.radarScores);
+console.log(`Violations:`, result.violations);
+```
+
+### With LLM (AI Writing)
+
+```typescript
+import { createEngineWithKB, OpenAICompatibleProvider } from 'gwe-engine';
+
+const provider = new OpenAICompatibleProvider({
+  apiKey: 'your-api-key',
+  baseURL: 'https://api.deepseek.com/v1',
+  model: 'deepseek-chat',
+});
+
+const { engine } = createEngineWithKB(provider);
+engine.selectPreset('preset_urban_tomato');
+
+const stream = await engine.writeChapter({
+  outline: 'Protagonist gets a system, encounters crisis on first use',
+  previousChapter: '...',
+  onDelta: (text) => process.stdout.write(text),
+});
+```
+
+## Scoring Guide
+
+| Score | Grade | Description |
+|-------|-------|-------------|
+| ≥90 | 🏆 Excellent | Top-tier popular web novel level, extremely high retention |
+| ≥85 | ✅ Good | Publishable quality, good reader retention |
+| ≥75 | ⚠ Passing | Noticeable issues, revision needed |
+| ≥60 | ⚠ Poor | Multiple problems, consider rewriting key sections |
+| <60 | ✗ Fail | Below standard, readers will scroll away |
+
+## Benchmark
+
+| Text Type | Chars | Score | Body | Sensory | Action | Emotion | Info | Twist | Hook | Violations |
+|-----------|-------|-------|------|---------|--------|---------|------|-------|------|------------|
+| Hook-driven style ("Miner" style) | 388 | **84.7** | 73 | 100 | 100 | 100 | 100 | 100 | 78 | 3 |
+| Classic cliché opening (system apotheosis) | 372 | **84.4** | 92 | 100 | 100 | 83 | 100 | 99 | 68 | 3 |
+| AI scenery slop | 391 | **57** | 73 | 90 | 97 | 77 | 61 | 53 | 68 | 9 |
+
+## Why Not LLMs?
+
+GWE doesn't depend on any large language model. Its detection logic is entirely rules-based, which means:
+
+1. **Blazing fast**: Checking a 3000-char chapter takes <10ms. LLMs take 3-10 seconds.
+2. **Zero cost**: No API keys, no GPU needed, works offline.
+3. **Consistent**: Same text always gets the same score, no model drift.
+4. **Explainable**: Every score and violation comes with a clear reason and fix suggestion.
+5. **Customizable**: 22 config nodes + custom vocabularies for any style.
+
+LLMs are great at generation. GWE is great at judgment. Best used together: LLM writes the draft, GWE does quality control, iterate until the score passes the threshold.
+
+## Architecture
+
+```
+gwe-engine/
+├── src/
+│   ├── index.ts           # Public API
+│   ├── types.ts           # Type definitions + default thresholds/weights
+│   ├── gwe-engine.ts      # Main engine class (GWEEngine)
+│   ├── checker.ts         # Text checker (26 rules)
+│   ├── radar.ts           # 7-dimension radar scoring
+│   ├── anchor-detector.ts # Body reaction anchor detection (3-tier quality)
+│   ├── filler-words.ts    # Filler word detection
+│   ├── config-merger.ts   # Config merger
+│   ├── node-registry.ts   # 22-node registry
+│   ├── validator.ts       # Conflict/dependency validator
+│   ├── prompt-builder.ts  # LLM prompt builder (9 task templates)
+│   ├── llm-provider.ts    # LLM abstraction (OpenAI-compatible / Mock)
+│   ├── kb-loader.ts       # Knowledge base loader (static imports)
+│   ├── cli.ts             # CLI tool
+│   └── kb/                # Knowledge base data
+│       ├── nodes/         # 22 nodes × option KB files (85 .kb.json files)
+│       ├── presets/       # 12 built-in presets
+│       ├── base-vocab.json
+│       ├── base-fillers.json
+│       └── base-prompt.ts
+└── dist/                  # Build output
+```
+
+## License
+
+MIT