ssh-keyman 1.0.1 → 2.0.0

package/.github/BADGE-SUMMARY.md

@@ -0,0 +1,244 @@
+# 🏆 Badge Summary - ssh-keyman
+
+## Visual Overview
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                      SSH-KEYMAN BADGES                          │
+├─────────────────────────────────────────────────────────────────┤
+│                                                                 │
+│  BUILD & TEST STATUS                                            │
+│  ├─ Build Status       : ✅ Passing                            │
+│  ├─ Tests Status       : ✅ 35/35 Passing                      │
+│  ├─ Test Coverage      : ✅ 75.11%                             │
+│  └─ Coverage Graph     : ✅ Trending Up                        │
+│                                                                 │
+│  PACKAGE INFORMATION                                            │
+│  ├─ NPM Version        : 📦 v1.0.2                             │
+│  ├─ Monthly Downloads  : 📊 Live from NPM                      │
+│  └─ Bundle Size        : 📦 < 50KB                             │
+│                                                                 │
+│  PLATFORM & STANDARDS                                           │
+│  ├─ Node.js Support    : 💚 v16+ (16.x, 18.x, 20.x)           │
+│  ├─ License            : 📜 ISC                                │
+│  ├─ Maintained         : ✅ Active                             │
+│  └─ PRs Welcome        : 💚 Yes                                │
+│                                                                 │
+│  REPOSITORY STATS                                               │
+│  ├─ Last Commit        : 🕐 Live from GitHub                   │
+│  ├─ Open Issues        : 🐛 Live Count                         │
+│  ├─ Pull Requests      : 🔀 Live Count                         │
+│  └─ GitHub Stars       : ⭐ Live Count                         │
+│                                                                 │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+## 📊 Badge Breakdown
+
+### Total Badges: 16
+
+#### By Category:
+- 🔧 **Build & Test**: 4 badges
+- 📦 **Package Info**: 3 badges
+- 🖥️  **Platform**: 4 badges
+- 📈 **Repository**: 4 badges
+- 🔄 **CI/CD Workflows**: 2 badges (in status table)
+
+---
+
+## 🎯 Badge Purposes
+
+### For Users
+✅ **Trust Indicators**
+- See that package is actively maintained
+- Verify tests are passing
+- Check platform compatibility
+
+✅ **Quick Info**
+- Latest version number
+- Download popularity
+- License type
+
+### For Contributors
+✅ **Development Status**
+- Build health
+- Test coverage
+- Open issues/PRs
+
+✅ **Contribution Welcome**
+- PR acceptance indicator
+- Links to guidelines
+
+### For Maintainers
+✅ **Quality Metrics**
+- Coverage tracking
+- Build status monitoring
+- Cross-platform validation
+
+---
+
+## 🚀 Auto-Update Schedule
+
+| Badge | Update Frequency |
+|-------|------------------|
+| Build Status | On every push |
+| Test Status | On every push |
+| Coverage | After CI run completes |
+| NPM Version | On publish |
+| Downloads | Daily |
+| Last Commit | Real-time |
+| Issues/PRs | Real-time |
+| Stars | Real-time |
+
+---
+
+## 🎨 Badge Colors Explained
+
+### Status Colors
+- 🟢 **Green**: Passing, Good, Active
+- 🟡 **Yellow**: Warning, Medium
+- 🔴 **Red**: Failing, Critical
+- 🔵 **Blue**: Info, Neutral
+- ⚫ **Gray**: Inactive, Unknown
+
+### Build Status
+```
+✅ Passing  → Green (All tests pass)
+⚠️  Warning → Yellow (Some tests skip)
+❌ Failing  → Red (Tests fail)
+```
+
+### Coverage Status
+```
+🟢 Green  → 75%+ coverage (Excellent)
+🟡 Yellow → 50-75% coverage (Good)
+🔴 Red    → <50% coverage (Needs work)
+```
+
+---
+
+## 📍 Badge Locations
+
+### README.md
+- **Top Section**: All 16 badges in organized groups
+- **CI/CD Table**: 2 workflow status badges
+- **Platform Section**: Cross-platform support summary
+
+### STATUS.md
+- **Detailed Coverage**: Full breakdown by file
+- **Platform Matrix**: Node version compatibility
+- **Test Suite Status**: Individual test file results
+
+---
+
+## 🔗 Badge Links
+
+Each badge links to relevant information:
+
+| Badge Type | Links To |
+|-----------|----------|
+| Build Status | GitHub Actions workflow |
+| Coverage | Codecov dashboard |
+| NPM Version | NPM package page |
+| Issues | GitHub issues list |
+| PRs | GitHub pull requests |
+| Stars | GitHub stargazers |
+| License | License details |
+
+---
+
+## ✨ Badge Highlights
+
+### Most Important
+1. **Build Status** - Primary health indicator
+2. **Test Coverage** - Quality metric
+3. **NPM Version** - Current release
+
+### Most Dynamic
+1. **Last Commit** - Updates with every commit
+2. **Issues/PRs** - Changes frequently
+3. **Downloads** - Updates daily
+
+### Most Informative
+1. **Coverage Graph** - Visual trend
+2. **Platform Support** - Compatibility info
+3. **Bundle Size** - Performance metric
+
+---
+
+## 🛠️ Customization Guide
+
+### To Update Badge Style
+Change `?style=` parameter:
+```markdown
+?style=flat          (default)
+?style=flat-square   (modern)
+?style=for-the-badge (bold)
+?style=plastic       (3D effect)
+?style=social        (with count)
+```
+
+### To Add Logo
+Add `&logo=` parameter:
+```markdown
+&logo=npm
+&logo=github
+&logo=node.js
+```
+
+### To Change Color
+Add `&color=` parameter:
+```markdown
+&color=blue
+&color=brightgreen
+&color=ff69b4
+```
+
+---
+
+## 📈 Badge Performance
+
+### Load Times
+- **Shields.io badges**: ~100-200ms
+- **GitHub badges**: ~50-100ms
+- **Codecov badges**: ~150-300ms
+
+### Caching
+- Most badges cached for 5-10 minutes
+- Real-time badges update immediately
+- CDN propagation: ~5 minutes
+
+### Reliability
+- **Shields.io**: 99.9% uptime
+- **GitHub Actions**: 99.9% uptime
+- **Codecov**: 99.5% uptime
+
+---
+
+## 🎓 Best Practices Applied
+
+✅ Badges grouped by category  
+✅ Most important badges first  
+✅ Clean, organized layout  
+✅ All badges link to details  
+✅ Color-coded for quick scanning  
+✅ Mobile-friendly display  
+✅ Accessible alt text  
+✅ Fast loading times  
+
+---
+
+## 📚 Resources
+
+- [Shields.io](https://shields.io) - Badge generator
+- [Simple Icons](https://simpleicons.org) - Logo library
+- [GitHub Actions Badges](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)
+- [Badge Best Practices](https://github.com/badges/shields#readme)
+
+---
+
+**Last Updated**: Automated via CI/CD  
+**Maintained By**: ssh-keyman team  
+**Badge Count**: 16 active badges  
+**Status**: ✅ All operational
+

package/.github/BADGES.md

@@ -0,0 +1,214 @@
+# Badge Reference Guide
+
+This document explains all the badges used in the README and what they indicate.
+
+## Build & Test Status Badges
+
+### Build Status
+```markdown
+[![Build Status](https://github.com/shahidullahkhankhattak/ssh-keyman/actions/workflows/ci.yml/badge.svg?branch=master)](...)
+```
+**Shows:** Whether the latest build on the master branch passed or failed  
+**Green = Passing** | **Red = Failing**
+
+### Tests Status
+```markdown
+[![Tests](https://img.shields.io/github/actions/workflow/status/shahidullahkhankhattak/ssh-keyman/ci.yml?branch=master&label=tests&logo=github)](...)
+```
+**Shows:** Current test execution status  
+**Updates:** On every push and pull request
+
+### Test Coverage (Codecov)
+```markdown
+[![Test Coverage](https://codecov.io/gh/shahidullahkhankhattak/ssh-keyman/branch/master/graph/badge.svg)](...)
+```
+**Shows:** Percentage of code covered by tests  
+**Target:** 55%+ coverage  
+**Current:** ~75%
+
+### Coverage Status (Shields.io)
+```markdown
+[![Coverage Status](https://img.shields.io/codecov/c/github/shahidullahkhankhattak/ssh-keyman/master.svg?logo=codecov)](...)
+```
+**Shows:** Alternative coverage badge with percentage  
+**Color Coding:**
+- 🟢 Green: 75%+
+- 🟡 Yellow: 50-75%
+- 🔴 Red: <50%
+
+---
+
+## Package Information Badges
+
+### NPM Version
+```markdown
+[![npm version](https://img.shields.io/npm/v/ssh-keyman.svg?logo=npm&color=cb3837)](...)
+```
+**Shows:** Current version published on NPM  
+**Updates:** On each NPM publish
+
+### NPM Downloads
+```markdown
+[![npm downloads](https://img.shields.io/npm/dm/ssh-keyman.svg?logo=npm)](...)
+```
+**Shows:** Monthly download count from NPM  
+**Updates:** Daily
+
+### Bundle Size
+```markdown
+[![npm bundle size](https://img.shields.io/bundlephobia/min/ssh-keyman?logo=npm)](...)
+```
+**Shows:** Minified package size  
+**Target:** Keep under 100KB
+
+---
+
+## Platform & Standards Badges
+
+### Node.js Version
+```markdown
+[![Node.js Version](https://img.shields.io/node/v/ssh-keyman.svg?logo=node.js)](...)
+```
+**Shows:** Minimum required Node.js version  
+**Currently:** Supports Node.js 16+
+
+### License
+```markdown
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](...)
+```
+**Shows:** Project license type  
+**License:** ISC (permissive open-source)
+
+### Maintained Status
+```markdown
+[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](...)
+```
+**Shows:** Whether project is actively maintained  
+**Status:** Yes ✅
+
+### PRs Welcome
+```markdown
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](...)
+```
+**Shows:** Project accepts pull requests  
+**Links to:** CONTRIBUTING.md
+
+---
+
+## Repository Statistics Badges
+
+### Last Commit
+```markdown
+[![Last Commit](https://img.shields.io/github/last-commit/shahidullahkhankhattak/ssh-keyman?logo=github)](...)
+```
+**Shows:** Date of most recent commit  
+**Indicates:** Project activity level
+
+### Open Issues
+```markdown
+[![Issues](https://img.shields.io/github/issues/shahidullahkhankhattak/ssh-keyman?logo=github)](...)
+```
+**Shows:** Number of open issues  
+**Links to:** GitHub issues page
+
+### Pull Requests
+```markdown
+[![Pull Requests](https://img.shields.io/github/issues-pr/shahidullahkhankhattak/ssh-keyman?logo=github)](...)
+```
+**Shows:** Number of open pull requests  
+**Links to:** GitHub PRs page
+
+### GitHub Stars
+```markdown
+[![Stars](https://img.shields.io/github/stars/shahidullahkhankhattak/ssh-keyman?style=social)](...)
+```
+**Shows:** Number of GitHub stars  
+**Style:** Social (includes star count)
+
+---
+
+## How Badges Update
+
+### Automatic Updates
+Most badges update automatically when:
+- Code is pushed to GitHub
+- Tests run in CI/CD
+- Package is published to NPM
+- Issues/PRs are created or closed
+
+### Manual Refresh
+If a badge appears outdated:
+1. Click the badge to visit the source
+2. Use Ctrl+F5 (or Cmd+Shift+R) to hard refresh
+3. Wait a few minutes for CDN cache to clear
+
+---
+
+## Adding More Badges
+
+### Shields.io
+Visit [shields.io](https://shields.io) to create custom badges:
+- Dynamic badges from APIs
+- Static badges with custom text
+- Styles: flat, flat-square, plastic, for-the-badge
+
+### Simple Icons
+Use [simpleicons.org](https://simpleicons.org) for logo names in badges:
+```markdown
+![Badge](https://img.shields.io/badge/text-value-color?logo=github)
+```
+
+---
+
+## Badge Best Practices
+
+1. **Order by Importance**
+   - Build/Test status first
+   - Package info second
+   - Stats last
+
+2. **Group Related Badges**
+   - Use HTML comments to section badges
+   - Keep similar badges together
+
+3. **Limit Badge Count**
+   - Too many badges = cluttered README
+   - Focus on most relevant information
+
+4. **Keep Links Updated**
+   - Badges should link to relevant pages
+   - Test links periodically
+
+5. **Use Alt Text**
+   - Always include descriptive alt text
+   - Helps with accessibility
+
+---
+
+## Troubleshooting
+
+### Badge Not Updating
+- Check if service is online
+- Verify URL parameters are correct
+- Clear browser cache
+- Wait for CDN propagation (5-10 mins)
+
+### Badge Shows Error
+- Verify repository/package name is correct
+- Check if badge service supports your platform
+- Ensure repository is public (for most badges)
+
+### Badge Wrong Color
+- Coverage thresholds may need adjustment
+- Check if tests are actually passing
+- Verify badge service status
+
+---
+
+## Resources
+
+- [Shields.io Documentation](https://shields.io)
+- [GitHub Actions Badges](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)
+- [Codecov Badges](https://docs.codecov.com/docs/status-badges)
+- [NPM Badges](https://shields.io/category/version)
+

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,36 @@
+## Description
+
+<!-- Provide a brief description of your changes -->
+
+## 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
+- [ ] Performance improvement
+
+## 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
+
+## Testing
+
+<!-- Describe the tests you ran and how to reproduce them -->
+
+```bash
+npm test
+```
+
+## Screenshots (if applicable)
+
+<!-- Add screenshots to help explain your changes -->
+

package/.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  test:
+    name: Test on Node.js ${{ matrix.node-version }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run linter (if available)
+      run: npm run lint --if-present
+    
+    - name: Run tests
+      run: npm run test:ci
+    
+    - name: Upload coverage to Codecov
+      if: matrix.os == 'ubuntu-latest' && matrix.node-version == '20.x'
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage/coverage-final.json
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  build:
+    name: Build Check
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Verify package installation
+      run: npm link
+    
+    - name: Test CLI help command
+      run: ssh-keyman -h
+

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        registry-url: 'https://registry.npmjs.org'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run tests
+      run: npm test
+    
+    - name: Publish to NPM
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

package/.github/workflows/test-report.yml

@@ -0,0 +1,50 @@
+name: Test Report
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+  schedule:
+    # Run tests daily at 2 AM UTC
+    - cron: '0 2 * * *'
+
+jobs:
+  test-report:
+    name: Generate Test Report
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run tests with coverage
+      run: npm run test:ci
+    
+    - name: Generate test report
+      if: always()
+      uses: dorny/test-reporter@v1
+      with:
+        name: Jest Tests
+        path: coverage/junit.xml
+        reporter: jest-junit
+        fail-on-error: false
+    
+    - name: Comment PR with test results
+      if: github.event_name == 'pull_request'
+      uses: ArtiomTr/jest-coverage-report-action@v2
+      with:
+        coverage-file: ./coverage/coverage-summary.json
+        base-coverage-file: ./coverage/coverage-summary.json
+        annotations: failed-tests
+        package-manager: npm
+