Skip to content

desmati/DevOps.JSON

Repository files navigation

DevOps.JSON Viewer

A Visual Studio Code extension for viewing and managing DevOps.JSON files with task tracking, filtering, and TODO comment scanning.


⚖️ LICENSE NOTICE - IMPORTANT

Copyright © 2025 Mohammad Hossein Dokht Esmati ([email protected])

This software is licensed under GNU Affero General Public License v3.0 (AGPL-3.0) with additional commercial use restrictions.

📋 What This Means For You:

Open Source / Non-Commercial Use:

  • ✓ You can use this extension for free
  • ✓ You can modify the code
  • ✓ You can distribute modified versions
  • BUT: Your project MUST also be open source under AGPL-3.0 or compatible copyleft license
  • AND: You MUST publish your source code publicly
  • AND: You MUST include this copyright notice

💼 Commercial Use:

  • ❌ Commercial use requires written permission
  • ❌ Using any part of this code in proprietary software is NOT allowed without permission
  • ❌ Using in commercial products/services requires permission
  • 📧 Contact for commercial licensing: [email protected]

⚠️ COPYLEFT REQUIREMENT:

If you use ANY PART of this code (even a single function or algorithm), your ENTIRE PROJECT must be licensed under AGPL-3.0 and the source code must be made publicly available.

Failure to comply is a violation of copyright law.

See LICENSE file for complete terms.


Features

  • Task Management: View all tasks from your devops.json file in a clean, organized interface
  • Lane Filtering: Filter tasks by their status (TODO, DOING, DONE)
  • Task Details: Expand tasks to view subtasks, dependencies, and blockers
  • Statistics Dashboard: View project statistics including progress, hours invested, and remaining work
  • Notes Management: View and edit project notes directly in the UI
  • TODO Comment Scanning: Automatically scan your workspace for // TODO: comments
  • Auto-Reload: Automatically updates when devops.json is edited externally
  • Interactive Subtasks: Check/uncheck subtasks directly in the UI

Installation

Development Setup

  1. Clone this repository
  2. Open the folder in VS Code
  3. Run npm install to install dependencies
  4. Press F5 to launch the extension in a new Extension Development Host window

Building

npm run compile

Usage

Opening the Viewer

  1. Open a workspace containing a devops.json file
  2. Click on the DevOps.JSON icon in the Activity Bar (left sidebar)
  3. Or use the command palette (Ctrl+Shift+P / Cmd+Shift+P) and run: DevOps.JSON: Open Viewer

Task View

  • Filter by Lane: Click the TODO, DOING, or DONE buttons to filter tasks
  • Search: Use the search box to find tasks by title, description, ID, or tags
  • Expand Details: Click on any task card to view subtasks and additional details
  • Toggle Subtasks: Check/uncheck subtask checkboxes to mark them as completed

Statistics View

View comprehensive project statistics including:

  • Total tasks and subtasks
  • Task distribution by lane (TODO/DOING/DONE)
  • Progress percentage
  • Hours estimated, invested, and remaining
  • Subtask completion rate

Notes View

  • View all project notes
  • Click on any note to edit it
  • Add new notes using the "Add Note" button
  • Delete notes you no longer need
  • Changes are saved automatically to devops.json

TODO Comments

  • Click the search icon in the viewer to scan workspace for TODO comments
  • View all TODO comments found in your codebase
  • Click on any TODO to jump to its location in the source file
  • Supports multiple file types: TypeScript, JavaScript, C#, Java, Python, Go, Rust, C++, PHP, Ruby, Swift, Kotlin

DevOps.JSON File Format

The extension expects a devops.json file in your workspace root with the following structure:

{
  "project": "Project Name",
  "version": "1.0.0",
  "lastUpdated": "2025-01-20",
  "lanes": ["TODO", "DOING", "DONE"],
  "tasks": [
    {
      "id": "TASK-001",
      "title": "Task Title",
      "description": "Task description",
      "status": "TODO",
      "priority": "HIGH",
      "estimatedHours": 8,
      "tags": ["tag1", "tag2"],
      "subtasks": [
        {
          "id": "TASK-001-1",
          "title": "Subtask title",
          "description": "Subtask description",
          "completed": false
        }
      ],
      "dependencies": [],
      "blockers": []
    }
  ],
  "statistics": {
    "totalTasks": 1,
    "totalSubtasks": 1,
    "totalEstimatedHours": 8,
    "todoCount": 1,
    "doingCount": 0,
    "doneCount": 0,
    "completedSubtasks": 0,
    "progressPercentage": 0,
    "hoursInvested": 0,
    "hoursRemaining": 8
  },
  "notes": [
    "Project note 1",
    "Project note 2"
  ]
}

Commands

  • DevOps.JSON: Open Viewer - Opens the DevOps.JSON viewer
  • DevOps.JSON: Refresh - Manually refresh the viewer
  • DevOps.JSON: Scan TODO Comments - Scan workspace for TODO comments

Requirements

  • Visual Studio Code 1.80.0 or higher
  • A devops.json file in your workspace root

Extension Settings

This extension currently does not add any VS Code settings.

Known Issues

  • None at this time

Release Notes

0.0.1

Initial release:

  • Task viewing and filtering
  • Statistics dashboard
  • Notes management
  • TODO comment scanning
  • Auto-reload on file changes

Contributing

Before contributing, please read the license terms carefully.

All contributions to this project will be licensed under AGPL-3.0 and subject to the same terms. By contributing, you agree to:

  • License your contributions under AGPL-3.0
  • Allow the copyright holder to include your contributions under these terms
  • Acknowledge that commercial licensing decisions remain with the copyright holder

License

GNU Affero General Public License v3.0 (AGPL-3.0)

Copyright © 2025 Mohammad Hossein Dokht Esmati ([email protected])

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

IMPORTANT COPYLEFT REQUIREMENT: Any use of this software or any part of its code requires your entire project to be licensed under AGPL-3.0 or compatible copyleft license and the source code to be made publicly available.

COMMERCIAL USE: Commercial use requires explicit written permission from the copyright holder.

📧 For commercial licensing inquiries: [email protected]

See the LICENSE file for the complete license text and terms.


By using this software, you agree to comply with the AGPL-3.0 license terms and the additional commercial use restrictions.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published