doit-toolkit-cli 0.1.9__py3-none-any.whl

doit_cli/templates/config/context.yaml

@@ -0,0 +1,134 @@
+# Context Configuration
+# ====================
+# This file configures automatic context injection for doit commands.
+# Project context (constitution, roadmap, specs) is automatically loaded
+# and provided to AI agents when running doit commands.
+#
+# Location: .doit/config/context.yaml
+# Documentation: https://github.com/your-org/doit/blob/main/docs/context-injection.md
+
+# Schema version (required, must be 1)
+version: 1
+
+# ---------------------------------------------------------------------------
+# Global Settings
+# ---------------------------------------------------------------------------
+
+# Master toggle - set to false to disable all context loading
+enabled: true
+
+# Maximum tokens per individual source
+# Sources exceeding this limit will be intelligently truncated
+# Default: 4000 (suitable for most AI model context windows)
+max_tokens_per_source: 4000
+
+# Maximum total tokens across all sources combined
+# Must be >= max_tokens_per_source
+# Default: 16000 (allows constitution + roadmap + spec + related specs)
+total_max_tokens: 16000
+
+# ---------------------------------------------------------------------------
+# Source Configuration
+# ---------------------------------------------------------------------------
+# Each source has:
+#   - enabled: Whether to load this source (default: true)
+#   - priority: Loading order, lower = higher priority (default: varies)
+#   - max_count: For multi-item sources like related_specs (default: 1)
+#
+# Available sources:
+#   - constitution: Project principles from .doit/memory/constitution.md
+#   - roadmap: Project roadmap from .doit/memory/roadmap.md
+#   - current_spec: Feature spec based on current git branch
+#   - related_specs: Similar specs found via content matching
+
+sources:
+  # Project constitution - core principles and architecture decisions
+  # Always loaded first as it provides essential context
+  constitution:
+    enabled: true
+    priority: 1
+
+  # Project roadmap - current priorities and upcoming work
+  # Helps AI understand project direction
+  roadmap:
+    enabled: true
+    priority: 2
+
+  # Current feature specification - detected from git branch
+  # Example: branch "026-ai-context" loads specs/026-ai-context/spec.md
+  current_spec:
+    enabled: true
+    priority: 3
+
+  # Related specifications - found via content similarity
+  # Provides context from similar features
+  related_specs:
+    enabled: true
+    priority: 4
+    # Maximum number of related specs to include
+    max_count: 3
+
+# ---------------------------------------------------------------------------
+# Per-Command Overrides
+# ---------------------------------------------------------------------------
+# Override source settings for specific doit commands.
+# Useful when certain commands need different context.
+#
+# Available commands: specit, planit, taskit, implementit, testit,
+#                     reviewit, checkin, roadmapit, constitution, etc.
+
+commands:
+  # specit: Creating new feature specs
+  # Disable related_specs since we're creating something new
+  specit:
+    sources:
+      related_specs:
+        enabled: false
+
+  # roadmapit: Updating project roadmap
+  # Disable current_spec as roadmap is project-wide
+  roadmapit:
+    sources:
+      current_spec:
+        enabled: false
+
+  # constitution: Updating project principles
+  # Only need current constitution for reference
+  constitution:
+    sources:
+      roadmap:
+        enabled: false
+      current_spec:
+        enabled: false
+      related_specs:
+        enabled: false
+
+# ---------------------------------------------------------------------------
+# Example: Minimal Configuration
+# ---------------------------------------------------------------------------
+# To use all defaults, your file can be as simple as:
+#
+#   version: 1
+#   enabled: true
+#
+# The system will use sensible defaults for all other settings.
+
+# ---------------------------------------------------------------------------
+# Example: Disable Context Loading
+# ---------------------------------------------------------------------------
+# To completely disable context injection:
+#
+#   version: 1
+#   enabled: false
+
+# ---------------------------------------------------------------------------
+# Example: Reduce Token Usage
+# ---------------------------------------------------------------------------
+# For smaller context windows or faster response times:
+#
+#   version: 1
+#   max_tokens_per_source: 2000
+#   total_max_tokens: 8000
+#   sources:
+#     related_specs:
+#       max_count: 1

