@zephyr424/wb-sdk 0.1.1 → 0.3.0

package/.github/workflows/deploy.yml

@@ -0,0 +1,41 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: cd docs && npm install
+      - name: Build
+        run: cd docs && npm run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/README.md

@@ -2,8 +2,8 @@
 
 > A developer-friendly spaced repetition engine for vocabulary building
 
-[![npm version](https://img.shields.io/npm/v/wb-sdk.svg)](https://www.npmjs.com/package/@zephyr424/wb-sdk)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Zephyr424/wb-sdk/blob/main/LICENSE)
+[![npm version](https://img.shields.io/npm/v/@zephyr424/wb-sdk.svg)](https://www.npmjs.com/package/@zephyr424/wb-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 **wb-sdk** is a lightweight, plug-and-play spaced repetition engine designed for developers who want to integrate intelligent vocabulary review into their applications.
 

package/bin/wb.js

@@ -0,0 +1,82 @@
+const { program } = require('commander');
+const { WordBank } = require('../index');
+const fs = require('fs');
+const path = require('path');
+
+program
+  .name('wb')
+  .description('📚 wb-sdk CLI — 间隔重复背单词工具')
+  .version('0.2.0');
+
+// ---------- learn 命令 ----------
+program
+  .command('learn')
+  .description('开始今天的学习')
+  .option('-n, --limit <number>', '限制复习单词数量', 10)
+  .action((options) => {
+    const wb = new WordBank();
+    wb.loadPreset('top5000');
+
+    const due = wb.review.getDue().slice(0, parseInt(options.limit));
+    if (due.length === 0) {
+      console.log('🎉 今天没有需要复习的单词！');
+      return;
+    }
+
+    console.log(`📚 今天有 ${due.length} 个单词需要复习：\n`);
+    due.forEach((word, i) => {
+      console.log(`  ${i + 1}. ${word.word}`);
+      console.log(`     释义: ${word.definition}`);
+      console.log(`     难度系数: ${word.easeFactor.toFixed(2)}`);
+      console.log(`     复习间隔: ${word.interval} 天`);
+      console.log('');
+    });
+  });
+
+// ---------- stats 命令 ----------
+program
+  .command('stats')
+  .description('查看学习进度统计')
+  .action(() => {
+    const wb = new WordBank();
+    wb.loadPreset('top5000');
+    const stats = wb.review.progress();
+
+    console.log('📊 学习进度统计:');
+    console.log(`  总词数: ${stats.total}`);
+    console.log(`  已掌握（间隔≥30天）: ${stats.mastered}`);
+    console.log(`  剩余: ${stats.remaining}`);
+    console.log(`  预计全部掌握: ${stats.daysToMaster} 天`);
+  });
+
+// ---------- remind 命令（艾宾浩斯提醒） ----------
+program
+  .command('remind')
+  .description('🔔 查看今天应复习的单词数量（艾宾浩斯提醒）')
+  .option('-d, --detail', '显示详细单词列表')
+  .action((options) => {
+    const wb = new WordBank();
+    wb.loadPreset('top5000');
+    const due = wb.review.getDue();
+    const today = new Date().toISOString().slice(0, 10);
+
+    if (due.length === 0) {
+      console.log(`📅 ${today} 没有需要复习的单词，继续保持！🎉`);
+      return;
+    }
+
+    console.log(`📅 ${today} 艾宾浩斯复习提醒：`);
+    console.log(`   今天有 ${due.length} 个单词需要复习`);
+
+    if (options.detail) {
+      console.log('\n📖 详细列表：');
+      due.forEach((word, i) => {
+        const last = word.lastReviewed ? new Date(word.lastReviewed).toISOString().slice(0, 10) : '从未';
+        console.log(`   ${i + 1}. ${word.word}（上次复习: ${last}）`);
+      });
+    }
+
+    console.log('\n💡 运行 `wb learn` 开始复习');
+  });
+
+program.parse();