Skip to content

Feature/config system expansion and docs cleanup#54

Merged
YagoBorba merged 5 commits into
developfrom
feature/config-system-expansion-and-docs-cleanup
Sep 11, 2025
Merged

Feature/config system expansion and docs cleanup#54
YagoBorba merged 5 commits into
developfrom
feature/config-system-expansion-and-docs-cleanup

Conversation

@YagoBorba

Copy link
Copy Markdown
Owner

📋 Description

This PR expands the StackCode configuration system and performs comprehensive documentation cleanup to ensure accuracy and reliability.

✨ New Features

  • Expanded Configuration System: Added StackCodeConfig interface with defaultAuthor, defaultLicense, and features properties
  • Configuration Utilities: Implemented loadStackCodeConfig() and saveStackCodeConfig() functions for managing project-specific settings
  • Enhanced CLI Integration: Updated init and config commands to use the new configuration system

📝 Documentation Improvements

  • Translation Status Fix: Removed incorrect "em desenvolvimento" and "en desarrollo" flags from README files - translations are actually complete
  • SELF_HOSTING_GUIDE.md Cleanup: Thoroughly cleaned all 3 language versions (EN, PT-BR, ES) to remove non-implemented enterprise features
  • Accuracy Verification: Ensured all documented features actually exist in the codebase

🗑️ Removed Documentation for Non-Implemented Features

  • Private registry configuration sections
  • Organization architecture and team integration features
  • Advanced security configurations (VPN, audit logging, etc.)
  • Enterprise deployment workflows
  • Non-functional environment variables and configuration options

🔗 Related Issue

Fixes documentation accuracy issues and implements basic configuration expansion as requested.

🧪 Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 📝 Documentation update
  • 🔧 Configuration change
  • 🧹 Code cleanup

📝 How Has This Been Tested?

  • Unit tests pass (32 total tests: 24 CLI + 9 Core + 4 VSCode)
  • Manual testing completed
    • Configuration save/load functionality verified
    • CLI commands tested with new configuration system
    • Documentation accuracy validated against actual codebase
  • Code formatting and linting verified
  • Build process successful

✅ Checklist

  • My code follows the project's coding standards
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas (JSDoc added)
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

🔄 Dependencies

No new dependencies added. Changes use existing:

  • fs/promises for file operations
  • path for file path handling
  • Existing TypeScript interfaces and types

📚 Additional Notes

Breaking Changes

  • Documentation now accurately reflects only implemented features (may affect users expecting non-existent enterprise features)

Files Modified

  • packages/core/src/types.ts - Added StackCodeConfig interface
  • packages/core/src/utils.ts - Added configuration utility functions
  • packages/core/src/index.ts - Exported new functions
  • packages/cli/src/commands/init.ts - Integrated with new config system
  • packages/cli/src/commands/config.ts - Updated to use new utilities
  • docs/SELF_HOSTING_GUIDE.md (all 3 languages) - Cleaned up non-implemented features
  • README.md - Fixed translation status
  • Test files updated with new mocks

Configuration File Format

{
  "defaultAuthor": "Author Name",
  "defaultLicense": "MIT",
  "features": {
    "commitValidation": true
  }
}

Issue Reference: Improves documentation accuracy and expands configuration capabilities

✨ 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
@YagoBorba YagoBorba requested a review from Copilot September 11, 2025 02:06
@YagoBorba YagoBorba self-assigned this Sep 11, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 StackCodeConfig interface 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.

Comment thread packages/core/src/utils.ts
Comment thread packages/cli/src/commands/config.ts
YagoBorba and others added 3 commits September 10, 2025 23:08
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
@YagoBorba YagoBorba merged commit ca94da1 into develop Sep 11, 2025
4 checks passed
@YagoBorba YagoBorba deleted the feature/config-system-expansion-and-docs-cleanup branch September 11, 2025 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants