zPlanner v1.4.0

zPlanner v1.4.0

zPlanner は、プロジェクトの計画と管理を支援するために開発されたコマンドラインツールで、特にソフトウェア開発プロジェクトに重点を置いています。このプロジェクトは、複雑なグラフィカルインターフェースを必要とせず、ターミナルから直接プロジェクトを管理できる、シンプルでありながら強力なツールが必要とされたことから生まれました。

zPlanner の主な差別化要因の 1 つは、プロンプト機能を備えた 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 ファイルをご覧ください。