dwinkl/np
1
0
Fork 0
mirror of https://github.com/dwinkler1/np.git synced 2026-02-19 22:40:57 -05:00
Code Issues Projects Releases Packages Wiki Activity

Cleanup

Browse source
This commit is contained in:
Daniel Winkler 2026-01-16 19:47:23 +11:00
commit c3bc8f74a6
4 changed files with 3 additions and 330 deletions
Download patch file Download diff file Expand all files Collapse all files

5
templates/rde/README.md
View file

@ -367,11 +367,6 @@ The CI runs on:
This ensures that users can confidently use the template knowing that all advertised functionality has been verified.
## Related Documentation
- [REFACTORING.md](REFACTORING.md) - Technical details about the modular structure
- [SUMMARY.md](SUMMARY.md) - Metrics and comparison with original template
## Usage
Use this template with:

150
templates/rde/REFACTORING.md
View file

@ -1,150 +0,0 @@
# Template Refactoring Summary
## Overview
This document summarizes the refactoring improvements made to the RDE (Research Development Environment) template flake.
## Changes Made
### 1. File Structure Reorganization
**Before**: Single 688-line `flake.nix` file
**After**: Modular structure with 17 files across 5 directories
```
templates/rde/
├── flake.nix (261 lines) - Main configuration
├── README.md - User documentation
├── REFACTORING.md - This file
├── overlays/ (5 files)
│ ├── r.nix - R package configuration
│ ├── python.nix - Python package configuration
│ ├── rix.nix - rstats-on-nix integration
│ ├── theme.nix - Neovim theme setup
│ └── project-scripts.nix - Script wrapper definitions
├── hosts/ (5 files)
│ ├── default.nix - Merges all host configs
│ ├── python.nix - Python command definitions
│ ├── julia.nix - Julia command definitions
│ ├── r.nix - R command definitions
│ └── utils.nix - Utility command definitions
├── lib/ (2 files)
│ ├── shell-hook.nix - Dev shell welcome message
│ └── mini-notify-config.lua - Neovim notification config
└── scripts/ (4 files)
├── initPython.sh - Python project initialization
├── initProject.sh - Project structure setup
├── updateDeps.sh - Dependency update script
└── activateDevenv.sh - Devenv activation
```
### 2. Key Improvements
#### Separation of Concerns
- **Config**: Main configuration stays in flake.nix
- **Overlays**: Package modifications isolated in overlays/
- **Hosts**: Command definitions organized by language in hosts/
- **Scripts**: Shell scripts extracted to scripts/ directory
- **Helpers**: Utility functions in lib/
#### Readability
- Reduced main file from 688 to 261 lines (62% reduction)
- Added strategic comments explaining key sections
- Extracted long inline strings to separate files
- Grouped related functionality together
#### Maintainability
- Language-specific changes isolated to dedicated files
- Easy to add new languages (create new host/overlay files)
- Easy to modify scripts without touching Nix code
- Clear separation between different concerns
#### Reusability
- Individual overlays can be reused in other projects
- Host definitions can be copied/modified independently
- Scripts can be tested/modified separately
- Modular design allows selective adoption
### 3. Specific Extractions
#### Shell Scripts (200+ lines → 4 files)
- `initPython.sh`: Python project initialization logic
- `initProject.sh`: Directory structure and git setup
- `updateDeps.sh`: Dependency update automation
- `activateDevenv.sh`: Devenv shell activation
#### Overlays (100+ lines → 5 files)
- `r.nix`: R package management with rix integration
- `python.nix`: Python package configuration
- `rix.nix`: rstats-on-nix package source
- `theme.nix`: Neovim colorscheme handling
- `project-scripts.nix`: Script wrapper generation
#### Host Definitions (200+ lines → 5 files)
- `python.nix`: marimo, ipy, py, initPython commands
- `julia.nix`: jl, pluto, initJl commands
- `r.nix`: R console command
- `utils.nix`: initProject, updateDeps, devenv commands
- `default.nix`: Merges all host configurations
#### Helper Functions (40+ lines → 2 files)
- `shell-hook.nix`: Dev shell welcome message generation
- `mini-notify-config.lua`: Neovim notification filtering
### 4. Added Documentation
#### README.md
- Overview of template purpose
- Directory structure explanation
- Benefits of modular design
- Configuration instructions
- Extension guidelines
- Usage examples
#### Inline Comments
- Section headers in flake.nix
- Explanation of key configuration blocks
- Purpose of each import
- Documentation of categories and settings
### 5. Benefits Achieved
1. **Maintainability**:
- Changes to one language don't affect others
- Easy to locate and modify specific functionality
- Clear ownership of different components
2. **Readability**:
- Main file is now scannable and understandable
- Related code grouped together
- Inline documentation guides users
3. **Testability**:
- Scripts can be tested independently
- Overlays can be verified in isolation
- Smaller files are easier to debug
4. **Extensibility**:
- Clear patterns for adding new languages
- Easy to add new commands
- Simple to customize per language
5. **Learning**:
- New users can understand the template structure
- Examples in each file guide modifications
- Documentation explains purpose and usage
## Migration Guide
For users of the old template:
1. The functionality remains identical
2. Configuration in the main config section is the same
3. All commands work exactly as before
4. To customize, now edit the specific file in the appropriate directory
## Future Improvements
Possible future enhancements:
- Add validation scripts for configuration
- Create unit tests for individual modules
- Add more language examples (Go, Rust, etc.)
- Create a configuration wizard script
- Add CI/CD integration examples

