mirror of
https://github.com/sbrow/envr.git
synced 2026-02-28 04:21:45 -05:00
Compare commits
7 Commits
v0.1.1
...
7cbc04cbf6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7cbc04cbf6 | ||
| cbd74f387e | |||
| c9c34ce771 | |||
| 17ce49cd2d | |||
| af0a9f9c4c | |||
| 4273fa5895 | |||
| bb3c0cdeee |
23
CHANGELOG.md
23
CHANGELOG.md
@@ -1,5 +1,28 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-06)
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠ BREAKING CHANGES
|
||||||
|
|
||||||
|
* **check:** Renamed the `check` command to `deps`.
|
||||||
|
* The config value `scan.Include` is now a list rather than a string.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Added new `check` command. ([cbd74f3](https://github.com/sbrow/envr/commit/cbd74f387e2e330b2557d07dd82ba05cc91300ac))
|
||||||
|
* Multiple scan includes are now supported. ([4273fa5](https://github.com/sbrow/envr/commit/4273fa58956d8736271a0af66202dca481126fe4))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **check:** `fd` now correctly gets marked as found. ([17ce49c](https://github.com/sbrow/envr/commit/17ce49cd2d33942282c6f54ce819ac25978f6b7c))
|
||||||
|
|
||||||
|
|
||||||
|
### Code Refactoring
|
||||||
|
|
||||||
|
* **check:** Renamed the `check` command to `deps`. ([c9c34ce](https://github.com/sbrow/envr/commit/c9c34ce771653da214635f1df1fef1f23265c552))
|
||||||
|
|
||||||
## [0.1.1](https://github.com/sbrow/envr/compare/v0.1.0...v0.1.1) (2025-11-05)
|
## [0.1.1](https://github.com/sbrow/envr/compare/v0.1.0...v0.1.1) (2025-11-05)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
120
app/config.go
120
app/config.go
@@ -24,9 +24,11 @@ type SshKeyPair struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type scanConfig struct {
|
type scanConfig struct {
|
||||||
|
// TODO: Support multiple matchers
|
||||||
Matcher string `json:"matcher"`
|
Matcher string `json:"matcher"`
|
||||||
Exclude string `json:"exclude"`
|
// TODO: Support multiple excludes
|
||||||
Include string `json:"include"`
|
Exclude string `json:"exclude"`
|
||||||
|
Include []string `json:"include"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a fresh config with sensible defaults.
|
// Create a fresh config with sensible defaults.
|
||||||
@@ -47,7 +49,7 @@ func NewConfig(privateKeyPaths []string) Config {
|
|||||||
ScanConfig: scanConfig{
|
ScanConfig: scanConfig{
|
||||||
Matcher: "\\.env",
|
Matcher: "\\.env",
|
||||||
Exclude: "*.envrc",
|
Exclude: "*.envrc",
|
||||||
Include: "~",
|
Include: []string{"~"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -109,71 +111,77 @@ func (c *Config) Save() error {
|
|||||||
|
|
||||||
// Use fd to find all ignored .env files that match the config's parameters
|
// Use fd to find all ignored .env files that match the config's parameters
|
||||||
func (c Config) scan() (paths []string, err error) {
|
func (c Config) scan() (paths []string, err error) {
|
||||||
searchPath, err := c.searchPath()
|
searchPaths, err := c.searchPaths()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return []string{}, err
|
return []string{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Find all files (including ignored ones)
|
for _, searchPath := range searchPaths {
|
||||||
fmt.Printf("Searching for all files in \"%s\"...\n", searchPath)
|
// Find all files (including ignored ones)
|
||||||
allCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-HI", searchPath)
|
fmt.Printf("Searching for all files in \"%s\"...\n", searchPath)
|
||||||
allOutput, err := allCmd.Output()
|
allCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-HI", searchPath)
|
||||||
if err != nil {
|
allOutput, err := allCmd.Output()
|
||||||
return []string{}, err
|
if err != nil {
|
||||||
}
|
return paths, err
|
||||||
|
|
||||||
allFiles := strings.Split(strings.TrimSpace(string(allOutput)), "\n")
|
|
||||||
if len(allFiles) == 1 && allFiles[0] == "" {
|
|
||||||
allFiles = []string{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Find unignored files
|
|
||||||
fmt.Printf("Search for unignored fies in \"%s\"...\n", searchPath)
|
|
||||||
unignoredCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-H", searchPath)
|
|
||||||
unignoredOutput, err := unignoredCmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
return []string{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
unignoredFiles := strings.Split(strings.TrimSpace(string(unignoredOutput)), "\n")
|
|
||||||
if len(unignoredFiles) == 1 && unignoredFiles[0] == "" {
|
|
||||||
unignoredFiles = []string{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a map for faster lookup
|
|
||||||
unignoredMap := make(map[string]bool)
|
|
||||||
for _, file := range unignoredFiles {
|
|
||||||
unignoredMap[file] = true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Filter to get only ignored files
|
|
||||||
var ignoredFiles []string
|
|
||||||
for _, file := range allFiles {
|
|
||||||
if !unignoredMap[file] {
|
|
||||||
ignoredFiles = append(ignoredFiles, file)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
allFiles := strings.Split(strings.TrimSpace(string(allOutput)), "\n")
|
||||||
|
if len(allFiles) == 1 && allFiles[0] == "" {
|
||||||
|
allFiles = []string{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find unignored files
|
||||||
|
fmt.Printf("Search for unignored fies in \"%s\"...\n", searchPath)
|
||||||
|
unignoredCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-H", searchPath)
|
||||||
|
unignoredOutput, err := unignoredCmd.Output()
|
||||||
|
if err != nil {
|
||||||
|
return []string{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
unignoredFiles := strings.Split(strings.TrimSpace(string(unignoredOutput)), "\n")
|
||||||
|
if len(unignoredFiles) == 1 && unignoredFiles[0] == "" {
|
||||||
|
unignoredFiles = []string{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a map for faster lookup
|
||||||
|
unignoredMap := make(map[string]bool)
|
||||||
|
for _, file := range unignoredFiles {
|
||||||
|
unignoredMap[file] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Filter to get only ignored files
|
||||||
|
var ignoredFiles []string
|
||||||
|
for _, file := range allFiles {
|
||||||
|
if !unignoredMap[file] {
|
||||||
|
ignoredFiles = append(ignoredFiles, file)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
paths = append(paths, ignoredFiles...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return ignoredFiles, nil
|
return paths, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c Config) searchPath() (path string, err error) {
|
func (c Config) searchPaths() (paths []string, err error) {
|
||||||
include := c.ScanConfig.Include
|
homeDir, err := os.UserHomeDir()
|
||||||
|
|
||||||
if include == "~" {
|
|
||||||
homeDir, err := os.UserHomeDir()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return homeDir, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
absPath, err := filepath.Abs(include)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return paths, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return absPath, nil
|
includes := c.ScanConfig.Include
|
||||||
|
|
||||||
|
for _, include := range includes {
|
||||||
|
path := strings.Replace(include, "~", homeDir, 1)
|
||||||
|
absPath, err := filepath.Abs(path)
|
||||||
|
if err != nil {
|
||||||
|
return paths, err
|
||||||
|
}
|
||||||
|
|
||||||
|
paths = append(paths, absPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
return paths, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: Should this be private?
|
// TODO: Should this be private?
|
||||||
|
|||||||
11
app/db.go
11
app/db.go
@@ -326,8 +326,15 @@ func (db *Db) Delete(path string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Finds .env files in the filesystem that aren't present in the database.
|
// Finds .env files in the filesystem that aren't present in the database.
|
||||||
func (db *Db) Scan() ([]string, error) {
|
// path overrides the already configured
|
||||||
all_paths, err := db.cfg.scan()
|
func (db *Db) Scan(paths []string) ([]string, error) {
|
||||||
|
cfg := db.cfg
|
||||||
|
|
||||||
|
if paths != nil {
|
||||||
|
cfg.ScanConfig.Include = paths
|
||||||
|
}
|
||||||
|
|
||||||
|
all_paths, err := cfg.scan()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return []string{}, err
|
return []string{}, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ const (
|
|||||||
// fd
|
// fd
|
||||||
Fd AvailableFeatures = 2
|
Fd AvailableFeatures = 2
|
||||||
// All features are present
|
// All features are present
|
||||||
All AvailableFeatures = Git & Fd
|
All AvailableFeatures = Git | Fd
|
||||||
)
|
)
|
||||||
|
|
||||||
// Checks for available features.
|
// Checks for available features.
|
||||||
|
|||||||
120
cmd/check.go
120
cmd/check.go
@@ -1,48 +1,106 @@
|
|||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
"github.com/olekukonko/tablewriter"
|
|
||||||
"github.com/sbrow/envr/app"
|
"github.com/sbrow/envr/app"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
var checkCmd = &cobra.Command{
|
var checkCmd = &cobra.Command{
|
||||||
Use: "check",
|
Use: "check [path]",
|
||||||
Short: "Check for missing binaries",
|
Short: "check if files in the current directory are backed up",
|
||||||
Long: `envr relies on external binaries for certain functionality.
|
// TODO: Long description for new check command
|
||||||
|
Args: cobra.MaximumNArgs(1),
|
||||||
The check command reports on which binaries are available and which are not.`,
|
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
// Accept an optional path arg, default to current working directory
|
||||||
|
var checkPath string
|
||||||
|
if len(args) > 0 {
|
||||||
|
checkPath = args[0]
|
||||||
|
} else {
|
||||||
|
cwd, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get current working directory: %w", err)
|
||||||
|
}
|
||||||
|
checkPath = cwd
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get absolute path
|
||||||
|
absPath, err := filepath.Abs(checkPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get absolute path: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open database
|
||||||
db, err := app.Open()
|
db, err := app.Open()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return fmt.Errorf("failed to open database: %w", err)
|
||||||
} else {
|
|
||||||
defer db.Close(app.ReadOnly)
|
|
||||||
features := db.Features()
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.Header([]string{"Feature", "Status"})
|
|
||||||
|
|
||||||
// Check Git
|
|
||||||
if features&app.Git == 1 {
|
|
||||||
table.Append([]string{"Git", "✓ Available"})
|
|
||||||
} else {
|
|
||||||
table.Append([]string{"Git", "✗ Missing"})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check fd
|
|
||||||
if features&app.Fd == 1 {
|
|
||||||
table.Append([]string{"fd", "✓ Available"})
|
|
||||||
} else {
|
|
||||||
table.Append([]string{"fd", "✗ Missing"})
|
|
||||||
}
|
|
||||||
|
|
||||||
table.Render()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
defer db.Close(app.ReadOnly)
|
||||||
|
|
||||||
|
// Check if the path is a file or directory
|
||||||
|
info, err := os.Stat(absPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to stat path: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var filesInPath []string
|
||||||
|
|
||||||
|
if info.IsDir() {
|
||||||
|
// Find .env files in the specified directory
|
||||||
|
if err := db.CanScan(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Scan only the specified path for .env files
|
||||||
|
filesInPath, err = db.Scan([]string{absPath})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to scan path for env files: %w", err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Path is a file, just check this specific file
|
||||||
|
filesInPath = []string{absPath}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get all backed up files from the database
|
||||||
|
envFiles, err := db.List()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to list files from database: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check which files are not backed up
|
||||||
|
var notBackedUp []string
|
||||||
|
for _, file := range filesInPath {
|
||||||
|
isBackedUp := false
|
||||||
|
for _, envFile := range envFiles {
|
||||||
|
if envFile.Path == file {
|
||||||
|
isBackedUp = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !isBackedUp {
|
||||||
|
notBackedUp = append(notBackedUp, file)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display results
|
||||||
|
if len(notBackedUp) == 0 {
|
||||||
|
if len(filesInPath) == 0 {
|
||||||
|
fmt.Println("No .env files found in the specified directory.")
|
||||||
|
} else {
|
||||||
|
fmt.Println("✓ All .env files in the directory are backed up.")
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
fmt.Printf("Found %d .env file(s) that are not backed up:\n", len(notBackedUp))
|
||||||
|
for _, file := range notBackedUp {
|
||||||
|
fmt.Printf(" %s\n", file)
|
||||||
|
}
|
||||||
|
fmt.Println("\nRun 'envr sync' to back up these files.")
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
51
cmd/deps.go
Normal file
51
cmd/deps.go
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/olekukonko/tablewriter"
|
||||||
|
"github.com/sbrow/envr/app"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
var depsCmd = &cobra.Command{
|
||||||
|
Use: "deps",
|
||||||
|
Short: "Check for missing binaries",
|
||||||
|
Long: `envr relies on external binaries for certain functionality.
|
||||||
|
|
||||||
|
The check command reports on which binaries are available and which are not.`,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
db, err := app.Open()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
defer db.Close(app.ReadOnly)
|
||||||
|
features := db.Features()
|
||||||
|
|
||||||
|
table := tablewriter.NewWriter(os.Stdout)
|
||||||
|
table.Header([]string{"Feature", "Status"})
|
||||||
|
|
||||||
|
// Check Git
|
||||||
|
if features&app.Git == 1 {
|
||||||
|
table.Append([]string{"Git", "✓ Available"})
|
||||||
|
} else {
|
||||||
|
table.Append([]string{"Git", "✗ Missing"})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check fd
|
||||||
|
if features&app.Fd == app.Fd {
|
||||||
|
table.Append([]string{"fd", "✓ Available"})
|
||||||
|
} else {
|
||||||
|
table.Append([]string{"fd", "✗ Missing"})
|
||||||
|
}
|
||||||
|
|
||||||
|
table.Render()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
rootCmd.AddCommand(depsCmd)
|
||||||
|
}
|
||||||
@@ -28,7 +28,7 @@ var scanCmd = &cobra.Command{
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
files, err := db.Scan()
|
files, err := db.Scan(nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -44,7 +44,8 @@ at before, restore your backup with:
|
|||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
* [envr backup](envr_backup.md) - Import a .env file into envr
|
* [envr backup](envr_backup.md) - Import a .env file into envr
|
||||||
* [envr check](envr_check.md) - Check for missing binaries
|
* [envr check](envr_check.md) - check if files in the current directory are backed up
|
||||||
|
* [envr deps](envr_deps.md) - Check for missing binaries
|
||||||
* [envr edit-config](envr_edit-config.md) - Edit your config with your default editor
|
* [envr edit-config](envr_edit-config.md) - Edit your config with your default editor
|
||||||
* [envr init](envr_init.md) - Set up envr
|
* [envr init](envr_init.md) - Set up envr
|
||||||
* [envr list](envr_list.md) - View your tracked files
|
* [envr list](envr_list.md) - View your tracked files
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
## envr check
|
## envr check
|
||||||
|
|
||||||
Check for missing binaries
|
check if files in the current directory are backed up
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
envr relies on external binaries for certain functionality.
|
|
||||||
|
|
||||||
The check command reports on which binaries are available and which are not.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
envr check [flags]
|
envr check [path] [flags]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|||||||
24
docs/cli/envr_deps.md
Normal file
24
docs/cli/envr_deps.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
## envr deps
|
||||||
|
|
||||||
|
Check for missing binaries
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
envr relies on external binaries for certain functionality.
|
||||||
|
|
||||||
|
The check command reports on which binaries are available and which are not.
|
||||||
|
|
||||||
|
```
|
||||||
|
envr deps [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for deps
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [envr](envr.md) - Manage your .env files.
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@
|
|||||||
|
|
||||||
packages.default = pkgs.buildGoModule rec {
|
packages.default = pkgs.buildGoModule rec {
|
||||||
pname = "envr";
|
pname = "envr";
|
||||||
version = "0.1.0";
|
version = "0.1.1";
|
||||||
src = ./.;
|
src = ./.;
|
||||||
# If the build complains, uncomment this line
|
# If the build complains, uncomment this line
|
||||||
# vendorHash = "sha256:0000000000000000000000000000000000000000000000000000";
|
# vendorHash = "sha256:0000000000000000000000000000000000000000000000000000";
|
||||||
|
|||||||
Reference in New Issue
Block a user