Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: show project name either from config or from directory name #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
F1bonacc1 merged 3 commits into from
Jul 16, 2025
Merged

feat: show project name either from config or from directory name #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
461b4d1
feat: replace hostname/server name with project name
jcmuller Jul 15, 2025
66e80ca
feat: set the terminal title to the project name
jcmuller Jul 15, 2025
303fc9d
docs: commit missing swagger attributes
jcmuller Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion schemas/process-compose-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://github.com/f1bonacc1/process-compose/src/types/project","$ref":"#/$defs/Project","$defs":{"DependsOnConfig":{"additionalProperties":{"$ref":"#/$defs/ProcessDependency"},"type":"object"},"EnvCmd":{"additionalProperties":{"type":"string"},"type":"object"},"Environment":{"items":{"type":"string"},"type":"array"},"ExecProbe":{"properties":{"command":{"type":"string"},"working_dir":{"type":"string"}},"type":"object"},"HttpProbe":{"properties":{"host":{"type":"string"},"path":{"type":"string"},"scheme":{"type":"string"},"port":{"type":"string"},"num_port":{"type":"integer"}},"type":"object"},"LogRotationConfig":{"properties":{"directory":{"type":"string"},"filename":{"type":"string"},"max_size_mb":{"type":"integer"},"max_backups":{"type":"integer"},"max_age_days":{"type":"integer"},"compress":{"type":"boolean"}},"type":"object"},"LoggerConfig":{"properties":{"rotation":{"$ref":"#/$defs/LogRotationConfig"},"fields_order":{"items":{"type":"string"},"type":"array"},"disable_json":{"type":"boolean"},"timestamp_format":{"type":"string"},"no_color":{"type":"boolean"},"no_metadata":{"type":"boolean"},"add_timestamp":{"type":"boolean"},"flush_each_line":{"type":"boolean"}},"type":"object"},"Probe":{"properties":{"exec":{"$ref":"#/$defs/ExecProbe"},"http_get":{"$ref":"#/$defs/HttpProbe"},"initial_delay_seconds":{"type":"integer"},"period_seconds":{"type":"integer"},"timeout_seconds":{"type":"integer"},"success_threshold":{"type":"integer"},"failure_threshold":{"type":"integer"}},"type":"object"},"ProcessConfig":{"properties":{"name":{"type":"string"},"disabled":{"type":"boolean"},"is_daemon":{"type":"boolean"},"command":{"type":"string"},"entrypoint":{"items":{"type":"string"},"type":"array"},"log_location":{"type":"string"},"log_configuration":{"$ref":"#/$defs/LoggerConfig"},"environment":{"$ref":"#/$defs/Environment"},"availability":{"$ref":"#/$defs/RestartPolicyConfig"},"depends_on":{"$ref":"#/$defs/DependsOnConfig"},"liveness_probe":{"$ref":"#/$defs/Probe"},"readiness_probe":{"$ref":"#/$defs/Probe"},"ready_log_line":{"type":"string"},"shutdown":{"$ref":"#/$defs/ShutDownParams"},"disable_ansi_colors":{"type":"boolean"},"working_dir":{"type":"string"},"namespace":{"type":"string"},"replicas":{"type":"integer"},"description":{"type":"string"},"vars":{"$ref":"#/$defs/Vars"},"is_foreground":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_elevated":{"type":"boolean"},"launch_timeout_seconds":{"type":"integer"},"is_disabled":{"type":"string"},"is_dotenv_disabled":{"type":"boolean"},"original_config":{"type":"string"},"replica_num":{"type":"integer"},"replica_name":{"type":"string"},"executable":{"type":"string"},"args":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["name","original_config","replica_num","replica_name","executable","args"]},"ProcessDependency":{"properties":{"condition":{"type":"string"}},"type":"object"},"Processes":{"additionalProperties":{"$ref":"#/$defs/ProcessConfig"},"type":"object"},"Project":{"properties":{"version":{"type":"string"},"log_location":{"type":"string"},"log_level":{"type":"string"},"log_length":{"type":"integer"},"log_configuration":{"$ref":"#/$defs/LoggerConfig"},"log_format":{"type":"string"},"processes":{"$ref":"#/$defs/Processes"},"environment":{"$ref":"#/$defs/Environment"},"shell":{"$ref":"#/$defs/ShellConfig"},"is_strict":{"type":"boolean"},"vars":{"$ref":"#/$defs/Vars"},"disable_env_expansion":{"type":"boolean"},"is_tui_disabled":{"type":"boolean"},"extends":{"type":"string"},"env_cmds":{"$ref":"#/$defs/EnvCmd"},"file_names":{"items":{"type":"string"},"type":"array"},"env_file_names":{"items":{"type":"string"},"type":"array"},"dot_env_vars":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","required":["version","processes","file_names","env_file_names","dot_env_vars"]},"RestartPolicyConfig":{"properties":{"restart":{"type":"string"},"backoff_seconds":{"type":"integer"},"max_restarts":{"type":"integer"},"exit_on_end":{"type":"boolean"},"exit_on_skipped":{"type":"boolean"}},"type":"object"},"ShellConfig":{"properties":{"shell_command":{"type":"string"},"shell_argument":{"type":"string"},"elevated_shell_command":{"type":"string"},"elevated_shell_argument":{"type":"string"}},"type":"object","required":["shell_command","shell_argument"]},"ShutDownParams":{"properties":{"command":{"type":"string"},"timeout_seconds":{"type":"integer"},"signal":{"type":"integer"},"parent_only":{"type":"boolean"}},"type":"object"},"Vars":{"type":"object"}}}
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://github.com/f1bonacc1/process-compose/src/types/project","$ref":"#/$defs/Project","$defs":{"DependsOnConfig":{"additionalProperties":{"$ref":"#/$defs/ProcessDependency"},"type":"object"},"EnvCmd":{"additionalProperties":{"type":"string"},"type":"object"},"Environment":{"items":{"type":"string"},"type":"array"},"ExecProbe":{"properties":{"command":{"type":"string"},"working_dir":{"type":"string"}},"type":"object"},"HttpProbe":{"properties":{"host":{"type":"string"},"path":{"type":"string"},"scheme":{"type":"string"},"port":{"type":"string"},"num_port":{"type":"integer"}},"type":"object"},"LogRotationConfig":{"properties":{"directory":{"type":"string"},"filename":{"type":"string"},"max_size_mb":{"type":"integer"},"max_backups":{"type":"integer"},"max_age_days":{"type":"integer"},"compress":{"type":"boolean"}},"type":"object"},"LoggerConfig":{"properties":{"rotation":{"$ref":"#/$defs/LogRotationConfig"},"fields_order":{"items":{"type":"string"},"type":"array"},"disable_json":{"type":"boolean"},"timestamp_format":{"type":"string"},"no_color":{"type":"boolean"},"no_metadata":{"type":"boolean"},"add_timestamp":{"type":"boolean"},"flush_each_line":{"type":"boolean"}},"type":"object"},"Probe":{"properties":{"exec":{"$ref":"#/$defs/ExecProbe"},"http_get":{"$ref":"#/$defs/HttpProbe"},"initial_delay_seconds":{"type":"integer"},"period_seconds":{"type":"integer"},"timeout_seconds":{"type":"integer"},"success_threshold":{"type":"integer"},"failure_threshold":{"type":"integer"}},"type":"object"},"ProcessConfig":{"properties":{"name":{"type":"string"},"disabled":{"type":"boolean"},"is_daemon":{"type":"boolean"},"command":{"type":"string"},"entrypoint":{"items":{"type":"string"},"type":"array"},"log_location":{"type":"string"},"log_configuration":{"$ref":"#/$defs/LoggerConfig"},"environment":{"$ref":"#/$defs/Environment"},"availability":{"$ref":"#/$defs/RestartPolicyConfig"},"depends_on":{"$ref":"#/$defs/DependsOnConfig"},"liveness_probe":{"$ref":"#/$defs/Probe"},"readiness_probe":{"$ref":"#/$defs/Probe"},"ready_log_line":{"type":"string"},"shutdown":{"$ref":"#/$defs/ShutDownParams"},"disable_ansi_colors":{"type":"boolean"},"working_dir":{"type":"string"},"namespace":{"type":"string"},"replicas":{"type":"integer"},"description":{"type":"string"},"vars":{"$ref":"#/$defs/Vars"},"is_foreground":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_elevated":{"type":"boolean"},"launch_timeout_seconds":{"type":"integer"},"is_disabled":{"type":"string"},"is_dotenv_disabled":{"type":"boolean"},"original_config":{"type":"string"},"replica_num":{"type":"integer"},"replica_name":{"type":"string"},"executable":{"type":"string"},"args":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["name","original_config","replica_num","replica_name","executable","args"]},"ProcessDependency":{"properties":{"condition":{"type":"integer"}},"type":"object"},"Processes":{"additionalProperties":{"$ref":"#/$defs/ProcessConfig"},"type":"object"},"Project":{"properties":{"version":{"type":"string"},"name":{"type":"string"},"log_location":{"type":"string"},"log_level":{"type":"string"},"log_length":{"type":"integer"},"log_configuration":{"$ref":"#/$defs/LoggerConfig"},"log_format":{"type":"string"},"processes":{"$ref":"#/$defs/Processes"},"environment":{"$ref":"#/$defs/Environment"},"shell":{"$ref":"#/$defs/ShellConfig"},"is_strict":{"type":"boolean"},"vars":{"$ref":"#/$defs/Vars"},"disable_env_expansion":{"type":"boolean"},"is_tui_disabled":{"type":"boolean"},"extends":{"type":"string"},"env_cmds":{"$ref":"#/$defs/EnvCmd"},"file_names":{"items":{"type":"string"},"type":"array"},"env_file_names":{"items":{"type":"string"},"type":"array"},"dot_env_vars":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","required":["version","processes","file_names","env_file_names","dot_env_vars"]},"RestartPolicyConfig":{"properties":{"restart":{"type":"integer"},"backoff_seconds":{"type":"integer"},"max_restarts":{"type":"integer"},"exit_on_end":{"type":"boolean"},"exit_on_skipped":{"type":"boolean"}},"type":"object"},"ShellConfig":{"properties":{"shell_command":{"type":"string"},"shell_argument":{"type":"string"},"elevated_shell_command":{"type":"string"},"elevated_shell_argument":{"type":"string"}},"type":"object","required":["shell_command","shell_argument"]},"ShutDownParams":{"properties":{"command":{"type":"string"},"timeout_seconds":{"type":"integer"},"signal":{"type":"integer"},"parent_only":{"type":"boolean"}},"type":"object"},"Vars":{"type":"object"}}}
18 changes: 9 additions & 9 deletions src/api/pc_api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,22 +289,22 @@ func (api *PcApi) IsAlive(c *gin.Context) {
}

