Merge pull request #7 from orenoi/pr

🛠️ Restructure CLI, implement version handling, and add install script

Author: axrona

Makefile

@@ -1,7 +1,11 @@
 BINARY := pulsarship
 BUILD_DIR := build
-VERSION := $(shell git describe --tags --always --dirty)
-#LDFLAGS := -s -w -X main.version=$(VERSION)
+VERSION := $(shell git describe --tags --abbrev=0)
+TAG := $(shell git describe --tags --abbrev=0)
+COMMIT := $(shell git rev-parse --short HEAD)
+BUILDTIME := $(shell date -u +%Y-%m-%dT%H:%M:%SZ)
+BUILDENV := $(shell go version)
+LDFLAGS := -X 'main.version=$(VERSION)' -X 'main.tag=$(TAG)' -X 'main.commit=$(COMMIT)' -X 'main.buildTime=$(BUILDTIME)' -X 'main.buildEnv=$(BUILDENV)'
 
 GOCMD := go
 GOBUILD := $(GOCMD) build
@@ -15,8 +19,7 @@ all: fmt vet test build install
 
 .PHONY: build
 build:
-#	$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY) .
-	$(GOBUILD) -o $(BUILD_DIR)/$(BINARY) .
+	$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY) .
 
 .PHONY: install
 install: build

README.md

@@ -54,13 +54,15 @@ or
 paru -S pulsarship
 ```
 
-### 🛠️ Manual Installation
+### 🛠️ Install via Script
+You can install `pulsarship` with a single command:
+
 ```bash
