@nbtca/prompt 1.0.0 → 1.0.3

package/README.md

@@ -1,235 +1,231 @@
-# NBTCA Welcome v2.3.0
+# NBTCA Prompt
 
-![Demo](assets/Prompt_demo.gif)
+Terminal-based information system for NingboTech Computer Association.
 
-> 为浙大宁波理工学院计算机协会打造的专业欢迎工具
+[![npm version](https://img.shields.io/npm/v/@nbtca/prompt)](https://www.npmjs.com/package/@nbtca/prompt)
+[![License](https://img.shields.io/npm/l/@nbtca/prompt)](LICENSE)
 
-## ✨ 新功能特性
+## Overview
 
-### 🎨 增强的视觉效果
+NBTCA Prompt is a minimalist command-line interface tool designed for the Computer Association of Zhejiang University Ningbo Institute of Technology. It provides quick access to association resources, events, and documentation directly from the terminal.
 
-- **多种动画效果**: 彩虹、波浪、脉冲、打字机等动画
-- **渐变文字**: 支持多种颜色渐变效果
-- **加载动画**: 自定义加载动画和进度条
-- **系统信息显示**: 实时显示系统状态和性能
+## Features
 
-### 🚀 丰富的交互体验
+- View upcoming association events (30-day calendar)
+- Access repair service information
+- Browse technical documentation from terminal
+- Quick links to official website and GitHub
+- Minimalist design with maximum terminal compatibility
 
-- **分类菜单**: 官方网站、技术支持、学习资源、社区交流等
-- **子菜单系统**: 每个分类都有详细的子菜单
-- **确认对话框**: 重要操作前的确认提示
-- **输入提示**: 支持文本和密码输入
+## Installation
 
-### 📊 系统监控
+### Global Installation
 
-- **实时系统信息**: CPU、内存、平台信息
-- **网络状态**: 连接状态和服务可用性
-- **性能指标**: 系统性能评估和建议
+```bash
+npm install -g @nbtca/prompt
+```
 
-### 🔧 技术支持服务
+### Using npx (No Installation Required)
 
-- **电脑维修**: 硬件和软件问题解决
-- **网络配置**: 网络连接和配置服务
-- **移动设备**: 手机和平板电脑支持
-- **服务预约**: 在线预约系统
+```bash
+npx @nbtca/prompt
+```
 
-## 🚀 快速开始
+## Usage
 
-### 安装
+Run the program with:
 
 ```bash
-npm install @nbtca/welcome
+nbtca
 ```
 
-### 使用
+Navigate using arrow keys or Vim bindings (j/k/g/G).
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 16.0.0
+
+### Setup
 
 ```bash
-# 推荐方式
-npx @nbtca/welcome
+git clone https://github.com/nbtca/prompt.git
+cd prompt
+pnpm install
+```
 
-# 或本地运行
-npm start
+### Development Workflow
 
-# 开发模式（自动重启）
-npm run dev
+#### Quick Testing (Recommended)
+
+```bash
+pnpm run dev
 ```
 
-## 📁 项目结构
+Runs TypeScript source directly without auto-restart. Exit with menu option or Ctrl+C.
 
+#### Watch Mode (File Changes)
+
+```bash
+pnpm run dev:watch
 ```
-.
-├── bin/
-│   └── nbtca-welcome.js          # CLI 入口点
-├── src/
-│   ├── index.js                  # 主入口文件
-│   ├── main.js                   # 核心应用逻辑
-│   ├── logo/                     # ASCII Logo 相关
-│   │   ├── printLogo.js
-│   │   └── logo.txt             # 终端图像数据
-│   ├── gradient/                 # 渐变文字效果
-│   │   └── printGradientText.js
-│   ├── animation/                # 动画效果
-│   │   ├── printLolcatAnimated.js
-│   │   └── loadingAnimation.js
-│   ├── ui/                       # 用户界面组件
-│   │   ├── welcomeBanner.js
-│   │   └── systemInfo.js
-│   └── menu/                     # 交互菜单
-│       ├── showMainMenu.js
-│       ├── handleUserAction.js
-│       └── subMenu.js
-├── assets/
-│   └── Prompt_demo.gif          # 演示动画
-└── package.json
+
+Auto-restarts on file changes. Not recommended for interactive testing.
+
+#### Production Build
+
+```bash
+pnpm run build
+pnpm start
 ```
 
-## 🎯 主要功能
+### Available Commands
 
-### 🌐 官方网站服务
+```bash
+pnpm run dev         # Run TypeScript source directly
+pnpm run dev:watch   # Run with file watching
+pnpm run build       # Compile TypeScript to JavaScript
+pnpm start           # Run compiled code
+pnpm run clean       # Remove dist directory
+```
 
-- 🏠 官方网站主页
-- 📰 新闻资讯
-- 📅 活动日历
-- 👥 团队介绍
-- 📞 联系我们
+## Project Structure
 
-### 🔧 技术支持服务
+```
+src/
+├── config/          # Configuration constants
+│   ├── data.ts     # URLs and app info
+│   └── theme.ts    # Color themes
+├── core/           # Core functionality
+│   ├── logo.ts     # Logo display logic
+│   ├── menu.ts     # Main menu system
+│   ├── ui.ts       # UI components
+│   └── vim-keys.ts # Vim key bindings
+├── features/       # Feature modules
+│   ├── calendar.ts # Event calendar
+│   ├── docs.ts     # Documentation viewer
+│   ├── repair.ts   # Repair service
+│   └── website.ts  # Website links
+└── main.ts         # Application entry point
+```
 
-- 💻 电脑硬件维修
-- 🔧 软件问题解决
-- 🌐 网络配置服务
-- 📱 移动设备支持
-- 🛠️ 硬件升级咨询
-- 📋 服务预约
+## Technology Stack
 
-### 📚 学习资源中心
+### Core Dependencies
 
-- 📚 技术文档
-- 🎥 视频教程
-- 💡 编程学习
-- 🎨 设计资源
-- 🔬 学术研究
-- 📖 推荐书籍
+- axios - HTTP requests
+- ical.js - ICS calendar parsing
+- marked + marked-terminal - Markdown rendering
+- chalk - Terminal colors
+- inquirer - Interactive prompts
+- open - Browser integration
 
-### 👥 社区交流
+### Development Dependencies
 
-- 💬 技术交流群
-- 📢 官方QQ群
-- 🐙 GitHub组织
-- 📱 微信公众号
-- 🎯 项目合作
-- 🏆 竞赛信息
+- TypeScript 5.3+
+- tsx - TypeScript execution
+- @types/* - Type definitions
 
-### ⚙️ 系统设置
+## Documentation Viewer
 
-- 🎨 主题设置
-- 🌐 网络配置
-- 📊 性能监控
-- 🔔 通知设置
-- 🔄 检查更新
+The knowledge base viewer features:
 
-## 🛠️ 技术栈
+- Direct GitHub repository access
+- VitePress syntax cleaning
+- Terminal Markdown rendering
+- Browser fallback option
+- Directory tree navigation
 
-- **Node.js** (ES Modules)
-- **inquirer** - 交互式命令行界面
-- **chalk** - 终端颜色输出
-- **isomorphic-lolcat** - 彩虹色动画效果
-- **open** - 打开系统默认浏览器
-- **boxen** - 创建边框效果
+### Supported Formats
 
-## 🎨 动画效果
+- Standard Markdown
+- VitePress frontmatter (auto-removed)
+- VitePress containers (auto-converted)
+- Table of contents (placeholder in terminal)
 
-### 彩虹动画
+## Terminal Compatibility
 
-```javascript
-await printLolcatAnimated("Hello World!", {
-  duration: 2000,
-  fps: 30,
-  effect: "rainbow",
-});
-```
+Designed for maximum compatibility with:
 
-### 波浪动画
+- Modern terminals (iTerm2, Windows Terminal, GNOME Terminal)
+- Legacy terminals (xterm, Terminal.app)
+- SSH sessions
+- Screen/tmux multiplexers
 
-```javascript
-await printLolcatAnimated("Hello World!", {
-  effect: "wave",
-});
-```
+ASCII-based UI elements ensure rendering on any terminal emulator.
 
-### 脉冲动画
+## System Requirements
 
-```javascript
-await printLolcatAnimated("Hello World!", {
-  effect: "pulse",
-});
-```
+- Node.js: >= 16.0.0
+- OS: Windows, macOS, Linux
+- Terminal: ANSI escape sequence support
 
-### 打字机效果
+## Common Issues
 
-```javascript
-await printLolcatAnimated("Hello World!", {
-  effect: "typewriter",
-});
-```
+### Q: Auto-restart when using `pnpm run dev:watch`?
 
-## 📊 系统要求
+A: This is expected behavior. Use `pnpm run dev` for interactive testing.
 
-- **Node.js**: >= 16.0.0
-- **操作系统**: Windows, macOS, Linux
-- **终端**: 支持 ANSI 转义序列的终端
+### Q: How to exit the program?
 
-## 🔧 开发
+A: Select the Exit option from menu, or press Ctrl+C.
 
-### 安装依赖
+### Q: Changes not reflected?
 
-```bash
-npm install
-```
+A: If using `pnpm start`, rebuild with `pnpm run build` first.
 
-### 运行开发模式
+## Contributing
 
-```bash
-npm run dev
-```
+Contributions are welcome. Please follow these guidelines:
 
-### 构建
+1. Fork the repository
+2. Create a feature branch
+3. Follow existing code style
+4. Add appropriate comments
+5. Ensure build passes
+6. Submit pull request
 
-```bash
-npm run build
-```
+### Code Standards
 
-## 📝 更新日志
+- Use TypeScript strict mode
+- Add JSDoc comments for functions
+- Use .js extension in imports (even for .ts files)
+- Keep code simple and readable
 
-### v2.3.0
+## License
 
-- ✨ 新增多种动画效果
-- 🎨 增强的渐变文字功能
-- 📊 实时系统信息显示
-- 🚀 分类菜单系统
-- 🔧 丰富的技术支持服务
-- 📚 学习资源中心
-- 👥 社区交流功能
-- ⚙️ 系统设置选项
+MIT License - See LICENSE file for details
 
-### v2.2.0
+## Contact
 
-- 🎨 基础动画效果
-- 🌐 官方网站访问
-- 🔧 维修服务
+- Website: https://nbtca.space
+- Email: contact@nbtca.space
+- GitHub: https://github.com/nbtca
+- NPM: https://www.npmjs.com/package/@nbtca/prompt
 
-## 🤝 贡献
+## Changelog
 
-欢迎提交 Issue 和 Pull Request！
+### v1.0.1 (2025-11-27)
 
-## 📄 许可证
+- Added terminal documentation viewer
+- Removed emoji icons for better compatibility
+- Improved Markdown rendering
+- Added VitePress syntax cleaning
+- Enhanced directory navigation
 
-MIT License
+### v1.0.0 (2025-11-21)
 
-## 📞 联系我们
+- Complete TypeScript rewrite
+- Minimalist UI redesign
+- ICS calendar integration
+- Terminal Markdown renderer
+- Smart logo display with fallback
 
-- 🌐 官网: https://nbtca.space/
-- 📧 邮箱: contact@m1ng.space
-- 🐙 GitHub: https://github.com/nbtca
+## Acknowledgments
+
+Built with focus on simplicity and terminal compatibility.
 
 ---
+
+Made by [NBTCA](https://nbtca.space)

package/TERMINAL_UX.md

@@ -0,0 +1,184 @@
+# Terminal UX Improvements
+
+## Summary
+
+All changes align with standard Linux/Unix terminal conventions for better user experience and consistency.
+
+## Changes Made
+
+### 1. Standardized Navigation Symbols
+
+**Before**:
+```
+[📁] emoji icons
+[<-] inconsistent arrows
+[ ] empty brackets
+```
+
+**After**:
+```
+[..] - Up to parent directory (Unix convention)
+[ <] - Back/Previous
+[ ^] - Return to main menu
+[ *] - Special action (open in browser)
+[DIR] - Directory indicator
+[MD]  - Markdown file indicator
+[ ?] - Help/About
+[ x] - Exit
+```
+
+**Rationale**: ASCII-only symbols ensure maximum terminal compatibility and follow Unix conventions (e.g., `..` for parent directory).
+
+### 2. Added Keybinding Hints
+
+**Main Menu**:
+```
+Navigation: j/k or ↑/↓ | Jump: g/G | Quit: q or Ctrl+C
+```
+
+**Location**: Displayed above main menu for visibility
+
+**Rationale**: Users should know available shortcuts without reading documentation.
+
+### 3. ESC Key Support
+
+**Implementation**: ESC key now properly passed through to menus
+
+**Expected Behavior** (future enhancement):
+- ESC in submenus = go back one level
+- ESC in main menu = exit application
+
+**Current State**: Infrastructure added, full implementation needs inquirer customization
+
+**Rationale**: ESC is standard cancel/back key in Unix terminals.
+
+### 4. Improved Documentation
+
+**Added Descriptions**:
+- Knowledge Base menu now shows purpose
+- Comments in code clarified
+
+**Rationale**: Self-documenting UI reduces user confusion.
+
+## Navigation Symbol Reference
+
+```
+Symbol  | Meaning                  | Unix Standard
+--------|--------------------------|---------------
+[..]    | Parent directory         | Yes (cd ..)
+[DIR]   | Directory entry          | Common
+[MD]    | Markdown file            | N/A
+[ <]    | Go back/previous         | No (custom)
+[ ^]    | Go to top/main menu      | No (custom)
+[ *]    | Special action           | No (custom)
+[ ?]    | Help/Information         | Common (man ?)
+[ x]    | Exit/Quit                | No (custom)
+```
+
+## Keybinding Reference
+
+```
+Key     | Action                | Standard
+--------|----------------------|----------
+↑/↓     | Navigate up/down     | Yes
+j/k     | Navigate up/down     | Vim
+g       | Jump to first        | Vim
+G       | Jump to last         | Vim
+q       | Quit application     | Vim/less/man
+ESC     | Cancel/Go back       | Yes
+Ctrl+C  | Force quit           | Yes
+Enter   | Select/Confirm       | Yes
+```
+
+## Comparison with Common Unix Tools
+
+### less/more
+- j/k navigation: ✓ Supported
+- g/G jump: ✓ Supported
+- q quit: ✓ Supported
+- ESC: Usually not used
+
+### man
+- j/k navigation: ✓ Supported
+- g/G jump: ✓ Supported
+- q quit: ✓ Supported
+- h for help: Not implemented (use [?] menu item)
+
+### vim
+- j/k navigation: ✓ Supported
+- g/G jump: ✓ Supported
+- q quit: ✓ Supported
+- ESC: ✓ Infrastructure added
+
+### fzf (fuzzy finder)
+- j/k navigation: ✓ Supported
+- Ctrl+C quit: ✓ Supported
+- ESC cancel: ✓ Infrastructure added
+
+## Implementation Details
+
+### vim-keys.ts
+- Maps j/k to arrow keys
+- Maps g/G to home/end
+- Maps q to Ctrl+C
+- Passes ESC through for menu handling
+
+### menu.ts
+- Shows keybinding hints before menu
+- Standardized symbol usage
+- Consistent formatting
+
+### docs.ts
+- Uses [..] for parent directory (Unix standard)
+- Uses [ ^] for main menu (clear intent)
+- Uses [ <] for back navigation
+- Added descriptive subtitle
+
+## Terminal Compatibility
+
+All symbols tested and work correctly on:
+- iTerm2 (macOS)
+- Terminal.app (macOS)
+- GNOME Terminal (Linux)
+- Windows Terminal
+- PuTTY (SSH)
+- tmux/screen multiplexers
+
+## Future Enhancements
+
+1. **Context-aware q key**: Currently q always exits. Consider:
+   - q in submenu = go back
+   - Q (shift) = force quit
+
+2. **ESC back navigation**: Full implementation requires:
+   - Custom inquirer plugin or wrapper
+   - State management for menu stack
+
+3. **Help overlay**: F1 or ? key for:
+   - Show all keybindings
+   - Context-sensitive help
+
+4. **Breadcrumb trail**: Show current location:
+   ```
+   Main > Docs > Tutorial > Getting Started
+   ```
+
+5. **Operation cancellation**: Allow Ctrl+C during:
+   - Network requests
+   - File loading
+   - Long operations
+
+## Migration Notes
+
+### Breaking Changes
+None. All changes are additive or improve existing behavior.
+
+### User-Facing Changes
+- New keybinding hints displayed
+- Updated navigation symbols (more intuitive)
+- ESC key now recognized (infrastructure)
+
+### Developer Notes
+- ESC handling requires inquirer extension for full functionality
+- Current implementation provides foundation
+- Symbol constants could be extracted to config

package/dist/config/data.d.ts

@@ -12,7 +12,7 @@ export declare const URLS: {
 };
 export declare const APP_INFO: {
     readonly name: "Prompt";
-    readonly version: "1.0.0";
+    readonly version: "1.0.2";
     readonly description: "浙大宁波理工学院计算机协会";
     readonly fullDescription: "NBTCA Prompt - 极简命令行工具";
     readonly author: "m1ngsama <contact@m1ng.space>";

package/dist/config/data.js

@@ -15,7 +15,7 @@ export const URLS = {
 };
 export const APP_INFO = {
     name: 'Prompt',
-    version: '1.0.0',
+    version: '1.0.2',
     description: '浙大宁波理工学院计算机协会',
     fullDescription: 'NBTCA Prompt - 极简命令行工具',
     author: 'm1ngsama <contact@m1ng.space>',

package/dist/core/logo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logo.d.ts","sourceRoot":"","sources":["../../src/core/logo.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsBH;;GAEG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAkC/C"}
+{"version":3,"file":"logo.d.ts","sourceRoot":"","sources":["../../src/core/logo.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwDH;;GAEG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAmC/C"}