Einfache Go CLI-Everything App

Hey Leute!

Ich habe seit über 2 Jahren nicht mehr über Dev gebloggt! Es ist schon eine Weile her, also entschuldigen Sie bitte, wenn meine Schreibfähigkeiten mit der Zeit nachgelassen haben.

Ich lerne gerade Go und habe eine Liste von Projekten erhalten, die abgeschlossen und geteilt werden müssen. Eines davon ist zufällig eine einfache Golang-Cli-Todo-App, mit der jemand Aufgaben zu einer Liste von Aufgaben hinzufügen und eine Reihe grundlegender Aufgaben erledigen kann Funktionalität für diese Aufgaben.

Dazu gehören:

1) Aufgaben auflisten
2) Weitere Aufgaben hinzufügen
3) Ändern dieser Aufgaben
4) Aufgaben erledigt machen

Leider habe ich keinen ausgefallenen Namen dafür? Da es sich um eine leichte, benutzerfreundliche App handelt, die jemand an einem Tag fertigstellen kann. Auch wenn Sie ein Anfänger sind.

~ Projektquellcode: https://github.com/SirTingling/cloudprojects/tree/main/go-cli-todo-app

Fangen wir an

Nun, wie immer die Erstellung unseres main.go. Sobald dies eingerichtet ist, müssen wir die Struktur und Funktionalität unserer Todos definieren. Ich habe das in einem separaten todo.go
gemacht

type Todo struct {
    Title       string
    Completed   bool
    CreatedAt   time.Time
    CompletedAt *time.Time
}

mit einer Scheibe für unsere Todos

type Todos []Todo

Dann benötigen wir die Implementierung der wichtigsten Funktionsmethoden, darunter:

• hinzufügen

func (todos *Todos) add(title string) {
    todo := Todo{
        Title:       title,
        Completed:   false,
        CompletedAt: nil,
        CreatedAt:   time.Now(),
    }

    *todos = append(*todos, todo)
}

Erstellt ein Todo-Objekt mit einem Titel, setzt seinen Abgeschlossen-Status auf „false“ und hängt es an den Todos-Slice an.

• löschen

func (todos *Todos) delete(index int) error {
    t := *todos

    if err := t.validateIndex(index); err != nil {
        return err
    }

    *todos = append(t[:index], t[index+1:]...)

    return nil
}

Validiert den Index und entfernt dann mithilfe von Slicing das Element aus der Todos-Liste.

• umschalten

func (todos *Todos) toggle(index int) error {
    if err := todos.validateIndex(index); err != nil {
        return err
    }

    t := *todos
    todo := &t[index]

    if !todo.Completed {
        completedTime := time.Now()
        todo.CompletedAt = &completedTime
    } else {
        todo.CompletedAt = nil
    }

    todo.Completed = !todo.Completed
    return nil
}

Validiert den Index, dreht den Booleschen Wert „Completed“ um und aktualisiert den Zeitstempel „CompletedAt“ entsprechend.

Die übrigen Methoden folgen einer sehr ähnlichen Funktionalität. Sollten Probleme auftreten, können Sie sich gerne den Quellcode ansehen

Ausführen der App

Ein häufiges Problem bei vielen To-Do-Apps, die auf CLI basieren, ist, dass sie nicht so ansprechend sind. Mit Hilfe eines Drittanbieterpakets namens aquasecurity/table wird die To-Do-Liste übersichtlich angezeigt.

Aquasicherheit/Tisch

Es kann installiert werden mit:

go get github.com/aquasecurity/table

Dann habe ich eine Methode erstellt, um die Aufgaben mithilfe von Methoden außerhalb des Pakets anzuzeigen. Insbesondere SetRowLines, SetHeaders, New, AddRow & Render wurden in meinem Fall hauptsächlich verwendet.

func (todos *Todos) print() {
    table := table.New(os.Stdout)
    table.SetRowLines(false)
    table.SetHeaders("#", "Title", "Completed", "Created At", "Completed At")

    for index, t := range *todos {
        completed := "❌"
        completedAt := ""

        if t.Completed {
            completed = "✅"
            if t.CompletedAt != nil {
                completedAt = t.CompletedAt.Format(time.RFC1123) //time standard
            }
        }

        table.AddRow(strconv.Itoa(index), t.Title, completed, t.CreatedAt.Format(time.RFC1123), completedAt)
    }

    table.Render()
}

Die Druckmethode ist eine praktische Möglichkeit, die Liste der Aufgaben im Terminal anzuzeigen. Es erstellt eine Tabelle mit Spalten für Dinge wie die Aufgabennummer, den Titel, ob die Aufgabe abgeschlossen ist, wann sie erstellt wurde und wann sie abgeschlossen wurde.

