feat: add project validation commands for fixing, formatting and validating code

Author: shyim

cmd/project/project_fix.go

@@ -0,0 +1,74 @@
+package project
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/sync/errgroup"
+
+	"github.com/shopware/shopware-cli/internal/verifier"
+)
+
+var projectFixCmd = &cobra.Command{
+	Use:   "fix",
+	Short: "Fix project",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		allowNonGit, _ := cmd.Flags().GetBool("allow-non-git")
+		gitPath := filepath.Join(args[0], ".git")
+		if !allowNonGit {
+			if stat, err := os.Stat(gitPath); err != nil || !stat.IsDir() {
+				return fmt.Errorf("provided folder is not a git repository. Use --allow-non-git flag to run anyway")
+			}
+		}
+
+		var err error
+		only, _ := cmd.Flags().GetString("only")
+
+		projectPath := ""
+
+		if len(args) > 0 {
+			projectPath = args[0]
+		} else {
+			projectPath, err = findClosestShopwareProject()
+			if err != nil {
+				return err
+			}
+		}
+
+		projectPath, err = filepath.Abs(projectPath)
+		if err != nil {
+			return fmt.Errorf("cannot find path: %w", err)
+		}
+
+		toolCfg, err := verifier.GetConfigFromProject(projectPath)
+		if err != nil {
+			return err
+		}
+
+		var gr errgroup.Group
+
+		tools := verifier.GetTools()
+
+		tools, err = tools.Only(only)
+		if err != nil {
+			return err
+		}
+
+		for _, tool := range tools {
+			tool := tool
+			gr.Go(func() error {
+				return tool.Fix(cmd.Context(), *toolCfg)
+			})
+		}
+
+		return gr.Wait()
+	},
+}
+
+func init() {
+	projectRootCmd.AddCommand(projectFixCmd)
+	projectFixCmd.PersistentFlags().String("only", "", "Run only specific tools by name (comma-separated, e.g. phpstan,eslint)")
+	projectFixCmd.PersistentFlags().Bool("allow-non-git", false, "Allow running on non git repositories")
+}

cmd/project/project_format.go

@@ -0,0 +1,66 @@
+package project
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/sync/errgroup"
+
+	"github.com/shopware/shopware-cli/internal/verifier"
+)
+
+var projectFormatCmd = &cobra.Command{
+	Use:   "format",
+	Short: "Format project",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		var err error
+		only, _ := cmd.Flags().GetString("only")
+		dryRun, _ := cmd.Flags().GetBool("dry-run")
+
+		projectPath := ""
+
+		if len(args) > 0 {
+			projectPath = args[0]
+		} else {
+			projectPath, err = findClosestShopwareProject()
+			if err != nil {
+				return err
+			}
+		}
+
+		projectPath, err = filepath.Abs(projectPath)
+		if err != nil {
+			return fmt.Errorf("cannot find path: %w", err)
+		}
+
+		toolCfg, err := verifier.GetConfigFromProject(projectPath)
+		if err != nil {
+			return err
+		}
+
+		var gr errgroup.Group
+
+		tools := verifier.GetTools()
+
+		tools, err = tools.Only(only)
+		if err != nil {
+			return err
+		}
+
+		for _, tool := range tools {
+			tool := tool
+			gr.Go(func() error {
+				return tool.Format(cmd.Context(), *toolCfg, dryRun)
+			})
+		}
+
+		return gr.Wait()
+	},
+}
+
+func init() {
+	projectRootCmd.AddCommand(projectFormatCmd)
+	projectFormatCmd.PersistentFlags().String("only", "", "Run only specific tools by name (comma-separated, e.g. phpstan,eslint)")
+	projectFormatCmd.PersistentFlags().Bool("dry-run", false, "Run tools in dry run mode")
+}

cmd/project/project_validate.go

@@ -0,0 +1,85 @@
+package project
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/sync/errgroup"
+
+	"github.com/shopware/shopware-cli/internal/system"
+	"github.com/shopware/shopware-cli/internal/verifier"
+)
+
+var projectValidateCmd = &cobra.Command{
+	Use:   "validate",
+	Short: "Validate project",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		reportingFormat, _ := cmd.Flags().GetString("reporter")
+		only, _ := cmd.Flags().GetString("only")
+		tmpDir, err := os.MkdirTemp(os.TempDir(), "analyse-project-*")
+		if err != nil {
+			return fmt.Errorf("cannot create temporary directory: %w", err)
+		}
+
+		projectPath := ""
+
+		if len(args) > 0 {
+			projectPath = args[0]
+		} else {
+			projectPath, err = findClosestShopwareProject()
+			if err != nil {
+				return err
+			}
+		}
+
+		projectPath, err = filepath.Abs(projectPath)
+		if err != nil {
+			return fmt.Errorf("cannot find path: %w", err)
+		}
+
+		if reportingFormat == "" {
+			reportingFormat = verifier.DetectDefaultReporter()
+		}
+
+		if err := system.CopyFiles(projectPath, tmpDir); err != nil {
+			return err
+		}
+
+		toolCfg, err := verifier.GetConfigFromProject(tmpDir)
+		if err != nil {
+			return err
+		}
+
+		result := verifier.NewCheck()
+
+		var gr errgroup.Group
+
+		tools := verifier.GetTools()
+
+		tools, err = tools.Only(only)
+		if err != nil {
+			return err
+		}
+
+		for _, tool := range tools {
+			tool := tool
+			gr.Go(func() error {
+				return tool.Check(cmd.Context(), result, *toolCfg)
+			})
+		}
+
+		if err := gr.Wait(); err != nil {
+			return err
+		}
+
+		return verifier.DoCheckReport(result.RemoveByIdentifier(toolCfg.ValidationIgnores), reportingFormat)
+	},
+}
+
+func init() {
+	projectRootCmd.AddCommand(projectValidateCmd)
+	projectValidateCmd.PersistentFlags().String("reporter", "", "Reporting format (summary, json, github, junit, markdown)")
+	projectValidateCmd.PersistentFlags().String("only", "", "Run only specific tools by name (comma-separated, e.g. phpstan,eslint)")
+}