// @Schemes
// @Id GetHostName
// @Description Get process compose hostname
// @Tags Hostname
// @Summary Get Hostname
// @Id GetProjectName
// @Description Get process compose project name
// @Tags ProjectName
// @Summary Get Project Name
// @Produce json
// @Success 200 {object} map[string]string "Hostname"
// @Success 200 {object} map[string]string "ProjectName"
// @Failure 400 {object} map[string]string
// @Router /hostname [get]
func (api *PcApi) GetHostName(c *gin.Context) {
name, err := api.project.GetHostName()
// @Router /project/name [get]
func (api *PcApi) GetProjectName(c *gin.Context) {
name, err := api.project.GetProjectName()
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

c.JSON(http.StatusOK, gin.H{"name": name})
c.JSON(http.StatusOK, gin.H{"projectName": name})
}

// @Schemes
Expand Down
2 changes: 1 addition & 1 deletion src/api/routes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ func InitRoutes(useLogger bool, handler *PcApi) *gin.Engine {
})

r.GET("/live", handler.IsAlive)
r.GET("/hostname", handler.GetHostName)
r.GET("/processes", handler.GetProcesses)
r.GET("/process/:name", handler.GetProcess)
r.GET("/process/info/:name", handler.GetProcessInfo)
Expand All @@ -39,6 +38,7 @@ func InitRoutes(useLogger bool, handler *PcApi) *gin.Engine {
r.POST("/project/stop", handler.ShutDownProject)
r.POST("/project", handler.UpdateProject)
r.POST("/project/configuration", handler.ReloadProject)
r.GET("/project/name", handler.GetProjectName)
r.GET("/project/state", handler.GetProjectState)
r.PATCH("/process/scale/:name/:scale", handler.ScaleProcess)

Expand Down
2 changes: 1 addition & 1 deletion src/app/project_interface.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type IProject interface {
ShutDownProject() error
IsRemote() bool
ErrorForSecs() int
GetHostName() (string, error)
GetProjectName() (string, error)
GetProjectState(checkMem bool) (*types.ProjectState, error)

GetLogLength() int
Expand Down
34 changes: 25 additions & 9 deletions src/app/project_runner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/f1bonacc1/process-compose/src/types"
"os"
"os/user"
"path"
"runtime"
"slices"
"strings"
Expand Down Expand Up @@ -596,8 +597,23 @@ func (p *ProjectRunner) ErrorForSecs() int {
return 0
}

func (p *ProjectRunner) GetHostName() (string, error) {
return p.projectState.HostName, nil
func (p *ProjectRunner) GetProjectName() (string, error) {
hostname, err := os.Hostname()
if err != nil {
log.Err(err).Msg("Failed get hostname")
hostname = "unknown"
}

name := p.project.Name
if name == "" {
name, err = os.Getwd()
if err != nil {
log.Err(err).Msg("Failed get CWD")
name = "unknown"
}
}

return fmt.Sprintf("%s/%s", hostname, path.Base(name)), nil
}

func (p *ProjectRunner) getProcessLog(name string) (*pclog.ProcessLogBuffer, error) {
Expand Down Expand Up @@ -908,12 +924,6 @@ func bToMb(b uint64) uint64 {
}

func NewProjectRunner(opts *ProjectOpts) (*ProjectRunner, error) {

hostname, err := os.Hostname()
if err != nil {
log.Err(err).Msg("Failed get hostname")
hostname = "unknown"
}
current, err := user.Current()
username := "unknown-user"
if err != nil {
Expand All @@ -935,11 +945,17 @@ func NewProjectRunner(opts *ProjectOpts) (*ProjectRunner, error) {
FileNames: opts.project.FileNames,
StartTime: time.Now(),
UserName: username,
HostName: hostname,
Version: config.Version,
},
}

name, err := runner.GetProjectName()
if err != nil {
log.Err(err).Msg("Failed get project name")
} else {
runner.projectState.ProjectName = name
}

if opts.noDeps {
err = runner.selectRunningProcessesNoDeps(opts.processesToRun)
} else {
Expand Down
41 changes: 41 additions & 0 deletions src/app/project_runner_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package app
import (
"github.com/f1bonacc1/process-compose/src/types"
"reflect"
"strings"
"testing"
)

Expand Down Expand Up @@ -252,3 +253,43 @@ func TestProject_GetDependenciesOrderNames(t *testing.T) {
})
}
}

func TestProjectRunner_GetProjectName(t *testing.T) {
type fields struct{ Name string }
tests := []struct {
name string
fields fields
want string
wantErr bool
}{
{
name: "ShouldContain_project name",
fields: fields{Name: "project name"},
want: "project name",
},
{
name: "ShouldContain_app",
want: "app",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
p := &ProjectRunner{
project: &types.Project{
Name: tt.fields.Name,
},
}

got, err := p.GetProjectName()
if (err != nil) != tt.wantErr {
t.Errorf("ProjectRunner.GetProjectName() error = %v, wantErr %v", err, nil)
return
}

if !strings.Contains(got, tt.want) {
t.Errorf("ProjectRunner.GetProjectName() = %s, want %s", got, tt.want)
}
})
}
}
4 changes: 2 additions & 2 deletions src/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ func (p *PcClient) IsRemote() bool {
return true
}

func (p *PcClient) GetHostName() (string, error) {
return p.getHostName()
func (p *PcClient) GetProjectName() (string, error) {
return p.getProjectName()
}

func (p *PcClient) GetLogLength() int {
Expand Down
6 changes: 3 additions & 3 deletions src/client/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ func (p *PcClient) isAlive() error {
return nil
}

func (p *PcClient) getHostName() (string, error) {
url := fmt.Sprintf("http://%s/hostname", p.address)
func (p *PcClient) getProjectName() (string, error) {
url := fmt.Sprintf("http://%s/project/name", p.address)
resp, err := p.client.Get(url)
if err != nil {
return "", err
Expand All @@ -37,5 +37,5 @@ func (p *PcClient) getHostName() (string, error) {
log.Err(err).Send()
return "", err
}
return nameMap["name"], nil
return nameMap["projectName"], nil
}
2 changes: 2 additions & 0 deletions src/cmd/project_runner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"github.com/f1bonacc1/process-compose/src/config"
"github.com/f1bonacc1/process-compose/src/loader"
"github.com/f1bonacc1/process-compose/src/tui"
"github.com/f1bonacc1/process-compose/src/util"
"github.com/rs/zerolog/log"
"os"
"os/signal"
Expand Down Expand Up @@ -68,6 +69,7 @@ func setSignal(signalHandler func()) {
}

func runHeadless(project *app.ProjectRunner) error {
util.SetProjectNameAsTerminalTitle(project)
setSignal(func() {
_ = project.ShutDownProject()
})
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func printState(state *types.ProjectState) {
green := col.SprintFunc()

longestKey := len("Running Processes")
printStateLine("Hostname", state.HostName, longestKey, green)
printStateLine("Project", state.ProjectName, longestKey, green)
printStateLine("User", state.UserName, longestKey, green)
printStateLine("Version", state.Version, longestKey, green)
printStateLine("Up Time", state.UpTime.Round(time.Second).String(), longestKey, green)
Expand Down
Loading