Es geht jedes Aufgabenelement durch, prüft, ob es erledigt ist oder nicht, und fügt ein ✅ hinzu, wenn es erledigt ist, oder ein ❌, wenn nicht. Wenn die Aufgabe erledigt ist, wird sogar das genaue Datum und die Uhrzeit der Fertigstellung angezeigt.

Sobald alle Zeilen fertig sind, wird die Tabelle in einem sauberen, lesbaren Format ausgedruckt. Super praktisch, um schnell den Status aller Aufgaben eines Benutzers auf einen Blick zu sehen!

Wie wäre es, diese Aufgaben zu speichern?

Deshalb dachte ich, dass die Funktionalität, die Todos lokal zu speichern, sagen wir in einer Datei, in diesem Fall todos.json, und dann von dort zu lesen, eine gute Idee wäre. Im Wesentlichen verfügen wir über ein gewisses Maß an Persistenz unserer Daten zu allen einzelnen Aufgaben.

Wir könnten diese Funktionalität zu einer vorhandenen Datei hinzufügen, aber ich denke, es ist eine gute Idee, die Bedenken zu trennen.

Ich habe ein storage.go hinzugefügt, es könnte beliebig heißen: store.go, persist.go usw.

Ich habe mich für JSON entschieden, aber die gleichen Prinzipien gelten normalerweise auch für jedes Datenformat, in dem Sie die Daten speichern möchten.

type Todo struct {
    Title       string
    Completed   bool
    CreatedAt   time.Time
    CompletedAt *time.Time
}

• Es gibt eine Speicherstruktur, die den Überblick über die Datei behält, mit der gearbeitet wird.

• Die Funktion NewStorage hilft beim Einrichten, indem sie ihr einfach den Dateinamen gibt.

• Die Methode Speichern nimmt die Daten, wandelt sie in hübsches JSON um und schreibt sie in die Datei (todos.json). Wenn etwas schief geht, teilt es uns dies mit einem Fehler mit.

• Die Methode Load macht das Gegenteil – liest die Datei, entpackt den JSON und füllt die Dateidaten mit den Daten.

Es ist eine einfache, wiederverwendbare Möglichkeit, Daten aller Art zu speichern und zu laden, ohne dass eine Datenbank oder irgendetwas Besonderes erforderlich ist.

Von hier aus nutze ich den NewStorage in main.go, um einige Aufgaben zu meiner Liste hinzuzufügen und sie zu speichern, die jetzt in meiner todos.json angezeigt werden können

type Todos []Todo

func (todos *Todos) add(title string) {
    todo := Todo{
        Title:       title,
        Completed:   false,
        CompletedAt: nil,
        CreatedAt:   time.Now(),
    }

    *todos = append(*todos, todo)
}

Für die Befehle habe ich nichts Besonderes gemacht. Ich habe die Flags definiert, die ich als Struktur
verwenden werde

func (todos *Todos) delete(index int) error {
    t := *todos

    if err := t.validateIndex(index); err != nil {
        return err
    }

    *todos = append(t[:index], t[index+1:]...)

    return nil
}

Dann listet eine einfache Funktion mithilfe des Flaggenpakets diese Flaggen auf, gibt ihnen weitere Details und Beschreibungen und passt sie an. Ich habe auch Gutes über das Cobra-Paket gehört, das hier sehr einfach zu verwenden sein könnte, das nächste Mal werde ich es ausprobieren.

func (todos *Todos) toggle(index int) error {
    if err := todos.validateIndex(index); err != nil {
        return err
    }

    t := *todos
    todo := &t[index]

    if !todo.Completed {
        completedTime := time.Now()
        todo.CompletedAt = &completedTime
    } else {
        todo.CompletedAt = nil
    }

    todo.Completed = !todo.Completed
    return nil
}

Von dort aus können Sie kreativ werden, wie Sie diese Flags ausführen möchten. In meinem Fall habe ich einfache Fallanweisungen erstellt.

Das ist es?

Ja! Damit ist diese einfache Go-Cli-To-Do-App fertiggestellt, die in relativ kurzer Zeit erstellt werden kann. Ein großes Dankeschön an Coding with Patrik und The Builder Beide haben tolle Inhalte, um bei Projekten wie diesen zu helfen und Spaß zu machen!

Vielen Dank fürs Lesen und ich hoffe, dass diese Miniprojekte andere dazu inspirieren, entweder mit Go anzufangen oder einfach weiter damit zu üben. Ich habe noch ein paar mehr zu tun und zu teilen, bis zum nächsten Mal!

Das obige ist der detaillierte Inhalt vonEinfache Go CLI-Everything App. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!