doit_cli/templates/config/hooks.yaml

@@ -0,0 +1,93 @@
+# Git Hooks Configuration for doit
+# Place this file at .doit/config/hooks.yaml to customize hook behavior
+#
+# For more information, see: https://github.com/yourusername/doit#git-hooks
+
+version: 1
+
+# Pre-commit hook configuration
+pre_commit:
+  # Enable/disable the pre-commit hook
+  enabled: true
+
+  # Require spec.md to exist for feature branches
+  require_spec: true
+
+  # Require plan.md to exist (set to false for pre-commit, true for pre-push)
+  require_plan: false
+
+  # Require tasks.md to exist
+  require_tasks: false
+
+  # Run spec validation rules before commit
+  validate_spec: true
+
+  # Minimum quality score required (0-100)
+  # Commits will be blocked if spec score is below this threshold
+  validate_spec_threshold: 70
+
+  # Allowed spec statuses for code commits
+  # Commits will be blocked if spec status is not in this list
+  allowed_statuses:
+    - In Progress
+    - Complete
+    - Approved
+
+  # Branches exempt from validation (supports glob patterns)
+  exempt_branches:
+    - main
+    - develop
+    - master
+    - "release/*"
+    - "hotfix/*"
+
+  # File paths exempt from validation (supports glob patterns)
+  exempt_paths:
+    - "*.md"
+    - "docs/**"
+    - ".github/**"
+    - "README.md"
+    - "CHANGELOG.md"
+
+# Pre-push hook configuration
+pre_push:
+  # Enable/disable the pre-push hook
+  enabled: true
+
+  # Require spec.md before push
+  require_spec: true
+
+  # Require plan.md before push
+  require_plan: true
+
+  # Require tasks.md before push
+  require_tasks: false
+
+  # Run spec validation before push
+  validate_spec: true
+
+  # Higher threshold for push (encourage higher quality)
+  validate_spec_threshold: 80
+
+  # Allowed spec statuses for push
+  allowed_statuses:
+    - In Progress
+    - Complete
+    - Approved
+
+  # Branches exempt from push validation
+  exempt_branches:
+    - main
+    - develop
+    - master
+
+# Logging configuration
+logging:
+  # Enable hook logging
+  enabled: true
+
+  # Log bypass events (when --no-verify is used)
+  log_bypasses: true
+
+  # Path to bypass log file
+  log_path: .doit/logs/hook-bypasses.log

doit_cli/templates/config/validation-rules.yaml

@@ -0,0 +1,64 @@
+# Validation Rules Configuration for doit
+# Place this file at .doit/validation-rules.yaml to customize validation behavior
+#
+# For more information, see: https://github.com/yourusername/doit#spec-validation
+
+version: "1.0"
+
+# Enable/disable validation globally
+enabled: true
+
+# Disable specific built-in rules by ID
+# Available rule IDs:
+#   - missing-user-scenarios
+#   - missing-requirements
+#   - missing-success-criteria
+#   - missing-acceptance-scenarios
+#   - fr-naming-convention
+#   - sc-naming-convention
+#   - feature-branch-format
+#   - todo-in-approved-spec
+#   - unresolved-clarification
+disabled_rules: []
+  # Example:
+  # - feature-branch-format  # Disable branch naming check
+
+# Override severity of built-in rules
+# Severity levels: error, warning, info
+overrides: []
+  # Example:
+  # - rule: todo-in-approved-spec
+  #   severity: info  # Change from error to info
+
+# Define custom validation rules
+# Each custom rule must have:
+#   - name: Unique identifier (will be used as rule ID)
+#   - description: Human-readable description
+#   - pattern: Regular expression to match
+#   - severity: error, warning, or info
+#   - category: custom (or structure, requirements, clarity for built-in categories)
+#   - check: present (pattern MUST exist) or absent (pattern must NOT exist)
+custom_rules: []
+  # Example - require Overview section:
+  # - name: require-overview
+  #   description: "Spec must include an Overview section"
+  #   pattern: "^## Overview"
+  #   severity: warning
+  #   category: structure
+  #   check: present
+  #
+  # Example - no placeholder text:
+  # - name: no-placeholder-text
+  #   description: "Remove placeholder text before approving"
+  #   pattern: "\\[placeholder\\]|\\[TBD\\]|\\[TODO\\]"
+  #   severity: error
+  #   category: clarity
+  #   check: absent
+  #
+  # Example - require dependencies section:
+  # - name: require-dependencies
+  #   description: "Spec should document dependencies"
+  #   pattern: "^##\\s+(Dependencies|External Dependencies)"
+  #   severity: info
+  #   category: structure
+  #   check: present

