Feature/config system expansion and docs cleanup#54
Merged
YagoBorba merged 5 commits intoSep 11, 2025
Conversation
✨ New Features: - Added StackCodeConfig interface with defaultAuthor, defaultLicense, and features - Implemented loadStackCodeConfig() and saveStackCodeConfig() utility functions - Updated CLI init command to save expanded configuration automatically - Enhanced config command to use new configuration management system 🧹 Documentation Cleanup: - Removed 'em desenvolvimento' and 'en desarrollo' labels from completed translations - Fixed SELF_HOSTING_GUIDE.md in all languages (EN, PT-BR, ES) by removing non-implemented features: - Removed sections about private registries, enterprise features, organization policies - Removed sections about network security, audit logging, team management - Removed sections about centralized configuration and deployment pipelines - Kept only practical, implemented features for basic self-hosting 🔧 Technical Improvements: - All tests passing (24/24) with updated mocks - Build process working correctly with new configuration system - Consistent documentation across all language versions - Type-safe configuration with proper TypeScript interfaces 📚 Files Updated: - packages/core/src/types.ts: Added StackCodeConfig interface - packages/core/src/utils.ts: Added config utility functions - packages/cli/src/commands/init.ts: Integrated with new config system - packages/cli/src/commands/config.ts: Refactored to use new utilities - docs/README.md: Removed development status from translations - docs/SELF_HOSTING_GUIDE.md: Cleaned up non-implemented features - docs/pt-BR/SELF_HOSTING_GUIDE.md: Removed enterprise sections - docs/es/SELF_HOSTING_GUIDE.md: Removed enterprise sections
🔧 Add StackCodeConfig interface with defaultAuthor, defaultLicense, and features 🛠️ Implement loadStackCodeConfig() and saveStackCodeConfig() utility functions ⚡ Update init command to use expanded configuration system 🔄 Update config command to use new configuration utilities 📝 Fix all translation status in README.md (removed 'em desenvolvimento' flags) 🧹 Clean up SELF_HOSTING_GUIDE.md in all 3 languages (EN, PT-BR, ES) 🗑️ Remove non-implemented enterprise features from documentation: - Private registry configuration - Organization architecture sections - Advanced security configurations - Team integration features ✅ Update all tests and mocks for new configuration functions 🎨 Apply code formatting with Prettier ✅ All tests passing (32 total) BREAKING CHANGE: Documentation now accurately reflects only implemented features
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR expands the StackCode configuration system with better type safety and utility functions, while performing comprehensive documentation cleanup to remove references to non-implemented enterprise features.
- Added structured configuration management with
StackCodeConfiginterface and utility functions - Cleaned up self-hosting documentation to remove non-existent enterprise features
- Fixed translation status flags in README files
Reviewed Changes
Copilot reviewed 12 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/core/src/types.ts | Added StackCodeConfig interface and moved ProjectOptions from scaffold.ts |
| packages/core/src/utils.ts | Added loadStackCodeConfig and saveStackCodeConfig utility functions |
| packages/core/src/index.ts | Exported new configuration utilities |
| packages/core/src/scaffold.ts | Removed duplicate ProjectOptions interface |
| packages/cli/src/commands/init.ts | Updated to use new configuration system and type-safe config creation |
| packages/cli/src/commands/config.ts | Refactored to use new utility functions for configuration management |
| packages/cli/test/commands/init.test.ts | Updated test mocks and assertions for new configuration approach |
| docs/SELF_HOSTING_GUIDE.md | Removed non-implemented enterprise features and simplified configuration documentation |
| docs/pt-BR/SELF_HOSTING_GUIDE.md | Cleaned up Portuguese version to match English documentation changes |
| docs/es/SELF_HOSTING_GUIDE.md | Cleaned up Spanish version to match English documentation changes |
| docs/README.md | Removed "em desenvolvimento" and "en desarrollo" flags from translation status |
| README.md | Removed "em desenvolvimento" and "en desarrollo" flags from translation status |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Remove unused '_error' parameter in config.ts catch block - Remove unused '_error' parameter in utils.ts catch block - Fixes ESLint warnings about unused variables
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 expands the StackCode configuration system and performs comprehensive documentation cleanup to ensure accuracy and reliability.
✨ New Features
StackCodeConfiginterface withdefaultAuthor,defaultLicense, andfeaturespropertiesloadStackCodeConfig()andsaveStackCodeConfig()functions for managing project-specific settingsinitandconfigcommands to use the new configuration system📝 Documentation Improvements
🗑️ Removed Documentation for Non-Implemented Features
🔗 Related Issue
Fixes documentation accuracy issues and implements basic configuration expansion as requested.
🧪 Type of Change
📝 How Has This Been Tested?
✅ Checklist
🔄 Dependencies
No new dependencies added. Changes use existing:
fs/promisesfor file operationspathfor file path handling📚 Additional Notes
Breaking Changes
Files Modified
packages/core/src/types.ts- Added StackCodeConfig interfacepackages/core/src/utils.ts- Added configuration utility functionspackages/core/src/index.ts- Exported new functionspackages/cli/src/commands/init.ts- Integrated with new config systempackages/cli/src/commands/config.ts- Updated to use new utilitiesdocs/SELF_HOSTING_GUIDE.md(all 3 languages) - Cleaned up non-implemented featuresREADME.md- Fixed translation statusConfiguration File Format
{ "defaultAuthor": "Author Name", "defaultLicense": "MIT", "features": { "commitValidation": true } }Issue Reference: Improves documentation accuracy and expands configuration capabilities