@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,597 +1,597 @@
1
- # Plugin Creation Workflow Example
2
-
3
- This example demonstrates the complete workflow for creating a new WordPress plugin from scratch using OpenSpec and Beads.
4
-
5
- ## Scenario
6
-
7
- Creating a "Reading Time Estimator" plugin that displays estimated reading time for posts and pages.
8
-
9
- ## Plugin Concept
10
-
11
- - **Plugin Name**: Reading Time Estimator
12
- - **Plugin Slug**: reading-time-estimator
13
- - **Text Domain**: reading-time-estimator
14
- - **Purpose**: Calculate and display estimated reading time for WordPress posts/pages
15
- - **Features**:
16
- - Automatic reading time calculation (words per minute configurable)
17
- - Display reading time before/after content
18
- - Shortcode support: `[reading_time]`
19
- - Settings page for customization
20
- - Support for custom post types
21
-
22
- ## Workflow Steps
23
-
24
- ### Step 1: Create OpenSpec Proposal
25
-
26
- **File**: `openspec/changes/reading-time-plugin/proposal.md`
27
-
28
- ```markdown
29
- ---
30
- id: reading-time-plugin
31
- relatedTasks: []
32
- relatedRules: [module-development.md]
33
- status: draft
34
- ---
35
-
36
- # Reading Time Estimator Plugin
37
-
38
- ## Motivation
39
-
40
- Many content-heavy websites want to display estimated reading time to help users
41
- gauge time commitment before reading. This is a common feature on Medium, blogs,
42
- and documentation sites.
43
-
44
- ## Changes
45
-
46
- 1. Create new WordPress plugin from scratch
47
- 2. Add reading time calculation algorithm
48
- 3. Add settings page for customization
49
- 4. Add display options (before/after content, shortcode)
50
- 5. Add support for custom post types
51
-
52
- ## Impact
53
-
54
- ### New Plugin Structure
55
- - Main plugin file with header
56
- - Core calculation class
57
- - Settings page class
58
- - Display handler class
59
- - Admin CSS/JS
60
- - Frontend CSS
61
-
62
- ### WordPress Integration
63
- - Settings page under Settings > Reading Time
64
- - Automatic display via content filter
65
- - Shortcode: `[reading_time]`
66
- - Widget support (optional)
67
-
68
- ## Timeline
69
-
70
- - Plugin scaffolding: 1 day
71
- - Core implementation: 1-2 days
72
- - Settings page: 1 day
73
- - Testing and polish: 1 day
74
-
75
- ## Dependencies
76
-
77
- - None (standalone plugin)
78
- ```
79
-
80
- ### Step 2: Create OpenSpec Spec
81
-
82
- **File**: `openspec/changes/reading-time-plugin/specs/plugin-features/reading-time.md`
83
-
84
- ```markdown
85
- ---
86
- id: plugin-features/reading-time
87
- status: active
88
- relatedTasks: []
89
- ---
90
-
91
- # Reading Time Estimator
92
-
93
- ## Overview
94
- Calculate and display estimated reading time for WordPress content.
95
-
96
- ## Requirements
97
-
98
- ### Functional Requirements
99
- - Calculate reading time based on word count
100
- - Default: 200 words per minute (configurable)
101
- - Display format: "X min read" or "X minute read"
102
- - Display options:
103
- - Before content
104
- - After content
105
- - Both
106
- - Manual via shortcode only
107
- - Support for posts, pages, and custom post types
108
- - Exclude HTML tags and shortcodes from word count
109
-
110
- ### Settings Requirements
111
- - Settings page under Settings > Reading Time
112
- - Options:
113
- - Words per minute (default: 200)
114
- - Display position (before/after/both/manual)
115
- - Post types to include
116
- - Display format template
117
- - Enable/disable for specific post types
118
-
119
- ### Performance Requirements
120
- - Cache reading time as post meta
121
- - Recalculate on post save
122
- - No performance impact on frontend
123
-
124
- ## User Stories
125
-
126
- **As a** content creator
127
- **I want** to display reading time on my posts
128
- **So that** readers know how long content will take
129
-
130
- **As a** site admin
131
- **I want** to customize reading time settings
132
- **So that** I can match my site's needs
133
-
134
- ## Technical Approach
135
-
136
- ### Calculation Algorithm
137
- ```
138
- words = strip_tags(strip_shortcodes(content))
139
- word_count = count(explode(' ', words))
140
- minutes = ceil(word_count / words_per_minute)
141
- ```
142
-
143
- ### WordPress Integration
144
- - Filter: `the_content` for automatic display
145
- - Shortcode: `reading_time` for manual placement
146
- - Post meta: `_reading_time_minutes` (cached)
147
- - Action: `save_post` to recalculate
148
-
149
- ### Files to Create
150
- - `reading-time-estimator.php` - Main plugin file
151
- - `includes/class-calculator.php` - Reading time calculation
152
- - `includes/class-display.php` - Display logic
153
- - `admin/class-settings.php` - Settings page
154
- - `admin/css/settings.css` - Admin styles
155
- - `public/css/display.css` - Frontend styles
156
-
157
- ## Testing Requirements
158
-
159
- ### Unit Tests
160
- - Test word count calculation
161
- - Test reading time calculation
162
- - Test different words-per-minute values
163
- - Test HTML/shortcode stripping
164
-
165
- ### Manual Testing
166
- - Test on posts with various lengths
167
- - Test on pages
168
- - Test on custom post types
169
- - Test settings page
170
- - Test shortcode
171
- - Test with different themes
172
- ```
173
-
174
- ### Step 3: Create Beads Tasks
175
-
176
- ```bash
177
- # Create epic
178
- bd create "Build Reading Time Estimator Plugin" -p 0 --type epic --label wordpress --label plugin
179
- # Returns: bd-rte
180
-
181
- # Scaffolding
182
- bd create "Create plugin structure and main file" -p 0 --parent bd-rte --label scaffolding
183
- # Returns: bd-rte.1
184
-
185
- bd create "Create readme.txt for WordPress.org" -p 0 --parent bd-rte --label scaffolding
186
- # Returns: bd-rte.2
187
-
188
- # Core implementation
189
- bd create "Create Calculator class" -p 1 --parent bd-rte --label implementation
190
- # Returns: bd-rte.3
191
-
192
- bd create "Create Display class" -p 1 --parent bd-rte --label implementation
193
- # Returns: bd-rte.4
194
-
195
- bd create "Add shortcode support" -p 1 --parent bd-rte --label implementation
196
- # Returns: bd-rte.5
197
-
198
- # Settings
199
- bd create "Create Settings class" -p 1 --parent bd-rte --label admin --label settings
200
- # Returns: bd-rte.6
201
-
202
- bd create "Add settings page UI" -p 1 --parent bd-rte --label admin --label settings
203
- # Returns: bd-rte.7
204
-
205
- bd create "Add settings CSS" -p 2 --parent bd-rte --label admin
206
- # Returns: bd-rte.8
207
-
208
- # Frontend
209
- bd create "Add frontend display CSS" -p 2 --parent bd-rte --label frontend
210
- # Returns: bd-rte.9
211
-
212
- # Testing
213
- bd create "Write unit tests" -p 1 --parent bd-rte --label testing
214
- # Returns: bd-rte.10
215
-
216
- bd create "Manual testing" -p 2 --parent bd-rte --label testing
217
- # Returns: bd-rte.11
218
-
219
- # Documentation
220
- bd create "Add inline documentation" -p 2 --parent bd-rte --label documentation
221
- # Returns: bd-rte.12
222
- ```
223
-
224
- ### Step 4: Add Task Dependencies
225
-
226
- ```bash
227
- # Display depends on Calculator
228
- bd dep add bd-rte.4 bd-rte.3
229
-
230
- # Shortcode depends on Calculator
231
- bd dep add bd-rte.5 bd-rte.3
232
-
233
- # Settings UI depends on Settings class
234
- bd dep add bd-rte.7 bd-rte.6
235
-
236
- # Settings CSS depends on Settings UI
237
- bd dep add bd-rte.8 bd-rte.7
238
-
239
- # Frontend CSS depends on Display
240
- bd dep add bd-rte.9 bd-rte.4
241
-
242
- # Testing depends on core implementation
243
- bd dep add bd-rte.10 bd-rte.5
244
- bd dep add bd-rte.11 bd-rte.10
245
-
246
- # Documentation depends on everything
247
- bd dep add bd-rte.12 bd-rte.11
248
- ```
249
-
250
- ### Step 5: Implementation
251
-
252
- #### Task bd-rte.1: Create Plugin Structure
253
-
254
- ```bash
255
- bd update bd-rte.1 --status in_progress
256
- ```
257
-
258
- **Create directory structure**:
259
-
260
- ```bash
261
- mkdir -p reading-time-estimator/{includes,admin/{css,js},public/css,tests,languages}
262
- cd reading-time-estimator
263
- ```
264
-
265
- **File**: `reading-time-estimator.php`
266
-
267
- ```php
268
- <?php
269
- /**
270
- * Plugin Name: Reading Time Estimator
271
- * Plugin URI: https://example.com/reading-time-estimator
272
- * Description: Display estimated reading time for posts and pages
273
- * Version: 1.0.0
274
- * Author: Your Name
275
- * Author URI: https://example.com
276
- * License: GPL-2.0+
277
- * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
278
- * Text Domain: reading-time-estimator
279
- * Domain Path: /languages
280
- */
281
-
282
- if (!defined('ABSPATH')) {
283
- exit;
284
- }
285
-
286
- define('RTE_VERSION', '1.0.0');
287
- define('RTE_PATH', plugin_dir_path(__FILE__));
288
- define('RTE_URL', plugin_dir_url(__FILE__));
289
-
290
- // Autoload classes
291
- spl_autoload_register(function ($class) {
292
- $prefix = 'RTE_';
293
- $base_dir = RTE_PATH . 'includes/';
294
-
295
- $len = strlen($prefix);
296
- if (strncmp($prefix, $class, $len) !== 0) {
297
- return;
298
- }
299
-
300
- $relative_class = substr($class, $len);
301
- $file = $base_dir . 'class-' . strtolower(str_replace('_', '-', $relative_class)) . '.php';
302
-
303
- if (file_exists($file)) {
304
- require $file;
305
- }
306
- });
307
-
308
- // Initialize plugin
309
- function rte_init() {
310
- // Load text domain
311
- load_plugin_textdomain('reading-time-estimator', false, dirname(plugin_basename(__FILE__)) . '/languages');
312
-
313
- // Initialize classes
314
- $calculator = new RTE_Calculator();
315
- $display = new RTE_Display($calculator);
316
- $display->init();
317
-
318
- if (is_admin()) {
319
- $settings = new RTE_Settings();
320
- $settings->init();
321
- }
322
- }
323
- add_action('plugins_loaded', 'rte_init');
324
-
325
- // Activation hook
326
- register_activation_hook(__FILE__, 'rte_activate');
327
- function rte_activate() {
328
- // Set default options
329
- add_option('rte_words_per_minute', 200);
330
- add_option('rte_display_position', 'before');
331
- add_option('rte_post_types', array('post', 'page'));
332
- add_option('rte_display_format', '%d min read');
333
- }
334
-
335
- // Deactivation hook
336
- register_deactivation_hook(__FILE__, 'rte_deactivate');
337
- function rte_deactivate() {
338
- // Cleanup if needed
339
- }
340
- ```
341
-
342
- ```bash
343
- bd comment bd-rte.1 "Created plugin structure with autoloader and activation hooks"
344
- bd close bd-rte.1
345
- ```
346
-
347
- #### Task bd-rte.2: Create readme.txt
348
-
349
- ```bash
350
- bd update bd-rte.2 --status in_progress
351
- ```
352
-
353
- **File**: `readme.txt`
354
-
355
- ```
356
- === Reading Time Estimator ===
357
- Contributors: yourname
358
- Tags: reading time, estimated time, content, posts
359
- Requires at least: 6.0
360
- Tested up to: 6.4
361
- Requires PHP: 7.4
362
- Stable tag: 1.0.0
363
- License: GPLv2 or later
364
- License URI: http://www.gnu.org/licenses/gpl-2.0.html
365
-
366
- Display estimated reading time for your posts and pages.
367
-
368
- == Description ==
369
-
370
- Reading Time Estimator calculates and displays the estimated reading time for your WordPress content. Help your readers gauge the time commitment before diving into your articles.
371
-
372
- **Features:**
373
-
374
- * Automatic reading time calculation
375
- * Customizable words per minute
376
- * Display before or after content
377
- * Shortcode support: [reading_time]
378
- * Settings page for easy configuration
379
- * Support for custom post types
380
- * Lightweight and fast
381
-
382
- == Installation ==
383
-
384
- 1. Upload the plugin files to `/wp-content/plugins/reading-time-estimator`
385
- 2. Activate the plugin through the 'Plugins' menu in WordPress
386
- 3. Go to Settings > Reading Time to configure options
387
-
388
- == Frequently Asked Questions ==
389
-
390
- = How is reading time calculated? =
391
-
392
- Reading time is calculated based on word count divided by words per minute (default: 200).
393
-
394
- = Can I customize the display format? =
395
-
396
- Yes! Go to Settings > Reading Time to customize the format and position.
397
-
398
- = Does it work with custom post types? =
399
-
400
- Yes, you can enable it for any post type in the settings.
401
-
402
- == Changelog ==
403
-
404
- = 1.0.0 =
405
- * Initial release
406
- ```
407
-
408
- ```bash
409
- bd comment bd-rte.2 "Created WordPress.org readme with description and FAQ"
410
- bd close bd-rte.2
411
- ```
412
-
413
- #### Task bd-rte.3: Create Calculator Class
414
-
415
- ```bash
416
- bd ready # Shows bd-rte.3 is ready
417
- bd update bd-rte.3 --status in_progress
418
- ```
419
-
420
- **File**: `includes/class-calculator.php`
421
-
422
- ```php
423
- <?php
424
- class RTE_Calculator {
425
- private $words_per_minute;
426
-
427
- public function __construct() {
428
- $this->words_per_minute = get_option('rte_words_per_minute', 200);
429
- }
430
-
431
- /**
432
- * Calculate reading time for content
433
- *
434
- * @param string $content Post content
435
- * @return int Reading time in minutes
436
- */
437
- public function calculate($content) {
438
- $word_count = $this->count_words($content);
439
- $minutes = ceil($word_count / $this->words_per_minute);
440
- return max(1, $minutes); // Minimum 1 minute
441
- }
442
-
443
- /**
444
- * Count words in content
445
- *
446
- * @param string $content Post content
447
- * @return int Word count
448
- */
449
- public function count_words($content) {
450
- // Strip HTML tags and shortcodes
451
- $text = strip_tags(strip_shortcodes($content));
452
-
453
- // Remove extra whitespace
454
- $text = preg_replace('/\s+/', ' ', $text);
455
-
456
- // Count words
457
- $words = explode(' ', trim($text));
458
- return count(array_filter($words));
459
- }
460
-
461
- /**
462
- * Get or calculate reading time for a post
463
- *
464
- * @param int $post_id Post ID
465
- * @return int Reading time in minutes
466
- */
467
- public function get_reading_time($post_id) {
468
- // Check cache
469
- $cached = get_post_meta($post_id, '_reading_time_minutes', true);
470
- if ($cached) {
471
- return (int) $cached;
472
- }
473
-
474
- // Calculate and cache
475
- $post = get_post($post_id);
476
- if (!$post) {
477
- return 0;
478
- }
479
-
480
- $minutes = $this->calculate($post->post_content);
481
- update_post_meta($post_id, '_reading_time_minutes', $minutes);
482
-
483
- return $minutes;
484
- }
485
-
486
- /**
487
- * Recalculate reading time on post save
488
- *
489
- * @param int $post_id Post ID
490
- */
491
- public function recalculate_on_save($post_id) {
492
- // Skip autosave
493
- if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
494
- return;
495
- }
496
-
497
- // Delete cache to force recalculation
498
- delete_post_meta($post_id, '_reading_time_minutes');
499
- }
500
- }
501
- ```
502
-
503
- ```bash
504
- bd comment bd-rte.3 "Created Calculator class with word counting and caching"
505
- bd close bd-rte.3
506
- ```
507
-
508
- ## Step 6: Continue Implementation
509
-
510
- Following the dependency chain, implement remaining tasks:
511
-
512
- - **bd-rte.4**: Display class with content filter
513
- - **bd-rte.5**: Shortcode handler
514
- - **bd-rte.6**: Settings class with options API
515
- - **bd-rte.7**: Settings page UI
516
- - **bd-rte.8**: Admin CSS
517
- - **bd-rte.9**: Frontend CSS
518
- - **bd-rte.10**: Unit tests
519
- - **bd-rte.11**: Manual testing
520
- - **bd-rte.12**: Inline documentation
521
-
522
- ## Step 7: Testing and Completion
523
-
524
- ```bash
525
- # Run tests
526
- ./vendor/bin/phpunit
527
-
528
- # Manual testing
529
- bd update bd-rte.11 --status in_progress
530
- bd comment bd-rte.11 "Manual testing completed:
531
- - ✓ Reading time displays correctly
532
- - ✓ Settings page works
533
- - ✓ Shortcode works
534
- - ✓ Caching works (no performance impact)
535
- - ✓ Works with different post types
536
- - ✓ Works with different themes"
537
- bd close bd-rte.11
538
-
539
- # Add documentation
540
- bd update bd-rte.12 --status in_progress
541
- bd comment bd-rte.12 "Added PHPDoc comments to all classes and methods"
542
- bd close bd-rte.12
543
-
544
- # Close epic
545
- bd close bd-rte
546
- ```
547
-
548
- ## Step 8: Archive OpenSpec Change
549
-
550
- ```bash
551
- # Move to archive
552
- mv openspec/changes/reading-time-plugin openspec/archive/reading-time-plugin
553
- ```
554
-
555
- ## AI Agent Workflow
556
-
557
- ### Initial Prompt
558
-
559
- ```
560
- Create a WordPress plugin called "Reading Time Estimator" that displays estimated reading time for posts and pages.
561
-
562
- Requirements:
563
- - Plugin slug: reading-time-estimator
564
- - Text domain: reading-time-estimator
565
- - Minimum WordPress version: 6.0
566
- - PHP version: 7.4+
567
-
568
- Features:
569
- - Calculate reading time based on word count (200 words/min default)
570
- - Display before or after content (configurable)
571
- - Shortcode support: [reading_time]
572
- - Settings page under Settings > Reading Time
573
- - Support for custom post types
574
- - Cache reading time as post meta for performance
575
-
576
- Use object-oriented architecture with separate classes for calculation, display, and settings.
577
- Follow WordPress coding standards and best practices.
578
- ```
579
-
580
- ### Implementation Approach
581
-
582
- 1. **Create OpenSpec proposal and spec** with detailed requirements
583
- 2. **Break down into Beads tasks** with clear dependencies
584
- 3. **Implement incrementally** starting with scaffolding
585
- 4. **Test thoroughly** with unit and manual tests
586
- 5. **Document** with inline comments and readme.txt
587
-
588
- ## Key Takeaways
589
-
590
- - **Start with scaffolding** to establish plugin structure
591
- - **Use OpenSpec** to define clear requirements before coding
592
- - **Break down into small tasks** with Beads for tracking
593
- - **Follow WordPress standards** for plugin structure and naming
594
- - **Cache expensive operations** (reading time calculation)
595
- - **Test thoroughly** before release
596
- - **Document well** for users and developers
597
-
1
+ # Plugin Creation Workflow Example
2
+
3
+ This example demonstrates the complete workflow for creating a new WordPress plugin from scratch using OpenSpec and Beads.
4
+
5
+ ## Scenario
6
+
7
+ Creating a "Reading Time Estimator" plugin that displays estimated reading time for posts and pages.
8
+
9
+ ## Plugin Concept
10
+
11
+ - **Plugin Name**: Reading Time Estimator
12
+ - **Plugin Slug**: reading-time-estimator
13
+ - **Text Domain**: reading-time-estimator
14
+ - **Purpose**: Calculate and display estimated reading time for WordPress posts/pages
15
+ - **Features**:
16
+ - Automatic reading time calculation (words per minute configurable)
17
+ - Display reading time before/after content
18
+ - Shortcode support: `[reading_time]`
19
+ - Settings page for customization
20
+ - Support for custom post types
21
+
22
+ ## Workflow Steps
23
+
24
+ ### Step 1: Create OpenSpec Proposal
25
+
26
+ **File**: `openspec/changes/reading-time-plugin/proposal.md`
27
+
28
+ ```markdown
29
+ ---
30
+ id: reading-time-plugin
31
+ relatedTasks: []
32
+ relatedRules: [module-development.md]
33
+ status: draft
34
+ ---
35
+
36
+ # Reading Time Estimator Plugin
37
+
38
+ ## Motivation
39
+
40
+ Many content-heavy websites want to display estimated reading time to help users
41
+ gauge time commitment before reading. This is a common feature on Medium, blogs,
42
+ and documentation sites.
43
+
44
+ ## Changes
45
+
46
+ 1. Create new WordPress plugin from scratch
47
+ 2. Add reading time calculation algorithm
48
+ 3. Add settings page for customization
49
+ 4. Add display options (before/after content, shortcode)
50
+ 5. Add support for custom post types
51
+
52
+ ## Impact
53
+
54
+ ### New Plugin Structure
55
+ - Main plugin file with header
56
+ - Core calculation class
57
+ - Settings page class
58
+ - Display handler class
59
+ - Admin CSS/JS
60
+ - Frontend CSS
61
+
62
+ ### WordPress Integration
63
+ - Settings page under Settings > Reading Time
64
+ - Automatic display via content filter
65
+ - Shortcode: `[reading_time]`
66
+ - Widget support (optional)
67
+
68
+ ## Timeline
69
+
70
+ - Plugin scaffolding: 1 day
71
+ - Core implementation: 1-2 days
72
+ - Settings page: 1 day
73
+ - Testing and polish: 1 day
74
+
75
+ ## Dependencies
76
+
77
+ - None (standalone plugin)
78
+ ```
79
+
80
+ ### Step 2: Create OpenSpec Spec
81
+
82
+ **File**: `openspec/changes/reading-time-plugin/specs/plugin-features/reading-time.md`
83
+
84
+ ```markdown
85
+ ---
86
+ id: plugin-features/reading-time
87
+ status: active
88
+ relatedTasks: []
89
+ ---
90
+
91
+ # Reading Time Estimator
92
+
93
+ ## Overview
94
+ Calculate and display estimated reading time for WordPress content.
95
+
96
+ ## Requirements
97
+
98
+ ### Functional Requirements
99
+ - Calculate reading time based on word count
100
+ - Default: 200 words per minute (configurable)
101
+ - Display format: "X min read" or "X minute read"
102
+ - Display options:
103
+ - Before content
104
+ - After content
105
+ - Both
106
+ - Manual via shortcode only
107
+ - Support for posts, pages, and custom post types
108
+ - Exclude HTML tags and shortcodes from word count
109
+
110
+ ### Settings Requirements
111
+ - Settings page under Settings > Reading Time
112
+ - Options:
113
+ - Words per minute (default: 200)
114
+ - Display position (before/after/both/manual)
115
+ - Post types to include
116
+ - Display format template
117
+ - Enable/disable for specific post types
118
+
119
+ ### Performance Requirements
120
+ - Cache reading time as post meta
121
+ - Recalculate on post save
122
+ - No performance impact on frontend
123
+
124
+ ## User Stories
125
+
126
+ **As a** content creator
127
+ **I want** to display reading time on my posts
128
+ **So that** readers know how long content will take
129
+
130
+ **As a** site admin
131
+ **I want** to customize reading time settings
132
+ **So that** I can match my site's needs
133
+
134
+ ## Technical Approach
135
+
136
+ ### Calculation Algorithm
137
+ ```
138
+ words = strip_tags(strip_shortcodes(content))
139
+ word_count = count(explode(' ', words))
140
+ minutes = ceil(word_count / words_per_minute)
141
+ ```
142
+
143
+ ### WordPress Integration
144
+ - Filter: `the_content` for automatic display
145
+ - Shortcode: `reading_time` for manual placement
146
+ - Post meta: `_reading_time_minutes` (cached)
147
+ - Action: `save_post` to recalculate
148
+
149
+ ### Files to Create
150
+ - `reading-time-estimator.php` - Main plugin file
151
+ - `includes/class-calculator.php` - Reading time calculation
152
+ - `includes/class-display.php` - Display logic
153
+ - `admin/class-settings.php` - Settings page
154
+ - `admin/css/settings.css` - Admin styles
155
+ - `public/css/display.css` - Frontend styles
156
+
157
+ ## Testing Requirements
158
+
159
+ ### Unit Tests
160
+ - Test word count calculation
161
+ - Test reading time calculation
162
+ - Test different words-per-minute values
163
+ - Test HTML/shortcode stripping
164
+
165
+ ### Manual Testing
166
+ - Test on posts with various lengths
167
+ - Test on pages
168
+ - Test on custom post types
169
+ - Test settings page
170
+ - Test shortcode
171
+ - Test with different themes
172
+ ```
173
+
174
+ ### Step 3: Create Beads Tasks
175
+
176
+ ```bash
177
+ # Create epic
178
+ bd create "Build Reading Time Estimator Plugin" -p 0 --type epic --label wordpress --label plugin
179
+ # Returns: bd-rte
180
+
181
+ # Scaffolding
182
+ bd create "Create plugin structure and main file" -p 0 --parent bd-rte --label scaffolding
183
+ # Returns: bd-rte.1
184
+
185
+ bd create "Create readme.txt for WordPress.org" -p 0 --parent bd-rte --label scaffolding
186
+ # Returns: bd-rte.2
187
+
188
+ # Core implementation
189
+ bd create "Create Calculator class" -p 1 --parent bd-rte --label implementation
190
+ # Returns: bd-rte.3
191
+
192
+ bd create "Create Display class" -p 1 --parent bd-rte --label implementation
193
+ # Returns: bd-rte.4
194
+
195
+ bd create "Add shortcode support" -p 1 --parent bd-rte --label implementation
196
+ # Returns: bd-rte.5
197
+
198
+ # Settings
199
+ bd create "Create Settings class" -p 1 --parent bd-rte --label admin --label settings
200
+ # Returns: bd-rte.6
201
+
202
+ bd create "Add settings page UI" -p 1 --parent bd-rte --label admin --label settings
203
+ # Returns: bd-rte.7
204
+
205
+ bd create "Add settings CSS" -p 2 --parent bd-rte --label admin
206
+ # Returns: bd-rte.8
207
+
208
+ # Frontend
209
+ bd create "Add frontend display CSS" -p 2 --parent bd-rte --label frontend
210
+ # Returns: bd-rte.9
211
+
212
+ # Testing
213
+ bd create "Write unit tests" -p 1 --parent bd-rte --label testing
214
+ # Returns: bd-rte.10
215
+
216
+ bd create "Manual testing" -p 2 --parent bd-rte --label testing
217
+ # Returns: bd-rte.11
218
+
219
+ # Documentation
220
+ bd create "Add inline documentation" -p 2 --parent bd-rte --label documentation
221
+ # Returns: bd-rte.12
222
+ ```
223
+
224
+ ### Step 4: Add Task Dependencies
225
+
226
+ ```bash
227
+ # Display depends on Calculator
228
+ bd dep add bd-rte.4 bd-rte.3
229
+
230
+ # Shortcode depends on Calculator
231
+ bd dep add bd-rte.5 bd-rte.3
232
+
233
+ # Settings UI depends on Settings class
234
+ bd dep add bd-rte.7 bd-rte.6
235
+
236
+ # Settings CSS depends on Settings UI
237
+ bd dep add bd-rte.8 bd-rte.7
238
+
239
+ # Frontend CSS depends on Display
240
+ bd dep add bd-rte.9 bd-rte.4
241
+
242
+ # Testing depends on core implementation
243
+ bd dep add bd-rte.10 bd-rte.5
244
+ bd dep add bd-rte.11 bd-rte.10
245
+
246
+ # Documentation depends on everything
247
+ bd dep add bd-rte.12 bd-rte.11
248
+ ```
249
+
250
+ ### Step 5: Implementation
251
+
252
+ #### Task bd-rte.1: Create Plugin Structure
253
+
254
+ ```bash
255
+ bd update bd-rte.1 --status in_progress
256
+ ```
257
+
258
+ **Create directory structure**:
259
+
260
+ ```bash
261
+ mkdir -p reading-time-estimator/{includes,admin/{css,js},public/css,tests,languages}
262
+ cd reading-time-estimator
263
+ ```
264
+
265
+ **File**: `reading-time-estimator.php`
266
+
267
+ ```php
268
+ <?php
269
+ /**
270
+ * Plugin Name: Reading Time Estimator
271
+ * Plugin URI: https://example.com/reading-time-estimator
272
+ * Description: Display estimated reading time for posts and pages
273
+ * Version: 1.0.0
274
+ * Author: Your Name
275
+ * Author URI: https://example.com
276
+ * License: GPL-2.0+
277
+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
278
+ * Text Domain: reading-time-estimator
279
+ * Domain Path: /languages
280
+ */
281
+
282
+ if (!defined('ABSPATH')) {
283
+ exit;
284
+ }
285
+
286
+ define('RTE_VERSION', '1.0.0');
287
+ define('RTE_PATH', plugin_dir_path(__FILE__));
288
+ define('RTE_URL', plugin_dir_url(__FILE__));
289
+
290
+ // Autoload classes
291
+ spl_autoload_register(function ($class) {
292
+ $prefix = 'RTE_';
293
+ $base_dir = RTE_PATH . 'includes/';
294
+
295
+ $len = strlen($prefix);
296
+ if (strncmp($prefix, $class, $len) !== 0) {
297
+ return;
298
+ }
299
+
300
+ $relative_class = substr($class, $len);
301
+ $file = $base_dir . 'class-' . strtolower(str_replace('_', '-', $relative_class)) . '.php';
302
+
303
+ if (file_exists($file)) {
304
+ require $file;
305
+ }
306
+ });
307
+
308
+ // Initialize plugin
309
+ function rte_init() {
310
+ // Load text domain
311
+ load_plugin_textdomain('reading-time-estimator', false, dirname(plugin_basename(__FILE__)) . '/languages');
312
+
313
+ // Initialize classes
314
+ $calculator = new RTE_Calculator();
315
+ $display = new RTE_Display($calculator);
316
+ $display->init();
317
+
318
+ if (is_admin()) {
319
+ $settings = new RTE_Settings();
320
+ $settings->init();
321
+ }
322
+ }
323
+ add_action('plugins_loaded', 'rte_init');
324
+
325
+ // Activation hook
326
+ register_activation_hook(__FILE__, 'rte_activate');
327
+ function rte_activate() {
328
+ // Set default options
329
+ add_option('rte_words_per_minute', 200);
330
+ add_option('rte_display_position', 'before');
331
+ add_option('rte_post_types', array('post', 'page'));
332
+ add_option('rte_display_format', '%d min read');
333
+ }
334
+
335
+ // Deactivation hook
336
+ register_deactivation_hook(__FILE__, 'rte_deactivate');
337
+ function rte_deactivate() {
338
+ // Cleanup if needed
339
+ }
340
+ ```
341
+
342
+ ```bash
343
+ bd comment bd-rte.1 "Created plugin structure with autoloader and activation hooks"
344
+ bd close bd-rte.1
345
+ ```
346
+
347
+ #### Task bd-rte.2: Create readme.txt
348
+
349
+ ```bash
350
+ bd update bd-rte.2 --status in_progress
351
+ ```
352
+
353
+ **File**: `readme.txt`
354
+
355
+ ```
356
+ === Reading Time Estimator ===
357
+ Contributors: yourname
358
+ Tags: reading time, estimated time, content, posts
359
+ Requires at least: 6.0
360
+ Tested up to: 6.4
361
+ Requires PHP: 7.4
362
+ Stable tag: 1.0.0
363
+ License: GPLv2 or later
364
+ License URI: http://www.gnu.org/licenses/gpl-2.0.html
365
+
366
+ Display estimated reading time for your posts and pages.
367
+
368
+ == Description ==
369
+
370
+ Reading Time Estimator calculates and displays the estimated reading time for your WordPress content. Help your readers gauge the time commitment before diving into your articles.
371
+
372
+ **Features:**
373
+
374
+ * Automatic reading time calculation
375
+ * Customizable words per minute
376
+ * Display before or after content
377
+ * Shortcode support: [reading_time]
378
+ * Settings page for easy configuration
379
+ * Support for custom post types
380
+ * Lightweight and fast
381
+
382
+ == Installation ==
383
+
384
+ 1. Upload the plugin files to `/wp-content/plugins/reading-time-estimator`
385
+ 2. Activate the plugin through the 'Plugins' menu in WordPress
386
+ 3. Go to Settings > Reading Time to configure options
387
+
388
+ == Frequently Asked Questions ==
389
+
390
+ = How is reading time calculated? =
391
+
392
+ Reading time is calculated based on word count divided by words per minute (default: 200).
393
+
394
+ = Can I customize the display format? =
395
+
396
+ Yes! Go to Settings > Reading Time to customize the format and position.
397
+
398
+ = Does it work with custom post types? =
399
+
400
+ Yes, you can enable it for any post type in the settings.
401
+
402
+ == Changelog ==
403
+
404
+ = 1.0.0 =
405
+ * Initial release
406
+ ```
407
+
408
+ ```bash
409
+ bd comment bd-rte.2 "Created WordPress.org readme with description and FAQ"
410
+ bd close bd-rte.2
411
+ ```
412
+
413
+ #### Task bd-rte.3: Create Calculator Class
414
+
415
+ ```bash
416
+ bd ready # Shows bd-rte.3 is ready
417
+ bd update bd-rte.3 --status in_progress
418
+ ```
419
+
420
+ **File**: `includes/class-calculator.php`
421
+
422
+ ```php
423
+ <?php
424
+ class RTE_Calculator {
425
+ private $words_per_minute;
426
+
427
+ public function __construct() {
428
+ $this->words_per_minute = get_option('rte_words_per_minute', 200);
429
+ }
430
+
431
+ /**
432
+ * Calculate reading time for content
433
+ *
434
+ * @param string $content Post content
435
+ * @return int Reading time in minutes
436
+ */
437
+ public function calculate($content) {
438
+ $word_count = $this->count_words($content);
439
+ $minutes = ceil($word_count / $this->words_per_minute);
440
+ return max(1, $minutes); // Minimum 1 minute
441
+ }
442
+
443
+ /**
444
+ * Count words in content
445
+ *
446
+ * @param string $content Post content
447
+ * @return int Word count
448
+ */
449
+ public function count_words($content) {
450
+ // Strip HTML tags and shortcodes
451
+ $text = strip_tags(strip_shortcodes($content));
452
+
453
+ // Remove extra whitespace
454
+ $text = preg_replace('/\s+/', ' ', $text);
455
+
456
+ // Count words
457
+ $words = explode(' ', trim($text));
458
+ return count(array_filter($words));
459
+ }
460
+
461
+ /**
462
+ * Get or calculate reading time for a post
463
+ *
464
+ * @param int $post_id Post ID
465
+ * @return int Reading time in minutes
466
+ */
467
+ public function get_reading_time($post_id) {
468
+ // Check cache
469
+ $cached = get_post_meta($post_id, '_reading_time_minutes', true);
470
+ if ($cached) {
471
+ return (int) $cached;
472
+ }
473
+
474
+ // Calculate and cache
475
+ $post = get_post($post_id);
476
+ if (!$post) {
477
+ return 0;
478
+ }
479
+
480
+ $minutes = $this->calculate($post->post_content);
481
+ update_post_meta($post_id, '_reading_time_minutes', $minutes);
482
+
483
+ return $minutes;
484
+ }
485
+
486
+ /**
487
+ * Recalculate reading time on post save
488
+ *
489
+ * @param int $post_id Post ID
490
+ */
491
+ public function recalculate_on_save($post_id) {
492
+ // Skip autosave
493
+ if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
494
+ return;
495
+ }
496
+
497
+ // Delete cache to force recalculation
498
+ delete_post_meta($post_id, '_reading_time_minutes');
499
+ }
500
+ }
501
+ ```
502
+
503
+ ```bash
504
+ bd comment bd-rte.3 "Created Calculator class with word counting and caching"
505
+ bd close bd-rte.3
506
+ ```
507
+
508
+ ## Step 6: Continue Implementation
509
+
510
+ Following the dependency chain, implement remaining tasks:
511
+
512
+ - **bd-rte.4**: Display class with content filter
513
+ - **bd-rte.5**: Shortcode handler
514
+ - **bd-rte.6**: Settings class with options API
515
+ - **bd-rte.7**: Settings page UI
516
+ - **bd-rte.8**: Admin CSS
517
+ - **bd-rte.9**: Frontend CSS
518
+ - **bd-rte.10**: Unit tests
519
+ - **bd-rte.11**: Manual testing
520
+ - **bd-rte.12**: Inline documentation
521
+
522
+ ## Step 7: Testing and Completion
523
+
524
+ ```bash
525
+ # Run tests
526
+ ./vendor/bin/phpunit
527
+
528
+ # Manual testing
529
+ bd update bd-rte.11 --status in_progress
530
+ bd comment bd-rte.11 "Manual testing completed:
531
+ - ✓ Reading time displays correctly
532
+ - ✓ Settings page works
533
+ - ✓ Shortcode works
534
+ - ✓ Caching works (no performance impact)
535
+ - ✓ Works with different post types
536
+ - ✓ Works with different themes"
537
+ bd close bd-rte.11
538
+
539
+ # Add documentation
540
+ bd update bd-rte.12 --status in_progress
541
+ bd comment bd-rte.12 "Added PHPDoc comments to all classes and methods"
542
+ bd close bd-rte.12
543
+
544
+ # Close epic
545
+ bd close bd-rte
546
+ ```
547
+
548
+ ## Step 8: Archive OpenSpec Change
549
+
550
+ ```bash
551
+ # Move to archive
552
+ mv openspec/changes/reading-time-plugin openspec/archive/reading-time-plugin
553
+ ```
554
+
555
+ ## AI Agent Workflow
556
+
557
+ ### Initial Prompt
558
+
559
+ ```
560
+ Create a WordPress plugin called "Reading Time Estimator" that displays estimated reading time for posts and pages.
561
+
562
+ Requirements:
563
+ - Plugin slug: reading-time-estimator
564
+ - Text domain: reading-time-estimator
565
+ - Minimum WordPress version: 6.0
566
+ - PHP version: 7.4+
567
+
568
+ Features:
569
+ - Calculate reading time based on word count (200 words/min default)
570
+ - Display before or after content (configurable)
571
+ - Shortcode support: [reading_time]
572
+ - Settings page under Settings > Reading Time
573
+ - Support for custom post types
574
+ - Cache reading time as post meta for performance
575
+
576
+ Use object-oriented architecture with separate classes for calculation, display, and settings.
577
+ Follow WordPress coding standards and best practices.
578
+ ```
579
+
580
+ ### Implementation Approach
581
+
582
+ 1. **Create OpenSpec proposal and spec** with detailed requirements
583
+ 2. **Break down into Beads tasks** with clear dependencies
584
+ 3. **Implement incrementally** starting with scaffolding
585
+ 4. **Test thoroughly** with unit and manual tests
586
+ 5. **Document** with inline comments and readme.txt
587
+
588
+ ## Key Takeaways
589
+
590
+ - **Start with scaffolding** to establish plugin structure
591
+ - **Use OpenSpec** to define clear requirements before coding
592
+ - **Break down into small tasks** with Beads for tracking
593
+ - **Follow WordPress standards** for plugin structure and naming
594
+ - **Cache expensive operations** (reading time calculation)
595
+ - **Test thoroughly** before release
596
+ - **Document well** for users and developers
597
+