mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-01-26 11:14:04 +00:00
Ismo Vuorinen
4f12c4d3dd
* chore(lint): added nlreturn, run linting * chore(lint): replace some fmt.Sprintf calls * chore(lint): replace fmt.Sprintf with strconv * chore(lint): add goconst, use http lib for status codes, and methods * chore(lint): use errors lib, errCodes from internal/errors * chore(lint): dupl, thelper and usetesting * chore(lint): fmt.Errorf %v to %w, more linters * chore(lint): paralleltest, where possible * perf(test): optimize test performance by 78% - Implement shared binary building with package-level cache to eliminate redundant builds - Add strategic parallelization to 15+ tests while preserving environment variable isolation - Implement thread-safe fixture caching with RWMutex to reduce I/O operations - Remove unnecessary working directory changes by leveraging embedded templates - Add embedded template system with go:embed directive for reliable template resolution - Fix linting issues: rename sharedBinaryError to errSharedBinary, add nolint directive Performance improvements: - Total test execution time: 12+ seconds → 2.7 seconds (78% faster) - Binary build overhead: 14+ separate builds → 1 shared build (93% reduction) - Parallel execution: Limited → 15+ concurrent tests (60-70% better CPU usage) - I/O operations: 66+ fixture reads → cached with sync.RWMutex (50% reduction) All tests maintain 100% success rate and coverage while running nearly 4x faster.
60 lines
1.5 KiB
Go
60 lines
1.5 KiB
Go
// Package helpers provides helper functions used across the application.
|
|
package helpers
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/ivuorinen/gh-action-readme/internal"
|
|
"github.com/ivuorinen/gh-action-readme/internal/git"
|
|
)
|
|
|
|
// GetCurrentDir gets current working directory with standardized error handling.
|
|
func GetCurrentDir() (string, error) {
|
|
currentDir, err := os.Getwd()
|
|
if err != nil {
|
|
return "", fmt.Errorf("error getting current directory: %w", err)
|
|
}
|
|
|
|
return currentDir, nil
|
|
}
|
|
|
|
// SetupGeneratorContext creates a generator with proper setup and current directory.
|
|
func SetupGeneratorContext(config *internal.AppConfig) (*internal.Generator, string, error) {
|
|
generator := internal.NewGenerator(config)
|
|
output := generator.Output
|
|
|
|
if config.Verbose {
|
|
output.Info("Using config: %+v", config)
|
|
}
|
|
|
|
currentDir, err := GetCurrentDir()
|
|
if err != nil {
|
|
return nil, "", err
|
|
}
|
|
|
|
return generator, currentDir, nil
|
|
}
|
|
|
|
// FindGitRepoRoot finds git repository root with standardized error handling.
|
|
func FindGitRepoRoot(currentDir string) string {
|
|
repoRoot, _ := git.FindRepositoryRoot(currentDir)
|
|
|
|
return repoRoot
|
|
}
|
|
|
|
// GetGitRepoRootAndInfo gets git repository root and info with error handling.
|
|
func GetGitRepoRootAndInfo(startPath string) (string, *git.RepoInfo, error) {
|
|
repoRoot, err := git.FindRepositoryRoot(startPath)
|
|
if err != nil {
|
|
return "", nil, err
|
|
}
|
|
|
|
gitInfo, err := git.DetectRepository(repoRoot)
|
|
if err != nil {
|
|
return repoRoot, nil, err
|
|
}
|
|
|
|
return repoRoot, gitInfo, nil
|
|
}
|