refactor(cmd/joj3): move stage to main package

cmd/joj3/main.go

@@ -11,8 +11,7 @@ import (
 
 	joj3Conf "github.com/joint-online-judge/JOJ3/cmd/joj3/conf"
 	"github.com/joint-online-judge/JOJ3/cmd/joj3/env"
-	"github.com/joint-online-judge/JOJ3/cmd/joj3/stage"
-	internalStage "github.com/joint-online-judge/JOJ3/internal/stage"
+	"github.com/joint-online-judge/JOJ3/internal/stage"
 )
 
 var (
@@ -92,11 +91,11 @@ func mainImpl() (err error) {
 	groups := joj3Conf.MatchGroups(conf, conventionalCommit)
 	env.Attr.Groups = strings.Join(groups, ",")
 	env.Set()
-	_, forceQuitStageName, err := stage.Run(
+	_, forceQuitStageName, err := runStages(
 		conf,
 		groups,
 		func(
-			stageResults []internalStage.StageResult,
+			stageResults []stage.StageResult,
 			forceQuitStageName string,
 		) {
 			env.Attr.ForceQuitStageName = forceQuitStageName

cmd/joj3/stage.go

@@ -1,12 +1,14 @@
-package stage
+package main
 
 import (
+	"encoding/json"
 	"fmt"
 	"log/slog"
+	"os"
 	"strings"
 
 	"github.com/joint-online-judge/JOJ3/cmd/joj3/conf"
-	executors "github.com/joint-online-judge/JOJ3/internal/executor"
+	"github.com/joint-online-judge/JOJ3/internal/executor"
 	_ "github.com/joint-online-judge/JOJ3/internal/parser"
 	"github.com/joint-online-judge/JOJ3/internal/stage"
 
@@ -132,14 +134,14 @@ func newErrorStageResults(err error) ([]stage.StageResult, string) {
 	}, "Internal Error"
 }
 
-func Run(
+func runStages(
 	conf *conf.Conf,
 	groups []string,
 	onStagesComplete func([]stage.StageResult, string),
 ) (
 	stageResults []stage.StageResult, forceQuitStageName string, err error,
 ) {
-	executors.InitWithConf(
+	executor.InitWithConf(
 		conf.Stage.SandboxExecServer,
 		conf.Stage.SandboxToken,
 	)
@@ -175,8 +177,16 @@ func Run(
 		stageResults, forceQuitStageName = newErrorStageResults(err)
 	}
 	onStagesComplete(stageResults, forceQuitStageName)
-	slog.Info("write stageResults")
-	if err = Write(conf.Stage.OutputPath, stageResults); err != nil {
+	slog.Info("output result start", "path", conf.Stage.OutputPath)
+	slog.Debug("output result start",
+		"path", conf.Stage.OutputPath, "results", stageResults)
+	content, err := json.Marshal(stageResults)
+	if err != nil {
+		slog.Error("marshal stageResults", "error", err)
+	}
+	err = os.WriteFile(conf.Stage.OutputPath,
+		append(content, []byte("\n")...), 0o600)
+	if err != nil {
 		slog.Error("write stageResults", "error", err)
 	}
 	slog.Info("run postStages")

cmd/joj3/stage/write.go

@@ -1,20 +0,0 @@
-package stage
-
-import (
-	"encoding/json"
-	"log/slog"
-	"os"
-
-	"github.com/joint-online-judge/JOJ3/internal/stage"
-)
-
-func Write(outputPath string, results []stage.StageResult) error {
-	slog.Info("output result start", "path", outputPath)
-	slog.Debug("output result start", "path", outputPath, "results", results)
-	content, err := json.Marshal(results)
-	if err != nil {
-		return err
-	}
-	return os.WriteFile(outputPath,
-		append(content, []byte("\n")...), 0o600)
-}

internal/executor/all.go

@@ -1,4 +1,5 @@
-package executors
+// Package executor contains all the executors.
+package executor
 
 import (
 	_ "github.com/joint-online-judge/JOJ3/internal/executor/dummy"

internal/parser/all.go

@@ -1,4 +1,5 @@
-package parsers
+// Package parser contains all the parsers.
+package parser
 
 import (
 	_ "github.com/joint-online-judge/JOJ3/internal/parser/clangtidy"

internal/parser/clangtidy/convert.go

@@ -1,4 +1,3 @@
-// Referenced from https://github.com/yuriisk/clang-tidy-converter/blob/master/clang_tidy_converter/parser/clang_tidy_parser.py
 package clangtidy
 
 import (
@@ -9,6 +8,7 @@ import (
 	"strings"
 )
 
+// Referenced from https://github.com/yuriisk/clang-tidy-converter/blob/master/clang_tidy_converter/parser/clang_tidy_parser.py
 type Level int
 
 const (

internal/parser/plugin/meta.go

@@ -2,7 +2,6 @@
 // dynamically. It is used for custom parsers.
 // The plugin needs to be located at `ModPath` and export a symbol with name
 // `SymName` that implements the stage.Parser interface.
-
 package plugin
 
 import "github.com/joint-online-judge/JOJ3/internal/stage"

internal/parser/tierscore/meta.go

@@ -1,6 +1,5 @@
 // Package tierscore provides a parser for tiered scoring based on
 // time and memory constraints. Leave the field empty or 0 to disable.
-
 package tierscore
 
 import "github.com/joint-online-judge/JOJ3/internal/stage"

internal/stage/run.go

@@ -1,3 +1,6 @@
+// Package stage provides functionality to run stages. Each stage contains an
+// executor and multiple parsers. The executor executes the command and parsers
+// parse the output generated by the executor.
 package stage
 
 import (

pkg/healthcheck/all.go

@@ -1,3 +1,4 @@
+// Package healthcheck provides a set of health checks for a repository.
 package healthcheck
 
 import (

pkg/sample/sample.go

@@ -1,3 +1,4 @@
+// Package sample provides a sample function that returns a Result.
 package sample
 
 import (