@mytechtoday/augment-extensions 0.5.0 → 1.2.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 (523) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +113 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +15 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +576 -23
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/config-system.d.ts +111 -0
  476. package/cli/dist/utils/config-system.d.ts.map +1 -0
  477. package/cli/dist/utils/config-system.js +239 -0
  478. package/cli/dist/utils/config-system.js.map +1 -0
  479. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  480. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  481. package/cli/dist/utils/extractCommandHelp.js +250 -0
  482. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  483. package/cli/dist/utils/hook-system.d.ts +84 -0
  484. package/cli/dist/utils/hook-system.d.ts.map +1 -0
  485. package/cli/dist/utils/hook-system.js +151 -0
  486. package/cli/dist/utils/hook-system.js.map +1 -0
  487. package/cli/dist/utils/inspection-cache.d.ts +56 -0
  488. package/cli/dist/utils/inspection-cache.d.ts.map +1 -0
  489. package/cli/dist/utils/inspection-cache.js +166 -0
  490. package/cli/dist/utils/inspection-cache.js.map +1 -0
  491. package/cli/dist/utils/inspection-handlers.d.ts +75 -0
  492. package/cli/dist/utils/inspection-handlers.d.ts.map +1 -0
  493. package/cli/dist/utils/inspection-handlers.js +171 -0
  494. package/cli/dist/utils/inspection-handlers.js.map +1 -0
  495. package/cli/dist/utils/install-rules.js +55 -55
  496. package/cli/dist/utils/mcp-integration.js +44 -44
  497. package/cli/dist/utils/module-system.d.ts +1 -0
  498. package/cli/dist/utils/module-system.d.ts.map +1 -1
  499. package/cli/dist/utils/module-system.js +8 -3
  500. package/cli/dist/utils/module-system.js.map +1 -1
  501. package/cli/dist/utils/plugin-system.d.ts +133 -0
  502. package/cli/dist/utils/plugin-system.d.ts.map +1 -0
  503. package/cli/dist/utils/plugin-system.js +210 -0
  504. package/cli/dist/utils/plugin-system.js.map +1 -0
  505. package/cli/dist/utils/progress.d.ts +67 -0
  506. package/cli/dist/utils/progress.d.ts.map +1 -0
  507. package/cli/dist/utils/progress.js +146 -0
  508. package/cli/dist/utils/progress.js.map +1 -0
  509. package/cli/dist/utils/rule-install-hooks.js +8 -8
  510. package/cli/dist/utils/stream-reader.d.ts +34 -0
  511. package/cli/dist/utils/stream-reader.d.ts.map +1 -0
  512. package/cli/dist/utils/stream-reader.js +147 -0
  513. package/cli/dist/utils/stream-reader.js.map +1 -0
  514. package/cli/dist/utils/vscode-editor.d.ts +45 -0
  515. package/cli/dist/utils/vscode-editor.d.ts.map +1 -0
  516. package/cli/dist/utils/vscode-editor.js +171 -0
  517. package/cli/dist/utils/vscode-editor.js.map +1 -0
  518. package/cli/dist/utils/vscode-links.d.ts +49 -0
  519. package/cli/dist/utils/vscode-links.d.ts.map +1 -0
  520. package/cli/dist/utils/vscode-links.js +167 -0
  521. package/cli/dist/utils/vscode-links.js.map +1 -0
  522. package/modules.md +667 -630
  523. package/package.json +85 -85
