@mytechtoday/augment-extensions 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/AGENTS.md +33 -1
  2. package/README.md +3 -3
  3. package/augment-extensions/domain-rules/software-architecture/README.md +143 -0
  4. package/augment-extensions/domain-rules/software-architecture/examples/banking-layered.md +961 -0
  5. package/augment-extensions/domain-rules/software-architecture/examples/ecommerce-microservices.md +990 -0
  6. package/augment-extensions/domain-rules/software-architecture/examples/iot-eventdriven.md +882 -0
  7. package/augment-extensions/domain-rules/software-architecture/examples/monolith-to-microservices-migration.md +703 -0
  8. package/augment-extensions/domain-rules/software-architecture/examples/serverless-imageprocessing.md +957 -0
  9. package/augment-extensions/domain-rules/software-architecture/examples/trading-eventdriven.md +747 -0
  10. package/augment-extensions/domain-rules/software-architecture/module.json +119 -0
  11. package/augment-extensions/domain-rules/software-architecture/rules/challenges-solutions.md +763 -0
  12. package/augment-extensions/domain-rules/software-architecture/rules/definitions-terminology.md +409 -0
  13. package/augment-extensions/domain-rules/software-architecture/rules/design-principles.md +684 -0
  14. package/augment-extensions/domain-rules/software-architecture/rules/evaluation-testing.md +1381 -0
  15. package/augment-extensions/domain-rules/software-architecture/rules/event-driven-architecture.md +616 -0
  16. package/augment-extensions/domain-rules/software-architecture/rules/fundamentals.md +306 -0
  17. package/augment-extensions/domain-rules/software-architecture/rules/industry-architectures.md +554 -0
  18. package/augment-extensions/domain-rules/software-architecture/rules/layered-architecture.md +776 -0
  19. package/augment-extensions/domain-rules/software-architecture/rules/microservices-architecture.md +503 -0
  20. package/augment-extensions/domain-rules/software-architecture/rules/modeling-documentation.md +1199 -0
  21. package/augment-extensions/domain-rules/software-architecture/rules/monolithic-architecture.md +351 -0
  22. package/augment-extensions/domain-rules/software-architecture/rules/principles.md +556 -0
  23. package/augment-extensions/domain-rules/software-architecture/rules/quality-attributes.md +797 -0
  24. package/augment-extensions/domain-rules/software-architecture/rules/scalability-performance.md +1345 -0
  25. package/augment-extensions/domain-rules/software-architecture/rules/security-architecture.md +1039 -0
  26. package/augment-extensions/domain-rules/software-architecture/rules/serverless-architecture.md +711 -0
  27. package/augment-extensions/domain-rules/software-architecture/rules/skills-development.md +568 -0
  28. package/augment-extensions/domain-rules/software-architecture/rules/tools-methodologies.md +961 -0
  29. package/augment-extensions/visual-design/CHANGELOG.md +132 -0
  30. package/augment-extensions/visual-design/README.md +255 -0
  31. package/augment-extensions/visual-design/__tests__/README.md +119 -0
  32. package/augment-extensions/visual-design/__tests__/style-selector.test.ts +172 -0
  33. package/augment-extensions/visual-design/__tests__/vendor-styles.test.ts +214 -0
  34. package/augment-extensions/visual-design/domains/other/ai-prompt-helper.ts +157 -0
  35. package/augment-extensions/visual-design/domains/other/dotnet-application.ts +156 -0
  36. package/augment-extensions/visual-design/domains/other/linux-platform.ts +156 -0
  37. package/augment-extensions/visual-design/domains/other/mobile-application.ts +157 -0
  38. package/augment-extensions/visual-design/domains/other/motion-picture.ts +156 -0
  39. package/augment-extensions/visual-design/domains/other/os-application.ts +156 -0
  40. package/augment-extensions/visual-design/domains/other/print-campaigns.ts +158 -0
  41. package/augment-extensions/visual-design/domains/other/web-app.ts +157 -0
  42. package/augment-extensions/visual-design/domains/other/website.ts +161 -0
  43. package/augment-extensions/visual-design/domains/other/windows-platform.ts +156 -0
  44. package/augment-extensions/visual-design/domains/web-page-styles/amazon-cloudscape.ts +506 -0
  45. package/augment-extensions/visual-design/domains/web-page-styles/google-modern.ts +615 -0
  46. package/augment-extensions/visual-design/domains/web-page-styles/microsoft-fluent.ts +531 -0
  47. package/augment-extensions/visual-design/examples/README.md +97 -0
  48. package/augment-extensions/visual-design/examples/ai-prompt-generation.md +233 -0
  49. package/augment-extensions/visual-design/examples/basic-usage.md +216 -0
  50. package/augment-extensions/visual-design/examples/domain-workflows.md +257 -0
  51. package/augment-extensions/visual-design/examples/vendor-comparison.md +247 -0
  52. package/augment-extensions/visual-design/module.json +78 -0
  53. package/augment-extensions/visual-design/style-selector.ts +177 -0
  54. package/augment-extensions/visual-design/types.ts +302 -0
  55. package/augment-extensions/visual-design/visual-design-core.ts +469 -0
  56. package/augment-extensions/workflows/adr-support/README.md +227 -0
  57. package/augment-extensions/workflows/adr-support/__tests__/adr-validator.test.ts +203 -0
  58. package/augment-extensions/workflows/adr-support/adr-validator.ts +162 -0
  59. package/augment-extensions/workflows/adr-support/examples/complete-lifecycle-example.md +449 -0
  60. package/augment-extensions/workflows/adr-support/examples/integration-example.md +580 -0
  61. package/augment-extensions/workflows/adr-support/examples/superseding-example.md +436 -0
  62. package/augment-extensions/workflows/adr-support/module.json +112 -0
  63. package/augment-extensions/workflows/adr-support/rules/adr-creation.md +372 -0
  64. package/augment-extensions/workflows/adr-support/rules/beads-integration.md +443 -0
  65. package/augment-extensions/workflows/adr-support/rules/conflict-detection.md +486 -0
  66. package/augment-extensions/workflows/adr-support/rules/decision-detection.md +362 -0
  67. package/augment-extensions/workflows/adr-support/rules/lifecycle-management.md +427 -0
  68. package/augment-extensions/workflows/adr-support/rules/openspec-integration.md +465 -0
  69. package/augment-extensions/workflows/adr-support/rules/template-selection.md +405 -0
  70. package/augment-extensions/workflows/adr-support/rules/validation-rules.md +543 -0
  71. package/augment-extensions/workflows/adr-support/schemas/adr-config.json +191 -0
  72. package/augment-extensions/workflows/adr-support/schemas/adr-metadata.json +172 -0
  73. package/augment-extensions/workflows/adr-support/templates/business-case.md +235 -0
  74. package/augment-extensions/workflows/adr-support/templates/madr-elaborate.md +197 -0
  75. package/augment-extensions/workflows/adr-support/templates/madr-simple.md +68 -0
  76. package/augment-extensions/workflows/adr-support/templates/nygard.md +84 -0
  77. package/augment-extensions/workflows/beads/rules/workflow.md +1 -1
  78. package/cli/dist/utils/__tests__/adr-validator.example.d.ts +6 -0
  79. package/cli/dist/utils/__tests__/adr-validator.example.d.ts.map +1 -0
  80. package/cli/dist/utils/__tests__/adr-validator.example.js +148 -0
  81. package/cli/dist/utils/__tests__/adr-validator.example.js.map +1 -0
  82. package/cli/dist/utils/adr-validator.d.ts +65 -0
  83. package/cli/dist/utils/adr-validator.d.ts.map +1 -0
  84. package/cli/dist/utils/adr-validator.js +203 -0
  85. package/cli/dist/utils/adr-validator.js.map +1 -0
  86. package/modules.md +40 -3
  87. package/package.json +1 -1
