@symbeon/orbit-devops 1.0.2 → 1.1.0

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,51 +1,24 @@
-# 🚀 Pull Request
-
-## 📄 Description
-A clear and concise description of what this PR achieves.
-
-## 🔗 Related Issues
-Fixes #(issue_number)
-
-## 🧪 Testing Performed
-Describe the tests you've performed to verify your changes:
-- [ ] Unit tests
-- [ ] Integration tests
-- [ ] Manual testing
-- [ ] Performance testing (if applicable)
-
-## 📝 Type of Change
-- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
-- [ ] ✨ New feature (non-breaking change which adds functionality)
-- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] 📚 Documentation update
-- [ ] 🧹 Code refactoring (no functional changes)
-- [ ] ⚡ Performance improvement
-- [ ] 🔒 Security fix
-- [ ] 🧪 Test updates
-- [ ] 🛠️ CI/CD or build system changes
-
-## 🧠 Implementation Details
-Brief explanation of the implementation approach.
-
-## 📸 Screenshots
-If applicable, add screenshots to help explain your changes.
-
-## 🔍 Review Checklist
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] 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
-- [ ] Any dependent changes have been merged and published
-
-## 📊 Performance Impact
-Describe any performance impacts (positive or negative).
-
-## 🔒 Security Considerations
-Explain any security implications of your changes.
-
-## 📋 Additional Notes
-Any additional information that would be helpful to reviewers.
-
+## 🪐 Orbit-DevOps Pull Request
+
+### 📝 Description
+Provide a concise summary of the changes and the rationale behind them.
+
+### 🚀 Type of Change
+- [ ] 🚀 New Feature
+- [ ] 🐛 Bug Fix
+- [ ] 🧹 Refactor / Cleanup
+- [ ] 📝 Documentation Update
+- [ ] 🧪 Testing
+
+### 🤖 AI Assistance
+- Was this PR generated or assisted by an AI agent? (Yes/No)
+- If yes, which agent/model was used?
+
+### ✅ Checklist
+- [ ] I have tested these changes on my local machine.
+- [ ] I have updated the documentation accordingly.
+- [ ] My code follows the project's style guidelines.
+- [ ] All new and existing tests passed.
+
+### 📸 Screenshots / Recordings (if applicable)
+Add any visual proof of the changes here.

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Lint code
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test

package/CONTRIBUTING.md

@@ -1,203 +1,23 @@
-# Contributing to Windows System Diagnostic & Optimization Toolkit
+# 🤝 Contributing to Orbit-DevOps
 
-First off, thank you for considering contributing to this project! This toolkit was born from a real-world crisis and has already helped recover critical disk space. Your contributions can help many more people.
+First off, thank you for considering contributing to Orbit-DevOps! It's people like you that make it a great tool for the community.
 
-## 🎯 How Can I Contribute?
+## 🛠️ Development Workflow
 
-### Reporting Bugs
+1.  **Fork the repo** and create your branch from `main`.
+2.  **Install dependencies**: `npm install`.
+3.  **Make your changes**. If you're adding a new PowerShell script, place it in the root or a logical subfolder under `scripts/`.
+4.  **Test your changes**: Run `node bin/orbit.js [command]` or `npm link` and run `orbit [command]`.
+5.  **Submit a Pull Request** using our PR template.
 
-Before creating bug reports, please check existing issues. When creating a bug report, include:
+## 📝 Coding Standards
 
-- **Windows Version:** (e.g., Windows 11 22H2)
-- **PowerShell Version:** Run `$PSVersionTable.PSVersion`
-- **Script Name:** Which script encountered the issue
-- **Expected Behavior:** What you expected to happen
-- **Actual Behavior:** What actually happened
-- **Error Messages:** Full error text from console/logs
-- **Steps to Reproduce:** Detailed steps to reproduce the issue
+- **PowerShell**: Use clear variable names, include error handling (`Try/Catch`), and use `Write-Log` (or similar output helpers) for visibility.
+- **Node.js**: Follow ESM standards, use `commander` for new CLI commands, and ensure Windows path compatibility using `path.resolve`.
 
-### Suggesting Enhancements
+## 🐛 Reporting Issues
 
-Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, include:
+Use GitHub Issues to report bugs or suggest features. Be as descriptive as possible and include your OS version and Node.js version.
 
-- **Use Case:** Describe the problem you're trying to solve
-- **Proposed Solution:** Your idea for how to solve it
-- **Alternatives Considered:** Other approaches you've thought about
-- **Additional Context:** Screenshots, examples, etc.
-
-### Pull Requests
-
-1. **Fork the repo** and create your branch from `main`
-2. **Test your changes** thoroughly on a Windows machine
-3. **Update documentation** if you're adding/changing functionality
-4. **Follow the coding style** used in existing scripts
-5. **Write clear commit messages**
-6. **Submit the PR** with a clear description
-
-## 💻 Development Setup
-
-```powershell
-# Clone your fork
-git clone https://github.com/YOUR_USERNAME/windows-diagnostic-toolkit.git
-cd windows-diagnostic-toolkit
-
-# Create a branch for your feature
-git checkout -b feature/your-feature-name
-
-# Make your changes and test them
-# ...
-
-# Commit your changes
-git add .
-git commit -m "Add: Brief description of your changes"
-
-# Push to your fork
-git push origin feature/your-feature-name
-```
-
-## 📝 Coding Guidelines
-
-### PowerShell Style
-
-- Use **PascalCase** for function names
-- Use **camelCase** for variables
-- Include **comment blocks** for complex logic
-- Add **error handling** with try/catch
-- Use **Write-Log** function for output (see existing scripts)
-- Include **parameter validation** where appropriate
-
-### Example:
-
-```powershell
-function Get-LargeFiles {
-    param(
-        [Parameter(Mandatory=$true)]
-        [string]$Path,
-        
-        [Parameter(Mandatory=$false)]
-        [int]$MinSizeMB = 100
-    )
-    
-    try {
-        Write-Log "Scanning for files larger than $MinSizeMB MB in $Path"
-        
-        Get-ChildItem $Path -Recurse -File -ErrorAction SilentlyContinue |
-            Where-Object { $_.Length -gt ($MinSizeMB * 1MB) } |
-            Sort-Object Length -Descending
-            
-        Write-Log "Scan completed successfully"
-    }
-    catch {
-        Write-Log "Error during scan: $_" -Type "ERROR"
-    }
-}
-```
-
-### Documentation
-
-- **README.md:** Update if adding new scripts or features
-- **Inline Comments:** Explain *why*, not *what* (code shows what)
-- **Function Headers:** Include purpose, parameters, and return values
-- **Examples:** Provide usage examples for new features
-
-## 🧪 Testing
-
-Before submitting a PR:
-
-1. **Test on clean system:** If possible, test on a fresh Windows install
-2. **Test error cases:** Try invalid inputs, missing files, etc.
-3. **Check logs:** Ensure logging is clear and helpful
-4. **Verify cleanup:** If it's a cleanup script, verify it doesn't delete important data
-5. **Test without admin:** Verify scripts work without elevation (if designed to)
-
-## 🎨 Project Structure
-
-```
-DIAGNOSTIC_BACKUP/
-├── README.md                      # Main documentation
-├── LICENSE                        # MIT License
-├── CONTRIBUTING.md               # This file
-│
-├── Core Diagnostic/
-│   ├── SystemDiagnostic.ps1      # Full diagnostic (admin)
-│   ├── SystemDiagnosticUser.ps1  # User-level diagnostic
-│   └── SystemDiagnosticSimple.ps1 # Lightweight scan
-│
-├── Analysis/
-│   ├── ScanStorage.ps1           # Storage analysis
-│   ├── ScanTargets.ps1           # Targeted scans
-│   ├── AnalyzeCursor.ps1         # Cursor-specific
-│   └── CheckAppData.ps1          # AppData analysis
-│
-├── Cleanup/
-│   ├── AdditionalCleanup.ps1     # Safe cleanup
-│   ├── ExecuteCleanup.ps1        # Standard cleanup
-│   ├── ExecuteTotalCleanup.ps1   # Aggressive cleanup
-│   └── PostRebootCleanup.ps1     # Post-reboot tasks
-│
-├── Utilities/
-│   ├── check_environment.ps1     # Environment check
-│   ├── setup_environment.ps1     # Setup helper
-│   └── verify_environment.ps1    # Verification
-│
-└── Documentation/
-    ├── SETUP.md                  # Setup guide
-    ├── NEXT_STEPS.md            # Next steps
-    └── Reports/                  # Generated reports
-```
-
-## 🏷️ Commit Message Guidelines
-
-Use clear, descriptive commit messages:
-
-- **Add:** New feature or script
-- **Fix:** Bug fix
-- **Update:** Modify existing functionality
-- **Docs:** Documentation changes
-- **Refactor:** Code restructuring without behavior change
-- **Test:** Adding or updating tests
-
-Examples:
-```
-Add: Browser cache cleanup to AdditionalCleanup.ps1
-Fix: Handle missing Docker installation gracefully
-Update: Improve error messages in SystemDiagnostic.ps1
-Docs: Add troubleshooting section to README
-```
-
-## 🌟 Feature Ideas
-
-Looking for contribution ideas? Here are some:
-
-### High Priority
-- [ ] Add Linux/macOS versions of diagnostic scripts
-- [ ] Create automated tests
-- [ ] Add GitHub Actions CI/CD
-- [ ] Improve error handling across all scripts
-
-### Medium Priority
-- [ ] GUI wrapper using Windows Forms
-- [ ] Scheduled task automation
-- [ ] Export reports to JSON/CSV
-- [ ] Integration with Windows Event Log
-
-### Nice to Have
-- [ ] Machine learning for cleanup recommendations
-- [ ] Multi-language support
-- [ ] Cloud backup integration warnings
-- [ ] Performance benchmarking
-
-## 📞 Questions?
-
-- **General Questions:** Open a GitHub Discussion
-- **Bug Reports:** Open a GitHub Issue
-- **Security Issues:** Email directly (don't open public issue)
-
-## 🙏 Recognition
-
-Contributors will be recognized in:
-- README.md contributors section
-- Release notes
-- Project documentation
-
-Thank you for helping make Windows system maintenance easier for everyone! 🎉
+---
+Built with ❤️ by the **Symbeon** community.

package/README.md

@@ -6,7 +6,8 @@
   <p><b>Diagnose. Optimize. Compact. Control.</b></p>
 
   <p>
-    <img src="https://img.shields.io/npm/v/orbit-devops?style=flat-square&color=cb3837" alt="NPM Version" />
+    <img src="https://img.shields.io/npm/v/@symbeon/orbit-devops?style=flat-square&color=cb3837" alt="NPM Version" />
+    <img src="https://github.com/SH1W4/orbit-devops/actions/workflows/ci.yml/badge.svg" alt="CI Status" />
     <img src="https://img.shields.io/badge/platform-Windows_11%20%7C%20WSL2-0078D6?style=flat-square&logo=windows" alt="Platform" />
     <img src="https://img.shields.io/badge/AI-MCP_Ready-purple?style=flat-square&logo=openai" alt="AI Ready" />
     <img src="https://img.shields.io/github/license/SH1W4/orbit-devops?style=flat-square" alt="License" />

package/bin/orbit.js

@@ -15,7 +15,7 @@ const program = new Command();
 program
   .name('orbit')
   .description('Orbit-DevOps: The Developer\'s Workspace Command Center')
-  .version('1.0.0');
+  .version('1.1.0');
 
 import fs from 'fs';
 
@@ -53,21 +53,21 @@ program
   .command('doctor')
   .description('Run a full system diagnostic health check')
   .action(() => {
-    runScript('SystemDiagnosticUser_v2.ps1');
+    runScript('scripts/diagnostic/SystemDiagnosticUser_v2.ps1');
   });
 
 program
   .command('space')
   .description('Analyze disk usage and find hotspots')
   .action(() => {
-    runScript('ScanStorage.ps1');
+    runScript('scripts/diagnostic/ScanStorage.ps1');
   });
 
 program
   .command('clean')
   .description('Perform safe system and dev-tool cleanup')
   .action(() => {
-    runScript('AdditionalCleanup.ps1');
+    runScript('scripts/cleanup/AdditionalCleanup.ps1');
   });
 
 program
@@ -89,7 +89,7 @@ program
   .command('menu')
   .description('Launch the interactive PowerShell menu (Legacy)')
   .action(() => {
-    runScript('Orbit.ps1');
+    runScript('scripts/core/Orbit.ps1');
   });
 
 program.parse(process.argv);

package/eslint.config.js

@@ -0,0 +1,32 @@
+import js from "@eslint/js";
+import vitest from "eslint-plugin-vitest";
+
+export default [
+  js.configs.recommended,
+  {
+    files: ["test/**/*.test.js"],
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+    languageOptions: {
+      globals: {
+        ...vitest.environments.env.globals,
+      },
+    },
+  },
+  {
+    languageOptions: {
+      ecmaVersion: "latest",
+      sourceType: "module",
+      globals: {
+        process: "readonly",
+        console: "readonly",
+      },
+    },
+    rules: {
+      "no-unused-vars": "warn",
+      "no-console": "off",
+    },
+  },
+];

package/package.json

@@ -1,39 +1,45 @@
-{
-  "name": "@symbeon/orbit-devops",
-  "version": "1.0.2",
-  "description": "The Developer's Workspace Command Center. Diagnose, Optimize, Compact, Control.",
-  "main": "bin/orbit.js",
-  "bin": {
-    "orbit": "./bin/orbit.js",
-    "orbit-devops": "./bin/orbit.js"
-  },
-  "scripts": {
-    "start": "node bin/orbit.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SH1W4/orbit-devops.git"
-  },
-  "keywords": [
-    "windows",
-    "devops",
-    "cleanup",
-    "wsl",
-    "docker",
-    "optimization"
-  ],
-  "author": "Symbeon",
-  "license": "MIT",
-  "type": "module",
-  "bugs": {
-    "url": "https://github.com/SH1W4/orbit-devops/issues"
-  },
-  "homepage": "https://github.com/SH1W4/orbit-devops#readme",
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "cross-spawn": "^7.0.6",
-    "inquirer": "^12.4.1"
-  }
-}
+{
+  "name": "@symbeon/orbit-devops",
+  "version": "1.1.0",
+  "description": "The Developer's Workspace Command Center. Diagnose, Optimize, Compact, Control.",
+  "main": "bin/orbit.js",
+  "bin": {
+    "orbit": "./bin/orbit.js",
+    "orbit-devops": "./bin/orbit.js"
+  },
+  "scripts": {
+    "start": "node bin/orbit.js",
+    "test": "vitest run",
+    "lint": "eslint ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SH1W4/orbit-devops.git"
+  },
+  "keywords": [
+    "windows",
+    "devops",
+    "cleanup",
+    "wsl",
+    "docker",
+    "optimization"
+  ],
+  "author": "Symbeon",
+  "license": "MIT",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/SH1W4/orbit-devops/issues"
+  },
+  "homepage": "https://github.com/SH1W4/orbit-devops#readme",
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "cross-spawn": "^7.0.6",
+    "inquirer": "^12.4.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.1",
+    "eslint-plugin-vitest": "^0.5.4",
+    "vitest": "^4.0.18"
+  }
+}

package/test/cli.test.js

@@ -0,0 +1,23 @@
+import { describe, it, expect } from 'vitest';
+import { execSync } from 'child_process';
+import path from 'path';
+
+const CLI_PATH = path.resolve(process.cwd(), 'bin/orbit.js');
+
+describe('Orbit-DevOps CLI', () => {
+  it('should display help information', () => {
+    const output = execSync(`node ${CLI_PATH} --help`).toString();
+    expect(output).toContain('Usage: orbit');
+    expect(output).toContain('Options:');
+  });
+
+  it('should have the doctor command', () => {
+    const output = execSync(`node ${CLI_PATH} --help`).toString();
+    expect(output).toContain('doctor');
+  });
+
+  it('should have the sync command', () => {
+    const output = execSync(`node ${CLI_PATH} --help`).toString();
+    expect(output).toContain('sync');
+  });
+});