172
templates/rde/SUMMARY.md
View file

@ -1,172 +0,0 @@
# Template Refactoring - Complete Summary
## 🎯 Objective Achieved
Successfully refactored the RDE template from a single 688-line file into a modular, maintainable structure.
## 📊 Key Metrics
| Aspect | Before | After | Improvement |
|--------|--------|-------|-------------|
| **Main file (flake.nix)** | 688 lines | 261 lines | **62% reduction** |
| **File structure** | 1 monolithic file | 17 modular files | **Better organized** |
| **Documentation** | 0 lines | 218 lines | **Fully documented** |
| **Directories** | 0 | 5 organized dirs | **Clear structure** |
## 📁 New Structure
```
templates/rde/
├── 📄 flake.nix (261 lines) # Main config - clean & commented
├── 📖 README.md # User guide
├── 📖 REFACTORING.md # Technical details
│
├── 📂 overlays/ # Package configurations
│ ├── r.nix # R packages
│ ├── python.nix # Python packages
│ ├── rix.nix # R nixpkgs source
│ ├── theme.nix # Neovim themes
│ └── project-scripts.nix # Script wrappers
│
├── 📂 hosts/ # Command definitions
│ ├── default.nix # Merger
│ ├── python.nix # Python commands
│ ├── julia.nix # Julia commands
│ ├── r.nix # R commands
│ └── utils.nix # Utility commands
│
├── 📂 lib/ # Helper functions
│ ├── shell-hook.nix # Welcome message
│ └── mini-notify-config.lua # Neovim config
│
└── 📂 scripts/ # Shell scripts
├── initPython.sh # Python init
├── initProject.sh # Project setup
├── updateDeps.sh # Update deps
└── activateDevenv.sh # Devenv activation
```
## ✨ Key Improvements
### 1. **Separation of Concerns**
- Configuration stays in main flake.nix
- Language-specific code in dedicated files
- Scripts separated from Nix code
- Helpers isolated in lib/
### 2. **Enhanced Readability**
- Main file reduced from 688 → 261 lines
- Strategic comments explain sections
- Clear naming conventions
- Logical grouping of related code
### 3. **Better Maintainability**
- Modify one language without affecting others
- Easy to locate specific functionality
- Clear patterns for adding features
- Reduced risk of breaking changes
### 4. **Improved Extensibility**
- Add new languages: create host + overlay files
- Add new commands: edit relevant host file
- Modify scripts: edit .sh files directly
- Customize behavior: clear config section
### 5. **Comprehensive Documentation**
- README.md: User-facing guide
- REFACTORING.md: Technical details
- Inline comments: Explain key sections
- Examples: Show how to extend
## 🔄 Backwards Compatibility
✅ **Zero Breaking Changes**
- All existing functionality preserved
- Same configuration interface
- All commands work identically
- Migration is seamless
## 🎓 Learning Benefits
### For Users
- Easier to understand template structure
- Clear examples for customization
- Self-documenting code organization
- Guided by inline comments
### For Developers
- Easy to modify individual components
- Clear separation aids debugging
- Modular structure enables testing
- Well-documented refactoring process
## 📈 Before & After Comparison
### Before Refactoring
```nix
{
description = "New Project";
outputs = { ... }: let
config = { ... };
# 200+ lines of inline bash scripts
initPython = ''
#!/usr/bin/env bash
# ... lots of bash code ...
'';
# 100+ lines of overlay definitions
rOverlay = final: prev: let
# ... complex overlay code ...
# 300+ lines of host definitions
hosts = {
marimo = let marimoInit = ''
# ... more inline bash ...
# ... continues for 688 lines total
```
### After Refactoring
```nix
{
description = "New Project";
outputs = { ... }: let
# Clear config section
config = { ... };
# Import from organized modules
rOverlay = import ./overlays/r.nix;
pythonOverlay = import ./overlays/python.nix;
# ... clean imports ...
# Main configuration
projectConfig = forSystems (system:
# ... focused on structure, not details
```
## 🚀 Next Steps
The template is now:
1. ✅ Well-organized and modular
2. ✅ Fully documented
3. ✅ Easy to maintain
4. ✅ Simple to extend
5. ✅ Ready for production use
## 💡 Usage
No changes required for existing users! The template works exactly as before, but now with:
- Better code organization
- Comprehensive documentation
- Easier customization options
- Clearer structure for learning
## 📝 Files Modified
- `flake.nix` - Simplified and reorganized
- Created `overlays/` - Package configurations
- Created `hosts/` - Command definitions
- Created `lib/` - Helper functions
- Created `scripts/` - Shell scripts
- Added `README.md` - User documentation
- Added `REFACTORING.md` - Technical guide
## 🎉 Success!
The refactoring is complete. The template is now significantly more maintainable, readable, and extensible while preserving all original functionality.

6
templates/rde/flake.lock generated
View file

@ -46,11 +46,11 @@
]
},
"locked": {
"lastModified": 1768314902,
"narHash": "sha256-faz7r9QbUxVyBNuu1rEHTilNBJc/wrzKQ5tibg1cSBI=",
"lastModified": 1768552827,
"narHash": "sha256-hOcpR1vSawDkIVgAJY96Y7jBy+mXdWCqQ5Ig0fDSUEQ=",
"owner": "dwinkler1",
"repo": "nixCatsConfig",
"rev": "bad4147e0374280c447c24900f0f738c75f89c80",
"rev": "53dfaba70d16a179f8a6dbd40d7b06cd495bbc15",
"type": "github"
},
"original": {