package/AGENTS.md CHANGED
@@ -147,6 +147,38 @@ When making architectural changes:
147
147
 
148
148
  ---
149
149
 
150
+ ## JIRA Integration
151
+
152
+ This repository integrates JIRA tickets into OpenSpec changes for traceability and context preservation.
153
+
154
+ ### JIRA Workflow
155
+
156
+ 1. **Store JIRA Tickets**: Place JIRA ticket content in `openspec/changes/[change-name]/jira/[TICKET-ID].md`
157
+ 2. **Link to Proposal**: Add "Related JIRA" section in proposal.md linking to the JIRA ticket
158
+ 3. **Update Coordination**: Track JIRA file in `.augment/coordination.json`
159
+ 4. **Cleanup**: Remove temporary JIRA files after migration
160
+
161
+ ### JIRA Directory Structure
162
+
163
+ ```
164
+ openspec/changes/[change-name]/jira/
165
+ ├── [TICKET-ID].md # JIRA ticket content
166
+ └── .gitkeep # Ensures directory is tracked
167
+ ```
168
+
169
+ ### For AI Agents
170
+
171
+ When working with JIRA tickets:
172
+ 1. Create `jira/` directory within the OpenSpec change
173
+ 2. Copy JIRA ticket content to `jira/[TICKET-ID].md`
174
+ 3. Add "Related JIRA" section to proposal.md
175
+ 4. Update coordination manifest with JIRA file tracking
176
+ 5. Remove temporary JIRA files after successful migration
177
+
178
+ **Example**: See `openspec/changes/bash-coding-standards/spec-delta-jira-integration.md` for complete workflow documentation.
179
+
180
+ ---
181
+
150
182
  ## Beads Integration
