@mytechtoday/augment-extensions 0.7.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 (483) 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 +109 -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 +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  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/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,624 +1,624 @@
1
- # WordPress Plugin Scaffolding Workflow
2
-
3
- ## Overview
4
-
5
- This document provides workflows for scaffolding WordPress plugins using WP-CLI and manual methods. It covers plugin generation, file structure creation, and initial setup for different plugin complexity levels.
6
-
7
- ---
8
-
9
- ## WP-CLI Scaffolding (Recommended)
10
-
11
- ### Prerequisites
12
-
13
- Install WP-CLI:
14
-
15
- ```bash
16
- # macOS/Linux
17
- curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
18
- chmod +x wp-cli.phar
19
- sudo mv wp-cli.phar /usr/local/bin/wp
20
-
21
- # Windows (via Composer)
22
- composer global require wp-cli/wp-cli-bundle
23
-
24
- # Verify installation
25
- wp --info
26
- ```
27
-
28
- ### Basic Plugin Scaffold
29
-
30
- ```bash
31
- # Navigate to WordPress plugins directory
32
- cd /path/to/wordpress/wp-content/plugins
33
-
34
- # Generate basic plugin
35
- wp scaffold plugin my-plugin \
36
- --plugin_name="My Plugin" \
37
- --plugin_description="Brief description of my plugin" \
38
- --plugin_author="Your Name" \
39
- --plugin_author_uri="https://example.com" \
40
- --plugin_uri="https://example.com/my-plugin" \
41
- --skip-tests
42
-
43
- # Navigate to plugin directory
44
- cd my-plugin
45
- ```
46
-
47
- **Generated structure:**
48
- ```
49
- my-plugin/
50
- ├── my-plugin.php
51
- ├── readme.txt
52
- ├── .gitignore
53
- └── package.json
54
- ```
55
-
56
- ### Plugin with Tests
57
-
58
- ```bash
59
- wp scaffold plugin my-plugin \
60
- --plugin_name="My Plugin" \
61
- --plugin_description="Brief description" \
62
- --plugin_author="Your Name" \
63
- --activate
64
- ```
65
-
66
- **Generated structure:**
67
- ```
68
- my-plugin/
69
- ├── my-plugin.php
70
- ├── readme.txt
71
- ├── .gitignore
72
- ├── package.json
73
- ├── phpunit.xml.dist
74
- ├── bin/
75
- │ └── install-wp-tests.sh
76
- └── tests/
77
- ├── bootstrap.php
78
- └── test-sample.php
79
- ```
80
-
81
- ### Advanced Scaffold with Custom Post Type
82
-
83
- ```bash
84
- # Generate plugin
85
- wp scaffold plugin my-plugin
86
-
87
- # Navigate to plugin
88
- cd my-plugin
89
-
90
- # Add custom post type
91
- wp scaffold post-type book \
92
- --label=Books \
93
- --textdomain=my-plugin \
94
- --dashicon=book \
95
- --plugin=my-plugin
96
-
97
- # Add custom taxonomy
98
- wp scaffold taxonomy genre \
99
- --post_types=book \
100
- --label=Genres \
101
- --plugin=my-plugin
102
- ```
103
-
104
- ### Scaffold Plugin Block
105
-
106
- ```bash
107
- # Generate Gutenberg block
108
- wp scaffold block my-block \
109
- --title="My Block" \
110
- --plugin=my-plugin \
111
- --namespace=my-plugin
112
-
113
- # Generate dynamic block
114
- wp scaffold block my-dynamic-block \
115
- --title="My Dynamic Block" \
116
- --plugin=my-plugin \
117
- --namespace=my-plugin \
118
- --dynamic
119
- ```
120
-
121
- ---
122
-
123
- ## Manual Scaffolding
124
-
125
- ### Simple Plugin (Pattern 1)
126
-
127
- For single-feature plugins:
128
-
129
- ```bash
130
- # Create plugin directory
131
- mkdir my-plugin
132
- cd my-plugin
133
-
134
- # Create main plugin file
135
- touch my-plugin.php
136
-
137
- # Create readme
138
- touch readme.txt
139
- ```
140
-
141
- **my-plugin.php:**
142
- ```php
143
- <?php
144
- /**
145
- * Plugin Name: My Plugin
146
- * Description: Brief description
147
- * Version: 1.0.0
148
- * Author: Your Name
149
- * License: GPL-2.0+
150
- * Text Domain: my-plugin
151
- */
152
-
153
- if (!defined('ABSPATH')) {
154
- exit;
155
- }
156
-
157
- // Plugin code here
158
- ```
159
-
160
- ### Organized Plugin (Pattern 2)
161
-
162
- For plugins with multiple features:
163
-
164
- ```bash
165
- mkdir -p my-plugin/{includes,admin,public}
166
- cd my-plugin
167
-
168
- # Create files
169
- touch my-plugin.php
170
- touch readme.txt
171
- touch includes/class-my-plugin.php
172
- touch admin/class-my-plugin-admin.php
173
- touch public/class-my-plugin-public.php
174
- ```
175
-
176
- **Directory structure:**
177
- ```
178
- my-plugin/
179
- ├── my-plugin.php
180
- ├── readme.txt
181
- ├── includes/
182
- │ └── class-my-plugin.php
183
- ├── admin/
184
- │ └── class-my-plugin-admin.php
185
- └── public/
186
- └── class-my-plugin-public.php
187
- ```
188
-
189
- ### Object-Oriented Plugin (Pattern 3)
190
-
191
- For complex plugins with OOP structure:
192
-
193
- ```bash
194
- mkdir -p my-plugin/{includes,admin,public,languages}
195
- cd my-plugin
196
-
197
- # Create main files
198
- touch my-plugin.php
199
- touch uninstall.php
200
- touch readme.txt
201
-
202
- # Create class files
203
- touch includes/class-my-plugin.php
204
- touch includes/class-my-plugin-loader.php
205
- touch includes/class-my-plugin-i18n.php
206
- touch admin/class-my-plugin-admin.php
207
- touch public/class-my-plugin-public.php
208
- ```
209
-
210
- **Directory structure:**
211
- ```
212
- my-plugin/
213
- ├── my-plugin.php
214
- ├── uninstall.php
215
- ├── readme.txt
216
- ├── includes/
217
- │ ├── class-my-plugin.php
218
- │ ├── class-my-plugin-loader.php
219
- │ └── class-my-plugin-i18n.php
220
- ├── admin/
221
- │ ├── class-my-plugin-admin.php
222
- │ ├── css/
223
- │ └── js/
224
- ├── public/
225
- │ ├── class-my-plugin-public.php
226
- │ ├── css/
227
- │ └── js/
228
- └── languages/
229
- ```
230
-
231
- ### Modern Plugin with Build Tools (Pattern 4)
232
-
233
- For plugins with JavaScript/CSS build process:
234
-
235
- ```bash
236
- # Create directory structure
237
- mkdir -p my-plugin/{src,dist,includes,admin,public,assets/{css,js,images}}
238
- cd my-plugin
239
-
240
- # Initialize npm
241
- npm init -y
242
-
243
- # Install build tools
244
- npm install --save-dev webpack webpack-cli @wordpress/scripts
245
-
246
- # Create configuration files
247
- touch webpack.config.js
248
- touch .babelrc
249
- touch .eslintrc.js
250
-
251
- # Create source files
252
- touch src/index.js
253
- touch src/style.scss
254
- ```
255
-
256
- **package.json scripts:**
257
- ```json
258
- {
259
- "scripts": {
260
- "build": "wp-scripts build",
261
- "start": "wp-scripts start",
262
- "lint:js": "wp-scripts lint-js",
263
- "lint:css": "wp-scripts lint-style"
264
- }
265
- }
266
- ```
267
-
268
- ---
269
-
270
- ## Composer Integration
271
-
272
- ### Initialize Composer
273
-
274
- ```bash
275
- cd my-plugin
276
-
277
- # Initialize composer
278
- composer init
279
-
280
- # Install dependencies
281
- composer require --dev phpunit/phpunit
282
- composer require --dev squizlabs/php_codesniffer
283
- composer require --dev wp-coding-standards/wpcs
284
-
285
- # Configure PHPCS
286
- ./vendor/bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs
287
- ```
288
-
289
- **composer.json:**
290
- ```json
291
- {
292
- "name": "vendor/my-plugin",
293
- "description": "My WordPress Plugin",
294
- "type": "wordpress-plugin",
295
- "license": "GPL-2.0+",
296
- "autoload": {
297
- "psr-4": {
298
- "MyPlugin\\": "includes/"
299
- }
300
- },
301
- "require": {
302
- "php": ">=7.4"
303
- },
304
- "require-dev": {
305
- "phpunit/phpunit": "^9.0",
306
- "squizlabs/php_codesniffer": "^3.7",
307
- "wp-coding-standards/wpcs": "^3.0"
308
- },
309
- "scripts": {
310
- "test": "phpunit",
311
- "lint": "phpcs --standard=WordPress includes/ admin/ public/",
312
- "lint:fix": "phpcbf --standard=WordPress includes/ admin/ public/"
313
- }
314
- }
315
- ```
316
-
317
- ---
318
-
319
- ## Git Integration
320
-
321
- ### Initialize Git Repository
322
-
323
- ```bash
324
- cd my-plugin
325
-
326
- # Initialize git
327
- git init
328
-
329
- # Create .gitignore
330
- cat > .gitignore << EOF
331
- # Dependencies
332
- /vendor/
333
- /node_modules/
334
-
335
- # Build files
336
- /dist/
337
- /build/
338
-
339
- # OS files
340
- .DS_Store
341
- Thumbs.db
342
-
343
- # IDE files
344
- .vscode/
345
- .idea/
346
- *.sublime-project
347
- *.sublime-workspace
348
-
349
- # WordPress
350
- wp-config.php
351
- .htaccess
352
-
353
- # Logs
354
- *.log
355
- npm-debug.log*
356
-
357
- # Environment
358
- .env
359
- .env.local
360
- EOF
361
-
362
- # Initial commit
363
- git add .
364
- git commit -m "Initial commit"
365
- ```
366
-
367
- ### GitHub Repository Setup
368
-
369
- ```bash
370
- # Create GitHub repository (using GitHub CLI)
371
- gh repo create my-plugin --public --source=. --remote=origin
372
-
373
- # Push to GitHub
374
- git push -u origin main
375
- ```
376
-
377
- ---
378
-
379
- ## Plugin Boilerplate Templates
380
-
381
- ### WordPress Plugin Boilerplate
382
-
383
- ```bash
384
- # Clone the boilerplate
385
- git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git my-plugin
386
-
387
- cd my-plugin
388
-
389
- # Run the rename script (if available) or manually rename
390
- # Replace 'plugin-name' with your plugin slug
391
- # Replace 'Plugin_Name' with your plugin class prefix
392
- ```
393
-
394
- ### Underscores Plugin Generator
395
-
396
- Use the online generator at [wppb.me](https://wppb.me/):
397
-
398
- 1. Enter plugin details
399
- 2. Select options (CPT, taxonomy, etc.)
400
- 3. Download generated plugin
401
- 4. Extract to plugins directory
402
-
403
- ---
404
-
405
- ## Scaffolding Checklist
406
-
407
- ### Initial Setup
408
-
409
- - [ ] Create plugin directory with proper slug
410
- - [ ] Create main plugin file with header
411
- - [ ] Create readme.txt
412
- - [ ] Initialize Git repository
413
- - [ ] Create .gitignore
414
- - [ ] Set up directory structure based on complexity
415
-
416
- ### Development Tools
417
-
418
- - [ ] Initialize Composer (if using PHP dependencies)
419
- - [ ] Initialize npm (if using JavaScript/CSS build)
420
- - [ ] Configure PHPCS with WordPress standards
421
- - [ ] Set up ESLint for JavaScript
422
- - [ ] Configure build scripts
423
-
424
- ### Code Quality
425
-
426
- - [ ] Set up PHPUnit for testing
427
- - [ ] Configure code linting (PHPCS, ESLint)
428
- - [ ] Add pre-commit hooks (optional)
429
- - [ ] Set up continuous integration (optional)
430
-
431
- ### Documentation
432
-
433
- - [ ] Create README.md for GitHub
434
- - [ ] Create readme.txt for WordPress.org
435
- - [ ] Add inline code documentation
436
- - [ ] Create CHANGELOG.md
437
-
438
- ---
439
-
440
- ## Quick Start Commands
441
-
442
- ### Simple Plugin (No Build Tools)
443
-
444
- ```bash
445
- # Create and scaffold
446
- mkdir my-plugin && cd my-plugin
447
- wp scaffold plugin . --plugin_name="My Plugin" --skip-tests
448
-
449
- # Initialize git
450
- git init
451
- git add .
452
- git commit -m "Initial commit"
453
- ```
454
-
455
- ### Modern Plugin (With Build Tools)
456
-
457
- ```bash
458
- # Create and scaffold
459
- mkdir my-plugin && cd my-plugin
460
- wp scaffold plugin . --plugin_name="My Plugin"
461
-
462
- # Initialize npm and install tools
463
- npm init -y
464
- npm install --save-dev @wordpress/scripts
465
-
466
- # Initialize composer
467
- composer init --no-interaction
468
- composer require --dev phpunit/phpunit wp-coding-standards/wpcs
469
-
470
- # Initialize git
471
- git init
472
- git add .
473
- git commit -m "Initial commit"
474
- ```
475
-
476
- ### Block Plugin
477
-
478
- ```bash
479
- # Create plugin directory
480
- mkdir my-block-plugin && cd my-block-plugin
481
-
482
- # Scaffold block plugin
483
- npx @wordpress/create-block my-block
484
-
485
- # Initialize git
486
- git init
487
- git add .
488
- git commit -m "Initial commit"
489
- ```
490
-
491
- ---
492
-
493
- ## Post-Scaffolding Tasks
494
-
495
- ### 1. Update Plugin Header
496
-
497
- Edit main plugin file and update:
498
- - Plugin Name
499
- - Description
500
- - Author information
501
- - Version number
502
- - Text Domain
503
-
504
- ### 2. Update readme.txt
505
-
506
- Edit readme.txt and update:
507
- - Plugin name and description
508
- - Tags
509
- - Requires at least / Tested up to
510
- - Installation instructions
511
- - FAQ section
512
-
513
- ### 3. Configure Build Tools
514
-
515
- If using build tools:
516
-
517
- ```bash
518
- # Install dependencies
519
- npm install
520
- composer install
521
-
522
- # Run initial build
523
- npm run build
524
-
525
- # Start development mode
526
- npm run start
527
- ```
528
-
529
- ### 4. Set Up Testing
530
-
531
- ```bash
532
- # Install WordPress test suite
533
- bin/install-wp-tests.sh wordpress_test root '' localhost latest
534
-
535
- # Run tests
536
- composer test
537
- # or
538
- npm test
539
- ```
540
-
541
- ### 5. Configure Linting
542
-
543
- ```bash
544
- # Lint PHP
545
- composer run lint
546
-
547
- # Lint JavaScript
548
- npm run lint:js
549
-
550
- # Lint CSS
551
- npm run lint:css
552
-
553
- # Auto-fix issues
554
- composer run lint:fix
555
- npm run lint:js -- --fix
556
- ```
557
-
558
- ---
559
-
560
- ## Best Practices
561
-
562
- ### DO
563
-
564
- ✅ Use WP-CLI for consistent scaffolding
565
- ✅ Initialize version control immediately
566
- ✅ Set up build tools before writing code
567
- ✅ Configure linting and testing early
568
- ✅ Use proper text domain matching plugin slug
569
- ✅ Follow WordPress coding standards from start
570
- ✅ Create .gitignore to exclude build files
571
-
572
- ### DON'T
573
-
574
- ❌ Manually create all files (use scaffolding tools)
575
- ❌ Skip version control setup
576
- ❌ Commit build files to repository
577
- ❌ Use generic function/class names
578
- ❌ Skip testing setup
579
- ❌ Ignore coding standards
580
- ❌ Hardcode plugin paths or URLs
581
-
582
- ---
583
-
584
- ## Troubleshooting
585
-
586
- ### WP-CLI Not Found
587
-
588
- ```bash
589
- # Verify installation
590
- which wp
591
-
592
- # Add to PATH (macOS/Linux)
593
- export PATH=$PATH:/usr/local/bin
594
-
595
- # Reinstall if needed
596
- curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
597
- chmod +x wp-cli.phar
598
- sudo mv wp-cli.phar /usr/local/bin/wp
599
- ```
600
-
601
- ### Composer Autoload Not Working
602
-
603
- ```bash
604
- # Regenerate autoload files
605
- composer dump-autoload
606
-
607
- # Verify autoload in main plugin file
608
- require_once plugin_dir_path(__FILE__) . 'vendor/autoload.php';
609
- ```
610
-
611
- ### Build Tools Not Working
612
-
613
- ```bash
614
- # Clear npm cache
615
- npm cache clean --force
616
-
617
- # Remove node_modules and reinstall
618
- rm -rf node_modules package-lock.json
619
- npm install
620
-
621
- # Verify webpack config
622
- npm run build -- --mode=development
623
- ```
624
-
1
+ # WordPress Plugin Scaffolding Workflow
2
+
3
+ ## Overview
4
+
5
+ This document provides workflows for scaffolding WordPress plugins using WP-CLI and manual methods. It covers plugin generation, file structure creation, and initial setup for different plugin complexity levels.
6
+
7
+ ---
8
+
9
+ ## WP-CLI Scaffolding (Recommended)
10
+
11
+ ### Prerequisites
12
+
13
+ Install WP-CLI:
14
+
15
+ ```bash
16
+ # macOS/Linux
17
+ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
18
+ chmod +x wp-cli.phar
19
+ sudo mv wp-cli.phar /usr/local/bin/wp
20
+
21
+ # Windows (via Composer)
22
+ composer global require wp-cli/wp-cli-bundle
23
+
24
+ # Verify installation
25
+ wp --info
26
+ ```
27
+
28
+ ### Basic Plugin Scaffold
29
+
30
+ ```bash
31
+ # Navigate to WordPress plugins directory
32
+ cd /path/to/wordpress/wp-content/plugins
33
+
34
+ # Generate basic plugin
35
+ wp scaffold plugin my-plugin \
36
+ --plugin_name="My Plugin" \
37
+ --plugin_description="Brief description of my plugin" \
38
+ --plugin_author="Your Name" \
39
+ --plugin_author_uri="https://example.com" \
40
+ --plugin_uri="https://example.com/my-plugin" \
41
+ --skip-tests
42
+
43
+ # Navigate to plugin directory
44
+ cd my-plugin
45
+ ```
46
+
47
+ **Generated structure:**
48
+ ```
49
+ my-plugin/
50
+ ├── my-plugin.php
51
+ ├── readme.txt
52
+ ├── .gitignore
53
+ └── package.json
54
+ ```
55
+
56
+ ### Plugin with Tests
57
+
58
+ ```bash
59
+ wp scaffold plugin my-plugin \
60
+ --plugin_name="My Plugin" \
61
+ --plugin_description="Brief description" \
62
+ --plugin_author="Your Name" \
63
+ --activate
64
+ ```
65
+
66
+ **Generated structure:**
67
+ ```
68
+ my-plugin/
69
+ ├── my-plugin.php
70
+ ├── readme.txt
71
+ ├── .gitignore
72
+ ├── package.json
73
+ ├── phpunit.xml.dist
74
+ ├── bin/
75
+ │ └── install-wp-tests.sh
76
+ └── tests/
77
+ ├── bootstrap.php
78
+ └── test-sample.php
79
+ ```
80
+
81
+ ### Advanced Scaffold with Custom Post Type
82
+
83
+ ```bash
84
+ # Generate plugin
85
+ wp scaffold plugin my-plugin
86
+
87
+ # Navigate to plugin
88
+ cd my-plugin
89
+
90
+ # Add custom post type
91
+ wp scaffold post-type book \
92
+ --label=Books \
93
+ --textdomain=my-plugin \
94
+ --dashicon=book \
95
+ --plugin=my-plugin
96
+
97
+ # Add custom taxonomy
98
+ wp scaffold taxonomy genre \
99
+ --post_types=book \
100
+ --label=Genres \
101
+ --plugin=my-plugin
102
+ ```
103
+
104
+ ### Scaffold Plugin Block
105
+
106
+ ```bash
107
+ # Generate Gutenberg block
108
+ wp scaffold block my-block \
109
+ --title="My Block" \
110
+ --plugin=my-plugin \
111
+ --namespace=my-plugin
112
+
113
+ # Generate dynamic block
114
+ wp scaffold block my-dynamic-block \
115
+ --title="My Dynamic Block" \
116
+ --plugin=my-plugin \
117
+ --namespace=my-plugin \
118
+ --dynamic
119
+ ```
120
+
121
+ ---
122
+
123
+ ## Manual Scaffolding
124
+
125
+ ### Simple Plugin (Pattern 1)
126
+
127
+ For single-feature plugins:
128
+
129
+ ```bash
130
+ # Create plugin directory
131
+ mkdir my-plugin
132
+ cd my-plugin
133
+
134
+ # Create main plugin file
135
+ touch my-plugin.php
136
+
137
+ # Create readme
138
+ touch readme.txt
139
+ ```
140
+
141
+ **my-plugin.php:**
142
+ ```php
143
+ <?php
144
+ /**
145
+ * Plugin Name: My Plugin
146
+ * Description: Brief description
147
+ * Version: 1.0.0
148
+ * Author: Your Name
149
+ * License: GPL-2.0+
150
+ * Text Domain: my-plugin
151
+ */
152
+
153
+ if (!defined('ABSPATH')) {
154
+ exit;
155
+ }
156
+
157
+ // Plugin code here
158
+ ```
159
+
160
+ ### Organized Plugin (Pattern 2)
161
+
162
+ For plugins with multiple features:
163
+
164
+ ```bash
165
+ mkdir -p my-plugin/{includes,admin,public}
166
+ cd my-plugin
167
+
168
+ # Create files
169
+ touch my-plugin.php
170
+ touch readme.txt
171
+ touch includes/class-my-plugin.php
172
+ touch admin/class-my-plugin-admin.php
173
+ touch public/class-my-plugin-public.php
174
+ ```
175
+
176
+ **Directory structure:**
177
+ ```
178
+ my-plugin/
179
+ ├── my-plugin.php
180
+ ├── readme.txt
181
+ ├── includes/
182
+ │ └── class-my-plugin.php
183
+ ├── admin/
184
+ │ └── class-my-plugin-admin.php
185
+ └── public/
186
+ └── class-my-plugin-public.php
187
+ ```
188
+
189
+ ### Object-Oriented Plugin (Pattern 3)
190
+
191
+ For complex plugins with OOP structure:
192
+
193
+ ```bash
194
+ mkdir -p my-plugin/{includes,admin,public,languages}
195
+ cd my-plugin
196
+
197
+ # Create main files
198
+ touch my-plugin.php
199
+ touch uninstall.php
200
+ touch readme.txt
201
+
202
+ # Create class files
203
+ touch includes/class-my-plugin.php
204
+ touch includes/class-my-plugin-loader.php
205
+ touch includes/class-my-plugin-i18n.php
206
+ touch admin/class-my-plugin-admin.php
207
+ touch public/class-my-plugin-public.php
208
+ ```
209
+
210
+ **Directory structure:**
211
+ ```
212
+ my-plugin/
213
+ ├── my-plugin.php
214
+ ├── uninstall.php
215
+ ├── readme.txt
216
+ ├── includes/
217
+ │ ├── class-my-plugin.php
218
+ │ ├── class-my-plugin-loader.php
219
+ │ └── class-my-plugin-i18n.php
220
+ ├── admin/
221
+ │ ├── class-my-plugin-admin.php
222
+ │ ├── css/
223
+ │ └── js/
224
+ ├── public/
225
+ │ ├── class-my-plugin-public.php
226
+ │ ├── css/
227
+ │ └── js/
228
+ └── languages/
229
+ ```
230
+
231
+ ### Modern Plugin with Build Tools (Pattern 4)
232
+
233
+ For plugins with JavaScript/CSS build process:
234
+
235
+ ```bash
236
+ # Create directory structure
237
+ mkdir -p my-plugin/{src,dist,includes,admin,public,assets/{css,js,images}}
238
+ cd my-plugin
239
+
240
+ # Initialize npm
241
+ npm init -y
242
+
243
+ # Install build tools
244
+ npm install --save-dev webpack webpack-cli @wordpress/scripts
245
+
246
+ # Create configuration files
247
+ touch webpack.config.js
248
+ touch .babelrc
249
+ touch .eslintrc.js
250
+
251
+ # Create source files
252
+ touch src/index.js
253
+ touch src/style.scss
254
+ ```
255
+
256
+ **package.json scripts:**
257
+ ```json
258
+ {
259
+ "scripts": {
260
+ "build": "wp-scripts build",
261
+ "start": "wp-scripts start",
262
+ "lint:js": "wp-scripts lint-js",
263
+ "lint:css": "wp-scripts lint-style"
264
+ }
265
+ }
266
+ ```
267
+
268
+ ---
269
+
270
+ ## Composer Integration
271
+
272
+ ### Initialize Composer
273
+
274
+ ```bash
275
+ cd my-plugin
276
+
277
+ # Initialize composer
278
+ composer init
279
+
280
+ # Install dependencies
281
+ composer require --dev phpunit/phpunit
282
+ composer require --dev squizlabs/php_codesniffer
283
+ composer require --dev wp-coding-standards/wpcs
284
+
285
+ # Configure PHPCS
286
+ ./vendor/bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs
287
+ ```
288
+
289
+ **composer.json:**
290
+ ```json
291
+ {
292
+ "name": "vendor/my-plugin",
293
+ "description": "My WordPress Plugin",
294
+ "type": "wordpress-plugin",
295
+ "license": "GPL-2.0+",
296
+ "autoload": {
297
+ "psr-4": {
298
+ "MyPlugin\\": "includes/"
299
+ }
300
+ },
301
+ "require": {
302
+ "php": ">=7.4"
303
+ },
304
+ "require-dev": {
305
+ "phpunit/phpunit": "^9.0",
306
+ "squizlabs/php_codesniffer": "^3.7",
307
+ "wp-coding-standards/wpcs": "^3.0"
308
+ },
309
+ "scripts": {
310
+ "test": "phpunit",
311
+ "lint": "phpcs --standard=WordPress includes/ admin/ public/",
312
+ "lint:fix": "phpcbf --standard=WordPress includes/ admin/ public/"
313
+ }
314
+ }
315
+ ```
316
+
317
+ ---
318
+
319
+ ## Git Integration
320
+
321
+ ### Initialize Git Repository
322
+
323
+ ```bash
324
+ cd my-plugin
325
+
326
+ # Initialize git
327
+ git init
328
+
329
+ # Create .gitignore
330
+ cat > .gitignore << EOF
331
+ # Dependencies
332
+ /vendor/
333
+ /node_modules/
334
+
335
+ # Build files
336
+ /dist/
337
+ /build/
338
+
339
+ # OS files
340
+ .DS_Store
341
+ Thumbs.db
342
+
343
+ # IDE files
344
+ .vscode/
345
+ .idea/
346
+ *.sublime-project
347
+ *.sublime-workspace
348
+
349
+ # WordPress
350
+ wp-config.php
351
+ .htaccess
352
+
353
+ # Logs
354
+ *.log
355
+ npm-debug.log*
356
+
357
+ # Environment
358
+ .env
359
+ .env.local
360
+ EOF
361
+
362
+ # Initial commit
363
+ git add .
364
+ git commit -m "Initial commit"
365
+ ```
366
+
367
+ ### GitHub Repository Setup
368
+
369
+ ```bash
370
+ # Create GitHub repository (using GitHub CLI)
371
+ gh repo create my-plugin --public --source=. --remote=origin
372
+
373
+ # Push to GitHub
374
+ git push -u origin main
375
+ ```
376
+
377
+ ---
378
+
379
+ ## Plugin Boilerplate Templates
380
+
381
+ ### WordPress Plugin Boilerplate
382
+
383
+ ```bash
384
+ # Clone the boilerplate
385
+ git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git my-plugin
386
+
387
+ cd my-plugin
388
+
389
+ # Run the rename script (if available) or manually rename
390
+ # Replace 'plugin-name' with your plugin slug
391
+ # Replace 'Plugin_Name' with your plugin class prefix
392
+ ```
393
+
394
+ ### Underscores Plugin Generator
395
+
396
+ Use the online generator at [wppb.me](https://wppb.me/):
397
+
398
+ 1. Enter plugin details
399
+ 2. Select options (CPT, taxonomy, etc.)
400
+ 3. Download generated plugin
401
+ 4. Extract to plugins directory
402
+
403
+ ---
404
+
405
+ ## Scaffolding Checklist
406
+
407
+ ### Initial Setup
408
+
409
+ - [ ] Create plugin directory with proper slug
410
+ - [ ] Create main plugin file with header
411
+ - [ ] Create readme.txt
412
+ - [ ] Initialize Git repository
413
+ - [ ] Create .gitignore
414
+ - [ ] Set up directory structure based on complexity
415
+
416
+ ### Development Tools
417
+
418
+ - [ ] Initialize Composer (if using PHP dependencies)
419
+ - [ ] Initialize npm (if using JavaScript/CSS build)
420
+ - [ ] Configure PHPCS with WordPress standards
421
+ - [ ] Set up ESLint for JavaScript
422
+ - [ ] Configure build scripts
423
+
424
+ ### Code Quality
425
+
426
+ - [ ] Set up PHPUnit for testing
427
+ - [ ] Configure code linting (PHPCS, ESLint)
428
+ - [ ] Add pre-commit hooks (optional)
429
+ - [ ] Set up continuous integration (optional)
430
+
431
+ ### Documentation
432
+
433
+ - [ ] Create README.md for GitHub
434
+ - [ ] Create readme.txt for WordPress.org
435
+ - [ ] Add inline code documentation
436
+ - [ ] Create CHANGELOG.md
437
+
438
+ ---
439
+
440
+ ## Quick Start Commands
441
+
442
+ ### Simple Plugin (No Build Tools)
443
+
444
+ ```bash
445
+ # Create and scaffold
446
+ mkdir my-plugin && cd my-plugin
447
+ wp scaffold plugin . --plugin_name="My Plugin" --skip-tests
448
+
449
+ # Initialize git
450
+ git init
451
+ git add .
452
+ git commit -m "Initial commit"
453
+ ```
454
+
455
+ ### Modern Plugin (With Build Tools)
456
+
457
+ ```bash
458
+ # Create and scaffold
459
+ mkdir my-plugin && cd my-plugin
460
+ wp scaffold plugin . --plugin_name="My Plugin"
461
+
462
+ # Initialize npm and install tools
463
+ npm init -y
464
+ npm install --save-dev @wordpress/scripts
465
+
466
+ # Initialize composer
467
+ composer init --no-interaction
468
+ composer require --dev phpunit/phpunit wp-coding-standards/wpcs
469
+
470
+ # Initialize git
471
+ git init
472
+ git add .
473
+ git commit -m "Initial commit"
474
+ ```
475
+
476
+ ### Block Plugin
477
+
478
+ ```bash
479
+ # Create plugin directory
480
+ mkdir my-block-plugin && cd my-block-plugin
481
+
482
+ # Scaffold block plugin
483
+ npx @wordpress/create-block my-block
484
+
485
+ # Initialize git
486
+ git init
487
+ git add .
488
+ git commit -m "Initial commit"
489
+ ```
490
+
491
+ ---
492
+
493
+ ## Post-Scaffolding Tasks
494
+
495
+ ### 1. Update Plugin Header
496
+
497
+ Edit main plugin file and update:
498
+ - Plugin Name
499
+ - Description
500
+ - Author information
501
+ - Version number
502
+ - Text Domain
503
+
504
+ ### 2. Update readme.txt
505
+
506
+ Edit readme.txt and update:
507
+ - Plugin name and description
508
+ - Tags
509
+ - Requires at least / Tested up to
510
+ - Installation instructions
511
+ - FAQ section
512
+
513
+ ### 3. Configure Build Tools
514
+
515
+ If using build tools:
516
+
517
+ ```bash
518
+ # Install dependencies
519
+ npm install
520
+ composer install
521
+
522
+ # Run initial build
523
+ npm run build
524
+
525
+ # Start development mode
526
+ npm run start
527
+ ```
528
+
529
+ ### 4. Set Up Testing
530
+
531
+ ```bash
532
+ # Install WordPress test suite
533
+ bin/install-wp-tests.sh wordpress_test root '' localhost latest
534
+
535
+ # Run tests
536
+ composer test
537
+ # or
538
+ npm test
539
+ ```
540
+
541
+ ### 5. Configure Linting
542
+
543
+ ```bash
544
+ # Lint PHP
545
+ composer run lint
546
+
547
+ # Lint JavaScript
548
+ npm run lint:js
549
+
550
+ # Lint CSS
551
+ npm run lint:css
552
+
553
+ # Auto-fix issues
554
+ composer run lint:fix
555
+ npm run lint:js -- --fix
556
+ ```
557
+
558
+ ---
559
+
560
+ ## Best Practices
561
+
562
+ ### DO
563
+
564
+ ✅ Use WP-CLI for consistent scaffolding
565
+ ✅ Initialize version control immediately
566
+ ✅ Set up build tools before writing code
567
+ ✅ Configure linting and testing early
568
+ ✅ Use proper text domain matching plugin slug
569
+ ✅ Follow WordPress coding standards from start
570
+ ✅ Create .gitignore to exclude build files
571
+
572
+ ### DON'T
573
+
574
+ ❌ Manually create all files (use scaffolding tools)
575
+ ❌ Skip version control setup
576
+ ❌ Commit build files to repository
577
+ ❌ Use generic function/class names
578
+ ❌ Skip testing setup
579
+ ❌ Ignore coding standards
580
+ ❌ Hardcode plugin paths or URLs
581
+
582
+ ---
583
+
584
+ ## Troubleshooting
585
+
586
+ ### WP-CLI Not Found
587
+
588
+ ```bash
589
+ # Verify installation
590
+ which wp
591
+
592
+ # Add to PATH (macOS/Linux)
593
+ export PATH=$PATH:/usr/local/bin
594
+
595
+ # Reinstall if needed
596
+ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
597
+ chmod +x wp-cli.phar
598
+ sudo mv wp-cli.phar /usr/local/bin/wp
599
+ ```
600
+
601
+ ### Composer Autoload Not Working
602
+
603
+ ```bash
604
+ # Regenerate autoload files
605
+ composer dump-autoload
606
+
607
+ # Verify autoload in main plugin file
608
+ require_once plugin_dir_path(__FILE__) . 'vendor/autoload.php';
609
+ ```
610
+
611
+ ### Build Tools Not Working
612
+
613
+ ```bash
614
+ # Clear npm cache
615
+ npm cache clean --force
616
+
617
+ # Remove node_modules and reinstall
618
+ rm -rf node_modules package-lock.json
619
+ npm install
620
+
621
+ # Verify webpack config
622
+ npm run build -- --mode=development
623
+ ```
624
+