zPlanner v1.4.0

zPlanner v1.4.0

zPlanner 是一款命令行工具，旨在协助项目规划和管理，尤其适用于软件开发项目。这个项目源于一种需求：需要一款简单而强大的工具，能够直接在终端中管理项目，无需复杂的图形界面。

zPlanner 的主要特色之一，是能够在支持提示词的 IDE 中充当 AI 辅助开发的记忆系统。通过维护结构化、分层的项目记录，ZPlanner 有助于保留开发上下文，让 AI 助手更好地理解项目的结构、历史和当前状态，从而提供更准确、更符合上下文的建议和协助。

目的

zPlanner 的设计目标如下：

1. 简单：支持直接在终端中管理项目
2. 高效：减少花在管理任务上的时间
3. 灵活：适应不同的项目类型和方法论
4. 可视化：生成清晰且响应式的 HTML 报告
5. 可追溯：保留进度历史和更新记录
6. AI 上下文：充当 AI 辅助开发的记忆系统，维护结构化的项目上下文

AI 优先设计

zPlanner 的设计充分考虑了现代 AI 辅助开发：

• 保留上下文：维护结构化历史，作为 AI 助手的记忆
• 分层结构：便于 AI 系统理解项目的组织方式
• 变更跟踪：帮助 AI 助手理解项目的演进过程
• 清晰的文档：采用标准化格式，提升 AI 系统的理解能力

功能

项目管理

• 创建和配置项目
• 分层结构（阶段、任务和子任务）
• 自动计算进度
• 导出响应式 HTML
• 跟踪更新时间

阶段组织

• 创建项目阶段
• 调整阶段顺序
• 重命名阶段
• 移除阶段
• 计算各阶段的进度

任务管理

• 添加主任务
• 创建子任务
• 标记完成状态
• 更新说明
• 移除任务

HTML 报告

• 现代化的响应式设计
• 清晰展示层级关系
• 进度指示器
• 更新历史
• 使用 BEM CSS 的专业样式

安装

npm install -g zplanner

使用指南

基本命令

项目管理

# Initialize new project
zplanner init "Project Name"

# List project structure
zplanner list

# Export HTML report
zplanner export ./path/report.html

阶段管理

# Add phase
zplanner add-phase "Phase Name"

# Rename phase
zplanner rename-phase "Current Name" "New Name"

# Move phase
zplanner move-phase "Phase Name" 2

# Remove phase
zplanner remove-phase "Phase Name"

任务管理

# Add task
zplanner add-task "Phase" "1.1" "Task Description"

# Add subtask
zplanner add-subtask "Phase" "1.1" "1.1.1" "Subtask Description"

# Mark as complete
zplanner complete "Phase" "1.1"

# Update description
zplanner update-task "Phase" "1.1" "New Description"

# Remove task
zplanner remove-task "Phase" "1.1"

项目结构

项目组织结构如下：

zPlanner/
├── src/
│   ├── cli.ts                 # Command-line interface
│   ├── index.ts              # Main entry point
│   ├── ProjectPlanner.ts     # Core project management
│   ├── config/              # Project configurations
│   ├── services/            # Business services
│   │   ├── PhaseService.ts  # Phase management
│   │   ├── TaskService.ts   # Task management
│   │   └── progress/        # Progress calculation
│   └── templates/           # HTML and CSS templates
├── dist/                    # Compiled code
└── docs/                    # Documentation

开发

先决条件

• Node.js >= 14.0.0
• npm >= 6.0.0

环境设置

# Clone repository
git clone https://github.com/cyllas/zPlanner.git

# Install dependencies
cd zPlanner
npm install

# Run tests
npm test

# Start development mode
npm run dev

配置

settings.ts 文件可用于配置：

export const settings = {
  defaultLanguage: "en-US",
  dateFormat: "MM/DD/YYYY",
  timeZone: "UTC",
  projectDefaults: {
    outputFormat: "html",
    indentSize: 2,
  },
  repository: {
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",
};

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。