@@ -1,540 +1,540 @@
1
- # Complete WordPress Plugin Example
2
-
3
- This example shows a complete WordPress plugin development workflow from start to finish using OpenSpec and Beads.
4
-
5
- ## Scenario
6
-
7
- Building a "Simple Contact Form" WordPress plugin that allows users to submit contact messages through a form on the frontend, with admin management capabilities.
8
-
9
- ## Plugin Requirements
10
-
11
- - **Plugin Name**: Simple Contact Form
12
- - **Plugin Slug**: simple-contact-form
13
- - **Text Domain**: simple-contact-form
14
- - **Minimum WordPress**: 6.0
15
- - **PHP Version**: 7.4+
16
- - **Features**:
17
- - Frontend contact form with name, email, subject, message fields
18
- - Admin page to view submitted messages
19
- - Email notifications to site admin
20
- - AJAX form submission
21
- - Security: nonces, sanitization, escaping, capability checks
22
-
23
- ## Directory Structure
24
-
25
- ```
26
- simple-contact-form/
27
- ├── simple-contact-form.php # Main plugin file
28
- ├── readme.txt # WordPress.org readme
29
- ├── uninstall.php # Cleanup on uninstall
30
- ├── includes/
31
- │ ├── class-contact-form.php # Core form logic
32
- │ ├── class-contact-message.php # Message model
33
- │ └── class-email-handler.php # Email sending
34
- ├── admin/
35
- │ ├── class-admin.php # Admin interface
36
- │ ├── css/
37
- │ │ └── admin.css
38
- │ └── js/
39
- │ └── admin.js
40
- ├── public/
41
- │ ├── class-public.php # Frontend display
42
- │ ├── css/
43
- │ │ └── public.css
44
- │ └── js/
45
- │ └── public.js
46
- ├── tests/
47
- │ ├── bootstrap.php
48
- │ ├── test-contact-form.php
49
- │ └── test-email-handler.php
50
- └── languages/
51
- └── simple-contact-form.pot
52
- ```
53
-
54
- ## Step 1: Initialize OpenSpec
55
-
56
- ```bash
57
- # Create OpenSpec directory structure
58
- mkdir -p openspec/specs/plugin-features
59
- mkdir -p openspec/changes
60
- ```
61
-
62
- ## Step 2: Create OpenSpec Specification
63
-
64
- **File**: `openspec/specs/plugin-features/contact-form.md`
65
-
66
- ```markdown
67
- ---
68
- id: plugin-features/contact-form
69
- status: active
70
- relatedTasks: []
71
- ---
72
-
73
- # Simple Contact Form Plugin
74
-
75
- ## Overview
76
- A WordPress plugin that provides a simple contact form with admin management.
77
-
78
- ## Requirements
79
-
80
- ### Functional Requirements
81
- - Display contact form via shortcode `[simple_contact_form]`
82
- - Collect: name, email, subject, message
83
- - Store submissions in custom database table
84
- - Send email notification to admin on submission
85
- - Admin page to view/delete submissions
86
- - AJAX form submission with loading state
87
-
88
- ### Security Requirements
89
- - Nonce verification for form submission
90
- - Capability check: `manage_options` for admin page
91
- - Sanitize all inputs using WordPress functions
92
- - Escape all outputs
93
- - Validate email addresses
94
- - Rate limiting: max 3 submissions per IP per hour
95
-
96
- ### Performance Requirements
97
- - Database queries optimized with indexes
98
- - AJAX for form submission (no page reload)
99
- - Conditional asset loading (only load on pages with shortcode)
100
-
101
- ## User Stories
102
-
103
- **As a** site visitor
104
- **I want** to submit a contact message
105
- **So that** I can communicate with the site owner
106
-
107
- **As a** site admin
108
- **I want** to view submitted messages
109
- **So that** I can respond to inquiries
110
-
111
- ## Technical Approach
112
-
113
- ### Database Schema
114
- Custom table: `wp_simple_contact_messages`
115
- - id (bigint, primary key, auto_increment)
116
- - name (varchar 255)
117
- - email (varchar 255)
118
- - subject (varchar 255)
119
- - message (text)
120
- - ip_address (varchar 45)
121
- - submitted_at (datetime)
122
- - status (varchar 20, default 'unread')
123
-
124
- ### WordPress Integration
125
- - Shortcode: `simple_contact_form`
126
- - Admin menu: Tools > Contact Messages
127
- - AJAX action: `simple_contact_form_submit`
128
- - Activation hook: create database table
129
- - Uninstall hook: remove database table and options
130
-
131
- ### Files to Create
132
- - Main plugin file with header
133
- - Core classes for form, message, email
134
- - Admin interface class
135
- - Frontend display class
136
- - CSS/JS assets
137
- - Unit tests
138
- ```
139
-
140
- ## Step 3: Create Beads Epic and Tasks
141
-
142
- ```bash
143
- # Create epic
144
- bd create "Build Simple Contact Form Plugin" -p 0 --type epic --label wordpress --label plugin
145
- # Returns: bd-scf
146
-
147
- # Database setup
148
- bd create "Create database schema" -p 0 --parent bd-scf --label database
149
- # Returns: bd-scf.1
150
-
151
- # Core implementation
152
- bd create "Create ContactForm core class" -p 1 --parent bd-scf --label implementation
153
- # Returns: bd-scf.2
154
-
155
- bd create "Create ContactMessage model class" -p 1 --parent bd-scf --label implementation
156
- # Returns: bd-scf.3
157
-
158
- bd create "Create EmailHandler class" -p 1 --parent bd-scf --label implementation
159
- # Returns: bd-scf.4
160
-
161
- # Admin interface
162
- bd create "Create admin interface" -p 1 --parent bd-scf --label admin
163
- # Returns: bd-scf.5
164
-
165
- bd create "Add admin CSS/JS" -p 1 --parent bd-scf --label admin
166
- # Returns: bd-scf.6
167
-
168
- # Frontend
169
- bd create "Create frontend form display" -p 1 --parent bd-scf --label frontend
170
- # Returns: bd-scf.7
171
-
172
- bd create "Add AJAX form submission" -p 1 --parent bd-scf --label frontend --label ajax
173
- # Returns: bd-scf.8
174
-
175
- bd create "Add frontend CSS/JS" -p 1 --parent bd-scf --label frontend
176
- # Returns: bd-scf.9
177
-
178
- # Security
179
- bd create "Add nonce verification" -p 1 --parent bd-scf --label security
180
- # Returns: bd-scf.10
181
-
182
- bd create "Add input sanitization" -p 1 --parent bd-scf --label security
183
- # Returns: bd-scf.11
184
-
185
- bd create "Add output escaping" -p 1 --parent bd-scf --label security
186
- # Returns: bd-scf.12
187
-
188
- bd create "Add rate limiting" -p 1 --parent bd-scf --label security
189
- # Returns: bd-scf.13
190
-
191
- # Testing
192
- bd create "Write unit tests" -p 1 --parent bd-scf --label testing
193
- # Returns: bd-scf.14
194
-
195
- bd create "Manual testing in WordPress" -p 2 --parent bd-scf --label testing
196
- # Returns: bd-scf.15
197
- ```
198
-
199
- ## Step 4: Add Task Dependencies
200
-
201
- ```bash
202
- # Core classes depend on database
203
- bd dep add bd-scf.2 bd-scf.1
204
- bd dep add bd-scf.3 bd-scf.1
205
- bd dep add bd-scf.4 bd-scf.1
206
-
207
- # Admin depends on core classes
208
- bd dep add bd-scf.5 bd-scf.3
209
- bd dep add bd-scf.6 bd-scf.5
210
-
211
- # Frontend depends on core classes
212
- bd dep add bd-scf.7 bd-scf.2
213
- bd dep add bd-scf.8 bd-scf.7
214
- bd dep add bd-scf.9 bd-scf.7
215
-
216
- # Security tasks depend on implementation
217
- bd dep add bd-scf.10 bd-scf.8
218
- bd dep add bd-scf.11 bd-scf.2
219
- bd dep add bd-scf.12 bd-scf.5
220
- bd dep add bd-scf.13 bd-scf.8
221
-
222
- # Testing depends on everything
223
- bd dep add bd-scf.14 bd-scf.13
224
- bd dep add bd-scf.15 bd-scf.14
225
- ```
226
-
227
- ## Step 5: Implementation Workflow
228
-
229
- ### Task bd-scf.1: Create Database Schema
230
-
231
- ```bash
232
- bd update bd-scf.1 --status in_progress
233
- ```
234
-
235
- **File**: `includes/class-contact-message.php` (database setup)
236
-
237
- ```php
238
- <?php
239
- class Simple_Contact_Message {
240
- public static function create_table() {
241
- global $wpdb;
242
- $table_name = $wpdb->prefix . 'simple_contact_messages';
243
- $charset_collate = $wpdb->get_charset_collate();
244
-
245
- $sql = "CREATE TABLE $table_name (
246
- id bigint(20) NOT NULL AUTO_INCREMENT,
247
- name varchar(255) NOT NULL,
248
- email varchar(255) NOT NULL,
249
- subject varchar(255) NOT NULL,
250
- message text NOT NULL,
251
- ip_address varchar(45) NOT NULL,
252
- submitted_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
253
- status varchar(20) DEFAULT 'unread' NOT NULL,
254
- PRIMARY KEY (id),
255
- KEY email (email),
256
- KEY submitted_at (submitted_at),
257
- KEY status (status)
258
- ) $charset_collate;";
259
-
260
- require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
261
- dbDelta($sql);
262
- }
263
-
264
- public static function drop_table() {
265
- global $wpdb;
266
- $table_name = $wpdb->prefix . 'simple_contact_messages';
267
- $wpdb->query("DROP TABLE IF EXISTS $table_name");
268
- }
269
- }
270
- ```
271
-
272
- **File**: `simple-contact-form.php` (activation hook)
273
-
274
- ```php
275
- <?php
276
- /**
277
- * Plugin Name: Simple Contact Form
278
- * Description: A simple contact form with admin management
279
- * Version: 1.0.0
280
- * Author: Your Name
281
- * License: GPL-2.0+
282
- * Text Domain: simple-contact-form
283
- */
284
-
285
- if (!defined('ABSPATH')) {
286
- exit;
287
- }
288
-
289
- define('SIMPLE_CONTACT_FORM_VERSION', '1.0.0');
290
- define('SIMPLE_CONTACT_FORM_PATH', plugin_dir_path(__FILE__));
291
-
292
- // Activation hook
293
- register_activation_hook(__FILE__, 'simple_contact_form_activate');
294
- function simple_contact_form_activate() {
295
- require_once SIMPLE_CONTACT_FORM_PATH . 'includes/class-contact-message.php';
296
- Simple_Contact_Message::create_table();
297
- }
298
-
299
- // Deactivation hook
300
- register_deactivation_hook(__FILE__, 'simple_contact_form_deactivate');
301
- function simple_contact_form_deactivate() {
302
- // Cleanup if needed
303
- }
304
- ```
305
-
306
- **File**: `uninstall.php`
307
-
308
- ```php
309
- <?php
310
- if (!defined('WP_UNINSTALL_PLUGIN')) {
311
- exit;
312
- }
313
-
314
- require_once plugin_dir_path(__FILE__) . 'includes/class-contact-message.php';
315
- Simple_Contact_Message::drop_table();
316
-
317
- // Delete options
318
- delete_option('simple_contact_form_version');
319
- ```
320
-
321
- ```bash
322
- bd comment bd-scf.1 "Created database schema with indexes for performance"
323
- bd close bd-scf.1
324
- ```
325
-
326
- ### Task bd-scf.2: Create ContactForm Core Class
327
-
328
- ```bash
329
- bd ready # Shows bd-scf.2, bd-scf.3, bd-scf.4 are ready
330
- bd update bd-scf.2 --status in_progress
331
- ```
332
-
333
- **File**: `includes/class-contact-form.php`
334
-
335
- ```php
336
- <?php
337
- class Simple_Contact_Form {
338
- private $message_model;
339
- private $email_handler;
340
-
341
- public function __construct() {
342
- $this->message_model = new Simple_Contact_Message();
343
- $this->email_handler = new Simple_Contact_Email_Handler();
344
- }
345
-
346
- public function init() {
347
- add_shortcode('simple_contact_form', array($this, 'render_form'));
348
- add_action('wp_ajax_simple_contact_form_submit', array($this, 'handle_submission'));
349
- add_action('wp_ajax_nopriv_simple_contact_form_submit', array($this, 'handle_submission'));
350
- }
351
-
352
- public function render_form($atts) {
353
- ob_start();
354
- include SIMPLE_CONTACT_FORM_PATH . 'public/partials/contact-form.php';
355
- return ob_get_clean();
356
- }
357
-
358
- public function handle_submission() {
359
- // Verify nonce
360
- if (!check_ajax_referer('simple_contact_form_nonce', 'nonce', false)) {
361
- wp_send_json_error(array('message' => 'Security check failed'));
362
- }
363
-
364
- // Rate limiting check
365
- if (!$this->check_rate_limit()) {
366
- wp_send_json_error(array('message' => 'Too many submissions. Please try again later.'));
367
- }
368
-
369
- // Sanitize inputs
370
- $name = sanitize_text_field($_POST['name']);
371
- $email = sanitize_email($_POST['email']);
372
- $subject = sanitize_text_field($_POST['subject']);
373
- $message = sanitize_textarea_field($_POST['message']);
374
-
375
- // Validate
376
- if (empty($name) || empty($email) || empty($subject) || empty($message)) {
377
- wp_send_json_error(array('message' => 'All fields are required'));
378
- }
379
-
380
- if (!is_email($email)) {
381
- wp_send_json_error(array('message' => 'Invalid email address'));
382
- }
383
-
384
- // Save to database
385
- $message_id = $this->message_model->save(array(
386
- 'name' => $name,
387
- 'email' => $email,
388
- 'subject' => $subject,
389
- 'message' => $message,
390
- 'ip_address' => $this->get_client_ip()
391
- ));
392
-
393
- if ($message_id) {
394
- // Send email notification
395
- $this->email_handler->send_notification($message_id);
396
- wp_send_json_success(array('message' => 'Thank you! Your message has been sent.'));
397
- } else {
398
- wp_send_json_error(array('message' => 'Failed to save message. Please try again.'));
399
- }
400
- }
401
-
402
- private function check_rate_limit() {
403
- $ip = $this->get_client_ip();
404
- $count = $this->message_model->count_recent_by_ip($ip, 1); // 1 hour
405
- return $count < 3; // Max 3 per hour
406
- }
407
-
408
- private function get_client_ip() {
409
- $ip = '';
410
- if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
411
- $ip = $_SERVER['HTTP_CLIENT_IP'];
412
- } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
413
- $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
414
- } else {
415
- $ip = $_SERVER['REMOTE_ADDR'];
416
- }
417
- return sanitize_text_field($ip);
418
- }
419
- }
420
- ```
421
-
422
- ```bash
423
- bd comment bd-scf.2 "Created ContactForm class with AJAX handler and rate limiting"
424
- bd close bd-scf.2
425
- ```
426
-
427
- ## Step 6: Continue Implementation
428
-
429
- Following the same pattern, implement remaining tasks:
430
-
431
- - **bd-scf.3**: ContactMessage model with CRUD operations
432
- - **bd-scf.4**: EmailHandler for sending notifications
433
- - **bd-scf.5**: Admin interface to view/delete messages
434
- - **bd-scf.6**: Admin CSS/JS for styling and interactions
435
- - **bd-scf.7**: Frontend form template
436
- - **bd-scf.8**: AJAX form submission JavaScript
437
- - **bd-scf.9**: Frontend CSS for form styling
438
- - **bd-scf.10-13**: Security hardening
439
- - **bd-scf.14**: Unit tests with PHPUnit
440
- - **bd-scf.15**: Manual testing
441
-
442
- ## Step 7: Testing
443
-
444
- ```bash
445
- # Run unit tests
446
- cd wp-content/plugins/simple-contact-form
447
- ./vendor/bin/phpunit
448
-
449
- # Manual testing checklist
450
- bd comment bd-scf.15 "Testing checklist:
451
- - ✓ Form displays correctly via shortcode
452
- - ✓ AJAX submission works without page reload
453
- - ✓ Email notifications sent to admin
454
- - ✓ Messages saved to database
455
- - ✓ Admin page displays messages
456
- - ✓ Rate limiting prevents spam
457
- - ✓ Security: nonces verified
458
- - ✓ Security: inputs sanitized
459
- - ✓ Security: outputs escaped
460
- - ✓ Works with different themes
461
- - ✓ Works on mobile devices"
462
-
463
- bd close bd-scf.15
464
- ```
465
-
466
- ## Step 8: Close Epic
467
-
468
- ```bash
469
- bd close bd-scf
470
- ```
471
-
472
- ## Final Plugin Structure
473
-
474
- ```
475
- simple-contact-form/
476
- ├── simple-contact-form.php ✓ Created
477
- ├── readme.txt ✓ Created
478
- ├── uninstall.php ✓ Created
479
- ├── includes/
480
- │ ├── class-contact-form.php ✓ Created
481
- │ ├── class-contact-message.php ✓ Created
482
- │ └── class-email-handler.php ✓ Created
483
- ├── admin/
484
- │ ├── class-admin.php ✓ Created
485
- │ ├── css/admin.css ✓ Created
486
- │ └── js/admin.js ✓ Created
487
- ├── public/
488
- │ ├── class-public.php ✓ Created
489
- │ ├── partials/contact-form.php ✓ Created
490
- │ ├── css/public.css ✓ Created
491
- │ └── js/public.js ✓ Created
492
- ├── tests/
493
- │ ├── bootstrap.php ✓ Created
494
- │ ├── test-contact-form.php ✓ Created
495
- │ └── test-email-handler.php ✓ Created
496
- └── languages/
497
- └── simple-contact-form.pot ✓ Created
498
- ```
499
-
500
- ## AI Agent Workflow Summary
501
-
502
- ### Creating the Plugin
503
-
504
- ```
505
- Create a WordPress plugin called "Simple Contact Form" that allows users to submit contact messages.
506
-
507
- Requirements:
508
- - Plugin slug: simple-contact-form
509
- - Text domain: simple-contact-form
510
- - Minimum WordPress version: 6.0
511
- - PHP version: 7.4+
512
-
513
- Features:
514
- - Frontend contact form (name, email, subject, message)
515
- - Admin page to view submissions
516
- - Email notifications
517
- - AJAX submission
518
- - Rate limiting (3 per hour per IP)
519
-
520
- Use object-oriented architecture with separate classes for form, message model, and email handling.
521
- Follow WordPress security best practices: nonces, sanitization, escaping, capability checks.
522
- ```
523
-
524
- ### Implementation Approach
525
-
526
- 1. **Create OpenSpec spec** defining requirements
527
- 2. **Break down into Beads tasks** with dependencies
528
- 3. **Implement incrementally** following task order
529
- 4. **Test thoroughly** with unit and manual tests
530
- 5. **Document progress** in Beads comments
531
- 6. **Close tasks** as completed
532
-
533
- ## Key Takeaways
534
-
535
- - **OpenSpec** provides clear requirements and technical approach
536
- - **Beads** tracks implementation progress with dependencies
537
- - **Security-first** approach with WordPress best practices
538
- - **Incremental development** with testable milestones
539
- - **Complete documentation** through Beads comments and OpenSpec specs
540
-
1
+ # Complete WordPress Plugin Example
2
+
3
+ This example shows a complete WordPress plugin development workflow from start to finish using OpenSpec and Beads.
4
+
5
+ ## Scenario
6
+
7
+ Building a "Simple Contact Form" WordPress plugin that allows users to submit contact messages through a form on the frontend, with admin management capabilities.
8
+
9
+ ## Plugin Requirements
10
+
11
+ - **Plugin Name**: Simple Contact Form
12
+ - **Plugin Slug**: simple-contact-form
13
+ - **Text Domain**: simple-contact-form
14
+ - **Minimum WordPress**: 6.0
15
+ - **PHP Version**: 7.4+
16
+ - **Features**:
17
+ - Frontend contact form with name, email, subject, message fields
18
+ - Admin page to view submitted messages
19
+ - Email notifications to site admin
20
+ - AJAX form submission
21
+ - Security: nonces, sanitization, escaping, capability checks
22
+
23
+ ## Directory Structure
24
+
25
+ ```
26
+ simple-contact-form/
27
+ ├── simple-contact-form.php # Main plugin file
28
+ ├── readme.txt # WordPress.org readme
29
+ ├── uninstall.php # Cleanup on uninstall
30
+ ├── includes/
31
+ │ ├── class-contact-form.php # Core form logic
32
+ │ ├── class-contact-message.php # Message model
33
+ │ └── class-email-handler.php # Email sending
34
+ ├── admin/
35
+ │ ├── class-admin.php # Admin interface
36
+ │ ├── css/
37
+ │ │ └── admin.css
38
+ │ └── js/
39
+ │ └── admin.js
40
+ ├── public/
41
+ │ ├── class-public.php # Frontend display
42
+ │ ├── css/
43
+ │ │ └── public.css
44
+ │ └── js/
45
+ │ └── public.js
46
+ ├── tests/
47
+ │ ├── bootstrap.php
48
+ │ ├── test-contact-form.php
49
+ │ └── test-email-handler.php
50
+ └── languages/
51
+ └── simple-contact-form.pot
52
+ ```
53
+
54
+ ## Step 1: Initialize OpenSpec
55
+
56
+ ```bash
57
+ # Create OpenSpec directory structure
58
+ mkdir -p openspec/specs/plugin-features
59
+ mkdir -p openspec/changes
60
+ ```
61
+
62
+ ## Step 2: Create OpenSpec Specification
63
+
64
+ **File**: `openspec/specs/plugin-features/contact-form.md`
65
+
66
+ ```markdown
67
+ ---
68
+ id: plugin-features/contact-form
69
+ status: active
70
+ relatedTasks: []
71
+ ---
72
+
73
+ # Simple Contact Form Plugin
74
+
75
+ ## Overview
76
+ A WordPress plugin that provides a simple contact form with admin management.
77
+
78
+ ## Requirements
79
+
80
+ ### Functional Requirements
81
+ - Display contact form via shortcode `[simple_contact_form]`
82
+ - Collect: name, email, subject, message
83
+ - Store submissions in custom database table
84
+ - Send email notification to admin on submission
85
+ - Admin page to view/delete submissions
86
+ - AJAX form submission with loading state
87
+
88
+ ### Security Requirements
89
+ - Nonce verification for form submission
90
+ - Capability check: `manage_options` for admin page
91
+ - Sanitize all inputs using WordPress functions
92
+ - Escape all outputs
93
+ - Validate email addresses
94
+ - Rate limiting: max 3 submissions per IP per hour
95
+
96
+ ### Performance Requirements
97
+ - Database queries optimized with indexes
98
+ - AJAX for form submission (no page reload)
99
+ - Conditional asset loading (only load on pages with shortcode)
100
+
101
+ ## User Stories
102
+
103
+ **As a** site visitor
104
+ **I want** to submit a contact message
105
+ **So that** I can communicate with the site owner
106
+
107
+ **As a** site admin
108
+ **I want** to view submitted messages
109
+ **So that** I can respond to inquiries
110
+
111
+ ## Technical Approach
112
+
113
+ ### Database Schema
114
+ Custom table: `wp_simple_contact_messages`
115
+ - id (bigint, primary key, auto_increment)
116
+ - name (varchar 255)
117
+ - email (varchar 255)
118
+ - subject (varchar 255)
119
+ - message (text)
120
+ - ip_address (varchar 45)
121
+ - submitted_at (datetime)
122
+ - status (varchar 20, default 'unread')
123
+
124
+ ### WordPress Integration
125
+ - Shortcode: `simple_contact_form`
126
+ - Admin menu: Tools > Contact Messages
127
+ - AJAX action: `simple_contact_form_submit`
128
+ - Activation hook: create database table
129
+ - Uninstall hook: remove database table and options
130
+
131
+ ### Files to Create
132
+ - Main plugin file with header
133
+ - Core classes for form, message, email
134
+ - Admin interface class
135
+ - Frontend display class
136
+ - CSS/JS assets
137
+ - Unit tests
138
+ ```
139
+
140
+ ## Step 3: Create Beads Epic and Tasks
141
+
142
+ ```bash
143
+ # Create epic
144
+ bd create "Build Simple Contact Form Plugin" -p 0 --type epic --label wordpress --label plugin
145
+ # Returns: bd-scf
146
+
147
+ # Database setup
148
+ bd create "Create database schema" -p 0 --parent bd-scf --label database
149
+ # Returns: bd-scf.1
150
+
151
+ # Core implementation
152
+ bd create "Create ContactForm core class" -p 1 --parent bd-scf --label implementation
153
+ # Returns: bd-scf.2
154
+
155
+ bd create "Create ContactMessage model class" -p 1 --parent bd-scf --label implementation
156
+ # Returns: bd-scf.3
157
+
158
+ bd create "Create EmailHandler class" -p 1 --parent bd-scf --label implementation
159
+ # Returns: bd-scf.4
160
+
161
+ # Admin interface
162
+ bd create "Create admin interface" -p 1 --parent bd-scf --label admin
163
+ # Returns: bd-scf.5
164
+
165
+ bd create "Add admin CSS/JS" -p 1 --parent bd-scf --label admin
166
+ # Returns: bd-scf.6
167
+
168
+ # Frontend
169
+ bd create "Create frontend form display" -p 1 --parent bd-scf --label frontend
170
+ # Returns: bd-scf.7
171
+
172
+ bd create "Add AJAX form submission" -p 1 --parent bd-scf --label frontend --label ajax
173
+ # Returns: bd-scf.8
174
+
175
+ bd create "Add frontend CSS/JS" -p 1 --parent bd-scf --label frontend
176
+ # Returns: bd-scf.9
177
+
178
+ # Security
179
+ bd create "Add nonce verification" -p 1 --parent bd-scf --label security
180
+ # Returns: bd-scf.10
181
+
182
+ bd create "Add input sanitization" -p 1 --parent bd-scf --label security
183
+ # Returns: bd-scf.11
184
+
185
+ bd create "Add output escaping" -p 1 --parent bd-scf --label security
186
+ # Returns: bd-scf.12
187
+
188
+ bd create "Add rate limiting" -p 1 --parent bd-scf --label security
189
+ # Returns: bd-scf.13
190
+
191
+ # Testing
192
+ bd create "Write unit tests" -p 1 --parent bd-scf --label testing
193
+ # Returns: bd-scf.14
194
+
195
+ bd create "Manual testing in WordPress" -p 2 --parent bd-scf --label testing
196
+ # Returns: bd-scf.15
197
+ ```
198
+
199
+ ## Step 4: Add Task Dependencies
200
+
201
+ ```bash
202
+ # Core classes depend on database
203
+ bd dep add bd-scf.2 bd-scf.1
204
+ bd dep add bd-scf.3 bd-scf.1
205
+ bd dep add bd-scf.4 bd-scf.1
206
+
207
+ # Admin depends on core classes
208
+ bd dep add bd-scf.5 bd-scf.3
209
+ bd dep add bd-scf.6 bd-scf.5
210
+
211
+ # Frontend depends on core classes
212
+ bd dep add bd-scf.7 bd-scf.2
213
+ bd dep add bd-scf.8 bd-scf.7
214
+ bd dep add bd-scf.9 bd-scf.7
215
+
216
+ # Security tasks depend on implementation
217
+ bd dep add bd-scf.10 bd-scf.8
218
+ bd dep add bd-scf.11 bd-scf.2
219
+ bd dep add bd-scf.12 bd-scf.5
220
+ bd dep add bd-scf.13 bd-scf.8
221
+
222
+ # Testing depends on everything
223
+ bd dep add bd-scf.14 bd-scf.13
224
+ bd dep add bd-scf.15 bd-scf.14
225
+ ```
226
+
227
+ ## Step 5: Implementation Workflow
228
+
229
+ ### Task bd-scf.1: Create Database Schema
230
+
231
+ ```bash
232
+ bd update bd-scf.1 --status in_progress
233
+ ```
234
+
235
+ **File**: `includes/class-contact-message.php` (database setup)
236
+
237
+ ```php
238
+ <?php
239
+ class Simple_Contact_Message {
240
+ public static function create_table() {
241
+ global $wpdb;
242
+ $table_name = $wpdb->prefix . 'simple_contact_messages';
243
+ $charset_collate = $wpdb->get_charset_collate();
244
+
245
+ $sql = "CREATE TABLE $table_name (
246
+ id bigint(20) NOT NULL AUTO_INCREMENT,
247
+ name varchar(255) NOT NULL,
248
+ email varchar(255) NOT NULL,
249
+ subject varchar(255) NOT NULL,
250
+ message text NOT NULL,
251
+ ip_address varchar(45) NOT NULL,
252
+ submitted_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
253
+ status varchar(20) DEFAULT 'unread' NOT NULL,
254
+ PRIMARY KEY (id),
255
+ KEY email (email),
256
+ KEY submitted_at (submitted_at),
257
+ KEY status (status)
258
+ ) $charset_collate;";
259
+
260
+ require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
261
+ dbDelta($sql);
262
+ }
263
+
264
+ public static function drop_table() {
265
+ global $wpdb;
266
+ $table_name = $wpdb->prefix . 'simple_contact_messages';
267
+ $wpdb->query("DROP TABLE IF EXISTS $table_name");
268
+ }
269
+ }
270
+ ```
271
+
272
+ **File**: `simple-contact-form.php` (activation hook)
273
+
274
+ ```php
275
+ <?php
276
+ /**
277
+ * Plugin Name: Simple Contact Form
278
+ * Description: A simple contact form with admin management
279
+ * Version: 1.0.0
280
+ * Author: Your Name
281
+ * License: GPL-2.0+
282
+ * Text Domain: simple-contact-form
283
+ */
284
+
285
+ if (!defined('ABSPATH')) {
286
+ exit;
287
+ }
288
+
289
+ define('SIMPLE_CONTACT_FORM_VERSION', '1.0.0');
290
+ define('SIMPLE_CONTACT_FORM_PATH', plugin_dir_path(__FILE__));
291
+
292
+ // Activation hook
293
+ register_activation_hook(__FILE__, 'simple_contact_form_activate');
294
+ function simple_contact_form_activate() {
295
+ require_once SIMPLE_CONTACT_FORM_PATH . 'includes/class-contact-message.php';
296
+ Simple_Contact_Message::create_table();
297
+ }
298
+
299
+ // Deactivation hook
300
+ register_deactivation_hook(__FILE__, 'simple_contact_form_deactivate');
301
+ function simple_contact_form_deactivate() {
302
+ // Cleanup if needed
303
+ }
304
+ ```
305
+
306
+ **File**: `uninstall.php`
307
+
308
+ ```php
309
+ <?php
310
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
311
+ exit;
312
+ }
313
+
314
+ require_once plugin_dir_path(__FILE__) . 'includes/class-contact-message.php';
315
+ Simple_Contact_Message::drop_table();
316
+
317
+ // Delete options
318
+ delete_option('simple_contact_form_version');
319
+ ```
320
+
321
+ ```bash
322
+ bd comment bd-scf.1 "Created database schema with indexes for performance"
323
+ bd close bd-scf.1
324
+ ```
325
+
326
+ ### Task bd-scf.2: Create ContactForm Core Class
327
+
328
+ ```bash
329
+ bd ready # Shows bd-scf.2, bd-scf.3, bd-scf.4 are ready
330
+ bd update bd-scf.2 --status in_progress
331
+ ```
332
+
333
+ **File**: `includes/class-contact-form.php`
334
+
335
+ ```php
336
+ <?php
337
+ class Simple_Contact_Form {
338
+ private $message_model;
339
+ private $email_handler;
340
+
341
+ public function __construct() {
342
+ $this->message_model = new Simple_Contact_Message();
343
+ $this->email_handler = new Simple_Contact_Email_Handler();
344
+ }
345
+
346
+ public function init() {
347
+ add_shortcode('simple_contact_form', array($this, 'render_form'));
348
+ add_action('wp_ajax_simple_contact_form_submit', array($this, 'handle_submission'));
349
+ add_action('wp_ajax_nopriv_simple_contact_form_submit', array($this, 'handle_submission'));
350
+ }
351
+
352
+ public function render_form($atts) {
353
+ ob_start();
354
+ include SIMPLE_CONTACT_FORM_PATH . 'public/partials/contact-form.php';
355
+ return ob_get_clean();
356
+ }
357
+
358
+ public function handle_submission() {
359
+ // Verify nonce
360
+ if (!check_ajax_referer('simple_contact_form_nonce', 'nonce', false)) {
361
+ wp_send_json_error(array('message' => 'Security check failed'));
362
+ }
363
+
364
+ // Rate limiting check
365
+ if (!$this->check_rate_limit()) {
366
+ wp_send_json_error(array('message' => 'Too many submissions. Please try again later.'));
367
+ }
368
+
369
+ // Sanitize inputs
370
+ $name = sanitize_text_field($_POST['name']);
371
+ $email = sanitize_email($_POST['email']);
372
+ $subject = sanitize_text_field($_POST['subject']);
373
+ $message = sanitize_textarea_field($_POST['message']);
374
+
375
+ // Validate
376
+ if (empty($name) || empty($email) || empty($subject) || empty($message)) {
377
+ wp_send_json_error(array('message' => 'All fields are required'));
378
+ }
379
+
380
+ if (!is_email($email)) {
381
+ wp_send_json_error(array('message' => 'Invalid email address'));
382
+ }
383
+
384
+ // Save to database
385
+ $message_id = $this->message_model->save(array(
386
+ 'name' => $name,
387
+ 'email' => $email,
388
+ 'subject' => $subject,
389
+ 'message' => $message,
390
+ 'ip_address' => $this->get_client_ip()
391
+ ));
392
+
393
+ if ($message_id) {
394
+ // Send email notification
395
+ $this->email_handler->send_notification($message_id);
396
+ wp_send_json_success(array('message' => 'Thank you! Your message has been sent.'));
397
+ } else {
398
+ wp_send_json_error(array('message' => 'Failed to save message. Please try again.'));
399
+ }
400
+ }
401
+
402
+ private function check_rate_limit() {
403
+ $ip = $this->get_client_ip();
404
+ $count = $this->message_model->count_recent_by_ip($ip, 1); // 1 hour
405
+ return $count < 3; // Max 3 per hour
406
+ }
407
+
408
+ private function get_client_ip() {
409
+ $ip = '';
410
+ if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
411
+ $ip = $_SERVER['HTTP_CLIENT_IP'];
412
+ } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
413
+ $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
414
+ } else {
415
+ $ip = $_SERVER['REMOTE_ADDR'];
416
+ }
417
+ return sanitize_text_field($ip);
418
+ }
419
+ }
420
+ ```
421
+
422
+ ```bash
423
+ bd comment bd-scf.2 "Created ContactForm class with AJAX handler and rate limiting"
424
+ bd close bd-scf.2
425
+ ```
426
+
427
+ ## Step 6: Continue Implementation
428
+
429
+ Following the same pattern, implement remaining tasks:
430
+
431
+ - **bd-scf.3**: ContactMessage model with CRUD operations
432
+ - **bd-scf.4**: EmailHandler for sending notifications
433
+ - **bd-scf.5**: Admin interface to view/delete messages
434
+ - **bd-scf.6**: Admin CSS/JS for styling and interactions
435
+ - **bd-scf.7**: Frontend form template
436
+ - **bd-scf.8**: AJAX form submission JavaScript
437
+ - **bd-scf.9**: Frontend CSS for form styling
438
+ - **bd-scf.10-13**: Security hardening
439
+ - **bd-scf.14**: Unit tests with PHPUnit
440
+ - **bd-scf.15**: Manual testing
441
+
442
+ ## Step 7: Testing
443
+
444
+ ```bash
445
+ # Run unit tests
446
+ cd wp-content/plugins/simple-contact-form
447
+ ./vendor/bin/phpunit
448
+
449
+ # Manual testing checklist
450
+ bd comment bd-scf.15 "Testing checklist:
451
+ - ✓ Form displays correctly via shortcode
452
+ - ✓ AJAX submission works without page reload
453
+ - ✓ Email notifications sent to admin
454
+ - ✓ Messages saved to database
455
+ - ✓ Admin page displays messages
456
+ - ✓ Rate limiting prevents spam
457
+ - ✓ Security: nonces verified
458
+ - ✓ Security: inputs sanitized
459
+ - ✓ Security: outputs escaped
460
+ - ✓ Works with different themes
461
+ - ✓ Works on mobile devices"
462
+
463
+ bd close bd-scf.15
464
+ ```
465
+
466
+ ## Step 8: Close Epic
467
+
468
+ ```bash
469
+ bd close bd-scf
470
+ ```
471
+
472
+ ## Final Plugin Structure
473
+
474
+ ```
475
+ simple-contact-form/
476
+ ├── simple-contact-form.php ✓ Created
477
+ ├── readme.txt ✓ Created
478
+ ├── uninstall.php ✓ Created
479
+ ├── includes/
480
+ │ ├── class-contact-form.php ✓ Created
481
+ │ ├── class-contact-message.php ✓ Created
482
+ │ └── class-email-handler.php ✓ Created
483
+ ├── admin/
484
+ │ ├── class-admin.php ✓ Created
485
+ │ ├── css/admin.css ✓ Created
486
+ │ └── js/admin.js ✓ Created
487
+ ├── public/
488
+ │ ├── class-public.php ✓ Created
489
+ │ ├── partials/contact-form.php ✓ Created
490
+ │ ├── css/public.css ✓ Created
491
+ │ └── js/public.js ✓ Created
492
+ ├── tests/
493
+ │ ├── bootstrap.php ✓ Created
494
+ │ ├── test-contact-form.php ✓ Created
495
+ │ └── test-email-handler.php ✓ Created
496
+ └── languages/
497
+ └── simple-contact-form.pot ✓ Created
498
+ ```
499
+
500
+ ## AI Agent Workflow Summary
501
+
502
+ ### Creating the Plugin
503
+
504
+ ```
505
+ Create a WordPress plugin called "Simple Contact Form" that allows users to submit contact messages.
506
+
507
+ Requirements:
508
+ - Plugin slug: simple-contact-form
509
+ - Text domain: simple-contact-form
510
+ - Minimum WordPress version: 6.0
511
+ - PHP version: 7.4+
512
+
513
+ Features:
514
+ - Frontend contact form (name, email, subject, message)
515
+ - Admin page to view submissions
516
+ - Email notifications
517
+ - AJAX submission
518
+ - Rate limiting (3 per hour per IP)
519
+
520
+ Use object-oriented architecture with separate classes for form, message model, and email handling.
521
+ Follow WordPress security best practices: nonces, sanitization, escaping, capability checks.
522
+ ```
523
+
524
+ ### Implementation Approach
525
+
526
+ 1. **Create OpenSpec spec** defining requirements
527
+ 2. **Break down into Beads tasks** with dependencies
528
+ 3. **Implement incrementally** following task order
529
+ 4. **Test thoroughly** with unit and manual tests
530
+ 5. **Document progress** in Beads comments
531
+ 6. **Close tasks** as completed
532
+
533
+ ## Key Takeaways
534
+
535
+ - **OpenSpec** provides clear requirements and technical approach
536
+ - **Beads** tracks implementation progress with dependencies
537
+ - **Security-first** approach with WordPress best practices
538
+ - **Incremental development** with testable milestones
539
+ - **Complete documentation** through Beads comments and OpenSpec specs
540
+