Feature/educational mode 35#55
Merged
Merged
Conversation
- Add --educate flag to all commands for on-demand explanations - Add global config option 'educate' (stackcode config set educate true/false) - Educational mode explains best practices behind each action - Smart behavior: if enabled globally, always shows explanations - If disabled globally, only shows with --educate flag - Add educational messages for commit validation, git init, scaffold, etc. - Full i18n support (Portuguese and English) - Add interactive configuration option in stackcode config menu - Closes #35
- Add educational mode system with global/per-command configuration - Implement contextual explanations for all major StackCode operations - Add complete Spanish translations (es.json) with 433+ lines of content - Update Portuguese and English translations with educational mode content - Add Spanish language option to CLI configuration interface - Create comprehensive documentation for educational mode in all languages - Add educational mode integration to all CLI commands (init, commit, validate, etc.) - Implement fallback message system for reliability - Update architecture documentation across all language variants - Add demo script and usage examples for educational mode BREAKING CHANGES: None - purely additive functionality Educational mode transforms StackCode into an interactive learning platform that teaches DevOps best practices contextually. Fully configurable and available in Spanish, Portuguese, and English. Resolves #35
- Fix TypeScript linting warnings in CLI commands (commit, init, validate) - Replace 'any' types with proper ArgumentsCamelCase<T> interfaces - Remove unused import 'showBestPractice' from init.ts - Add comprehensive test suite for educational-mode.ts (13 tests) - Test global configuration, fallback messages, and all educational functions - Ensure type safety across all command handlers All linting errors resolved and educational mode fully tested.
- Apply prettier formatting to educational-mode.test.ts - Ensure all files follow project code style standards - Fix CI format check pipeline
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📋 Description
This PR implements the Educational Mode feature (#35) that transforms StackCode into an interactive learning platform. The educational mode provides contextual explanations and best practice guidance for every StackCode action, helping developers learn DevOps practices while working.
✨ Key Features
stackcode config set educate trueor use--educateflag on any command🔗 Related Issue
Fixes #35
🧪 Type of Change
📝 How Has This Been Tested?
🧪 Test Coverage
✓ Educational mode initialization (global/flag-based) ✓ Message display functionality (educational/best practice/security tips) ✓ Internationalization system integration ✓ Fallback message system reliability ✓ Configuration precedence handling ✓ Icon display for different message types📷 Screenshots (if applicable)
English Example:
$ stackcode validate "feat: new feature" --educate ✔ Valid: This is a valid conventional commit message. 📚 Conventional commits follow a standard that enables automation and understanding. Format: type(scope): descriptionSpanish Example:
$ stackcode validate "feat: nueva función" --educate ✔ Válido: Este es un mensaje de commit convencional válido. 📚 Los commits convencionales siguen un estándar que habilita automatización y comprensión. Formato: tipo(alcance): descripción✅ Checklist
🔄 Dependencies
@stackcode/core,@stackcode/i18n, andinquirerpackages📚 Additional Notes
🎓 Educational Content Includes:
🌐 Internationalization:
🏗️ Technical Implementation:
Issue Reference: Closes #35