151
183
 
152
184
  This repository uses **Beads** for task tracking and memory.
@@ -231,7 +263,7 @@ const specsForFile = Object.entries(coord.specs)
231
263
  );
232
264
  ```
233
265
 
234
- **Learn More**: See `.augment/rules/coordination-system.md` for detailed documentation.
266
+ **Learn More**: See `.augment-guidelines/system-integration/coordination-system.md` for detailed documentation.
235
267
 
236
268
  ---
237
269
 
package/README.md CHANGED
@@ -622,8 +622,8 @@ Extensions integrate seamlessly:
622
622
  ### Core Documentation
623
623
  - [AGENTS.md](./AGENTS.md) - AI agent integration guide
624
624
  - [MODULES.md](./MODULES.md) - Complete module catalog
625
- - [Module Development](./.augment/rules/module-development.md) - Creating custom modules
626
- - [Character Count Management](./.augment/rules/character-count-management.md) - Managing .augment/ limits
625
+ - [Module Development](./.augment-guidelines/development/module-development.md) - Creating custom modules
626
+ - [Character Count Management](./.augment-guidelines/repository-rules/character-count-management.md) - Managing .augment/ limits
627
627
 
628
628
  ### Workflow Documentation
629
629
  - [OpenSpec Workflow](./augment-extensions/workflows/openspec/) - Spec-driven development
@@ -917,7 +917,7 @@ The most comprehensive WordPress module:
917
917
 
918
918
  We welcome contributions! Here's how to help:
919
919
 
920
- 1. **Create New Modules** - Follow [module-development.md](./.augment/rules/module-development.md)
920
+ 1. **Create New Modules** - Follow [module-development.md](./.augment-guidelines/development/module-development.md)
921
921
  2. **Improve Existing Modules** - Submit PRs with enhancements
922
922
  3. **Report Issues** - Use GitHub issues for bugs and feature requests
923
923
  4. **Share Examples** - Contribute real-world examples
@@ -0,0 +1,143 @@
1
+ # Software Architecture Design Module
2
+
3
+ Comprehensive software architecture design patterns, principles, and best practices for building scalable, maintainable, and secure systems.
4
+
5
+ ## Overview
6
+
7
+ This module provides AI agents with comprehensive guidance on software architecture design, covering:
8
+
9
+ - **Architecture Fundamentals** - Core elements, components, connectors, and configurations
10
+ - **Architecture Patterns** - Monolithic, microservices, event-driven, serverless, and layered architectures
11
+ - **Quality Attributes** - Performance, security, scalability, reliability, and maintainability
12
+ - **Best Practices** - Tools, methodologies, modeling, and documentation
13
+ - **Specialized Architectures** - Industry-specific patterns for IoT, AI, blockchain, and edge computing
14
+
15
+ ## Installation
16
+
17
+ ### With CLI (Future)
18
+
19
+ ```bash
20
+ augx link domain-rules/software-architecture
21
+ ```
22
+
23
+ ### Without CLI (Current)
24
+
25
+ Copy the contents of this module to your project's `.augment/` folder or reference the module files directly.
26
+
27
+ ## Module Structure
28
+
29
+ ```
30
+ augment-extensions/domain-rules/software-architecture/
31
+ ├── module.json # Module metadata and configuration
32
+ ├── README.md # This file
33
+ ├── rules/ # Architecture guidelines
34
+ │ ├── fundamentals.md # Core architectural elements
35
+ │ ├── principles.md # Design principles
36
+ │ ├── monolithic.md # Monolithic architecture
37
+ │ ├── microservices.md # Microservices patterns
38
+ │ ├── event-driven.md # Event-driven architecture
39
+ │ ├── serverless.md # Serverless patterns
40
+ │ ├── layered.md # Layered architecture
41
+ │ ├── quality-attributes.md # Non-functional requirements
42
+ │ ├── security.md # Security architecture
43
+ │ ├── scalability.md # Scalability patterns
44
+ │ ├── tools-methodologies.md # TOGAF, DDD, CI/CD
45
+ │ ├── modeling-documentation.md # 4+1 views, UML, C4
46
+ │ ├── industry-architectures.md # IoT, AI, blockchain
47
+ │ └── skills-development.md # Architect skills
48
+ └── examples/ # Architecture examples
49
+ ├── ecommerce-microservices.md # E-commerce platform
50
+ ├── iot-eventdriven.md # IoT sensor network
51
+ ├── trading-eventdriven.md # Stock trading system
52
+ └── serverless-imageprocessing.md # Image processing pipeline
53
+ ```
54
+
55
+ ## Sub-Modules
56
+
57
+ This module is organized into five sub-modules for selective loading:
58
+
59
+ ### 1. Fundamentals
60
+ Core architectural concepts and principles.
61
+ - `fundamentals.md` - Components, connectors, configurations (ISO/IEC 42010)
62
+ - `principles.md` - Modularity, separation of concerns, coupling, cohesion
63
+
64
+ ### 2. Patterns
65
+ Common architectural patterns and styles.
66
+ - `monolithic.md` - Monolithic architecture patterns
67
+ - `microservices.md` - Service discovery, API gateways, distributed systems
68
+ - `event-driven.md` - Pub/sub, CQRS, event sourcing
69
+ - `serverless.md` - FaaS, stateless functions, cloud-native
70
+ - `layered.md` - MVC, pipe-and-filter, n-tier
71
+
72
+ ### 3. Quality
73
+ Non-functional requirements and quality attributes.
74
+ - `quality-attributes.md` - Performance, reliability, maintainability
75
+ - `security.md` - Threat modeling, zero-trust, RBAC (OWASP)
76
+ - `scalability.md` - Horizontal/vertical scaling, caching, load balancing
77
+
78
+ ### 4. Practices
79
+ Tools, methodologies, and documentation.
80
+ - `tools-methodologies.md` - TOGAF, DDD, CI/CD frameworks
81
+ - `modeling-documentation.md` - 4+1 views, UML, C4 model, auto-generation
82
+
83
+ ### 5. Specialized
84
+ Industry-specific and specialized patterns.
85
+ - `industry-architectures.md` - IoT, AI/ML, blockchain, edge computing
86
+ - `skills-development.md` - Technical and soft skills for architects
87
+
88
+ ## Usage
89
+
90
+ ### For AI Agents
91
+
92
+ When working on architecture-related tasks:
93
+
94
+ 1. **Query the module**: `augx show software-architecture`
95
+ 2. **Load specific sub-module**: `augx show software-architecture/fundamentals`
96
+ 3. **Apply guidelines**: Follow the patterns and principles in the rule files
97
+ 4. **Reference examples**: Use example architectures as templates
98
+
99
+ ### Common Use Cases
100
+
101
+ - **Designing new systems**: Start with fundamentals and principles
102
+ - **Choosing architecture pattern**: Review patterns sub-module
103
+ - **Security review**: Consult security.md and quality-attributes.md
104
+ - **Scaling existing system**: Review scalability.md and microservices.md
105
+ - **Documentation**: Use modeling-documentation.md for architecture diagrams
106
+
107
+ ## Key Features
108
+
109
+ ✅ **Comprehensive Coverage** - All major architecture patterns and styles
110
+ ✅ **Industry Standards** - Based on ISO/IEC 42010, TOGAF, OWASP
111
+ ✅ **Practical Examples** - Real-world architecture examples
112
+ ✅ **Quality Focus** - Emphasis on non-functional requirements
113
+ ✅ **Modular Design** - Sub-modules for selective loading
114
+ ✅ **Best Practices** - Proven patterns and anti-patterns
115
+
116
+ ## Character Count
117
+
118
+ **Total**: 508,000 characters (25 files including rules, examples, and documentation)
119
+
120
+ ## Version
121
+
122
+ **Current Version**: 1.0.0
123
+
124
+ ## Contents
125
+
126
+ - **16 Rule Files** covering all aspects of software architecture
127
+ - **4 Example Files** demonstrating real-world architectures
128
+ - **5 Sub-Modules** for organized, selective loading
129
+ - **Standards-Based** - ISO/IEC 42010, TOGAF, OWASP, DDD
130
+
131
+ ## References
132
+
133
+ - ISO/IEC 42010 - Systems and software engineering — Architecture description
134
+ - TOGAF - The Open Group Architecture Framework
135
+ - OWASP - Open Web Application Security Project
136
+ - Domain-Driven Design (DDD) - Eric Evans
137
+ - C4 Model - Simon Brown
138
+ - 4+1 Architectural View Model - Philippe Kruchten
139
+
140
+ ## License
141
+
142
+ Part of Augment Extensions repository.
143
+