refactor!: move all not-intended-for-the-public dirs into ./internal

BREAKING CHANGE: removes all public code except for pkg/parser
SKalt · Apr 20, 2024 · 43cf8e4 · 43cf8e4
1 parent c380c85
commit 43cf8e4
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 16 deletions.
diff --git a/cmd/cli.go b/cmd/cli.go
@@ -11,7 +11,7 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/spf13/cobra"
 
-	"github.com/skalt/git-cc/pkg/config"
+	"github.com/skalt/git-cc/internal/config"
 	"github.com/skalt/git-cc/pkg/parser"
 )
 

diff --git a/cmd/tui.go b/cmd/tui.go
@@ -5,12 +5,12 @@ import (
 	"strings"
 
 	tea "github.com/charmbracelet/bubbletea"
-	"github.com/skalt/git-cc/pkg/breaking_change_input"
-	"github.com/skalt/git-cc/pkg/config"
-	"github.com/skalt/git-cc/pkg/description_editor"
+	"github.com/skalt/git-cc/internal/breaking_change_input"
+	"github.com/skalt/git-cc/internal/config"
+	"github.com/skalt/git-cc/internal/description_editor"
+	"github.com/skalt/git-cc/internal/scope_selector"
+	"github.com/skalt/git-cc/internal/type_selector"
 	"github.com/skalt/git-cc/pkg/parser"
-	"github.com/skalt/git-cc/pkg/scope_selector"
-	"github.com/skalt/git-cc/pkg/type_selector"
 )
 
 type componentIndex int

diff --git a/...ing_change_input/breaking_change_input.go → ...ing_change_input/breaking_change_input.go b/...ing_change_input/breaking_change_input.go → ...ing_change_input/breaking_change_input.go
@@ -6,8 +6,8 @@ import (
 	"github.com/charmbracelet/bubbles/textinput"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/muesli/termenv"
-	"github.com/skalt/git-cc/pkg/config"
-	"github.com/skalt/git-cc/pkg/helpbar"
+	"github.com/skalt/git-cc/internal/config"
+	"github.com/skalt/git-cc/internal/helpbar"
 )
 
 type Model struct {

diff --git a/pkg/config/cfg.go → internal/config/cfg.go b/pkg/config/cfg.go → internal/config/cfg.go
@@ -491,6 +491,7 @@ func FindCCConfigFile(gitRepoRoot string) (string, []string, error) {
 		// "package.json",
 		// "pyproject.toml",
 	}
+	var alternate string
 	dirsToSearch := make([]string, 0, 3)
 
 	cwd, err := filepath.Abs(".")
@@ -525,6 +526,12 @@ func FindCCConfigFile(gitRepoRoot string) (string, []string, error) {
 			} else {
 				tried = append(tried, configFile)
 			}
+			wrongName := strings.ReplaceAll(candidate, "_", "-")
+			_, wrongNotPresent := os.Stat(path.Join(dir, wrongName))
+			if wrongNotPresent == nil && alternate != "" {
+				// warn about the wrong name
+				fmt.Printf("found %s, but expected %s\n", wrongName, candidate)
+			}
 		}
 	}
 	return "", tried, fmt.Errorf("no configuration found in \n  - %s", strings.Join(tried, "\n  - "))

diff --git a/pkg/description_editor/description_editor.go → .../description_editor/description_editor.go b/pkg/description_editor/description_editor.go → .../description_editor/description_editor.go
@@ -11,8 +11,8 @@ import (
 	"github.com/muesli/reflow/ansi"
 	"github.com/muesli/reflow/wordwrap"
 	"github.com/muesli/termenv"
-	"github.com/skalt/git-cc/pkg/config"
-	"github.com/skalt/git-cc/pkg/helpbar"
+	"github.com/skalt/git-cc/internal/config"
+	"github.com/skalt/git-cc/internal/helpbar"
 )
 
 const prePrompt = "A short description of the changes:"

diff --git a/pkg/helpbar/help.go → internal/helpbar/help.go b/pkg/helpbar/help.go → internal/helpbar/help.go
diff --git a/pkg/scope_selector/input.go → internal/scope_selector/input.go b/pkg/scope_selector/input.go → internal/scope_selector/input.go
@@ -7,10 +7,10 @@ import (
 
 	"github.com/atotto/clipboard"
 	tea "github.com/charmbracelet/bubbletea"
-	"github.com/skalt/git-cc/pkg/config"
-	"github.com/skalt/git-cc/pkg/helpbar"
+	"github.com/skalt/git-cc/internal/config"
+	"github.com/skalt/git-cc/internal/helpbar"
+	"github.com/skalt/git-cc/internal/single_select"
 	"github.com/skalt/git-cc/pkg/parser"
-	"github.com/skalt/git-cc/pkg/single_select"
 )
 
 const newScopeTemplate = "description of what short-form `%s` represents"

diff --git a/pkg/single_select/select.go → internal/single_select/select.go b/pkg/single_select/select.go → internal/single_select/select.go
diff --git a/pkg/type_selector/input.go → internal/type_selector/input.go b/pkg/type_selector/input.go → internal/type_selector/input.go
@@ -4,10 +4,10 @@ import (
 	"strings"
 
 	tea "github.com/charmbracelet/bubbletea"
-	"github.com/skalt/git-cc/pkg/config"
-	"github.com/skalt/git-cc/pkg/helpbar"
+	"github.com/skalt/git-cc/internal/config"
+	"github.com/skalt/git-cc/internal/helpbar"
+	"github.com/skalt/git-cc/internal/single_select"
 	"github.com/skalt/git-cc/pkg/parser"
-	"github.com/skalt/git-cc/pkg/single_select"
 )
 
 type Model struct {