-git clone https://github.com/xeyossr/pulsarship
-cd pulsarship
-make install
+curl -sS https://raw.githubusercontent.com/xeyossr/pulsarship/main/install.sh | bash
 ```
 
+This script will clone the repository, build the binary, and install it for you.
+
 ### 🔧 Add to your shell config
 Add the following to your `~/.config/fish/config.fish`:
 **Fish:**

aur/.SRCINFO

@@ -1,13 +1,16 @@
 pkgbase = pulsarship
 	pkgdesc = 🚀🌠 A minimal, fast, and customizable prompt written in Go
-	pkgver = 0.2.1
+	pkgver = 0.2.2
 	pkgrel = 1
 	url = https://github.com/xeyossr/pulsarship
 	arch = x86_64
+	arch = aarch64
+	arch = armv7h
+	arch = i686
 	license = GPL3
 	makedepends = go
 	makedepends = git
-	source = git+https://github.com/xeyossr/pulsarship.git#tag=v0.2.1
+	source = git+https://github.com/xeyossr/pulsarship.git#tag=v0.2.2
 	sha256sums = SKIP
 
 pkgname = pulsarship

aur/PKGBUILD

@@ -1,10 +1,10 @@
 # Maintainer: kamisaki
 # Description: 🚀🌠 A minimal, fast, and customizable prompt written in Go
 pkgname=pulsarship
-pkgver=0.2.1
+pkgver=0.2.2
 pkgrel=1
 pkgdesc="🚀🌠 A minimal, fast, and customizable prompt written in Go"
-arch=('x86_64')
+arch=('x86_64' 'aarch64' 'armv7h' 'i686')
 url="https://github.com/xeyossr/pulsarship"
 license=('GPL3')
 depends=()
@@ -17,11 +17,22 @@ sha256sums=('SKIP')
 
 build() {
     cd "$srcdir/${pkgname}"
+
+    # Fetch version, tag, commit, build time, and build environment dynamically
+    TAG=$(git describe --tags)
+    COMMIT=$(git rev-parse --short HEAD)
+    BUILDTIME=$(date -u +%Y-%m-%dT%H:%M:%SZ)
+    BUILDENV=$(go version)
+
+    LDFLAGS="-X main.version=${pkgver} -X main.tag=${TAG} -X main.commit=${COMMIT} -X main.buildTime=${BUILDTIME} -X main.buildEnv=${BUILDENV}"
+
+    # Build the binary with dynamic LDFLAGS
     go mod tidy
-    go build -o pulsarship
+    go build -ldflags "${LDFLAGS}" -o pulsarship
 }
 
 package() {
     cd "$srcdir/${pkgname}"
+    # Install the binary to /usr/bin/
     install -Dm755 "${srcdir}/${pkgname}/pulsarship" "${pkgdir}/usr/bin/${pkgname}"
 }

go.mod

@@ -3,7 +3,7 @@ module github.com/xeyossr/pulsarship
 go 1.24.5
 
 require (
-	github.com/BurntSushi/toml v1.5.0
+	github.com/pelletier/go-toml/v2 v2.2.4
 	github.com/spf13/cobra v1.9.1
 )
 

go.sum

@@ -1,8 +1,8 @@
-github.com/BurntSushi/toml v1.5.0 h1:W5quZX/G/csjUnuI8SUYlsHs9M38FC7znL0lIO+DvMg=
-github.com/BurntSushi/toml v1.5.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
+github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
 github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=

install.sh

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+# Pulsarship Installation Script
+
+# Function to print error messages with red color
+function print_error {
+    echo -e "\033[1;31m❌ ERROR: $1\033[0m"
+}
+
+# Function to print success messages with green color
+function print_success {
+    echo -e "\033[1;32m✅ SUCCESS: $1\033[0m"
+}
+
+# Function to print info messages with blue color
+function print_info {
+    echo -e "\033[1;34mℹ️ INFO: $1\033[0m"
+}
+
+# Function to print warning messages with yellow color
+function print_warning {
+    echo -e "\033[1;33m⚠️ WARNING: $1\033[0m"
+}
+
+# Function to check if a command exists
+function command_exists {
+    command -v "$1" &>/dev/null
+}
+
+# Ensure Git is installed
+if ! command_exists git; then
+    print_error "Git is not installed. Please install Git first."
+    exit 1
+fi
+
+# Ensure Make is installed (if not, fall back to Go build)
+if ! command_exists make; then
+    print_warning "Make is not installed. Falling back to 'go build' for compilation."
+    if ! command_exists go; then
+        print_error "Go is not installed either. Please install Go or Make to proceed."
+        exit 1
+    fi
+fi
+
+# Clear screen before starting the Pulsarship installation
+clear
+print_info "🚀 Cloning the Pulsarship repository..."
+
+# Clone Pulsarship repository and install
+git clone https://github.com/xeyossr/pulsarship
+cd pulsarship
+
+# If Make is not available, use Go build
+if command_exists make; then
+    print_info "⚡ Running 'make install'..."
+    make install
+else
+    print_info "⚡ Running 'go build'..."
+    go build -ldflags "\
+  -X 'main.version=$(git describe --tags --abbrev=0)' \
+  -X 'main.tag=$(git describe --tags --abbrev=0)' \
+  -X 'main.commit=$(git rev-parse --short HEAD)' \
+  -X 'main.buildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)' \
+  -X 'main.buildEnv=$(go version)'" \
+        -o pulsarship .
+
+    print_info "⚡ Installing to /usr/bin ..."
+    sudo install -Dm755 pulsarship "/usr/bin/pulsarship"
+fi
+
+# Clear screen and display final success message
+clear
+print_success "🎉 Pulsarship installation completed!"

internal/cli/commands.go

@@ -19,26 +19,32 @@ var InitCmd = &cobra.Command{
 	Use:   "init",
 	Short: "Prints the shell function used to execute pulsarship",
 }
-
-var PromptCmd = &cobra.Command{
-	Use:   "prompt",
-	Short: "",
+var GenConfig = &cobra.Command{
+	Use:   "gen-config",
+	Short: "Generates a default configuration file",
 	Run: func(cmd *cobra.Command, args []string) {
 		path := config.GetConfigPath(flags.ConfigFlag)
-		err := RunPrompt(path, os.Stdout)
-		if err != nil {
-			fmt.Fprintln(os.Stderr, "Error:", err)
+		if err := config.WriteDefaultConfig(path); err != nil {
+			fmt.Fprintln(os.Stderr, "Error generating config:", err)
 			os.Exit(1)
 		}
+		fmt.Println("Configuration file generated at:", path)
 	},
 }
 
-var RightCmd = &cobra.Command{
-	Use:   "right",
-	Short: "",
+var PromptCmd = &cobra.Command{
+	Use:   "prompt",
+	Short: "Prints the full pulsarship prompt",
 	Run: func(cmd *cobra.Command, args []string) {
 		path := config.GetConfigPath(flags.ConfigFlag)
-		err := RunRightPrompt(path, os.Stdout)
+		var err error
+
+		if flags.ShowRight {
+			err = RunRightPrompt(path, os.Stdout)
+		} else {
+			err = RunPrompt(path, os.Stdout)
+		}
+
 		if err != nil {
 			fmt.Fprintln(os.Stderr, "Error:", err)
 			os.Exit(1)
@@ -69,3 +75,17 @@ var InitFishCmd = &cobra.Command{
 		fmt.Println(initShell.FishInit())
 	},
 }
+
+func init() {
+	RootCmd.PersistentFlags().StringVarP(&flags.ConfigFlag, "config", "c", "", "Path to the config file")
+	RootCmd.CompletionOptions.DisableDefaultCmd = true
+	PromptCmd.Flags().BoolVarP(&flags.ShowRight, "right", "r", false, "Print the right prompt instead of left prompt")
+
+	RootCmd.AddCommand(InitCmd)
+	RootCmd.AddCommand(GenConfig)
+	RootCmd.AddCommand(PromptCmd)
+
+	InitCmd.AddCommand(InitBashCmd)
+	InitCmd.AddCommand(InitZshCmd)
+	InitCmd.AddCommand(InitFishCmd)
+}

internal/cli/flags/flags.go

@@ -1,3 +1,4 @@
 package flags
 
 var ConfigFlag string
+var ShowRight bool

internal/config/config.go

@@ -0,0 +1,67 @@
+package config
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/pelletier/go-toml/v2"
+	env "github.com/xeyossr/pulsarship/internal"
+	"github.com/xeyossr/pulsarship/internal/models"
+)
+
+func ExpandPath(path string) string {
+	if strings.HasPrefix(path, "~/") {
+		path = filepath.Join(env.HOME_ENV, path[2:])
+	}
+	return path
+}
+
+func GetConfigPath(configFlag string) string {
+	if configFlag != "" {
+		return ExpandPath(configFlag)
+	}
+
+	if env.PULSARSHIP_CONFIG != "" {
+		return ExpandPath(env.PULSARSHIP_CONFIG)
+	}
+
+	return filepath.Join(env.HOME_ENV, ".config", "pulsarship", "pulsarship.toml")
+}
+
+// Read and parse the configuration file at the given path.
+func ParseConfig(file string) (models.PromptConfig, error) {
+	var config models.PromptConfig
+
+	data, err := os.ReadFile(file)
+	if err != nil {
+		return models.PromptConfig{}, fmt.Errorf("could not read config file: %w", err)
+	}
+
+	if err := toml.Unmarshal(data, &config); err != nil {
+		return models.PromptConfig{}, fmt.Errorf("could not parse config file: %w", err)
+	}
+
+	return config, nil
+}
+
+// Write the default config to the given path.
+func WriteDefaultConfig(path string) error {
+	data, err := toml.Marshal(DefaultConfig)
+	if err != nil {
+		return fmt.Errorf("could not encode default config: %w", err)
+	}
+
+	err = os.MkdirAll(filepath.Dir(path), 0755)
+	if err != nil {
+		return fmt.Errorf("could not create config directory: %w", err)
+	}
+
+	err = os.WriteFile(path, data, 0644)
+	if err != nil {
+		return fmt.Errorf("could not write config file: %w", err)
+	}
+
+	return nil
+}