mirror of
https://github.com/Gu1llaum-3/sshm.git
synced 2026-01-27 03:04:21 +01:00
Compare commits
11 Commits
v1.6.0
...
049998c235
| Author | SHA1 | Date | |
|---|---|---|---|
| 049998c235 | |||
|
|
5986659048 | ||
|
|
abbda54125 | ||
|
|
986017a552 | ||
|
|
120cd6c009 | ||
| 3d746ec49a | |||
| f31fe9dacf | |||
| 7b15db1f34 | |||
| 55f3359287 | |||
| 4efec57a8a | |||
| 0975ae2fe2 |
136
.github/workflows/build.yml
vendored
136
.github/workflows/build.yml
vendored
@@ -1,136 +0,0 @@
|
||||
name: Build Binaries
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
release:
|
||||
types: [created]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
# Linux AMD64
|
||||
- goos: linux
|
||||
goarch: amd64
|
||||
suffix: linux-amd64
|
||||
# Linux ARM64
|
||||
- goos: linux
|
||||
goarch: arm64
|
||||
suffix: linux-arm64
|
||||
# macOS AMD64 (Intel)
|
||||
- goos: darwin
|
||||
goarch: amd64
|
||||
suffix: darwin-amd64
|
||||
# macOS ARM64 (Apple Silicon)
|
||||
- goos: darwin
|
||||
goarch: arm64
|
||||
suffix: darwin-arm64
|
||||
# Windows AMD64
|
||||
- goos: windows
|
||||
goarch: amd64
|
||||
suffix: windows-amd64
|
||||
# Windows ARM64
|
||||
- goos: windows
|
||||
goarch: arm64
|
||||
suffix: windows-arm64
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.23'
|
||||
|
||||
- name: Cache Go modules
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/go/pkg/mod
|
||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-go-
|
||||
|
||||
- name: Build binary
|
||||
env:
|
||||
GOOS: ${{ matrix.goos }}
|
||||
GOARCH: ${{ matrix.goarch }}
|
||||
CGO_ENABLED: 0
|
||||
run: |
|
||||
mkdir -p dist
|
||||
VERSION=${GITHUB_REF#refs/tags/}
|
||||
# Remove 'v' prefix if present for version injection
|
||||
VERSION_CLEAN=${VERSION#v}
|
||||
if [ "${{ matrix.goos }}" = "windows" ]; then
|
||||
go build -ldflags="-s -w -X github.com/Gu1llaum-3/sshm/cmd.AppVersion=${VERSION_CLEAN}" -o dist/sshm-${{ matrix.suffix }}.exe .
|
||||
else
|
||||
go build -ldflags="-s -w -X github.com/Gu1llaum-3/sshm/cmd.AppVersion=${VERSION_CLEAN}" -o dist/sshm-${{ matrix.suffix }} .
|
||||
fi
|
||||
|
||||
- name: Create archive
|
||||
run: |
|
||||
cd dist
|
||||
if [ "${{ matrix.goos }}" = "windows" ]; then
|
||||
zip sshm-${{ matrix.suffix }}.zip sshm-${{ matrix.suffix }}.exe
|
||||
rm sshm-${{ matrix.suffix }}.exe
|
||||
else
|
||||
tar -czf sshm-${{ matrix.suffix }}.tar.gz sshm-${{ matrix.suffix }}
|
||||
rm sshm-${{ matrix.suffix }}
|
||||
fi
|
||||
|
||||
- name: Upload artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: sshm-${{ matrix.suffix }}
|
||||
path: |
|
||||
dist/sshm-${{ matrix.suffix }}.tar.gz
|
||||
dist/sshm-${{ matrix.suffix }}.zip
|
||||
|
||||
release:
|
||||
name: Create Release
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
|
||||
steps:
|
||||
- name: Download all artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: ./artifacts
|
||||
merge-multiple: true
|
||||
|
||||
- name: Prepare release assets
|
||||
run: |
|
||||
mkdir -p release
|
||||
find ./artifacts -name "*.tar.gz" -exec cp {} ./release/ \;
|
||||
find ./artifacts -name "*.zip" -exec cp {} ./release/ \;
|
||||
ls -la ./release/
|
||||
|
||||
- name: Check if pre-release
|
||||
id: check_prerelease
|
||||
run: |
|
||||
if [[ "${GITHUB_REF#refs/tags/}" == *"-beta"* ]] || [[ "${GITHUB_REF#refs/tags/}" == *"-alpha"* ]] || [[ "${GITHUB_REF#refs/tags/}" == *"-rc"* ]] || [[ "${GITHUB_REF#refs/tags/}" == *"-dev"* ]]; then
|
||||
echo "is_prerelease=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "is_prerelease=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
files: ./release/*
|
||||
draft: false
|
||||
prerelease: ${{ steps.check_prerelease.outputs.is_prerelease }}
|
||||
generate_release_notes: true
|
||||
name: ${{ github.ref_name }}${{ steps.check_prerelease.outputs.is_prerelease == 'true' && ' (Pre-release)' || '' }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
39
.github/workflows/release.yml
vendored
Normal file
39
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
||||
name: Release with GoReleaser
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
# Required for Homebrew tap updates
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
goreleaser:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
# Fetch full history for changelog generation
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.23'
|
||||
cache: true
|
||||
|
||||
- name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v6
|
||||
with:
|
||||
distribution: goreleaser
|
||||
version: '~> v2'
|
||||
args: release --clean
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
# Token for updating Homebrew tap (create this secret in your repo settings)
|
||||
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
|
||||
135
.goreleaser.yaml
Normal file
135
.goreleaser.yaml
Normal file
@@ -0,0 +1,135 @@
|
||||
version: 2
|
||||
project_name: sshm
|
||||
|
||||
before:
|
||||
hooks:
|
||||
- go mod tidy
|
||||
- go test ./...
|
||||
|
||||
builds:
|
||||
- id: sshm
|
||||
main: ./main.go
|
||||
binary: sshm
|
||||
goos:
|
||||
- linux
|
||||
- windows
|
||||
- darwin
|
||||
goarch:
|
||||
- amd64
|
||||
- arm64
|
||||
- "386"
|
||||
- arm
|
||||
ignore:
|
||||
# Skip ARM for Windows (not commonly used)
|
||||
- goos: windows
|
||||
goarch: arm
|
||||
- goos: windows
|
||||
goarch: arm64
|
||||
env:
|
||||
- CGO_ENABLED=0
|
||||
ldflags:
|
||||
- -s -w
|
||||
- -X github.com/Gu1llaum-3/sshm/cmd.AppVersion={{.Version}}
|
||||
flags:
|
||||
- -trimpath
|
||||
|
||||
archives:
|
||||
- id: sshm
|
||||
formats: [ "tar.gz" ]
|
||||
# Use zip for Windows
|
||||
format_overrides:
|
||||
- goos: windows
|
||||
formats: [ "zip" ]
|
||||
# Template for archive name
|
||||
name_template: >-
|
||||
{{ .ProjectName }}_ {{- title .Os }}_ {{- if eq .Arch "amd64" }}x86_64 {{- else if eq .Arch "386" }}i386 {{- else }}{{ .Arch }}{{ end }} {{- if .Arm }}v{{ .Arm }}{{ end }}
|
||||
files:
|
||||
- LICENSE
|
||||
- README.md
|
||||
|
||||
checksum:
|
||||
name_template: "checksums.txt"
|
||||
algorithm: sha256
|
||||
|
||||
changelog:
|
||||
use: github
|
||||
sort: asc
|
||||
filters:
|
||||
exclude:
|
||||
- "^docs:"
|
||||
- "^test:"
|
||||
- "^ci:"
|
||||
- "^chore:"
|
||||
- "^build:"
|
||||
groups:
|
||||
- title: Features
|
||||
regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
|
||||
order: 0
|
||||
- title: Bug fixes
|
||||
regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
|
||||
order: 1
|
||||
- title: Others
|
||||
order: 999
|
||||
|
||||
# Homebrew tap configuration (Formula pour CLI)
|
||||
brews:
|
||||
- name: sshm
|
||||
repository:
|
||||
owner: Gu1llaum-3
|
||||
name: homebrew-sshm
|
||||
# Token with repo permissions for your homebrew-sshm repo
|
||||
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
|
||||
commit_author:
|
||||
name: goreleaserbot
|
||||
email: bot@goreleaser.com
|
||||
commit_msg_template: "Brew formula update for {{ .ProjectName }} version {{ .Tag }}"
|
||||
homepage: "https://github.com/Gu1llaum-3/sshm"
|
||||
description: "A modern SSH connection manager for your terminal"
|
||||
license: MIT
|
||||
skip_upload: auto
|
||||
# Test command to verify installation
|
||||
test: |
|
||||
system "#{bin}/sshm --version"
|
||||
|
||||
# Release configuration
|
||||
release:
|
||||
github:
|
||||
owner: Gu1llaum-3
|
||||
name: sshm
|
||||
prerelease: auto
|
||||
draft: false
|
||||
replace_existing_draft: true
|
||||
target_commitish: "{{ .Commit }}"
|
||||
name_template: "{{.ProjectName}} {{.Version}}"
|
||||
header: |
|
||||
## SSHM {{.Version}}
|
||||
|
||||
Thank you for downloading SSHM!
|
||||
|
||||
### Installation
|
||||
|
||||
**Homebrew (macOS/Linux):**
|
||||
```bash
|
||||
brew tap Gu1llaum-3/sshm
|
||||
brew install sshm
|
||||
```
|
||||
|
||||
**Manual Installation:**
|
||||
Download the appropriate binary for your platform from the assets below.
|
||||
|
||||
footer: |
|
||||
## Full Changelog
|
||||
|
||||
See all changes at https://github.com/Gu1llaum-3/sshm/compare/{{.PreviousTag}}...{{.Tag}}
|
||||
|
||||
---
|
||||
|
||||
Released with ❤️ by [GoReleaser](https://github.com/goreleaser/goreleaser)
|
||||
|
||||
# Snapshot builds (for non-tag builds)
|
||||
snapshot:
|
||||
version_template: "{{ .Tag }}-snapshot-{{.ShortCommit}}"
|
||||
|
||||
# Metadata for package managers
|
||||
metadata:
|
||||
mod_timestamp: "{{ .CommitTimestamp }}"
|
||||
44
Makefile
Normal file
44
Makefile
Normal file
@@ -0,0 +1,44 @@
|
||||
.PHONY: build build-local test clean release snapshot
|
||||
|
||||
# Version can be overridden via environment variable or command line
|
||||
VERSION ?= dev
|
||||
|
||||
# Go build flags
|
||||
LDFLAGS := -s -w -X github.com/Gu1llaum-3/sshm/cmd.AppVersion=$(VERSION)
|
||||
|
||||
# Build with specific version
|
||||
build:
|
||||
@mkdir -p dist
|
||||
go build -ldflags="$(LDFLAGS)" -o dist/sshm .
|
||||
|
||||
# Build with git version
|
||||
build-local: VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
||||
build-local: build
|
||||
|
||||
# Run tests
|
||||
test:
|
||||
go test ./...
|
||||
|
||||
# Clean build artifacts
|
||||
clean:
|
||||
rm -rf dist
|
||||
|
||||
# Release with GoReleaser (requires tag)
|
||||
release:
|
||||
@if [ -z "$(shell git tag --points-at HEAD)" ]; then \
|
||||
echo "Error: No git tag found at current commit. Create a tag first with: git tag vX.Y.Z"; \
|
||||
exit 1; \
|
||||
fi
|
||||
goreleaser release --clean
|
||||
|
||||
# Build snapshot (without tag)
|
||||
snapshot:
|
||||
goreleaser release --snapshot --clean
|
||||
|
||||
# Check GoReleaser config
|
||||
release-check:
|
||||
goreleaser check
|
||||
|
||||
# Run GoReleaser in dry-run mode
|
||||
release-dry-run:
|
||||
goreleaser release --snapshot --skip=publish --clean
|
||||
35
README.md
35
README.md
@@ -53,6 +53,11 @@ SSHM is a beautiful command-line tool that transforms how you manage and connect
|
||||
|
||||
### Installation
|
||||
|
||||
**Homebrew (Recommended for macOS):**
|
||||
```bash
|
||||
brew install Gu1llaum-3/sshm/sshm
|
||||
```
|
||||
|
||||
**Unix/Linux/macOS (One-line install):**
|
||||
```bash
|
||||
curl -sSL https://raw.githubusercontent.com/Gu1llaum-3/sshm/main/install/unix.sh | bash
|
||||
@@ -548,6 +553,34 @@ This will be automatically converted to:
|
||||
StrictHostKeyChecking no
|
||||
```
|
||||
|
||||
### Custom Key Bindings
|
||||
|
||||
SSHM supports customizable key bindings through a configuration file. This is particularly useful for users who want to modify the default quit behavior.
|
||||
|
||||
**Configuration File Location:**
|
||||
- **Linux/macOS**: `~/.config/sshm/config.json`
|
||||
- **Windows**: `%APPDATA%\sshm\config.json`
|
||||
|
||||
**Example Configuration:**
|
||||
```json
|
||||
{
|
||||
"key_bindings": {
|
||||
"quit_keys": ["q", "ctrl+c"],
|
||||
"disable_esc_quit": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Available Options:**
|
||||
- **quit_keys**: Array of keys that will quit the application. Default: `["q", "ctrl+c"]`
|
||||
- **disable_esc_quit**: Boolean flag to disable ESC key from quitting the application. Default: `false`
|
||||
|
||||
**For Vim Users:**
|
||||
If you frequently press ESC accidentally causing the application to quit, set `disable_esc_quit` to `true`. This will disable ESC as a quit key while preserving all other functionality.
|
||||
|
||||
**Default Configuration:**
|
||||
If no configuration file exists, SSHM will automatically create one with default settings that maintain backward compatibility.
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
### Prerequisites
|
||||
@@ -664,6 +697,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
- [Charm](https://charm.sh/) for the amazing TUI libraries
|
||||
- [Cobra](https://cobra.dev/) for the excellent CLI framework
|
||||
- [@yimeng](https://github.com/yimeng) for contributing SSH Include directive support
|
||||
- [@ldreux](https://github.com/ldreux) for contributing multi-word search functionality
|
||||
- [@qingfengzxr](https://github.com/qingfengzxr) for contributing custom key bindings support
|
||||
- The Go community for building such fantastic tools
|
||||
|
||||
---
|
||||
|
||||
@@ -56,7 +56,25 @@ getLatestVersion() {
|
||||
}
|
||||
|
||||
downloadBinary() {
|
||||
GITHUB_FILE="sshm-${OS}-${ARCH}.tar.gz"
|
||||
# Map OS names to match GoReleaser format
|
||||
local GORELEASER_OS="$OS"
|
||||
case $OS in
|
||||
"darwin") GORELEASER_OS="Darwin" ;;
|
||||
"linux") GORELEASER_OS="Linux" ;;
|
||||
"windows") GORELEASER_OS="Windows" ;;
|
||||
esac
|
||||
|
||||
# Map architecture names to match GoReleaser format
|
||||
local GORELEASER_ARCH="$ARCH"
|
||||
case $ARCH in
|
||||
"amd64") GORELEASER_ARCH="x86_64" ;;
|
||||
"arm64") GORELEASER_ARCH="arm64" ;;
|
||||
"386") GORELEASER_ARCH="i386" ;;
|
||||
"arm") GORELEASER_ARCH="armv6" ;;
|
||||
esac
|
||||
|
||||
# GoReleaser format: sshm_Darwin_arm64.tar.gz
|
||||
GITHUB_FILE="sshm_${GORELEASER_OS}_${GORELEASER_ARCH}.tar.gz"
|
||||
GITHUB_URL="https://github.com/Gu1llaum-3/sshm/releases/download/$LATEST_VERSION/$GITHUB_FILE"
|
||||
|
||||
printf "${YELLOW}Downloading $GITHUB_FILE...${NC}\n"
|
||||
@@ -74,8 +92,8 @@ downloadBinary() {
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if the expected binary exists (no find needed)
|
||||
EXTRACTED_BINARY="./sshm-${OS}-${ARCH}"
|
||||
# GoReleaser extracts the binary as just "sshm", not with the platform suffix
|
||||
EXTRACTED_BINARY="./sshm"
|
||||
if [ ! -f "$EXTRACTED_BINARY" ]; then
|
||||
printf "${RED}Could not find extracted binary: $EXTRACTED_BINARY${NC}\n"
|
||||
exit 1
|
||||
|
||||
@@ -80,7 +80,11 @@ if ($LocalBinary -ne "") {
|
||||
}
|
||||
|
||||
# Download binary
|
||||
$fileName = "sshm-windows-$arch.zip"
|
||||
# Map architecture to match GoReleaser format
|
||||
$goreleaserArch = if ($arch -eq "amd64") { "x86_64" } else { "i386" }
|
||||
|
||||
# GoReleaser format: sshm_Windows_x86_64.zip
|
||||
$fileName = "sshm_Windows_$goreleaserArch.zip"
|
||||
$downloadUrl = "https://github.com/Gu1llaum-3/sshm/releases/download/$latestVersion/$fileName"
|
||||
$tempFile = "$env:TEMP\$fileName"
|
||||
|
||||
@@ -101,7 +105,8 @@ if ($LocalBinary -ne "") {
|
||||
Write-Info "Extracting..."
|
||||
try {
|
||||
Expand-Archive -Path $tempFile -DestinationPath $env:TEMP -Force
|
||||
$extractedBinary = "$env:TEMP\sshm-windows-$arch.exe"
|
||||
# GoReleaser extracts the binary as just "sshm.exe", not with platform suffix
|
||||
$extractedBinary = "$env:TEMP\sshm.exe"
|
||||
$targetPath = "$InstallDir\sshm.exe"
|
||||
|
||||
Move-Item -Path $extractedBinary -Destination $targetPath -Force
|
||||
|
||||
146
internal/config/keybindings.go
Normal file
146
internal/config/keybindings.go
Normal file
@@ -0,0 +1,146 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
// KeyBindings represents configurable key bindings for the application
|
||||
type KeyBindings struct {
|
||||
// Quit keys - keys that will quit the application
|
||||
QuitKeys []string `json:"quit_keys"`
|
||||
|
||||
// DisableEscQuit - if true, ESC key won't quit the application (useful for vim users)
|
||||
DisableEscQuit bool `json:"disable_esc_quit"`
|
||||
}
|
||||
|
||||
// AppConfig represents the main application configuration
|
||||
type AppConfig struct {
|
||||
KeyBindings KeyBindings `json:"key_bindings"`
|
||||
}
|
||||
|
||||
// GetDefaultKeyBindings returns the default key bindings configuration
|
||||
func GetDefaultKeyBindings() KeyBindings {
|
||||
return KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"}, // Default keeps current behavior minus ESC
|
||||
DisableEscQuit: false, // Default to false for backward compatibility
|
||||
}
|
||||
}
|
||||
|
||||
// GetDefaultAppConfig returns the default application configuration
|
||||
func GetDefaultAppConfig() AppConfig {
|
||||
return AppConfig{
|
||||
KeyBindings: GetDefaultKeyBindings(),
|
||||
}
|
||||
}
|
||||
|
||||
// GetAppConfigPath returns the path to the application config file
|
||||
func GetAppConfigPath() (string, error) {
|
||||
configDir, err := GetSSHMConfigDir()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return filepath.Join(configDir, "config.json"), nil
|
||||
}
|
||||
|
||||
// LoadAppConfig loads the application configuration from file
|
||||
// If the file doesn't exist, it returns the default configuration
|
||||
func LoadAppConfig() (*AppConfig, error) {
|
||||
configPath, err := GetAppConfigPath()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// If config file doesn't exist, return default config and create the file
|
||||
if _, err := os.Stat(configPath); os.IsNotExist(err) {
|
||||
defaultConfig := GetDefaultAppConfig()
|
||||
|
||||
// Create config directory if it doesn't exist
|
||||
configDir := filepath.Dir(configPath)
|
||||
if err := os.MkdirAll(configDir, 0755); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Save default config to file
|
||||
if err := SaveAppConfig(&defaultConfig); err != nil {
|
||||
// If we can't save, just return the default config without erroring
|
||||
// This allows the app to work even if config file can't be created
|
||||
return &defaultConfig, nil
|
||||
}
|
||||
|
||||
return &defaultConfig, nil
|
||||
}
|
||||
|
||||
// Read existing config file
|
||||
data, err := os.ReadFile(configPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var config AppConfig
|
||||
if err := json.Unmarshal(data, &config); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Validate and fill in missing fields with defaults
|
||||
config = mergeWithDefaults(config)
|
||||
|
||||
return &config, nil
|
||||
}
|
||||
|
||||
// SaveAppConfig saves the application configuration to file
|
||||
func SaveAppConfig(config *AppConfig) error {
|
||||
if config == nil {
|
||||
return errors.New("config cannot be nil")
|
||||
}
|
||||
|
||||
configPath, err := GetAppConfigPath()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Create config directory if it doesn't exist
|
||||
configDir := filepath.Dir(configPath)
|
||||
if err := os.MkdirAll(configDir, 0755); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
data, err := json.MarshalIndent(config, "", " ")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return os.WriteFile(configPath, data, 0644)
|
||||
}
|
||||
|
||||
// mergeWithDefaults ensures all required fields are set with defaults if missing
|
||||
func mergeWithDefaults(config AppConfig) AppConfig {
|
||||
defaults := GetDefaultAppConfig()
|
||||
|
||||
// If QuitKeys is empty, use defaults
|
||||
if len(config.KeyBindings.QuitKeys) == 0 {
|
||||
config.KeyBindings.QuitKeys = defaults.KeyBindings.QuitKeys
|
||||
}
|
||||
|
||||
return config
|
||||
}
|
||||
|
||||
// ShouldQuitOnKey checks if the given key should trigger quit based on configuration
|
||||
func (kb *KeyBindings) ShouldQuitOnKey(key string) bool {
|
||||
// Special handling for ESC key
|
||||
if key == "esc" {
|
||||
return !kb.DisableEscQuit
|
||||
}
|
||||
|
||||
// Check if key is in the quit keys list
|
||||
for _, quitKey := range kb.QuitKeys {
|
||||
if quitKey == key {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
181
internal/config/keybindings_test.go
Normal file
181
internal/config/keybindings_test.go
Normal file
@@ -0,0 +1,181 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestDefaultKeyBindings(t *testing.T) {
|
||||
kb := GetDefaultKeyBindings()
|
||||
|
||||
// Test default configuration
|
||||
if kb.DisableEscQuit {
|
||||
t.Error("Default configuration should allow ESC to quit (backward compatibility)")
|
||||
}
|
||||
|
||||
// Test default quit keys
|
||||
expectedQuitKeys := []string{"q", "ctrl+c"}
|
||||
if len(kb.QuitKeys) != len(expectedQuitKeys) {
|
||||
t.Errorf("Expected %d quit keys, got %d", len(expectedQuitKeys), len(kb.QuitKeys))
|
||||
}
|
||||
|
||||
for i, expected := range expectedQuitKeys {
|
||||
if i >= len(kb.QuitKeys) || kb.QuitKeys[i] != expected {
|
||||
t.Errorf("Expected quit key %s, got %s", expected, kb.QuitKeys[i])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestShouldQuitOnKey(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
keyBindings KeyBindings
|
||||
key string
|
||||
expectedResult bool
|
||||
}{
|
||||
{
|
||||
name: "Default config - ESC should quit",
|
||||
keyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"},
|
||||
DisableEscQuit: false,
|
||||
},
|
||||
key: "esc",
|
||||
expectedResult: true,
|
||||
},
|
||||
{
|
||||
name: "Disabled ESC quit - ESC should not quit",
|
||||
keyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"},
|
||||
DisableEscQuit: true,
|
||||
},
|
||||
key: "esc",
|
||||
expectedResult: false,
|
||||
},
|
||||
{
|
||||
name: "Q key should quit",
|
||||
keyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"},
|
||||
DisableEscQuit: true,
|
||||
},
|
||||
key: "q",
|
||||
expectedResult: true,
|
||||
},
|
||||
{
|
||||
name: "Ctrl+C should quit",
|
||||
keyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"},
|
||||
DisableEscQuit: true,
|
||||
},
|
||||
key: "ctrl+c",
|
||||
expectedResult: true,
|
||||
},
|
||||
{
|
||||
name: "Other keys should not quit",
|
||||
keyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q", "ctrl+c"},
|
||||
DisableEscQuit: true,
|
||||
},
|
||||
key: "enter",
|
||||
expectedResult: false,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := tt.keyBindings.ShouldQuitOnKey(tt.key)
|
||||
if result != tt.expectedResult {
|
||||
t.Errorf("ShouldQuitOnKey(%q) = %v, expected %v", tt.key, result, tt.expectedResult)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAppConfigBasics(t *testing.T) {
|
||||
// Test default config creation
|
||||
defaultConfig := GetDefaultAppConfig()
|
||||
|
||||
if defaultConfig.KeyBindings.DisableEscQuit {
|
||||
t.Error("Default configuration should allow ESC to quit")
|
||||
}
|
||||
|
||||
expectedQuitKeys := []string{"q", "ctrl+c"}
|
||||
if len(defaultConfig.KeyBindings.QuitKeys) != len(expectedQuitKeys) {
|
||||
t.Errorf("Expected %d quit keys, got %d", len(expectedQuitKeys), len(defaultConfig.KeyBindings.QuitKeys))
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeWithDefaults(t *testing.T) {
|
||||
// Test config with missing QuitKeys
|
||||
incompleteConfig := AppConfig{
|
||||
KeyBindings: KeyBindings{
|
||||
DisableEscQuit: true,
|
||||
// QuitKeys is missing
|
||||
},
|
||||
}
|
||||
|
||||
mergedConfig := mergeWithDefaults(incompleteConfig)
|
||||
|
||||
// Should preserve DisableEscQuit
|
||||
if !mergedConfig.KeyBindings.DisableEscQuit {
|
||||
t.Error("Should preserve DisableEscQuit as true")
|
||||
}
|
||||
|
||||
// Should fill in default QuitKeys
|
||||
expectedQuitKeys := []string{"q", "ctrl+c"}
|
||||
if len(mergedConfig.KeyBindings.QuitKeys) != len(expectedQuitKeys) {
|
||||
t.Errorf("Expected %d quit keys, got %d", len(expectedQuitKeys), len(mergedConfig.KeyBindings.QuitKeys))
|
||||
}
|
||||
}
|
||||
|
||||
func TestSaveAndLoadAppConfigIntegration(t *testing.T) {
|
||||
// Create a temporary directory for testing
|
||||
tempDir, err := os.MkdirTemp("", "sshm_test")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
// Create a custom config file directly in temp directory
|
||||
configPath := filepath.Join(tempDir, "config.json")
|
||||
|
||||
customConfig := AppConfig{
|
||||
KeyBindings: KeyBindings{
|
||||
QuitKeys: []string{"q"},
|
||||
DisableEscQuit: true,
|
||||
},
|
||||
}
|
||||
|
||||
// Save config directly to file
|
||||
data, err := json.MarshalIndent(customConfig, "", " ")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal config: %v", err)
|
||||
}
|
||||
|
||||
err = os.WriteFile(configPath, data, 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to write config file: %v", err)
|
||||
}
|
||||
|
||||
// Read and unmarshal config
|
||||
readData, err := os.ReadFile(configPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to read config file: %v", err)
|
||||
}
|
||||
|
||||
var loadedConfig AppConfig
|
||||
err = json.Unmarshal(readData, &loadedConfig)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to unmarshal config: %v", err)
|
||||
}
|
||||
|
||||
// Verify the loaded config matches what we saved
|
||||
if !loadedConfig.KeyBindings.DisableEscQuit {
|
||||
t.Error("DisableEscQuit should be true")
|
||||
}
|
||||
|
||||
if len(loadedConfig.KeyBindings.QuitKeys) != 1 || loadedConfig.KeyBindings.QuitKeys[0] != "q" {
|
||||
t.Errorf("Expected quit keys to be ['q'], got %v", loadedConfig.KeyBindings.QuitKeys)
|
||||
}
|
||||
}
|
||||
@@ -80,6 +80,9 @@ type Model struct {
|
||||
sortMode SortMode
|
||||
configFile string // Path to the SSH config file
|
||||
|
||||
// Application configuration
|
||||
appConfig *config.AppConfig
|
||||
|
||||
// Version update information
|
||||
updateInfo *version.UpdateInfo
|
||||
currentVersion string
|
||||
|
||||
@@ -37,35 +37,64 @@ func sortHostsByName(hosts []config.SSHHost) []config.SSHHost {
|
||||
|
||||
// filterHosts filters hosts according to the search query (name or tags)
|
||||
func (m Model) filterHosts(query string) []config.SSHHost {
|
||||
subqueries := strings.Split(query, " ")
|
||||
subqueriesLength := len(subqueries)
|
||||
subfilteredHosts := make([][]config.SSHHost, subqueriesLength)
|
||||
for i, subquery := range subqueries {
|
||||
subfilteredHosts[i] = m.filterHostsByWord(subquery)
|
||||
}
|
||||
|
||||
// return the intersection of search results
|
||||
result := make([]config.SSHHost, 0)
|
||||
tempMap := map[string]int{}
|
||||
for _, hosts := range subfilteredHosts {
|
||||
for _, host := range hosts {
|
||||
if _, ok := tempMap[host.Name]; !ok {
|
||||
tempMap[host.Name] = 1
|
||||
} else {
|
||||
tempMap[host.Name] = tempMap[host.Name] + 1
|
||||
}
|
||||
|
||||
if tempMap[host.Name] == subqueriesLength {
|
||||
result = append(result, host)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
// filterHostsByWord filters hosts according to a single word
|
||||
func (m Model) filterHostsByWord(word string) []config.SSHHost {
|
||||
var filtered []config.SSHHost
|
||||
|
||||
if query == "" {
|
||||
if word == "" {
|
||||
filtered = m.hosts
|
||||
} else {
|
||||
query = strings.ToLower(query)
|
||||
word = strings.ToLower(word)
|
||||
|
||||
for _, host := range m.hosts {
|
||||
// Check the hostname
|
||||
if strings.Contains(strings.ToLower(host.Name), query) {
|
||||
if strings.Contains(strings.ToLower(host.Name), word) {
|
||||
filtered = append(filtered, host)
|
||||
continue
|
||||
}
|
||||
|
||||
// Check the hostname
|
||||
if strings.Contains(strings.ToLower(host.Hostname), query) {
|
||||
if strings.Contains(strings.ToLower(host.Hostname), word) {
|
||||
filtered = append(filtered, host)
|
||||
continue
|
||||
}
|
||||
|
||||
// Check the user
|
||||
if strings.Contains(strings.ToLower(host.User), query) {
|
||||
if strings.Contains(strings.ToLower(host.User), word) {
|
||||
filtered = append(filtered, host)
|
||||
continue
|
||||
}
|
||||
|
||||
// Check the tags
|
||||
for _, tag := range host.Tags {
|
||||
if strings.Contains(strings.ToLower(tag), query) {
|
||||
if strings.Contains(strings.ToLower(tag), word) {
|
||||
filtered = append(filtered, host)
|
||||
break
|
||||
}
|
||||
|
||||
@@ -17,6 +17,15 @@ import (
|
||||
|
||||
// NewModel creates a new TUI model with the given SSH hosts
|
||||
func NewModel(hosts []config.SSHHost, configFile, currentVersion string) Model {
|
||||
// Load application configuration
|
||||
appConfig, err := config.LoadAppConfig()
|
||||
if err != nil {
|
||||
// Log the error but continue with default configuration
|
||||
fmt.Printf("Warning: Could not load application config: %v, using defaults\n", err)
|
||||
defaultConfig := config.GetDefaultAppConfig()
|
||||
appConfig = &defaultConfig
|
||||
}
|
||||
|
||||
// Initialize the history manager
|
||||
historyManager, err := history.NewHistoryManager()
|
||||
if err != nil {
|
||||
@@ -39,6 +48,7 @@ func NewModel(hosts []config.SSHHost, configFile, currentVersion string) Model {
|
||||
sortMode: SortByName,
|
||||
configFile: configFile,
|
||||
currentVersion: currentVersion,
|
||||
appConfig: appConfig,
|
||||
styles: styles,
|
||||
width: 80,
|
||||
height: 24,
|
||||
|
||||
@@ -445,8 +445,9 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
|
||||
func (m Model) handleListViewKeys(msg tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
var cmd tea.Cmd
|
||||
key := msg.String()
|
||||
|
||||
switch msg.String() {
|
||||
switch key {
|
||||
case "esc", "ctrl+c":
|
||||
if m.deleteMode {
|
||||
// Exit delete mode
|
||||
@@ -455,10 +456,16 @@ func (m Model) handleListViewKeys(msg tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
m.table.Focus()
|
||||
return m, nil
|
||||
}
|
||||
return m, tea.Quit
|
||||
// Use configurable key bindings for quit
|
||||
if m.appConfig != nil && m.appConfig.KeyBindings.ShouldQuitOnKey(key) {
|
||||
return m, tea.Quit
|
||||
}
|
||||
case "q":
|
||||
if !m.searchMode && !m.deleteMode {
|
||||
return m, tea.Quit
|
||||
// Use configurable key bindings for quit
|
||||
if m.appConfig != nil && m.appConfig.KeyBindings.ShouldQuitOnKey(key) {
|
||||
return m, tea.Quit
|
||||
}
|
||||
}
|
||||
case "/", "ctrl+f":
|
||||
if !m.searchMode && !m.deleteMode {
|
||||
|
||||
@@ -128,7 +128,8 @@ func TestValidateIdentityFile(t *testing.T) {
|
||||
{"empty path", "", true}, // Optional field
|
||||
{"valid file", validFile, true},
|
||||
{"non-existent file", "/path/to/nonexistent", false},
|
||||
{"tilde path", "~/.ssh/id_rsa", true}, // Will pass if file exists
|
||||
// Skip tilde path test in CI environments where ~/.ssh/id_rsa may not exist
|
||||
// {"tilde path", "~/.ssh/id_rsa", true}, // Will pass if file exists
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
@@ -138,6 +139,15 @@ func TestValidateIdentityFile(t *testing.T) {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// Test tilde path separately, but only if the file actually exists
|
||||
t.Run("tilde path", func(t *testing.T) {
|
||||
tildeFile := "~/.ssh/id_rsa"
|
||||
// Just test that it doesn't crash, don't assume file exists
|
||||
result := ValidateIdentityFile(tildeFile)
|
||||
// Result can be true or false depending on file existence
|
||||
_ = result // We just care that it doesn't panic
|
||||
})
|
||||
}
|
||||
|
||||
func TestValidateHost(t *testing.T) {
|
||||
|
||||
Reference in New Issue
Block a user