mirror of
https://github.com/sbrow/envr.git
synced 2026-02-27 20:11:45 -05:00
Compare commits
4 Commits
v0.2.0
...
release-pl
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18fb435b1f | ||
| cf363abc4d | |||
| d3dbf2a05a | |||
| 5a9038df87 |
@@ -1,5 +1,12 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [0.2.1](https://github.com/sbrow/envr/compare/v0.2.0...v0.2.1) (2026-01-12)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* Added `add` as an alias for backup. ([cf363ab](https://github.com/sbrow/envr/commit/cf363abc4d8cec208d23c6acedbb7e0dd6900332))
|
||||||
|
|
||||||
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-10)
|
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-10)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
92
WINDOWS.md
Normal file
92
WINDOWS.md
Normal file
@@ -0,0 +1,92 @@
|
|||||||
|
# Windows Compatibility Guide
|
||||||
|
|
||||||
|
This document outlines Windows compatibility issues and solutions for the envr project.
|
||||||
|
|
||||||
|
## Critical Issues
|
||||||
|
|
||||||
|
### 1. Path Handling Bug (MUST FIX)
|
||||||
|
|
||||||
|
**File:** `app/env_file.go:209`
|
||||||
|
|
||||||
|
**Issue:** Uses `path.Join` instead of `filepath.Join`, which won't work correctly on Windows due to different path separators.
|
||||||
|
|
||||||
|
**Current code:**
|
||||||
|
```go
|
||||||
|
f.Path = path.Join(newDir, path.Base(f.Path))
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fixed code:**
|
||||||
|
```go
|
||||||
|
f.Path = filepath.Join(newDir, filepath.Base(f.Path))
|
||||||
|
```
|
||||||
|
|
||||||
|
## External Dependencies
|
||||||
|
|
||||||
|
The application relies on external tools that need to be installed separately on Windows:
|
||||||
|
|
||||||
|
### Required Tools
|
||||||
|
|
||||||
|
1. **fd** - Fast file finder
|
||||||
|
- Install via: `winget install sharkdp.fd` or `choco install fd`
|
||||||
|
- Alternative: `scoop install fd`
|
||||||
|
|
||||||
|
2. **git** - Version control system
|
||||||
|
- Install via: `winget install Git.Git` or download from git-scm.com
|
||||||
|
- Usually already available on most development machines
|
||||||
|
|
||||||
|
## Minor Compatibility Notes
|
||||||
|
|
||||||
|
### File Permissions
|
||||||
|
- Unix file permissions (`0755`, `0644`) are used throughout the codebase
|
||||||
|
- These are safely ignored on Windows - no changes needed
|
||||||
|
|
||||||
|
### Editor Configuration
|
||||||
|
**File:** `cmd/edit_config.go:20-24`
|
||||||
|
|
||||||
|
**Issue:** Relies on `$EDITOR` environment variable which is less common on Windows.
|
||||||
|
|
||||||
|
**Current behavior:** Fails if `$EDITOR` is not set
|
||||||
|
|
||||||
|
**Recommended improvement:** Add fallback detection for Windows editors:
|
||||||
|
```go
|
||||||
|
editor := os.Getenv("EDITOR")
|
||||||
|
if editor == "" {
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
editor = "notepad.exe" // or "code.exe" for VS Code
|
||||||
|
} else {
|
||||||
|
fmt.Println("Error: $EDITOR environment variable is not set")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation Instructions for Windows
|
||||||
|
|
||||||
|
1. Install required dependencies:
|
||||||
|
```powershell
|
||||||
|
winget install sharkdp.fd
|
||||||
|
winget install Git.Git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Fix the path handling bug in `app/env_file.go:209`
|
||||||
|
|
||||||
|
3. Build and run as normal:
|
||||||
|
```powershell
|
||||||
|
go build
|
||||||
|
.\envr.exe init
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing on Windows
|
||||||
|
|
||||||
|
After applying the critical path fix, the core functionality should work correctly on Windows. The application has been designed with cross-platform compatibility in mind, using:
|
||||||
|
|
||||||
|
- `filepath` package for path operations (mostly)
|
||||||
|
- `os.UserHomeDir()` for home directory detection
|
||||||
|
- Standard Go file operations
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- **1 critical bug** must be fixed for Windows compatibility
|
||||||
|
- **2 external tools** need to be installed
|
||||||
|
- **1 minor enhancement** recommended for better Windows UX
|
||||||
|
- Overall architecture is Windows-compatible
|
||||||
@@ -13,9 +13,10 @@ import (
|
|||||||
|
|
||||||
// backupCmd represents the backup command
|
// backupCmd represents the backup command
|
||||||
var backupCmd = &cobra.Command{
|
var backupCmd = &cobra.Command{
|
||||||
Use: "backup <path>",
|
Use: "backup <path>",
|
||||||
Short: "Import a .env file into envr",
|
Short: "Import a .env file into envr",
|
||||||
Args: cobra.ExactArgs(1),
|
Aliases: []string{"add"},
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
// Long: `Long desc`
|
// Long: `Long desc`
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
path := args[0]
|
path := args[0]
|
||||||
|
|||||||
30
flake.lock
generated
30
flake.lock
generated
@@ -5,11 +5,11 @@
|
|||||||
"nixpkgs-lib": "nixpkgs-lib"
|
"nixpkgs-lib": "nixpkgs-lib"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1751413152,
|
"lastModified": 1768135262,
|
||||||
"narHash": "sha256-Tyw1RjYEsp5scoigs1384gIg6e0GoBVjms4aXFfRssQ=",
|
"narHash": "sha256-PVvu7OqHBGWN16zSi6tEmPwwHQ4rLPU9Plvs8/1TUBY=",
|
||||||
"owner": "hercules-ci",
|
"owner": "hercules-ci",
|
||||||
"repo": "flake-parts",
|
"repo": "flake-parts",
|
||||||
"rev": "77826244401ea9de6e3bac47c2db46005e1f30b5",
|
"rev": "80daad04eddbbf5a4d883996a73f3f542fa437ac",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -20,11 +20,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1761597516,
|
"lastModified": 1767313136,
|
||||||
"narHash": "sha256-wxX7u6D2rpkJLWkZ2E932SIvDJW8+ON/0Yy8+a5vsDU=",
|
"narHash": "sha256-16KkgfdYqjaeRGBaYsNrhPRRENs0qzkQVUooNHtoy2w=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"rev": "daf6dc47aa4b44791372d6139ab7b25269184d55",
|
"rev": "ac62194c3917d5f474c1a844b6fd6da2db95077d",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -36,11 +36,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs-lib": {
|
"nixpkgs-lib": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1751159883,
|
"lastModified": 1765674936,
|
||||||
"narHash": "sha256-urW/Ylk9FIfvXfliA1ywh75yszAbiTEVgpPeinFyVZo=",
|
"narHash": "sha256-k00uTP4JNfmejrCLJOwdObYC9jHRrr/5M/a/8L2EIdo=",
|
||||||
"owner": "nix-community",
|
"owner": "nix-community",
|
||||||
"repo": "nixpkgs.lib",
|
"repo": "nixpkgs.lib",
|
||||||
"rev": "14a40a1d7fb9afa4739275ac642ed7301a9ba1ab",
|
"rev": "2075416fcb47225d9b68ac469a5c4801a9c4dd85",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -51,11 +51,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs-unstable": {
|
"nixpkgs-unstable": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1751949589,
|
"lastModified": 1768178648,
|
||||||
"narHash": "sha256-mgFxAPLWw0Kq+C8P3dRrZrOYEQXOtKuYVlo9xvPntt8=",
|
"narHash": "sha256-kz/F6mhESPvU1diB7tOM3nLcBfQe7GU7GQCymRlTi/s=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"rev": "9b008d60392981ad674e04016d25619281550a9d",
|
"rev": "3fbab70c6e69c87ea2b6e48aa6629da2aa6a23b0",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -80,11 +80,11 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1752055615,
|
"lastModified": 1768158989,
|
||||||
"narHash": "sha256-19m7P4O/Aw/6+CzncWMAJu89JaKeMh3aMle1CNQSIwM=",
|
"narHash": "sha256-67vyT1+xClLldnumAzCTBvU0jLZ1YBcf4vANRWP3+Ak=",
|
||||||
"owner": "numtide",
|
"owner": "numtide",
|
||||||
"repo": "treefmt-nix",
|
"repo": "treefmt-nix",
|
||||||
"rev": "c9d477b5d5bd7f26adddd3f96cfd6a904768d4f9",
|
"rev": "e96d59dff5c0d7fddb9d113ba108f03c3ef99eca",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
|
|||||||
Reference in New Issue
Block a user