@torus-engineering/tas-kit 1.14.0 → 2.1.0

package/.tas/templates/PRD.md

@@ -1,142 +1,173 @@
-# Product Requirements Document (PRD)
-
-> **Document Status:** [Draft | In Review | Approved | Archived]
-> **Last Updated:** [Date]
-> **Product Manager:** [Name]
-> **Contributors:** [Names/Roles]
-
----
-
-## Executive Summary
-
-**Product Name:** [Product/Feature Name]
-
-**Problem Statement:**
-[In 2-3 sentences, describe the core problem you're solving.]
-
-**Proposed Solution:**
-[In 2-3 sentences, describe your solution approach.]
-
-**Success Metrics:**
-- [Key metric 1 with target]
-- [Key metric 2 with target]
-
-**Launch Target:** [Quarter/Date]
-
----
-
-## Background & Context
-
-### Why Now?
-[Market timing, competitive landscape, internal factors]
-
-### User Research & Insights
-- **Research Methods:** [Interviews, surveys, usage data]
-- **Key Findings:**
-  - [Finding 1]
-  - [Finding 2]
-
-### Market Analysis
-- **Competitive Landscape:** [Key competitors]
-- **Differentiation:** [What makes our approach unique]
-
----
-
-## Goals & Success Criteria
-
-### Business Goals
-1. [Primary business objective]
-2. [Secondary business objective]
-
-### User Goals
-1. [What users should accomplish]
-2. [What friction we're removing]
-
-### Non-Goals (Out of Scope)
-- [Explicitly what this will NOT do]
-
----
-
-## User Personas & Use Cases
-
-### Primary Persona: [Name]
-- **Role:** [Job title]
-- **Goals:** [What they're trying to achieve]
-- **Pain Points:** [Current frustrations]
-
-### Key Use Cases
-
-#### Use Case 1: [Title]
-**Actor:** [Which persona]
-**Flow:**
-1. User [action]
-2. System [response]
-**Expected Outcome:** [Success looks like]
-
----
-
-## Product Requirements
-
-### Functional Requirements
-
-#### Must Have (P0)
-- **FR-001:** [Description]
-  - User Story: As a [persona], I want to [action] so that [benefit]
-  - Acceptance Criteria: [testable criteria]
-
-#### Should Have (P1)
-- **FR-010:** [Description]
-
-#### Could Have (P2)
-- **FR-020:** [Description]
-
-### Non-Functional Requirements
-- **NFR-001:** Performance - [requirement]
-- **NFR-002:** Security - [requirement]
-- **NFR-003:** Scalability - [requirement]
-
----
-
-## Technical Specifications
-[High-level architecture overview - link to SAD]
-
----
-
-## Go-to-Market Strategy
-
-### Launch Plan
-- **Beta Testing:** [Timeline, criteria]
-- **Launch Date:** [Target date]
-
-### Marketing & Positioning
-- **Value Proposition:** [One sentence]
-
----
-
-## Dependencies & Risks
-
-### Risks & Mitigation
-| Risk | Impact | Probability | Mitigation |
-|------|--------|-------------|------------|
-| [Risk 1] | High | Medium | [Mitigation] |
-
-### Open Questions
-- [Question 1]
-- [Question 2]
-
----
-
-## Timeline & Milestones
-| Phase | Timeline | Deliverables | Owner |
-|-------|----------|-------------|-------|
-| Discovery | [Dates] | PRD, Design | PE |
-| Development | [Dates] | Features | SE |
-| QA & Testing | [Dates] | Test reports | PE |
-| Launch | [Dates] | Production | DSE |
-
----
-
-## Changelog
-| Date | Version | Changes | Author |
-|------|---------|---------|--------|
-| [Date] | 1.0 | Initial draft | [Name] |
+# Product Requirements Document (PRD)
+
+> **Document Status:** [Draft | In Review | Approved | Archived]
+> **Last Updated:** [Date]
+> **Product Manager:** [Name]
+> **Contributors:** [Names/Roles]
+
+---
+
+## Executive Summary
+
+**Product Name:** [Product/Feature Name]
+
+**Problem Statement:**
+[In 2-3 sentences, describe the core problem you're solving.]
+
+**Proposed Solution:**
+[In 2-3 sentences, describe your solution approach.]
+
+**Success Metrics:**
+- [Key metric 1 with target]
+- [Key metric 2 with target]
+
+**Launch Target:** [Quarter/Date]
+
+---
+
+## Business Context
+
+<!--
+  COMMAND INSTRUCTION (tas-prd fills this section):
+  - docs/brd.md EXISTS   → use "With BRD" format below
+  - docs/brd.md MISSING  → use "Standalone" format below
+  Remove this comment block and the unused format when filling.
+-->
+
+<!-- WITH BRD: collapse to summary + link -->
+> **BRD:** [Business Requirements Document](brd.md)
+
+**Problem:** [1-2 sentence summary from BRD Problem Statement section]
+
+**Business Goals:**
+- [Goal 1 — copy from BRD Business Objectives]
+- [Goal 2]
+
+### Non-Goals (Out of Scope)
+- [Explicitly what this PRD will NOT do]
+
+<!-- STANDALONE: fill all sub-sections when no BRD exists -->
+### Why Now?
+[Market timing, competitive landscape, internal factors]
+
+### User Research & Insights
+- **Research Methods:** [Interviews, surveys, usage data]
+- **Key Findings:**
+  - [Finding 1]
+  - [Finding 2]
+
+### Market Analysis
+- **Competitive Landscape:** [Key competitors]
+- **Differentiation:** [What makes our approach unique]
+
+### Business Goals
+1. [Primary business objective]
+2. [Secondary business objective]
+
+### User Goals
+1. [What users should accomplish]
+2. [What friction we're removing]
+
+### Non-Goals (Out of Scope)
+- [Explicitly what this will NOT do]
+
+---
+
+## Product Specification
+
+> **Note:** Acceptance Criteria (AC) in this section drive test planning. Each AC generates test IDs (`{PROJECT}_F{FEATURE}_AC{N}_SMOKE_NNN`) and automated tests. Clarity here = fewer bugs in code.
+
+### User Personas & Use Cases
+
+#### Primary Persona: [Name]
+- **Role:** [Job title]
+- **Goals:** [What they're trying to achieve]
+- **Pain Points:** [Current frustrations]
+
+#### Key Use Cases
+
+##### Use Case 1: [Title]
+**Actor:** [Which persona]
+**Flow:**
+1. User [action]
+2. System [response]
+**Expected Outcome:** [Success looks like]
+
+---
+
+### Functional Requirements
+
+#### Must Have (P0)
+- **FR-001:** [Description]
+  - User Story: As a [persona], I want to [action] so that [benefit]
+  - **Acceptance Criteria:**
+    - **AC-1:** Given [context], when [action], then [outcome]
+    - **AC-2:** Given [context], when [action], then [outcome]
+
+#### Should Have (P1)
+- **FR-010:** [Description]
+
+#### Could Have (P2)
+- **FR-020:** [Description]
+
+---
+
+### Non-Functional Requirements
+- **NFR-001:** Performance - [requirement]
+- **NFR-002:** Security - [requirement]
+- **NFR-003:** Scalability - [requirement]
+
+---
+
+### Technical Specifications
+[High-level architecture overview - link to SAD]
+
+---
+
+### Go-to-Market Strategy
+
+#### Launch Plan
+- **Beta Testing:** [Timeline, criteria]
+- **Launch Date:** [Target date]
+
+#### Marketing & Positioning
+- **Value Proposition:** [One sentence]
+
+---
+
+### Dependencies & Risks
+
+#### Risks & Mitigation
+| Risk | Impact | Probability | Mitigation |
+|------|--------|-------------|------------|
+| [Risk 1] | High | Medium | [Mitigation] |
+
+#### Open Questions
+- [Question 1]
+- [Question 2]
+
+---
+
+### Timeline & Milestones
+| Phase | Timeline | Deliverables | Owner |
+|-------|----------|-------------|-------|
+| Discovery | [Dates] | PRD, Design | PE |
+| Development | [Dates] | Features | SE |
+| QA & Testing | [Dates] | Test reports | PE |
+| Launch | [Dates] | Production | DSE |
+
+---
+
+## Changelog
+| Date | Version | Changes | Author |
+|------|---------|---------|--------|
+| [Date] | 1.0 | Initial draft | [Name] |
+
+---
+
+## AI Usage Log
+
+| # | Date | Command | Input (est.) | Output (est.) |
+|---|------|---------|-------------|---------------|
+| 1 | [Date] | /tas-prd | ~{N}k | ~{N}k |
+| **Total** | | | **~{N}k** | **~{N}k** |

package/.tas/templates/TestChecklist.md

@@ -0,0 +1,96 @@
+# {PROJECT} - Test Checklist
+
+**Feature:** {Feature Name}
+**Feature Code:** {CODE}-Feature-{NNN}
+**Created Date:** {YYYY-MM-DD}
+**Tester:** {Tester Name}
+**Reviewer:** {Reviewer Name}
+**Status:** [ ] Draft [ ] In Review [ ] Approved
+
+---
+
+## 1. Feature Overview
+
+**Feature Description:**
+_{Brief description of the feature being tested}_
+
+**Business Objective:**
+_{What business value this feature delivers}_
+
+**Scope:**
+_{In scope: what will be tested}_
+_{Out of scope: what will NOT be tested}_
+
+---
+
+## 2. Checklist Matrix
+
+| Category | Point to Check | Priority | Requirement ID | Test Case ID | Notes |
+|----------|----------------|----------|----------------|--------------|-------|
+| **GUI & UX** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Validation** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Business Logic** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Exception Handling** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Security** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Performance** | | | | | |
+| | | | | | |
+| | | | | | |
+| **Integration** | | | | | |
+| | | | | | |
+| | | | | | |
+
+---
+
+## 3. Coverage Summary
+
+| Category | Total Points | Covered | Coverage % |
+|----------|--------------|---------|------------|
+| GUI & UX | | | |
+| Validation | | | |
+| Business Logic | | | |
+| Exception Handling | | | |
+| Security | | | |
+| Performance | | | |
+| Integration | | | |
+| **TOTAL** | | | |
+
+**Target Coverage:** ≥90%
+
+---
+
+## 4. Risk Assessment
+
+| Risk | Impact | Mitigation |
+|------|--------|------------|
+| | | |
+| | | |
+
+---
+
+## 5. Review & Approval
+
+| Role | Name | Date | Status |
+|------|------|------|--------|
+| Author | | | [ ] Done |
+| Reviewer | | | [ ] Approved [ ] Reject |
+| | | | |
+
+**Review Comments:**
+
+---
+
+## 6. Change Log
+
+| Date | Version | Changed By | Changes |
+|------|---------|------------|---------|
+| | 1.0 | | Initial |

package/.tas/templates/torus-dotnet-bootstrap.md

@@ -0,0 +1,223 @@
+# Torus Bootstrap
+
+CLI tool to bootstrap ASP.NET Core applications with Onion Architecture using the Torus Backend Framework.
+
+> **Rule:** see [`.tas/rules/csharp/torus-core-framework.md`](../rules/csharp/torus-core-framework.md) for the guardrails `/tas-plan` and `/tas-dev` apply when scaffolding.
+
+## Installation
+
+```bash
+dotnet tool install --global Torus.Bootstrap
+```
+
+Or build from source:
+
+```bash
+cd Torus.Bootstrap
+dotnet pack
+dotnet tool install --global --add-source ./bin/Debug Torus.Bootstrap
+```
+
+## Usage
+
+### Interactive Mode (Default)
+
+```bash
+torus-bootstrap create --name Torus.Org
+```
+
+This will prompt you for:
+- Cache configuration (Memory/Redis/Both)
+- Messaging (Kafka)
+- Background Jobs (Quartz)
+- Telemetry (OpenTelemetry)
+- Captcha (Google/Turnstile)
+- OPA Authorization
+- Blob Storage (FileSystem/MinIO/S3)
+- Email (MailKit/SES)
+- Database type (SQL Server/PostgreSQL/MySQL/MongoDB)
+- Multi-tenancy
+
+### Non-Interactive Mode
+
+```bash
+torus-bootstrap create --name Torus.Org --interactive false
+```
+
+Uses default configuration:
+- Memory Cache
+- OpenTelemetry
+- SQL Server
+
+### Command-Line Options
+
+You can specify configuration options via command-line flags:
+
+```bash
+torus-bootstrap create --name Torus.Org \
+  --cache redis \
+  --distributed-lock \
+  --messaging \
+  --kafka \
+  --background-jobs \
+  --quartz \
+  --telemetry \
+  --otel \
+  --captcha google \
+  --opa \
+  --blob-storage s3 \
+  --email ses \
+  --database postgresql \
+  --multi-tenancy
+```
+
+#### Available Options
+
+**Cache:**
+- `--cache <none|memory|redis|both>` - Cache type (default: memory)
+- `--distributed-lock` - Enable distributed locks (requires Redis)
+
+**Messaging:**
+- `--messaging` - Enable messaging
+- `--kafka` - Use Kafka (requires --messaging)
+
+**Background Jobs:**
+- `--background-jobs` - Enable background jobs
+- `--quartz` - Use Quartz.NET (requires --background-jobs)
+
+**Telemetry:**
+- `--telemetry` - Enable telemetry
+- `--otel` - Use OpenTelemetry (requires --telemetry)
+
+**Captcha:**
+- `--captcha <none|google|turnstile|both>` - Captcha type
+
+**Authorization:**
+- `--opa` - Use OPA (Open Policy Agent) for policy-based authorization
+
+**Blob Storage:**
+- `--blob-storage <none|filesystem|minio|s3|both>` - Blob storage type
+
+**Email:**
+- `--email <none|mailkit|ses|both>` - Email type
+
+**Database:**
+- `--database <sqlserver|postgresql|mysql|mongodb>` - Database type (default: sqlserver)
+
+**Multi-Tenancy:**
+- `--multi-tenancy` - Enable multi-tenancy
+
+#### Combining Interactive and Command-Line Options
+
+Command-line options override interactive prompts:
+
+```bash
+torus-bootstrap create --name Torus.Org --cache redis --database postgresql
+```
+
+This will use interactive mode but skip prompts for cache and database, using the provided values instead.
+
+### Output Directory
+
+```bash
+torus-bootstrap create --name Torus.Org --output ./MyProjects
+```
+
+## Generated Project Structure
+
+```
+Torus.Org/
+├── Torus.Org.Domain.Shared/     # Shared domain types
+├── Torus.Org.Domain/            # Domain layer
+├── Torus.Org.Application.Contracts/  # Application contracts
+├── Torus.Org.Application/        # Application layer
+├── Torus.Org.Persistence.EfCore/ # Data access layer
+├── Torus.Org.Infrastructure/      # Infrastructure layer
+├── Torus.Org.WebApi/             # Web API layer
+└── Torus.Org.sln                 # Solution file
+```
+
+## Next Steps
+
+After generating the project:
+
+1. Navigate to the project directory:
+   ```bash
+   cd Torus.Org
+   ```
+
+2. Restore packages:
+   ```bash
+   dotnet restore
+   ```
+
+3. Update `appsettings.json` with your configuration
+
+4. Add database provider package to `Persistence.EfCore` project:
+   - SQL Server: `Microsoft.EntityFrameworkCore.SqlServer`
+   - PostgreSQL: `Npgsql.EntityFrameworkCore.PostgreSQL`
+   - MySQL: `Pomelo.EntityFrameworkCore.MySql`
+
+5. Create initial migration:
+   ```bash
+   dotnet ef migrations add InitialCreate --project Torus.Org.Persistence.EfCore
+   ```
+
+6. Build and run:
+   ```bash
+   dotnet build
+   dotnet run --project Torus.Org.WebApi
+   ```
+
+## Features
+
+The tool generates:
+
+- Onion Architecture project structure
+- DbContext and UnitOfWork setup
+- Program.cs with configured services
+- appsettings.json with configuration templates
+- Solution file with all projects
+- README.md with setup instructions
+
+## Configuration Options
+
+### Cache
+- **Memory**: In-memory caching
+- **Redis**: Distributed Redis cache
+- **Both**: Memory + Redis with invalidation
+
+### Messaging
+- **Kafka**: Kafka message broker integration
+
+### Background Jobs
+- **Quartz.NET**: Scheduled and recurring jobs
+
+### Telemetry
+- **OpenTelemetry**: Distributed tracing and metrics
+
+### Captcha
+- **Google reCAPTCHA**: Bot detection
+- **Cloudflare Turnstile**: Privacy-focused captcha
+
+### Authorization
+- **OPA**: Open Policy Agent integration
+
+### Blob Storage
+- **FileSystem**: Local file storage
+- **MinIO**: S3-compatible object storage
+- **AWS S3**: Amazon S3 storage
+
+### Email
+- **MailKit**: SMTP email sending
+- **AWS SES**: Amazon Simple Email Service
+
+### Database
+- **SQL Server**: Microsoft SQL Server
+- **PostgreSQL**: PostgreSQL database
+- **MySQL**: MySQL database
+- **MongoDB**: MongoDB (NoSQL)
+
+## License
+
+Part of the Torus Backend Framework.