doit_cli/templates/github-issue-templates/epic.yml

@@ -0,0 +1,78 @@
+name: Epic
+description: Create a new epic to group related features and user stories
+title: "[Epic]: "
+labels: ["epic"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Epic Definition
+        An Epic represents a large body of work that can be broken down into multiple features/user stories.
+
+  - type: input
+    id: branch-name
+    attributes:
+      label: Branch Name
+      description: The feature branch name for this epic (e.g., 001-user-authentication)
+      placeholder: "###-epic-name"
+    validations:
+      required: true
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: High-level description of what this epic aims to achieve
+      placeholder: "Describe the epic's overall goal and scope..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: success-criteria
+    attributes:
+      label: Success Criteria
+      description: How will we know when this epic is complete?
+      placeholder: |
+        - [ ] Criterion 1
+        - [ ] Criterion 2
+        - [ ] Criterion 3
+    validations:
+      required: true
+
+  - type: textarea
+    id: user-stories
+    attributes:
+      label: User Stories / Features
+      description: Links to related feature issues (add as they are created)
+      placeholder: |
+        - [ ] #123 - Feature A
+        - [ ] #124 - Feature B
+    validations:
+      required: false
+
+  - type: textarea
+    id: out-of-scope
+    attributes:
+      label: Out of Scope
+      description: What is explicitly NOT included in this epic?
+      placeholder: "List items that are out of scope for this epic..."
+    validations:
+      required: false
+
+  - type: textarea
+    id: part-of
+    attributes:
+      label: Part Of
+      description: Link to parent initiative or roadmap item (if applicable)
+      placeholder: "Part of #XXX or Roadmap item link"
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other relevant information, links, or references
+      placeholder: "Add any other context here..."
+    validations:
+      required: false

doit_cli/templates/github-issue-templates/feature.yml

@@ -0,0 +1,116 @@
+name: Feature
+description: Create a new feature or user story that delivers value
+title: "[Feature]: "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Feature / User Story
+        A Feature represents a specific piece of functionality that delivers value to users.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the feature and the value it provides
+      placeholder: |
+        As a [type of user],
+        I want [goal/desire],
+        So that [benefit/value].
+    validations:
+      required: true
+
+  - type: input
+    id: parent-epic
+    attributes:
+      label: Parent Epic
+      description: Link to the parent epic issue
+      placeholder: "#123"
+    validations:
+      required: false
+
+  - type: textarea
+    id: acceptance-scenarios
+    attributes:
+      label: Acceptance Scenarios
+      description: Specific scenarios that must pass for this feature to be complete
+      placeholder: |
+        **Scenario 1: [Name]**
+        Given [context]
+        When [action]
+        Then [outcome]
+
+        **Scenario 2: [Name]**
+        Given [context]
+        When [action]
+        Then [outcome]
+    validations:
+      required: true
+
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How important is this feature?
+      options:
+        - P1 - Critical (MVP)
+        - P2 - High
+        - P3 - Medium
+        - P4 - Low (Nice to have)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: size
+    attributes:
+      label: Size Estimate
+      description: Rough estimate of effort
+      options:
+        - XS (< 1 day)
+        - S (1-2 days)
+        - M (3-5 days)
+        - L (1-2 weeks)
+        - XL (> 2 weeks - consider breaking down)
+    validations:
+      required: false
+
+  - type: textarea
+    id: tasks
+    attributes:
+      label: Implementation Tasks
+      description: Links to task issues (add as they are created)
+      placeholder: |
+        - [ ] #125 - Task A
+        - [ ] #126 - Task B
+    validations:
+      required: false
+
+  - type: textarea
+    id: part-of
+    attributes:
+      label: Part Of
+      description: Link to parent epic
+      placeholder: "Part of Epic #XXX"
+    validations:
+      required: false
+
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: Dependencies
+      description: Other features or tasks this depends on
+      placeholder: |
+        - Blocked by #XXX
+        - Requires #YYY to be complete
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other relevant information, mockups, or references
+      placeholder: "Add screenshots, diagrams, or links here..."
+    validations:
+      required: false

doit_cli/templates/github-issue-templates/task.yml

@@ -0,0 +1,129 @@
+name: Task
+description: Create a specific implementation task
+title: "[Task]: "
+labels: ["task"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Implementation Task
+        A Task is a specific, actionable piece of work that contributes to a feature.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What needs to be done?
+      placeholder: "Describe the specific work to be completed..."
+    validations:
+      required: true
+
+  - type: input
+    id: parent-feature
+    attributes:
+      label: Parent Feature
+      description: Link to the parent feature issue
+      placeholder: "#123"
+    validations:
+      required: false
+
+  - type: input
+    id: task-id
+    attributes:
+      label: Task ID
+      description: Task identifier from tasks.md (e.g., T001, T002)
+      placeholder: "T###"
+    validations:
+      required: false
+
+  - type: dropdown
+    id: phase
+    attributes:
+      label: Phase
+      description: Which implementation phase does this belong to?
+      options:
+        - Phase 1 - Setup
+        - Phase 2 - Foundational
+        - Phase 3 - Core Implementation
+        - Phase 4 - Integration
+        - Phase 5 - Testing
+        - Phase 6 - Polish
+    validations:
+      required: false
+
+  - type: textarea
+    id: definition-of-done
+    attributes:
+      label: Definition of Done
+      description: Checklist of items that must be complete
+      placeholder: |
+        - [ ] Code implemented
+        - [ ] Unit tests written and passing
+        - [ ] Code reviewed
+        - [ ] Documentation updated
+    validations:
+      required: true
+
+  - type: dropdown
+    id: effort
+    attributes:
+      label: Estimated Effort
+      description: How long will this task take?
+      options:
+        - XS (< 1 hour)
+        - S (1-4 hours)
+        - M (4-8 hours)
+        - L (1-2 days)
+        - XL (> 2 days - consider breaking down)
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: parallel
+    attributes:
+      label: Parallel Execution
+      description: Can this task run in parallel with others?
+      options:
+        - label: This task can be worked on in parallel with other tasks (different files, no dependencies)
+          required: false
+
+  - type: textarea
+    id: part-of
+    attributes:
+      label: Part Of
+      description: Link to parent feature
+      placeholder: "Part of Feature #XXX"
+    validations:
+      required: false
+
+  - type: textarea
+    id: files
+    attributes:
+      label: Files to Modify
+      description: List of files that will be created or modified
+      placeholder: |
+        - src/models/user.py (create)
+        - src/services/auth.py (modify)
+        - tests/test_auth.py (create)
+    validations:
+      required: false
+
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: Dependencies
+      description: Other tasks this depends on
+      placeholder: |
+        - Depends on T001
+        - Blocked by #XXX
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other relevant information
+      placeholder: "Add any technical notes or references here..."
+    validations:
+      required: false

doit_cli/templates/hooks/post-commit.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+# Post-commit hook installed by doit
+# This hook logs bypass events when --no-verify was used
+
+# Exit on error
+set -e
+
+# Check if doit is available
+if ! command -v doit &> /dev/null; then
+    exit 0
+fi
+
+# Get the current commit hash
+COMMIT_HASH=$(git rev-parse HEAD 2>/dev/null || echo "")
+
+# Check if the pre-commit hook would have run validation
+# We detect bypass by checking if the commit was made without our validation
+# This is a best-effort detection since we can't know for certain if --no-verify was used
+
+# For now, we only log when explicitly called via doit hooks log-bypass
+# The actual bypass detection requires more complex logic that would need
+# to track state between pre-commit and post-commit hooks.
+
+# This hook is available for future enhancement to detect and log bypasses
+exit 0