@mytechtoday/augment-extensions 0.1.2 → 0.4.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.
- package/README.md +614 -39
- package/augment-extensions/coding-standards/bash/README.md +196 -0
- package/augment-extensions/coding-standards/bash/module.json +163 -0
- package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -0
- package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -0
- package/augment-extensions/coding-standards/css/README.md +40 -0
- package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/css/module.json +44 -0
- package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html/README.md +40 -0
- package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html/module.json +44 -0
- package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/README.md +194 -0
- package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html-css-js/module.json +48 -0
- package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/js/README.md +46 -0
- package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/js/module.json +49 -0
- package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/php/README.md +248 -0
- package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -0
- package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -0
- package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -0
- package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -0
- package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -0
- package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -0
- package/augment-extensions/coding-standards/php/module.json +166 -0
- package/augment-extensions/coding-standards/php/rules/api-development.md +480 -0
- package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -0
- package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -0
- package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -0
- package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -0
- package/augment-extensions/coding-standards/php/rules/documentation.md +425 -0
- package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -0
- package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -0
- package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -0
- package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -0
- package/augment-extensions/coding-standards/php/rules/performance.md +392 -0
- package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -0
- package/augment-extensions/coding-standards/php/rules/security.md +358 -0
- package/augment-extensions/coding-standards/php/rules/testing.md +403 -0
- package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -0
- package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -0
- package/augment-extensions/coding-standards/powershell/README.md +154 -0
- package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -0
- package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -0
- package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -0
- package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -0
- package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -0
- package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -0
- package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -0
- package/augment-extensions/coding-standards/powershell/module.json +165 -0
- package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -0
- package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -0
- package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -0
- package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -0
- package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -0
- package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -0
- package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -0
- package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -0
- package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -0
- package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -0
- package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -0
- package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -0
- package/augment-extensions/coding-standards/python/README.md +12 -8
- package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -0
- package/augment-extensions/coding-standards/python/module.json +8 -4
- package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -0
- package/augment-extensions/coding-standards/python/rules/documentation.md +831 -0
- package/augment-extensions/coding-standards/python/rules/error-handling.md +855 -68
- package/augment-extensions/coding-standards/python/rules/testing.md +409 -0
- package/augment-extensions/coding-standards/python/rules/tooling.md +446 -0
- package/augment-extensions/coding-standards/python/rules/type-hints.md +115 -50
- package/augment-extensions/collections/html-css-js/README.md +82 -0
- package/augment-extensions/collections/html-css-js/collection.json +41 -0
- package/augment-extensions/domain-rules/database/README.md +161 -0
- package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -0
- package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -0
- package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -0
- package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -0
- package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -0
- package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -0
- package/augment-extensions/domain-rules/database/module.json +28 -0
- package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -0
- package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -0
- package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -0
- package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -0
- package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -0
- package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -0
- package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -0
- package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -0
- package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -0
- package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -0
- package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -0
- package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -0
- package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -0
- package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -0
- package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -0
- package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -0
- package/augment-extensions/domain-rules/mcp/README.md +150 -0
- package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -0
- package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -0
- package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -0
- package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -0
- package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -0
- package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -0
- package/augment-extensions/domain-rules/mcp/module.json +49 -0
- package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -0
- package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -0
- package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -0
- package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -0
- package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -0
- package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -0
- package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -0
- package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -0
- package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -0
- package/augment-extensions/domain-rules/wordpress/README.md +163 -0
- package/augment-extensions/domain-rules/wordpress/module.json +32 -0
- package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -0
- package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -0
- package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -0
- package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -0
- package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -0
- package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -0
- package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -0
- package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -0
- package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -0
- package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -0
- package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -0
- package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -0
- package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -0
- package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -0
- package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -0
- package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -0
- package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -0
- package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -0
- package/augment-extensions/examples/rest-api-plugin/README.md +98 -0
- package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -0
- package/augment-extensions/examples/rest-api-plugin/module.json +40 -0
- package/augment-extensions/examples/woocommerce-extension/README.md +98 -0
- package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -0
- package/augment-extensions/examples/woocommerce-extension/module.json +40 -0
- package/augment-extensions/workflows/beads/module.json +4 -3
- package/augment-extensions/workflows/database/README.md +195 -0
- package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -0
- package/augment-extensions/workflows/database/examples/migration-example.md +498 -0
- package/augment-extensions/workflows/database/examples/optimization-example.md +496 -0
- package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -0
- package/augment-extensions/workflows/database/module.json +42 -0
- package/augment-extensions/workflows/database/rules/data-migration.md +249 -0
- package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -0
- package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -0
- package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -0
- package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -0
- package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -0
- package/augment-extensions/workflows/database/rules/workflow.md +458 -0
- package/augment-extensions/workflows/openspec/module.json +4 -3
- package/augment-extensions/workflows/wordpress-plugin/README.md +232 -0
- package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -0
- package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -0
- package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -0
- package/augment-extensions/workflows/wordpress-plugin/module.json +49 -0
- package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -0
- package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -0
- package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -0
- package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -0
- package/augment-extensions/writing-standards/screenplay/README.md +171 -0
- package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -0
- package/augment-extensions/writing-standards/screenplay/module.json +124 -0
- package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -0
- package/cli/MODULES.md +302 -0
- package/cli/dist/cli.js +142 -9
- package/cli/dist/cli.js.map +1 -1
- package/cli/dist/commands/catalog.d.ts +13 -0
- package/cli/dist/commands/catalog.d.ts.map +1 -0
- package/cli/dist/commands/catalog.js +104 -0
- package/cli/dist/commands/catalog.js.map +1 -0
- package/cli/dist/commands/gui.d.ts +6 -0
- package/cli/dist/commands/gui.d.ts.map +1 -0
- package/cli/dist/commands/gui.js +211 -0
- package/cli/dist/commands/gui.js.map +1 -0
- package/cli/dist/commands/init.d.ts.map +1 -1
- package/cli/dist/commands/init.js +12 -0
- package/cli/dist/commands/init.js.map +1 -1
- package/cli/dist/commands/install-rules.d.ts +14 -0
- package/cli/dist/commands/install-rules.d.ts.map +1 -0
- package/cli/dist/commands/install-rules.js +127 -0
- package/cli/dist/commands/install-rules.js.map +1 -0
- package/cli/dist/commands/link.d.ts.map +1 -1
- package/cli/dist/commands/link.js +9 -11
- package/cli/dist/commands/link.js.map +1 -1
- package/cli/dist/commands/list.d.ts.map +1 -1
- package/cli/dist/commands/list.js +11 -28
- package/cli/dist/commands/list.js.map +1 -1
- package/cli/dist/commands/mcp.d.ts +48 -0
- package/cli/dist/commands/mcp.d.ts.map +1 -0
- package/cli/dist/commands/mcp.js +229 -0
- package/cli/dist/commands/mcp.js.map +1 -0
- package/cli/dist/commands/self-remove.d.ts +7 -0
- package/cli/dist/commands/self-remove.d.ts.map +1 -0
- package/cli/dist/commands/self-remove.js +179 -0
- package/cli/dist/commands/self-remove.js.map +1 -0
- package/cli/dist/commands/show.d.ts.map +1 -1
- package/cli/dist/commands/show.js +42 -71
- package/cli/dist/commands/show.js.map +1 -1
- package/cli/dist/commands/skill.d.ts +67 -0
- package/cli/dist/commands/skill.d.ts.map +1 -0
- package/cli/dist/commands/skill.js +513 -0
- package/cli/dist/commands/skill.js.map +1 -0
- package/cli/dist/commands/unlink.d.ts +6 -0
- package/cli/dist/commands/unlink.d.ts.map +1 -0
- package/cli/dist/commands/unlink.js +115 -0
- package/cli/dist/commands/unlink.js.map +1 -0
- package/cli/dist/commands/validate.d.ts +6 -0
- package/cli/dist/commands/validate.d.ts.map +1 -0
- package/cli/dist/commands/validate.js +159 -0
- package/cli/dist/commands/validate.js.map +1 -0
- package/cli/dist/utils/catalog-sync.d.ts +22 -0
- package/cli/dist/utils/catalog-sync.d.ts.map +1 -0
- package/cli/dist/utils/catalog-sync.js +157 -0
- package/cli/dist/utils/catalog-sync.js.map +1 -0
- package/cli/dist/utils/character-count.d.ts +56 -0
- package/cli/dist/utils/character-count.d.ts.map +1 -0
- package/cli/dist/utils/character-count.js +190 -0
- package/cli/dist/utils/character-count.js.map +1 -0
- package/cli/dist/utils/documentation-validator.d.ts +18 -0
- package/cli/dist/utils/documentation-validator.d.ts.map +1 -0
- package/cli/dist/utils/documentation-validator.js +233 -0
- package/cli/dist/utils/documentation-validator.js.map +1 -0
- package/cli/dist/utils/install-rules.d.ts +32 -0
- package/cli/dist/utils/install-rules.d.ts.map +1 -0
- package/cli/dist/utils/install-rules.js +375 -0
- package/cli/dist/utils/install-rules.js.map +1 -0
- package/cli/dist/utils/mcp-integration.d.ts +70 -0
- package/cli/dist/utils/mcp-integration.d.ts.map +1 -0
- package/cli/dist/utils/mcp-integration.js +292 -0
- package/cli/dist/utils/mcp-integration.js.map +1 -0
- package/cli/dist/utils/module-system.d.ts +153 -0
- package/cli/dist/utils/module-system.d.ts.map +1 -0
- package/cli/dist/utils/module-system.js +528 -0
- package/cli/dist/utils/module-system.js.map +1 -0
- package/cli/dist/utils/modules-catalog.d.ts +33 -0
- package/cli/dist/utils/modules-catalog.d.ts.map +1 -0
- package/cli/dist/utils/modules-catalog.js +163 -0
- package/cli/dist/utils/modules-catalog.js.map +1 -0
- package/cli/dist/utils/rule-install-hooks.d.ts +19 -0
- package/cli/dist/utils/rule-install-hooks.d.ts.map +1 -0
- package/cli/dist/utils/rule-install-hooks.js +224 -0
- package/cli/dist/utils/rule-install-hooks.js.map +1 -0
- package/cli/dist/utils/skill-system.d.ts +95 -0
- package/cli/dist/utils/skill-system.d.ts.map +1 -0
- package/cli/dist/utils/skill-system.js +313 -0
- package/cli/dist/utils/skill-system.js.map +1 -0
- package/modules.md +534 -70
- package/package.json +12 -3
package/README.md
CHANGED
|
@@ -2,18 +2,55 @@
|
|
|
2
2
|
|
|
3
3
|
**Reusable augmentation modules for Augment Code AI - Beyond the 49,400 character limit.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[](https://github.com/mytech-today-now/augment)
|
|
6
|
+
[](./LICENSE)
|
|
7
|
+
[](https://www.npmjs.com/package/@mytechtoday/augment-extensions)
|
|
8
|
+
|
|
9
|
+
Augment Extensions is a modular repository system that extends Augment Code AI's capabilities by providing domain-specific rules, coding standards, workflow integrations, and extensive examples that can be consumed across multiple projects.
|
|
6
10
|
|
|
7
11
|
## 🎯 Purpose
|
|
8
12
|
|
|
9
13
|
Augment Code AI limits the `.augment/` folder to ~49,400 characters. This repository provides:
|
|
10
14
|
|
|
11
|
-
- **
|
|
12
|
-
- **Coding standards** for
|
|
13
|
-
- **
|
|
15
|
+
- **1.7M+ characters** of comprehensive guidelines across 20+ modules
|
|
16
|
+
- **Coding standards** for 8 languages/frameworks (HTML, CSS, JS, TypeScript, Python, React, PHP)
|
|
17
|
+
- **Domain-specific rules** (WordPress, API design, security, databases, MCP)
|
|
18
|
+
- **Workflow integrations** (OpenSpec, Beads)
|
|
19
|
+
- **Extensive examples** (Gutenberg blocks, REST API, WooCommerce, design patterns)
|
|
14
20
|
- **Versioned updates** that propagate to consuming projects
|
|
15
21
|
- **Project-agnostic modules** that work across different codebases
|
|
16
22
|
|
|
23
|
+
## ✨ What's New in v0.4.0 (Beta)
|
|
24
|
+
|
|
25
|
+
- 🧠 **Skills System** - Token-efficient, on-demand skill loading (500-10K tokens vs 50K+ for modules)
|
|
26
|
+
- 🔧 **CLI Integration** - Wrap external tools and MCP servers as skills
|
|
27
|
+
- 📊 **Skill Categories** - 6 categories: retrieval, transformation, analysis, generation, integration, utility
|
|
28
|
+
- 🔍 **Skill Discovery** - `augx skill list`, `augx skill show`, `augx skill search`
|
|
29
|
+
- ⚡ **Dynamic Loading** - Load skills only when needed, reducing context overhead
|
|
30
|
+
- 🔗 **Dependency Resolution** - Automatic skill dependency management
|
|
31
|
+
- 📝 **Skill Development** - Comprehensive guide for creating new skills
|
|
32
|
+
|
|
33
|
+
### Previous Releases
|
|
34
|
+
|
|
35
|
+
**v0.3.0:**
|
|
36
|
+
- 🎨 **GUI Module Manager** - Interactive terminal UI for module selection (`augx gui`)
|
|
37
|
+
- 📦 **Modular HTML/CSS/JS** - Split into independent modules for better flexibility
|
|
38
|
+
- 📚 **Collections System** - Bundle multiple modules together (e.g., `html-css-js` collection)
|
|
39
|
+
- 🔗 **Unlink Command** - Remove modules or collections with dependency checking
|
|
40
|
+
- 🗑️ **Self-Remove** - Safely uninstall all Augment Extensions with dry-run mode
|
|
41
|
+
- 🔍 **Enhanced Search** - Find modules by name, description, or tags in the GUI
|
|
42
|
+
- 🧠 **Model Context Protocol (MCP)** - 219K+ characters of MCP guidelines (6 types, examples)
|
|
43
|
+
- 🐘 **PHP Standards** - 186K+ characters of comprehensive PHP coding standards
|
|
44
|
+
- 🗄️ **Database Guidelines** - 449K+ characters covering SQL, NoSQL, vector, and graph databases
|
|
45
|
+
|
|
46
|
+
**v0.2.0:**
|
|
47
|
+
- 🎉 **WordPress Plugin Development Module** - 344K+ characters of comprehensive guidelines
|
|
48
|
+
- 🔧 **WordPress Plugin Workflow** - Development, testing, and submission workflows
|
|
49
|
+
- 📦 **Beads Workflow Integration** - Git-backed issue tracking for AI agents
|
|
50
|
+
- 🧩 **Example Modules** - Gutenberg blocks, REST API plugins, WooCommerce extensions
|
|
51
|
+
- 📝 **Migration Guides** - WordPress core, PHP, theme, and plugin migrations
|
|
52
|
+
- 💻 **VS Code Integration** - Complete IDE setup for WordPress development
|
|
53
|
+
|
|
17
54
|
## 🚀 Quick Start
|
|
18
55
|
|
|
19
56
|
### For Humans (One-time Setup)
|
|
@@ -25,10 +62,24 @@ npm install -g @mytechtoday/augment-extensions
|
|
|
25
62
|
# Initialize in your project
|
|
26
63
|
augx init
|
|
27
64
|
|
|
28
|
-
#
|
|
29
|
-
augx
|
|
30
|
-
|
|
31
|
-
|
|
65
|
+
# Option 1: Use the interactive GUI (recommended)
|
|
66
|
+
augx gui
|
|
67
|
+
|
|
68
|
+
# Option 2: Link modules manually
|
|
69
|
+
augx link coding-standards/html
|
|
70
|
+
augx link coding-standards/css
|
|
71
|
+
augx link coding-standards/js
|
|
72
|
+
|
|
73
|
+
# Option 3: Link a collection
|
|
74
|
+
augx link collections/html-css-js
|
|
75
|
+
|
|
76
|
+
# Unlink modules or collections
|
|
77
|
+
augx unlink coding-standards/html
|
|
78
|
+
augx unlink collections/html-css-js --force
|
|
79
|
+
|
|
80
|
+
# Remove all Augment Extensions
|
|
81
|
+
augx self-remove --dry-run # Preview what will be removed
|
|
82
|
+
augx self-remove # Actually remove (with confirmation)
|
|
32
83
|
```
|
|
33
84
|
|
|
34
85
|
### For AI Agents
|
|
@@ -38,28 +89,193 @@ Once initialized, AI agents automatically discover available extensions through:
|
|
|
38
89
|
- `.augment/extensions.json` manifest
|
|
39
90
|
- CLI commands: `augx list`, `augx show <module>`
|
|
40
91
|
|
|
92
|
+
## 🧠 Skills System (Beta)
|
|
93
|
+
|
|
94
|
+
The Skills System provides lightweight, token-efficient modules that can be dynamically loaded on-demand, reducing context overhead while maintaining powerful capabilities.
|
|
95
|
+
|
|
96
|
+
### What are Skills?
|
|
97
|
+
|
|
98
|
+
Skills are focused Markdown files with YAML frontmatter that provide specific functionality:
|
|
99
|
+
- **Token-efficient**: 500-10K tokens per skill (vs 50K+ for full modules)
|
|
100
|
+
- **On-demand loading**: Only loaded when needed
|
|
101
|
+
- **CLI integration**: Can wrap external tools and MCP servers
|
|
102
|
+
- **Dependency-aware**: Automatic dependency resolution
|
|
103
|
+
|
|
104
|
+
### Skill Categories
|
|
105
|
+
|
|
106
|
+
- **retrieval**: Fetch data from codebases, SDKs, or documentation
|
|
107
|
+
- **transformation**: Transform code or data formats
|
|
108
|
+
- **analysis**: Analyze code for quality, security, or performance
|
|
109
|
+
- **generation**: Generate code, documentation, or tests
|
|
110
|
+
- **integration**: Integrate with external systems or APIs
|
|
111
|
+
- **utility**: General-purpose utility functions
|
|
112
|
+
|
|
113
|
+
### Using Skills
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# List available skills
|
|
117
|
+
augx skill list
|
|
118
|
+
|
|
119
|
+
# Show skill details
|
|
120
|
+
augx skill show sdk-query
|
|
121
|
+
|
|
122
|
+
# Search for skills
|
|
123
|
+
augx skill search "code review"
|
|
124
|
+
|
|
125
|
+
# Validate a skill file
|
|
126
|
+
augx skill validate skills/retrieval/my-skill.md
|
|
127
|
+
|
|
128
|
+
# Execute a skill (if it has a CLI command)
|
|
129
|
+
augx skill exec sdk-query --args "search term"
|
|
130
|
+
|
|
131
|
+
# Inject skill content into context (with dynamic loading)
|
|
132
|
+
augx skill inject sdk-query
|
|
133
|
+
augx skill inject sdk-query --no-deps # Skip dependencies
|
|
134
|
+
augx skill inject sdk-query --max-tokens 5000 # Limit token budget
|
|
135
|
+
|
|
136
|
+
# Load multiple skills in batch
|
|
137
|
+
augx skill load sdk-query code-review api-design
|
|
138
|
+
|
|
139
|
+
# Cache management
|
|
140
|
+
augx skill cache-clear
|
|
141
|
+
augx skill cache-stats
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### For AI Agents: Skill Discovery
|
|
145
|
+
|
|
146
|
+
AI agents can discover and use skills through:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
# Discover all available skills
|
|
150
|
+
augx skill list
|
|
151
|
+
|
|
152
|
+
# Get skill content for injection (with dependencies)
|
|
153
|
+
augx skill show <skill-id>
|
|
154
|
+
|
|
155
|
+
# Execute skill CLI commands
|
|
156
|
+
augx skill exec <skill-id> --args "..."
|
|
157
|
+
|
|
158
|
+
# Dynamic loading with dependency resolution
|
|
159
|
+
augx skill inject <skill-id> --max-tokens 10000
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Creating New Skills
|
|
163
|
+
|
|
164
|
+
See [docs/SKILL_DEVELOPMENT.md](./docs/SKILL_DEVELOPMENT.md) for detailed instructions on creating, testing, and publishing new skills.
|
|
165
|
+
|
|
166
|
+
## 🔌 MCP Integration (Beta)
|
|
167
|
+
|
|
168
|
+
The MCP Integration allows wrapping Model Context Protocol (MCP) servers as CLI commands and skills, enabling seamless integration with external tools and services.
|
|
169
|
+
|
|
170
|
+
### What is MCP?
|
|
171
|
+
|
|
172
|
+
Model Context Protocol (MCP) is a protocol for AI agents to interact with external tools and services. This integration is inspired by [mcporter](https://github.com/steipete/mcporter).
|
|
173
|
+
|
|
174
|
+
### MCP Commands
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
# List configured MCP servers
|
|
178
|
+
augx mcp list
|
|
179
|
+
|
|
180
|
+
# Add MCP server
|
|
181
|
+
augx mcp add my-server "npx -y my-mcp-server@latest" --transport stdio
|
|
182
|
+
|
|
183
|
+
# Execute MCP tool
|
|
184
|
+
augx mcp exec my-server tool-name --args '{"param":"value"}'
|
|
185
|
+
|
|
186
|
+
# Generate skill wrapper for MCP tool
|
|
187
|
+
augx mcp wrap my-server tool-name skill-id --category integration
|
|
188
|
+
|
|
189
|
+
# Discover tools from MCP server
|
|
190
|
+
augx mcp discover my-server
|
|
191
|
+
|
|
192
|
+
# Generate CLI using mcporter (requires mcporter installed)
|
|
193
|
+
augx mcp generate-cli "npx -y server" dist/cli.js
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### MCP Configuration
|
|
197
|
+
|
|
198
|
+
MCP servers are configured in `.augment/mcp/servers.json`:
|
|
199
|
+
|
|
200
|
+
```json
|
|
201
|
+
{
|
|
202
|
+
"servers": [
|
|
203
|
+
{
|
|
204
|
+
"name": "my-server",
|
|
205
|
+
"command": "npx",
|
|
206
|
+
"args": ["-y", "my-mcp-server@latest"],
|
|
207
|
+
"transport": "stdio",
|
|
208
|
+
"env": {
|
|
209
|
+
"API_KEY": "your-api-key"
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
]
|
|
213
|
+
}
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### MCP Workflow
|
|
217
|
+
|
|
218
|
+
1. **Add MCP Server**: Configure server connection
|
|
219
|
+
2. **Discover Tools**: List available tools from server
|
|
220
|
+
3. **Generate Skill**: Create skill wrapper for tool
|
|
221
|
+
4. **Execute**: Run tool via CLI or inject into AI context
|
|
222
|
+
|
|
223
|
+
See [.augment/mcp/README.md](./.augment/mcp/README.md) for detailed MCP integration documentation.
|
|
224
|
+
|
|
41
225
|
## 📦 Repository Structure
|
|
42
226
|
|
|
43
227
|
```
|
|
44
228
|
augment-extensions/
|
|
45
|
-
├── augment-extensions/
|
|
46
|
-
│ ├── coding-standards/
|
|
47
|
-
│ │ ├──
|
|
48
|
-
│ │ ├──
|
|
49
|
-
│ │ ├──
|
|
50
|
-
│ │
|
|
51
|
-
│ ├──
|
|
52
|
-
│ │ ├──
|
|
53
|
-
│ │ ├──
|
|
54
|
-
│ │
|
|
55
|
-
│
|
|
56
|
-
│ └──
|
|
57
|
-
│
|
|
58
|
-
│
|
|
59
|
-
│
|
|
60
|
-
├──
|
|
61
|
-
├──
|
|
62
|
-
|
|
229
|
+
├── augment-extensions/ # Extension modules (1.7M+ characters)
|
|
230
|
+
│ ├── coding-standards/ # Language/framework standards (8 modules)
|
|
231
|
+
│ │ ├── html/ # HTML standards (32K chars)
|
|
232
|
+
│ │ ├── css/ # CSS standards (30K chars)
|
|
233
|
+
│ │ ├── js/ # JavaScript ES6+ standards (101K chars)
|
|
234
|
+
│ │ ├── typescript/ # TypeScript standards (6K chars)
|
|
235
|
+
│ │ ├── python/ # Python standards with type hints (116K chars)
|
|
236
|
+
│ │ ├── react/ # React patterns and hooks (32K chars)
|
|
237
|
+
│ │ ├── php/ # PHP PSR standards (186K chars)
|
|
238
|
+
│ │ └── html-css-js/ # Legacy monolithic module (deprecated)
|
|
239
|
+
│ ├── collections/ # Module collections
|
|
240
|
+
│ │ └── html-css-js/ # HTML/CSS/JS frontend collection (164K chars)
|
|
241
|
+
│ ├── domain-rules/ # Domain-specific rules (6 modules)
|
|
242
|
+
│ │ ├── api-design/ # REST/GraphQL API design (35K chars)
|
|
243
|
+
│ │ ├── database/ # Database design (SQL, NoSQL, vector) (449K chars) ✨ NEW
|
|
244
|
+
│ │ ├── mcp/ # Model Context Protocol (219K chars) ✨ NEW
|
|
245
|
+
│ │ ├── security/ # OWASP security guidelines (38K chars)
|
|
246
|
+
│ │ ├── wordpress/ # WordPress development (general)
|
|
247
|
+
│ │ └── wordpress-plugin/ # WordPress plugin development (344K chars)
|
|
248
|
+
│ ├── workflows/ # Workflow integrations (2 modules)
|
|
249
|
+
│ │ ├── openspec/ # Spec-driven development (32K chars)
|
|
250
|
+
│ │ └── beads/ # Git-backed issue tracking (39K chars)
|
|
251
|
+
│ └── examples/ # Extensive code examples (4 modules)
|
|
252
|
+
│ ├── design-patterns/ # Design patterns (42K chars)
|
|
253
|
+
│ ├── gutenberg-block-plugin/ # Gutenberg block examples (15K chars)
|
|
254
|
+
│ ├── rest-api-plugin/ # REST API plugin examples (40K chars)
|
|
255
|
+
│ └── woocommerce-extension/ # WooCommerce extension examples (24K chars)
|
|
256
|
+
├── skills/ # Skills system (Beta) 🆕
|
|
257
|
+
│ ├── retrieval/ # Retrieval skills (SDK query, context search)
|
|
258
|
+
│ ├── transformation/ # Transformation skills (code refactor, format conversion)
|
|
259
|
+
│ ├── analysis/ # Analysis skills (code review, security audit)
|
|
260
|
+
│ ├── generation/ # Generation skills (code gen, docs gen)
|
|
261
|
+
│ ├── integration/ # Integration skills (API, database)
|
|
262
|
+
│ └── utility/ # Utility skills (file ops, text processing)
|
|
263
|
+
├── cli/ # CLI tool source (augx)
|
|
264
|
+
│ ├── src/ # TypeScript source
|
|
265
|
+
│ │ ├── commands/ # CLI commands (including skill commands)
|
|
266
|
+
│ │ └── utils/ # Utilities (including skill-system.ts)
|
|
267
|
+
│ └── dist/ # Compiled JavaScript
|
|
268
|
+
├── .augment/ # Core rules (character-limited)
|
|
269
|
+
│ ├── rules/ # Core workflow rules
|
|
270
|
+
│ └── coordination.json # Coordination manifest (OpenSpec + Beads + Skills)
|
|
271
|
+
├── .beads/ # Beads issue tracking
|
|
272
|
+
│ ├── issues.jsonl # Issue log
|
|
273
|
+
│ └── config.json # Beads configuration
|
|
274
|
+
├── openspec/ # OpenSpec specifications
|
|
275
|
+
│ ├── specs/ # Source of truth specs
|
|
276
|
+
│ └── changes/ # Proposed changes
|
|
277
|
+
└── docs/ # Documentation
|
|
278
|
+
└── SKILL_DEVELOPMENT.md # Skill development guide 🆕
|
|
63
279
|
```
|
|
64
280
|
|
|
65
281
|
## 🔧 How It Works
|
|
@@ -113,7 +329,95 @@ augx pin typescript-standards@1.2.0
|
|
|
113
329
|
|
|
114
330
|
## 📖 Available Modules
|
|
115
331
|
|
|
116
|
-
|
|
332
|
+
### Coding Standards (8 modules, ~504K chars)
|
|
333
|
+
|
|
334
|
+
- **[HTML Standards](./augment-extensions/coding-standards/html/)** (v1.0.0, ~32K chars)
|
|
335
|
+
- Semantic HTML, accessibility (ARIA, WCAG), forms, SEO, performance
|
|
336
|
+
|
|
337
|
+
- **[CSS Standards](./augment-extensions/coding-standards/css/)** (v1.0.0, ~30K chars)
|
|
338
|
+
- Modern CSS (Grid, Flexbox, Custom Properties), responsive design, BEM/SMACSS
|
|
339
|
+
|
|
340
|
+
- **[JavaScript Standards](./augment-extensions/coding-standards/js/)** (v1.0.0, ~101K chars)
|
|
341
|
+
- ES6+ features, async patterns, DOM manipulation, error handling, tooling
|
|
342
|
+
|
|
343
|
+
- **[TypeScript Standards](./augment-extensions/coding-standards/typescript/)** (v1.0.0, ~6K chars)
|
|
344
|
+
- Naming conventions, type safety, best practices
|
|
345
|
+
|
|
346
|
+
- **[Python Standards](./augment-extensions/coding-standards/python/)** (v1.1.0, ~116K chars)
|
|
347
|
+
- Type hints (PEP 484, 585, 604), async patterns, testing, documentation
|
|
348
|
+
|
|
349
|
+
- **[React Patterns](./augment-extensions/coding-standards/react/)** (v1.0.0, ~32K chars)
|
|
350
|
+
- Component patterns, hooks, state management, performance, TypeScript integration
|
|
351
|
+
|
|
352
|
+
- **[PHP Standards](./augment-extensions/coding-standards/php/)** (v1.0.0, ~186K chars) ✨ NEW
|
|
353
|
+
- PSR standards (PSR-1, PSR-12, PSR-4, PSR-7, PSR-11), security (OWASP), testing, CMS integration
|
|
354
|
+
|
|
355
|
+
- **[HTML/CSS/JS Collection](./augment-extensions/collections/html-css-js/)** (v1.0.0, ~164K chars)
|
|
356
|
+
- Bundles HTML, CSS, and JavaScript modules together
|
|
357
|
+
|
|
358
|
+
### Domain Rules (6 modules, ~1.08M chars)
|
|
359
|
+
|
|
360
|
+
- **[API Design Guidelines](./augment-extensions/domain-rules/api-design/)** (v1.0.0, ~35K chars)
|
|
361
|
+
- REST/GraphQL API design, authentication, versioning, error handling
|
|
362
|
+
|
|
363
|
+
- **[Database Design Guidelines](./augment-extensions/domain-rules/database/)** (v1.0.0, ~449K chars) ✨ NEW
|
|
364
|
+
- Relational databases (schema design, indexing, query optimization, transactions)
|
|
365
|
+
- NoSQL databases (document stores, key-value stores, graph databases)
|
|
366
|
+
- Vector databases (embeddings, indexing, semantic search)
|
|
367
|
+
- Flat databases, performance optimization, security standards
|
|
368
|
+
|
|
369
|
+
- **[Model Context Protocol (MCP)](./augment-extensions/domain-rules/mcp/)** (v1.0.0, ~219K chars) ✨ NEW
|
|
370
|
+
- Token-based MCP (compression, chunking, budgeting)
|
|
371
|
+
- State-based MCP (persistence, state machines, concurrency)
|
|
372
|
+
- Vector-based MCP (RAG, embeddings, semantic search)
|
|
373
|
+
- Hybrid MCP (multi-memory coordination)
|
|
374
|
+
- Graph-augmented MCP (knowledge graphs, entity relationships)
|
|
375
|
+
- Compressed MCP (mobile optimization)
|
|
376
|
+
- 6 complete implementation examples with code
|
|
377
|
+
|
|
378
|
+
- **[Security Guidelines](./augment-extensions/domain-rules/security/)** (v1.0.0, ~38K chars)
|
|
379
|
+
- OWASP Top 10, authentication, encryption, input validation, secure coding
|
|
380
|
+
|
|
381
|
+
- **[WordPress Development](./augment-extensions/domain-rules/wordpress/)** (v1.0.0)
|
|
382
|
+
- Project detection, directory structure, coding standards, themes, plugins, blocks
|
|
383
|
+
|
|
384
|
+
- **[WordPress Plugin Development](./augment-extensions/domain-rules/wordpress-plugin/)** (v1.1.0, ~344K chars)
|
|
385
|
+
- **Most comprehensive module** - 7 architecture patterns, Gutenberg blocks, REST API
|
|
386
|
+
- AJAX handlers, database management, security, performance, WooCommerce
|
|
387
|
+
- Testing patterns, WordPress.org submission, migration workflows, VS Code integration
|
|
388
|
+
|
|
389
|
+
### Workflows (2 modules, ~71K chars)
|
|
390
|
+
|
|
391
|
+
- **[OpenSpec](./augment-extensions/workflows/openspec/)** (v1.0.0, ~32K chars)
|
|
392
|
+
- Spec-driven development workflow for AI coding assistants
|
|
393
|
+
- Proposal → Specs → Tasks → Implement → Archive
|
|
394
|
+
|
|
395
|
+
- **[Beads](./augment-extensions/workflows/beads/)** (v1.0.0, ~39K chars)
|
|
396
|
+
- Distributed, git-backed graph issue tracker for AI agents
|
|
397
|
+
- Create → Dependencies → Ready → Work → Close
|
|
398
|
+
|
|
399
|
+
### Examples (4 modules, ~122K chars)
|
|
400
|
+
|
|
401
|
+
- **[Design Patterns](./augment-extensions/examples/design-patterns/)** (v1.0.0, ~42K chars)
|
|
402
|
+
- Common design patterns with TypeScript/JavaScript implementations
|
|
403
|
+
|
|
404
|
+
- **[Gutenberg Block Plugin](./augment-extensions/examples/gutenberg-block-plugin/)** (v1.0.0, ~15K chars)
|
|
405
|
+
- Complete Gutenberg block plugin with testimonial example
|
|
406
|
+
|
|
407
|
+
- **[REST API Plugin](./augment-extensions/examples/rest-api-plugin/)** (v1.0.0, ~40K chars)
|
|
408
|
+
- Task manager API with CRUD operations, authentication, validation
|
|
409
|
+
|
|
410
|
+
- **[WooCommerce Extension](./augment-extensions/examples/woocommerce-extension/)** (v1.0.0, ~24K chars)
|
|
411
|
+
- Product customizer with custom fields, checkout customization
|
|
412
|
+
|
|
413
|
+
### Statistics
|
|
414
|
+
|
|
415
|
+
- **Total Modules**: 20 (8 coding standards, 6 domain rules, 2 workflows, 4 examples)
|
|
416
|
+
- **Total Character Count**: ~1,774,692 (1.7M+ characters)
|
|
417
|
+
- **Languages Covered**: HTML, CSS, JavaScript, TypeScript, Python, React, PHP
|
|
418
|
+
- **Domains Covered**: APIs, Databases, MCP, Security, WordPress
|
|
419
|
+
|
|
420
|
+
See [MODULES.md](./MODULES.md) for detailed module documentation.
|
|
117
421
|
|
|
118
422
|
## 🛠 Creating Custom Modules
|
|
119
423
|
|
|
@@ -136,10 +440,57 @@ Extensions integrate seamlessly:
|
|
|
136
440
|
|
|
137
441
|
## 📚 Documentation
|
|
138
442
|
|
|
139
|
-
|
|
140
|
-
- [
|
|
141
|
-
- [
|
|
142
|
-
- [
|
|
443
|
+
### Core Documentation
|
|
444
|
+
- [AGENTS.md](./AGENTS.md) - AI agent integration guide
|
|
445
|
+
- [MODULES.md](./MODULES.md) - Complete module catalog
|
|
446
|
+
- [Module Development](./.augment/rules/module-development.md) - Creating custom modules
|
|
447
|
+
- [Character Count Management](./.augment/rules/character-count-management.md) - Managing .augment/ limits
|
|
448
|
+
|
|
449
|
+
### Workflow Documentation
|
|
450
|
+
- [OpenSpec Workflow](./augment-extensions/workflows/openspec/) - Spec-driven development
|
|
451
|
+
- [Beads Workflow](./augment-extensions/workflows/beads/) - Git-backed issue tracking
|
|
452
|
+
- [WordPress Plugin Workflow](./augment-extensions/workflows/wordpress-plugin/) - Plugin development cycle
|
|
453
|
+
|
|
454
|
+
### Module Documentation
|
|
455
|
+
- [TypeScript Standards](./augment-extensions/coding-standards/typescript/)
|
|
456
|
+
- [WordPress Plugin Development](./augment-extensions/domain-rules/wordpress-plugin/)
|
|
457
|
+
- [WordPress Development](./augment-extensions/domain-rules/wordpress/)
|
|
458
|
+
|
|
459
|
+
## ✅ Module Validation
|
|
460
|
+
|
|
461
|
+
The CLI includes comprehensive validation to ensure module quality:
|
|
462
|
+
|
|
463
|
+
```bash
|
|
464
|
+
# Validate a module
|
|
465
|
+
augx validate coding-standards/typescript --verbose
|
|
466
|
+
|
|
467
|
+
# Validation checks:
|
|
468
|
+
# ✅ Module structure (required files and directories)
|
|
469
|
+
# ✅ Category matching (type matches directory)
|
|
470
|
+
# ✅ Semantic versioning (MAJOR.MINOR.PATCH format)
|
|
471
|
+
# ✅ Project-agnostic content (no hardcoded paths)
|
|
472
|
+
# ✅ Documentation completeness (required sections, examples)
|
|
473
|
+
# ✅ Character count accuracy (matches declaration)
|
|
474
|
+
# ✅ Metadata completeness (all required fields)
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
### Automatic Catalog Updates
|
|
478
|
+
|
|
479
|
+
Keep the module catalog up to date automatically:
|
|
480
|
+
|
|
481
|
+
```bash
|
|
482
|
+
# Update catalog manually
|
|
483
|
+
augx catalog
|
|
484
|
+
|
|
485
|
+
# Check if catalog is out of date
|
|
486
|
+
augx catalog --check
|
|
487
|
+
|
|
488
|
+
# Auto-update only if needed
|
|
489
|
+
augx catalog --auto
|
|
490
|
+
|
|
491
|
+
# Set up git hook for automatic updates
|
|
492
|
+
augx catalog-hook
|
|
493
|
+
```
|
|
143
494
|
|
|
144
495
|
## 🤝 Contributing
|
|
145
496
|
|
|
@@ -149,22 +500,92 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on creating and sharing
|
|
|
149
500
|
|
|
150
501
|
MIT License - See [LICENSE](./LICENSE) for details.
|
|
151
502
|
|
|
152
|
-
## 🌟 Examples
|
|
503
|
+
## 🌟 Usage Examples
|
|
153
504
|
|
|
154
|
-
### Example 1:
|
|
505
|
+
### Example 1: Frontend Web Development
|
|
155
506
|
|
|
156
507
|
```bash
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
508
|
+
# Install CLI
|
|
509
|
+
npm install -g @mytechtoday/augment-extensions
|
|
510
|
+
|
|
511
|
+
# Initialize in your project
|
|
512
|
+
augx init
|
|
513
|
+
|
|
514
|
+
# Option 1: Use the collection (recommended)
|
|
515
|
+
augx link collections/html-css-js
|
|
516
|
+
|
|
517
|
+
# Option 2: Link individual modules
|
|
518
|
+
augx link coding-standards/html
|
|
519
|
+
augx link coding-standards/css
|
|
520
|
+
augx link coding-standards/js
|
|
521
|
+
|
|
522
|
+
# Add workflows
|
|
523
|
+
augx link workflows/openspec
|
|
524
|
+
augx link workflows/beads
|
|
160
525
|
```
|
|
161
526
|
|
|
162
|
-
### Example 2: Python
|
|
527
|
+
### Example 2: Python AI/ML Project with MCP
|
|
163
528
|
|
|
164
529
|
```bash
|
|
530
|
+
# Link Python standards and MCP guidelines
|
|
165
531
|
augx link coding-standards/python
|
|
532
|
+
augx link domain-rules/mcp
|
|
533
|
+
augx link domain-rules/database # For vector databases
|
|
534
|
+
|
|
535
|
+
# View MCP guidelines
|
|
536
|
+
augx show mcp
|
|
537
|
+
|
|
538
|
+
# Search for specific MCP patterns
|
|
539
|
+
augx search "vector-based MCP"
|
|
540
|
+
augx search "RAG"
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
### Example 3: WordPress Plugin Development
|
|
544
|
+
|
|
545
|
+
```bash
|
|
546
|
+
# Link WordPress plugin modules
|
|
547
|
+
augx link domain-rules/wordpress-plugin
|
|
548
|
+
augx link coding-standards/php
|
|
549
|
+
augx link workflows/beads
|
|
550
|
+
|
|
551
|
+
# Link example modules
|
|
552
|
+
augx link examples/gutenberg-block-plugin
|
|
553
|
+
augx link examples/rest-api-plugin
|
|
554
|
+
augx link examples/woocommerce-extension
|
|
555
|
+
|
|
556
|
+
# View module content
|
|
557
|
+
augx show wordpress-plugin
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
### Example 4: Full-Stack TypeScript/React Project
|
|
561
|
+
|
|
562
|
+
```bash
|
|
563
|
+
# Link TypeScript and React standards
|
|
564
|
+
augx link coding-standards/typescript
|
|
565
|
+
augx link coding-standards/react
|
|
166
566
|
augx link domain-rules/api-design
|
|
167
|
-
augx link
|
|
567
|
+
augx link domain-rules/database
|
|
568
|
+
augx link domain-rules/security
|
|
569
|
+
|
|
570
|
+
# Add workflows
|
|
571
|
+
augx link workflows/openspec
|
|
572
|
+
augx link workflows/beads
|
|
573
|
+
|
|
574
|
+
# Add design patterns
|
|
575
|
+
augx link examples/design-patterns
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### Example 5: PHP Web Application
|
|
579
|
+
|
|
580
|
+
```bash
|
|
581
|
+
# Link PHP standards and domain rules
|
|
582
|
+
augx link coding-standards/php
|
|
583
|
+
augx link domain-rules/api-design
|
|
584
|
+
augx link domain-rules/database
|
|
585
|
+
augx link domain-rules/security
|
|
586
|
+
|
|
587
|
+
# Add workflows
|
|
588
|
+
augx link workflows/openspec
|
|
168
589
|
```
|
|
169
590
|
|
|
170
591
|
## 🔄 Update Propagation
|
|
@@ -190,7 +611,161 @@ augx diff typescript-standards
|
|
|
190
611
|
4. **AI-friendly**: JSON output, structured data, CLI-first
|
|
191
612
|
5. **Project-agnostic**: Works across different project types
|
|
192
613
|
|
|
614
|
+
## 🚀 CLI Commands
|
|
615
|
+
|
|
616
|
+
```bash
|
|
617
|
+
# List all available modules
|
|
618
|
+
augx list
|
|
619
|
+
|
|
620
|
+
# List linked modules in current project
|
|
621
|
+
augx list --linked
|
|
622
|
+
|
|
623
|
+
# Show module details
|
|
624
|
+
augx show <module-name>
|
|
625
|
+
|
|
626
|
+
# Show module as JSON
|
|
627
|
+
augx show <module-name> --json
|
|
628
|
+
|
|
629
|
+
# Search for modules
|
|
630
|
+
augx search <keyword>
|
|
631
|
+
|
|
632
|
+
# Update all linked modules
|
|
633
|
+
augx update
|
|
634
|
+
|
|
635
|
+
# Check CLI version
|
|
636
|
+
augx version
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
## 🔧 Integration with AI Agents
|
|
640
|
+
|
|
641
|
+
Augment Extensions integrates seamlessly with AI coding assistants:
|
|
642
|
+
|
|
643
|
+
1. **Automatic Discovery**: AI agents discover modules via `AGENTS.md` convention
|
|
644
|
+
2. **CLI Integration**: Query modules using `augx` commands
|
|
645
|
+
3. **Workflow Integration**: OpenSpec and Beads workflows for structured development
|
|
646
|
+
4. **Context Providers**: WordPress-specific file contexts for intelligent assistance
|
|
647
|
+
5. **Character Limit Bypass**: Unlimited content in extension modules
|
|
648
|
+
|
|
649
|
+
### For AI Agents
|
|
650
|
+
|
|
651
|
+
When working on a project with Augment Extensions:
|
|
652
|
+
|
|
653
|
+
```bash
|
|
654
|
+
# Check linked modules
|
|
655
|
+
augx list --linked
|
|
656
|
+
|
|
657
|
+
# View module content
|
|
658
|
+
augx show wordpress-plugin
|
|
659
|
+
|
|
660
|
+
# Search for specific guidance
|
|
661
|
+
augx search "security best practices"
|
|
662
|
+
augx search "gutenberg blocks"
|
|
663
|
+
augx search "REST API"
|
|
664
|
+
```
|
|
665
|
+
|
|
666
|
+
## 🎯 Key Features
|
|
667
|
+
|
|
668
|
+
### Comprehensive Coverage
|
|
669
|
+
|
|
670
|
+
- **1.7M+ characters** of guidelines across 20+ modules
|
|
671
|
+
- **8 programming languages/frameworks** - HTML, CSS, JavaScript, TypeScript, Python, React, PHP
|
|
672
|
+
- **6 domain-specific areas** - APIs, Databases, MCP, Security, WordPress
|
|
673
|
+
- **2 workflow systems** - OpenSpec (spec-driven development), Beads (issue tracking)
|
|
674
|
+
- **4 example modules** - Design patterns, Gutenberg blocks, REST API, WooCommerce
|
|
675
|
+
|
|
676
|
+
### Model Context Protocol (MCP) - 219K chars ✨ NEW
|
|
677
|
+
|
|
678
|
+
The most comprehensive MCP guidelines available:
|
|
679
|
+
|
|
680
|
+
- ✅ **6 MCP Types** - Token-based, state-based, vector-based, hybrid, graph-augmented, compressed
|
|
681
|
+
- ✅ **Universal Rules** - Context optimization, error handling, security, monitoring, testing
|
|
682
|
+
- ✅ **Configuration System** - JSON schema, validation, override semantics
|
|
683
|
+
- ✅ **Testing Framework** - Unit, integration, synthetic testing strategies
|
|
684
|
+
- ✅ **6 Complete Examples** - Legal contract analysis, customer support, knowledge base Q&A, research assistant, supply chain analysis, mobile assistant
|
|
685
|
+
- ✅ **RAG Patterns** - Retrieval Augmented Generation with embeddings and vector search
|
|
686
|
+
- ✅ **State Management** - Persistent conversation state with Redis, serialization, concurrency
|
|
687
|
+
- ✅ **Graph Integration** - Neo4j knowledge graphs with entity extraction and traversal
|
|
688
|
+
|
|
689
|
+
### Database Design Guidelines - 449K chars ✨ NEW
|
|
690
|
+
|
|
691
|
+
The largest module with comprehensive database coverage:
|
|
692
|
+
|
|
693
|
+
- ✅ **Relational Databases** - Schema design, normalization, indexing, query optimization, transactions
|
|
694
|
+
- ✅ **NoSQL Databases** - Document stores (MongoDB), key-value stores (Redis), graph databases (Neo4j)
|
|
695
|
+
- ✅ **Vector Databases** - Embeddings, indexing, semantic search (Pinecone, Weaviate, Qdrant)
|
|
696
|
+
- ✅ **Flat Databases** - CSV, JSON, SQLite use cases
|
|
697
|
+
- ✅ **Performance Optimization** - Query optimization, caching, connection pooling
|
|
698
|
+
- ✅ **Security Standards** - Encryption, access control, SQL injection prevention
|
|
699
|
+
|
|
700
|
+
### PHP Coding Standards - 186K chars ✨ NEW
|
|
701
|
+
|
|
702
|
+
Comprehensive PHP standards for modern development:
|
|
703
|
+
|
|
704
|
+
- ✅ **PSR Standards** - PSR-1, PSR-12, PSR-4, PSR-7, PSR-11
|
|
705
|
+
- ✅ **Security** - OWASP guidelines, input validation, SQL injection prevention
|
|
706
|
+
- ✅ **Testing** - PHPUnit, integration testing, mocking
|
|
707
|
+
- ✅ **CMS Integration** - WordPress, Drupal best practices
|
|
708
|
+
- ✅ **E-commerce** - WooCommerce development patterns
|
|
709
|
+
- ✅ **Legacy Migration** - Modernizing legacy PHP codebases
|
|
710
|
+
|
|
711
|
+
### WordPress Plugin Development - 344K chars
|
|
712
|
+
|
|
713
|
+
The most comprehensive WordPress module:
|
|
714
|
+
|
|
715
|
+
- ✅ **7 Architecture Patterns** - Procedural, OOP, MVC, singleton, DI, boilerplate
|
|
716
|
+
- ✅ **Gutenberg Blocks** - Block development with block.json and React
|
|
717
|
+
- ✅ **REST API** - Custom endpoints with authentication and validation
|
|
718
|
+
- ✅ **AJAX Handlers** - Secure AJAX with nonces and capability checks
|
|
719
|
+
- ✅ **Database Management** - Custom tables, queries, migrations
|
|
720
|
+
- ✅ **Security** - Nonces, sanitization, escaping, capability checks
|
|
721
|
+
- ✅ **WooCommerce** - Product fields, checkout, payment gateways, orders
|
|
722
|
+
- ✅ **Testing** - PHPUnit, Theme Check, Plugin Check, accessibility
|
|
723
|
+
- ✅ **VS Code Integration** - Complete IDE setup with tasks and snippets
|
|
724
|
+
|
|
725
|
+
### Workflow Integrations
|
|
726
|
+
|
|
727
|
+
- **OpenSpec** - Spec-driven development with proposal → specs → tasks → implement → archive
|
|
728
|
+
- **Beads** - Git-backed issue tracking with dependencies and graph visualization
|
|
729
|
+
- **Coordination System** - Harmonizes OpenSpec, Beads, and .augment/ rules
|
|
730
|
+
|
|
731
|
+
## 🤝 Contributing
|
|
732
|
+
|
|
733
|
+
We welcome contributions! Here's how to help:
|
|
734
|
+
|
|
735
|
+
1. **Create New Modules** - Follow [module-development.md](./.augment/rules/module-development.md)
|
|
736
|
+
2. **Improve Existing Modules** - Submit PRs with enhancements
|
|
737
|
+
3. **Report Issues** - Use GitHub issues for bugs and feature requests
|
|
738
|
+
4. **Share Examples** - Contribute real-world examples
|
|
739
|
+
|
|
740
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.
|
|
741
|
+
|
|
742
|
+
## 📄 License
|
|
743
|
+
|
|
744
|
+
MIT License - See [LICENSE](./LICENSE) for details.
|
|
745
|
+
|
|
193
746
|
---
|
|
194
747
|
|
|
195
|
-
|
|
748
|
+
## 📊 Module Statistics
|
|
749
|
+
|
|
750
|
+
| Category | Modules | Total Characters | Highlights |
|
|
751
|
+
|----------|---------|------------------|------------|
|
|
752
|
+
| **Coding Standards** | 8 | ~504,000 | HTML, CSS, JS, TypeScript, Python, React, PHP |
|
|
753
|
+
| **Domain Rules** | 6 | ~1,085,000 | APIs, Databases, MCP, Security, WordPress |
|
|
754
|
+
| **Workflows** | 2 | ~71,000 | OpenSpec, Beads |
|
|
755
|
+
| **Examples** | 4 | ~122,000 | Design Patterns, Gutenberg, REST API, WooCommerce |
|
|
756
|
+
| **Collections** | 1 | ~164,000 | HTML/CSS/JS Bundle |
|
|
757
|
+
| **TOTAL** | **20** | **~1,774,000** | **1.7M+ characters** |
|
|
758
|
+
|
|
759
|
+
## 🔗 Links
|
|
760
|
+
|
|
761
|
+
- **npm Package**: [@mytechtoday/augment-extensions](https://www.npmjs.com/package/@mytechtoday/augment-extensions)
|
|
762
|
+
- **Repository**: [github.com/mytech-today-now/augment](https://github.com/mytech-today-now/augment)
|
|
763
|
+
- **Issues**: [github.com/mytech-today-now/augment/issues](https://github.com/mytech-today-now/augment/issues)
|
|
764
|
+
- **Documentation**: [MODULES.md](./MODULES.md) | [AGENTS.md](./AGENTS.md)
|
|
765
|
+
|
|
766
|
+
---
|
|
767
|
+
|
|
768
|
+
**Status**: Active Development | **Version**: 0.3.0 | **Maintainer**: @mytech-today-now
|
|
769
|
+
|
|
770
|
+
**Latest Release**: Model Context Protocol (MCP) module, PHP standards, Database guidelines, and enhanced module management with GUI.
|
|
196
771
|
|