mirror of
https://github.com/sbrow/envr.git
synced 2025-12-29 23:47:39 -05:00
Compare commits
8 Commits
7cbc04cbf6
...
47fec65063
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
47fec65063 | ||
| 169653d756 | |||
| 8074f7ae6d | |||
| 9a729e6e2a | |||
| 0fef74a9bb | |||
| 38a6776b31 | |||
| 15be62b5a2 | |||
| f43705cd53 |
@@ -1,17 +1,23 @@
|
||||
# Changelog
|
||||
|
||||
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-06)
|
||||
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-07)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* Dir is now derived from Path rather than stored in the DB. Your DB will need to be updated.
|
||||
* **scan:** The config value `scan.Exclude` is now a list rather than a string.
|
||||
* **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))
|
||||
* **config:** The default config now filters out more junk. ([15be62b](https://github.com/sbrow/envr/commit/15be62b5a2a5a735b90b074497d645c5a2cfced8))
|
||||
* **init:** Added a `--force` flag for overwriting an existing config. ([169653d](https://github.com/sbrow/envr/commit/169653d7566f63730fb9da80a18330a566223be9))
|
||||
* Multiple scan includes are now supported. ([4273fa5](https://github.com/sbrow/envr/commit/4273fa58956d8736271a0af66202dca481126fe4))
|
||||
* **scan:** Added support for multiple exports. ([f43705c](https://github.com/sbrow/envr/commit/f43705cd53c6d87aef1f69df4e474441f25c1dc7))
|
||||
* **sync:** Now checks files for mismatched hashes before replacing. ([8074f7a](https://github.com/sbrow/envr/commit/8074f7ae6dfa54e931a198257f3f8e6d0cfe353a))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
@@ -22,6 +28,7 @@
|
||||
### Code Refactoring
|
||||
|
||||
* **check:** Renamed the `check` command to `deps`. ([c9c34ce](https://github.com/sbrow/envr/commit/c9c34ce771653da214635f1df1fef1f23265c552))
|
||||
* Dir is no longer stored in the database. ([0fef74a](https://github.com/sbrow/envr/commit/0fef74a9bba0fbf3c34b66c2095955e6eee7047b))
|
||||
|
||||
## [0.1.1](https://github.com/sbrow/envr/compare/v0.1.0...v0.1.1) (2025-11-05)
|
||||
|
||||
|
||||
@@ -26,8 +26,7 @@ type SshKeyPair struct {
|
||||
type scanConfig struct {
|
||||
// TODO: Support multiple matchers
|
||||
Matcher string `json:"matcher"`
|
||||
// TODO: Support multiple excludes
|
||||
Exclude string `json:"exclude"`
|
||||
Exclude []string `json:"exclude"`
|
||||
Include []string `json:"include"`
|
||||
}
|
||||
|
||||
@@ -48,7 +47,12 @@ func NewConfig(privateKeyPaths []string) Config {
|
||||
Keys: keys,
|
||||
ScanConfig: scanConfig{
|
||||
Matcher: "\\.env",
|
||||
Exclude: "*.envrc",
|
||||
Exclude: []string{
|
||||
"*\\.envrc",
|
||||
"\\.local/",
|
||||
"node_modules",
|
||||
"vendor",
|
||||
},
|
||||
Include: []string{"~"},
|
||||
},
|
||||
}
|
||||
@@ -109,6 +113,25 @@ func (c *Config) Save() error {
|
||||
return os.WriteFile(configPath, data, 0644)
|
||||
}
|
||||
|
||||
// buildFdArgs builds the fd command arguments with multiple exclude patterns
|
||||
func (c Config) buildFdArgs(searchPath string, includeIgnored bool) []string {
|
||||
args := []string{"-a", c.ScanConfig.Matcher}
|
||||
|
||||
// Add exclude patterns
|
||||
for _, exclude := range c.ScanConfig.Exclude {
|
||||
args = append(args, "-E", exclude)
|
||||
}
|
||||
|
||||
if includeIgnored {
|
||||
args = append(args, "-HI")
|
||||
} else {
|
||||
args = append(args, "-H")
|
||||
}
|
||||
|
||||
args = append(args, searchPath)
|
||||
return args
|
||||
}
|
||||
|
||||
// Use fd to find all ignored .env files that match the config's parameters
|
||||
func (c Config) scan() (paths []string, err error) {
|
||||
searchPaths, err := c.searchPaths()
|
||||
@@ -119,7 +142,7 @@ func (c Config) scan() (paths []string, err error) {
|
||||
for _, searchPath := range searchPaths {
|
||||
// Find all files (including ignored ones)
|
||||
fmt.Printf("Searching for all files in \"%s\"...\n", searchPath)
|
||||
allCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-HI", searchPath)
|
||||
allCmd := exec.Command("fd", c.buildFdArgs(searchPath, true)...)
|
||||
allOutput, err := allCmd.Output()
|
||||
if err != nil {
|
||||
return paths, err
|
||||
@@ -132,7 +155,7 @@ func (c Config) scan() (paths []string, err error) {
|
||||
|
||||
// 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)
|
||||
unignoredCmd := exec.Command("fd", c.buildFdArgs(searchPath, false)...)
|
||||
unignoredOutput, err := unignoredCmd.Output()
|
||||
if err != nil {
|
||||
return []string{}, err
|
||||
|
||||
30
app/db.go
30
app/db.go
@@ -72,7 +72,6 @@ func newDb() (*sql.DB, error) {
|
||||
} else {
|
||||
_, err := db.Exec(`create table envr_env_files (
|
||||
path text primary key not null
|
||||
, dir text not null
|
||||
, remotes text -- JSON
|
||||
, sha256 text not null
|
||||
, contents text not null
|
||||
@@ -150,23 +149,27 @@ func restoreDB(path string, destDB *sql.DB) error {
|
||||
|
||||
// Returns all the EnvFiles present in the database.
|
||||
func (db *Db) List() (results []EnvFile, err error) {
|
||||
rows, err := db.db.Query("select * from envr_env_files")
|
||||
rows, err := db.db.Query("select path, remotes, sha256, contents from envr_env_files")
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
for rows.Next() {
|
||||
var envFile EnvFile
|
||||
var remotesJSON string
|
||||
|
||||
err := rows.Scan(&envFile.Path, &envFile.Dir, &remotesJSON, &envFile.Sha256, &envFile.contents)
|
||||
var remotesJson []byte
|
||||
for rows.Next() {
|
||||
err := rows.Scan(&envFile.Path, &remotesJson, &envFile.Sha256, &envFile.contents)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// TODO: unmarshal remotesJSON into envFile.remotes
|
||||
// Populate Dir from Path
|
||||
envFile.Dir = filepath.Dir(envFile.Path)
|
||||
|
||||
if err := json.Unmarshal(remotesJson, &envFile.Remotes); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
results = append(results, envFile)
|
||||
}
|
||||
@@ -278,9 +281,9 @@ func (db *Db) Insert(file EnvFile) error {
|
||||
|
||||
// Insert into database
|
||||
_, err = db.db.Exec(`
|
||||
INSERT OR REPLACE INTO envr_env_files (path, dir, remotes, sha256, contents)
|
||||
VALUES (?, ?, ?, ?, ?)
|
||||
`, file.Path, file.Dir, string(remotesJSON), file.Sha256, file.contents)
|
||||
INSERT OR REPLACE INTO envr_env_files (path, remotes, sha256, contents)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, file.Path, string(remotesJSON), file.Sha256, file.contents)
|
||||
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to insert env file: %w", err)
|
||||
@@ -293,12 +296,15 @@ func (db *Db) Insert(file EnvFile) error {
|
||||
func (db *Db) Fetch(path string) (envFile EnvFile, err error) {
|
||||
var remotesJSON string
|
||||
|
||||
row := db.db.QueryRow("SELECT path, dir, remotes, sha256, contents FROM envr_env_files WHERE path = ?", path)
|
||||
err = row.Scan(&envFile.Path, &envFile.Dir, &remotesJSON, &envFile.Sha256, &envFile.contents)
|
||||
row := db.db.QueryRow("SELECT path, remotes, sha256, contents FROM envr_env_files WHERE path = ?", path)
|
||||
err = row.Scan(&envFile.Path, &remotesJSON, &envFile.Sha256, &envFile.contents)
|
||||
if err != nil {
|
||||
return EnvFile{}, fmt.Errorf("failed to fetch env file: %w", err)
|
||||
}
|
||||
|
||||
// Populate Dir from Path
|
||||
envFile.Dir = filepath.Dir(envFile.Path)
|
||||
|
||||
if err = json.Unmarshal([]byte(remotesJSON), &envFile.Remotes); err != nil {
|
||||
return EnvFile{}, fmt.Errorf("failed to unmarshal remotes: %w", err)
|
||||
}
|
||||
|
||||
@@ -11,6 +11,7 @@ import (
|
||||
|
||||
type EnvFile struct {
|
||||
Path string
|
||||
// Dir is derived from Path, and is not stored in the database.
|
||||
Dir string
|
||||
Remotes []string // []string
|
||||
Sha256 string
|
||||
@@ -95,19 +96,39 @@ func getGitRemotes(dir string) []string {
|
||||
return remotes
|
||||
}
|
||||
|
||||
// Install the file into the file system
|
||||
// Install the file into the file system. If the file already exists,
|
||||
// it will be overwritten.
|
||||
func (file EnvFile) Restore() error {
|
||||
// TODO: Handle restores more cleanly
|
||||
// TODO: Duplicate work is being done when called from the Sync function.
|
||||
if _, err := os.Stat(file.Path); err == nil {
|
||||
// file already exists
|
||||
|
||||
// Read existing file and calculate its hash
|
||||
existingContents, err := os.ReadFile(file.Path)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read existing file for hash comparison: %w", err)
|
||||
}
|
||||
|
||||
hash := sha256.Sum256(existingContents)
|
||||
existingSha := fmt.Sprintf("%x", hash)
|
||||
|
||||
if existingSha == file.Sha256 {
|
||||
return fmt.Errorf("file already exists: %s", file.Path)
|
||||
} else {
|
||||
if err := os.WriteFile(file.Path, []byte(file.contents), 0644); err != nil {
|
||||
return fmt.Errorf("failed to write file: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
} else {
|
||||
// file doesn't exist
|
||||
|
||||
// Ensure the directory exists
|
||||
if _, err := os.Stat(file.Dir); err != nil {
|
||||
return fmt.Errorf("directory missing")
|
||||
}
|
||||
|
||||
// Check if file already exists
|
||||
if _, err := os.Stat(file.Path); err == nil {
|
||||
return fmt.Errorf("file already exists: %s", file.Path)
|
||||
}
|
||||
|
||||
// Write the contents to the file
|
||||
if err := os.WriteFile(file.Path, []byte(file.contents), 0644); err != nil {
|
||||
return fmt.Errorf("failed to write file: %w", err)
|
||||
@@ -116,6 +137,8 @@ func (file EnvFile) Restore() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// Try to reconcile the EnvFile with the filesystem.
|
||||
//
|
||||
// If Updated is returned, [Db.Insert] should be called on file.
|
||||
@@ -150,7 +173,7 @@ func (file *EnvFile) Sync() (result EnvFileSyncResult, err error) {
|
||||
}
|
||||
}
|
||||
|
||||
// Update the EnvFile using the file system
|
||||
// Update the EnvFile using the file system.
|
||||
func (file *EnvFile) Backup() error {
|
||||
// Read the contents of the file
|
||||
contents, err := os.ReadFile(file.Path)
|
||||
|
||||
15
cmd/init.go
15
cmd/init.go
@@ -11,10 +11,8 @@ import (
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// TODO: Add --force (-f) flag.
|
||||
var initCmd = &cobra.Command{
|
||||
Use: "init",
|
||||
DisableFlagsInUseLine: true,
|
||||
Short: "Set up envr",
|
||||
Long: `The init command generates your initial config and saves it to
|
||||
~/.envr/config in JSON format.
|
||||
@@ -23,11 +21,10 @@ During setup, you will be prompted to select one or more ssh keys with which to
|
||||
encrypt your databse. **Make 100% sure** that you have **a remote copy** of this
|
||||
key somewhere, otherwise your data could be lost forever.`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
force, _ := cmd.Flags().GetBool("force")
|
||||
config, _ := app.LoadConfig()
|
||||
|
||||
if config != nil {
|
||||
return fmt.Errorf("You have already initialized envr")
|
||||
} else {
|
||||
if config == nil || force {
|
||||
keys, err := selectSSHKeys()
|
||||
if err != nil {
|
||||
return fmt.Errorf("Error selecting SSH keys: %v", err)
|
||||
@@ -43,13 +40,17 @@ key somewhere, otherwise your data could be lost forever.`,
|
||||
}
|
||||
|
||||
fmt.Printf("Config initialized with %d SSH key(s). You are ready to use envr.\n", len(keys))
|
||||
}
|
||||
|
||||
return nil
|
||||
} else {
|
||||
return fmt.Errorf(`You have already initialized envr.
|
||||
Run again with the --force flag if you want to reinitialize.
|
||||
`)
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
initCmd.Flags().BoolP("force", "f", false, "Overwrite an existing config")
|
||||
rootCmd.AddCommand(initCmd)
|
||||
}
|
||||
|
||||
|
||||
@@ -12,12 +12,13 @@ encrypt your databse. **Make 100% sure** that you have **a remote copy** of this
|
||||
key somewhere, otherwise your data could be lost forever.
|
||||
|
||||
```
|
||||
envr init
|
||||
envr init [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --force Overwrite an existing config
|
||||
-h, --help help for init
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user