feat!: migrate to Go module v2 with enhanced documentation

M0Rf30 · M0Rf30 · commit b3048ced66fc · 2025-08-07T21:30:20.000+02:00
BREAKING CHANGE: Module path changed from github.com/M0Rf30/yap to github.com/M0Rf30/yap/v2

- Update module path to github.com/M0Rf30/yap/v2 for proper semantic versioning
- Migrate all internal import paths to use v2 module references
- Update Go version requirement to 1.24 for latest language features
- Add comprehensive module-level documentation in doc.go
- Ensure all 40+ Go source files use correct v2 import paths
- Maintain full backward compatibility within v2 major version
- Prepare module for pkg.go.dev discovery and distribution

This migration enables proper semantic versioning and allows users to
import stable v2 packages while maintaining the ability to release
breaking changes in future major versions.

Import paths now use: github.com/M0Rf30/yap/v2/pkg/*
diff --git a/cmd/yap/command/build.go b/cmd/yap/command/build.go
@@ -8,11 +8,11 @@ import (
 
 	"github.com/spf13/cobra"
 
-	yapErrors "github.com/M0Rf30/yap/pkg/errors"
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/parser"
-	"github.com/M0Rf30/yap/pkg/project"
-	"github.com/M0Rf30/yap/pkg/source"
+	yapErrors "github.com/M0Rf30/yap/v2/pkg/errors"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/parser"
+	"github.com/M0Rf30/yap/v2/pkg/project"
+	"github.com/M0Rf30/yap/v2/pkg/source"
 )
 
 // buildCmd represents the command to build the entire project.
diff --git a/cmd/yap/command/completion.go b/cmd/yap/command/completion.go
@@ -3,7 +3,7 @@ package command
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // completionCmd represents the completion command.
diff --git a/cmd/yap/command/help_formatting.go b/cmd/yap/command/help_formatting.go
@@ -8,7 +8,7 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // SetupEnhancedHelp configures enhanced help formatting for commands.
diff --git a/cmd/yap/command/list_distros.go b/cmd/yap/command/list_distros.go
@@ -4,7 +4,7 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
 )
 
 // listDistrosCmd represents the listDistros command.
diff --git a/cmd/yap/command/prepare.go b/cmd/yap/command/prepare.go
@@ -5,10 +5,10 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/packer"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
-	"github.com/M0Rf30/yap/pkg/project"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/packer"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/project"
 )
 
 var (
diff --git a/cmd/yap/command/pull.go b/cmd/yap/command/pull.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // pullCmd represents the pull command.
diff --git a/cmd/yap/command/root.go b/cmd/yap/command/root.go
@@ -6,7 +6,7 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 var (
diff --git a/cmd/yap/command/smart_help.go b/cmd/yap/command/smart_help.go
@@ -7,8 +7,8 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 const (
diff --git a/cmd/yap/command/status.go b/cmd/yap/command/status.go
@@ -9,8 +9,8 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // statusCmd provides system and environment information.
diff --git a/cmd/yap/command/validation.go b/cmd/yap/command/validation.go
@@ -9,8 +9,8 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // Static error definitions to satisfy err113 linter.
diff --git a/cmd/yap/command/version.go b/cmd/yap/command/version.go
@@ -10,7 +10,7 @@ import (
 	"github.com/pterm/pterm/putils"
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
 )
 
 var versionCmd = &cobra.Command{
diff --git a/cmd/yap/command/zap.go b/cmd/yap/command/zap.go
@@ -6,8 +6,8 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/project"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/project"
 )
 
 // zapCmd represents the command to deeply clean build environments.
diff --git a/cmd/yap/yap.go b/cmd/yap/yap.go
@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/M0Rf30/yap/cmd/yap/command"
+	"github.com/M0Rf30/yap/v2/cmd/yap/command"
 )
 
 // main is the entry point of the Go program.
diff --git a/doc.go b/doc.go
@@ -0,0 +1,49 @@
+// Package yap provides a powerful, container-based package building system
+// that creates packages for multiple GNU/Linux distributions from a single
+// PKGBUILD-like specification format.
+//
+// YAP (Yet Another Packager) eliminates the need to learn multiple packaging
+// formats by providing a unified interface based on the familiar PKGBUILD
+// format from Arch Linux, extended with multi-distribution support and
+// modern container-based builds.
+//
+// # Key Features
+//
+//   - Multi-format package support: RPM, DEB, APK, TAR.ZST packages
+//   - Container-based isolation for clean, reproducible builds
+//   - Dependency-aware build orchestration with project management
+//   - PKGBUILD compatibility with enhanced parsing capabilities
+//   - Component-aware structured logging system
+//
+// # Supported Distributions
+//
+// YAP supports building packages for Alpine, Arch, CentOS, Debian, Fedora,
+// OpenSUSE, Rocky, Ubuntu, and more.
+//
+// # Usage
+//
+// The primary way to use YAP is through its command-line interface:
+//
+//	// Build for current system distribution
+//	yap build .
+//
+//	// Build for specific distribution
+//	yap build ubuntu-jammy /path/to/project
+//
+//	// Prepare build environment
+//	yap prepare fedora-38
+//
+// # Package Structure
+//
+// YAP is organized into several key packages:
+//
+//   - pkg/project: Project configuration and orchestration
+//   - pkg/parser: PKGBUILD parsing and processing
+//   - pkg/packer: Package format implementations (RPM, DEB, APK, etc.)
+//   - pkg/source: Source code retrieval and management
+//   - pkg/builder: Container-based build execution
+//   - pkg/logger: Component-aware structured logging
+//   - pkg/osutils: Operating system utilities and helpers
+//
+// For detailed documentation and examples, visit https://github.com/M0Rf30/yap
+package main
diff --git a/go.mod b/go.mod
@@ -1,7 +1,9 @@
-module github.com/M0Rf30/yap
+module github.com/M0Rf30/yap/v2
 
 go 1.24
 
+toolchain go1.24.6
+
 require (
 	github.com/blakesmith/ar v0.0.0-20190502131153-809d4375e1fb
 	github.com/cavaliergopher/grab/v3 v3.0.1
diff --git a/pkg/abuild/abuild.go b/pkg/abuild/abuild.go
@@ -23,9 +23,9 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 // Apk represents the APK package manager.
diff --git a/pkg/abuild/abuild_test.go b/pkg/abuild/abuild_test.go
@@ -8,8 +8,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/M0Rf30/yap/pkg/abuild"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/abuild"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 func TestApk_BuildPackage(t *testing.T) {
diff --git a/pkg/builder/builder.go b/pkg/builder/builder.go
@@ -3,10 +3,10 @@ package builder
 import (
 	"sync"
 
-	"github.com/M0Rf30/yap/pkg/errors"
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
-	"github.com/M0Rf30/yap/pkg/source"
+	"github.com/M0Rf30/yap/v2/pkg/errors"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/source"
 )
 
 // Builder maps PKGBUILD to generic functions aimed at artifacts generation.
diff --git a/pkg/builder/builder_test.go b/pkg/builder/builder_test.go
@@ -8,8 +8,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/M0Rf30/yap/pkg/builder"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/builder"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 func TestNewBuilder(t *testing.T) {
diff --git a/pkg/constants/constants.go b/pkg/constants/constants.go
@@ -3,7 +3,7 @@ package constants
 import (
 	"strings"
 
-	"github.com/M0Rf30/yap/pkg/set"
+	"github.com/M0Rf30/yap/v2/pkg/set"
 )
 
 const (
diff --git a/pkg/context/context.go b/pkg/context/context.go
@@ -5,7 +5,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/M0Rf30/yap/pkg/logger"
+	"github.com/M0Rf30/yap/v2/pkg/logger"
 )
 
 // contextKey is a custom type for context keys to avoid collisions.
diff --git a/pkg/context/context_test.go b/pkg/context/context_test.go
@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/M0Rf30/yap/pkg/logger"
+	"github.com/M0Rf30/yap/v2/pkg/logger"
 )
 
 func TestNewBuildContext(t *testing.T) {
diff --git a/pkg/dpkg/dpkg.go b/pkg/dpkg/dpkg.go
@@ -11,9 +11,9 @@ import (
 	"github.com/blakesmith/ar"
 	"github.com/otiai10/copy"
 
-	"github.com/M0Rf30/yap/pkg/options"
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/options"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 // Deb represents a Deb package.
diff --git a/pkg/dpkg/dpkg_test.go b/pkg/dpkg/dpkg_test.go
@@ -10,8 +10,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/M0Rf30/yap/pkg/dpkg"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/dpkg"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 func TestDeb_BuildPackage(t *testing.T) {
diff --git a/pkg/integration_test.go b/pkg/integration_test.go
@@ -7,9 +7,9 @@ import (
 	"os"
 	"time"
 
-	yapcontext "github.com/M0Rf30/yap/pkg/context"
-	"github.com/M0Rf30/yap/pkg/errors"
-	"github.com/M0Rf30/yap/pkg/logger"
+	yapcontext "github.com/M0Rf30/yap/v2/pkg/context"
+	"github.com/M0Rf30/yap/v2/pkg/errors"
+	"github.com/M0Rf30/yap/v2/pkg/logger"
 )
 
 // Static errors for err113 compliance.
diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go
@@ -11,7 +11,7 @@ import (
 	"runtime"
 	"time"
 
-	yaperrors "github.com/M0Rf30/yap/pkg/errors"
+	yaperrors "github.com/M0Rf30/yap/v2/pkg/errors"
 )
 
 // LogLevel represents the severity level of log messages.
diff --git a/pkg/logger/logger_test.go b/pkg/logger/logger_test.go
@@ -13,7 +13,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	yaperrors "github.com/M0Rf30/yap/pkg/errors"
+	yaperrors "github.com/M0Rf30/yap/v2/pkg/errors"
 )
 
 func TestLogLevel_String(t *testing.T) {
diff --git a/pkg/makepkg/makepkg.go b/pkg/makepkg/makepkg.go
@@ -14,9 +14,9 @@ import (
 
 	"github.com/klauspost/pgzip"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	"github.com/M0Rf30/yap/pkg/osutils"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 // Pkg represents a package manager for the Pkg distribution.
diff --git a/pkg/makepkg/makepkg_test.go b/pkg/makepkg/makepkg_test.go
@@ -12,8 +12,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/M0Rf30/yap/pkg/makepkg"
-	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/v2/pkg/makepkg"
+	"github.com/M0Rf30/yap/v2/pkg/pkgbuild"
 )
 
 func TestPkg_BuildPackage(t *testing.T) {
diff --git a/pkg/options/strip.go b/pkg/options/strip.go
@@ -6,7 +6,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 // Strip walks through the directory to process each file.
diff --git a/pkg/osutils/file_test.go b/pkg/osutils/file_test.go
@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/M0Rf30/yap/pkg/osutils"
+	"github.com/M0Rf30/yap/v2/pkg/osutils"
 )
 
 const nonexistentFilePath = "/nonexistent/file.txt"
diff --git a/pkg/osutils/utils.go b/pkg/osutils/utils.go
@@ -23,8 +23,8 @@ import (
 	"mvdan.cc/sh/v3/interp"
 	"mvdan.cc/sh/v3/syntax"
 
-	"github.com/M0Rf30/yap/pkg/constants"
-	ycontext "github.com/M0Rf30/yap/pkg/context"
+	"github.com/M0Rf30/yap/v2/pkg/constants"
+	ycontext "github.com/M0Rf30/yap/v2/pkg/context"
 )
 
 const (
diff --git a/pkg/packer/packer.go b/pkg/packer/packer.go
diff --git a/pkg/packer/packer_test.go b/pkg/packer/packer_test.go
diff --git a/pkg/parser/additional_parser_test.go b/pkg/parser/additional_parser_test.go
diff --git a/pkg/parser/parser.go b/pkg/parser/parser.go
diff --git a/pkg/parser/parser_test.go b/pkg/parser/parser_test.go
diff --git a/pkg/pkgbuild/pkgbuild.go b/pkg/pkgbuild/pkgbuild.go
diff --git a/pkg/project/project.go b/pkg/project/project.go
diff --git a/pkg/project/project_test.go b/pkg/project/project_test.go
diff --git a/pkg/rpm/rpm.go b/pkg/rpm/rpm.go
diff --git a/pkg/rpm/rpm_test.go b/pkg/rpm/rpm_test.go
diff --git a/pkg/source/source.go b/pkg/source/source.go
diff --git a/pkg/source/source_test.go b/pkg/source/source_test.go

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ package command`
`3`	`3`	`import (`
`4`	`4`	`"github.com/spf13/cobra"`
`5`	`5`
`6`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`6`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`7`	`7`	`)`
`8`	`8`
`9`	`9`	`// completionCmd represents the completion command.`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"github.com/pterm/pterm"`
`9`	`9`	`"github.com/spf13/cobra"`
`10`	`10`
`11`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`11`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`// SetupEnhancedHelp configures enhanced help formatting for commands.`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import (`
`4`	`4`	`"github.com/pterm/pterm"`
`5`	`5`	`"github.com/spf13/cobra"`
`6`	`6`
`7`		`- "github.com/M0Rf30/yap/pkg/constants"`
	`7`	`+ "github.com/M0Rf30/yap/v2/pkg/constants"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`// listDistrosCmd represents the listDistros command.`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/spf13/cobra"`
`7`	`7`
`8`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`8`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`// pullCmd represents the pull command.`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"github.com/pterm/pterm"`
`7`	`7`	`"github.com/spf13/cobra"`
`8`	`8`
`9`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`9`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`var (`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@ import (`
`7`	`7`	`"github.com/pterm/pterm"`
`8`	`8`	`"github.com/spf13/cobra"`
`9`	`9`
`10`		`- "github.com/M0Rf30/yap/pkg/constants"`
`11`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`10`	`+ "github.com/M0Rf30/yap/v2/pkg/constants"`
	`11`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,8 @@ import (`
`9`	`9`	`"github.com/pterm/pterm"`
`10`	`10`	`"github.com/spf13/cobra"`
`11`	`11`
`12`		`- "github.com/M0Rf30/yap/pkg/constants"`
`13`		`- "github.com/M0Rf30/yap/pkg/osutils"`
	`12`	`+ "github.com/M0Rf30/yap/v2/pkg/constants"`
	`13`	`+ "github.com/M0Rf30/yap/v2/pkg/osutils"`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`// statusCmd provides system and environment information.`