feat: add projects to cli tool (#7)

Author: zhravan

README.md

@@ -1,6 +1,8 @@
-# GoLearn
-
-Rustlings‑style Go exercises in a tiny CLI.
+<p align="center">
+    <img align="center" width="20%" src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/93hg76euzrulrc59x36s.png" alt="logo"/>
+    <h1 align="center">GoLearn</h1>
+    <h6 align="center">Rustlings‑style Go exercises in a tiny CLI.</h6>
+</p>
 
 ## Why this exists
 
@@ -62,4 +64,6 @@ make watch
 - Non-code lesson content and any included gopher artwork: [CC BY 3.0](./CONTENT_LICENSE).
 - Inspired by rustlings and Go by Example. [NOTICE](./NOTICE) for attributions.
 
-Built with love for learning and knowledge sharing.
+<div align="center">
+    <img src="https://img.shields.io/badge/Built%20with%20%E2%9D%A4%EF%B8%8F-for%20learning%20and%20knowledge%20sharing-blueviolet"/>
+</div>

go.mod

@@ -11,5 +11,6 @@ require (
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.11.0 // indirect
 	golang.org/x/sys v0.4.0 // indirect
 )

internal/cli/commands.go

@@ -21,14 +21,15 @@ import (
 )
 
 func runList() error {
-	items, err := exercises.List()
+	cat, err := exercises.ListAll()
 	if err != nil {
 		return err
 	}
-	if h := theme.Heading("Exercises"); h != "" {
+
+	if h := theme.Heading("Concepts"); h != "" {
 		fmt.Println(h)
 	}
-	for _, ex := range items {
+	for _, ex := range cat.Concepts {
 		status := "pending"
 		done, _ := progress.IsCompleted(ex.Slug)
 		if done {
@@ -39,6 +40,22 @@ func runList() error {
 		}
 		fmt.Printf("%s - %s [%s]\n", ex.Slug, ex.Title, status)
 	}
+
+	if h := theme.Heading("Projects"); h != "" {
+		fmt.Println(h)
+	}
+	for _, ex := range cat.Projects {
+		status := "pending"
+		done, _ := progress.IsCompleted(ex.Slug)
+		if done {
+			status = theme.Success("done")
+		}
+		if !done {
+			status = theme.Muted(status)
+		}
+		fmt.Printf("%s - %s [%s]\n", ex.Slug, ex.Title, status)
+	}
+
 	return nil
 }
 
@@ -50,12 +67,18 @@ func runVerify(name string) error {
 		}
 		return verifyOne(ex)
 	}
-	items, err := exercises.List()
+
+	cat, err := exercises.ListAll()
 	if err != nil {
 		return err
 	}
+
+	var allExercises []exercises.Exercise
+	allExercises = append(allExercises, cat.Concepts...)
+	allExercises = append(allExercises, cat.Projects...)
+
 	var anyFailed bool
-	for _, ex := range items {
+	for _, ex := range allExercises {
 		if err := verifyOne(ex); err != nil {
 			anyFailed = true
 		}
@@ -204,14 +227,19 @@ func runWatch() error {
 }
 
 func runProgress() error {
-	items, err := exercises.List()
+	cat, err := exercises.ListAll()
 	if err != nil {
 		return err
 	}
-	sort.Slice(items, func(i, j int) bool { return items[i].Slug < items[j].Slug })
+
+	var allExercises []exercises.Exercise
+	allExercises = append(allExercises, cat.Concepts...)
+	allExercises = append(allExercises, cat.Projects...)
+
+	sort.Slice(allExercises, func(i, j int) bool { return allExercises[i].Slug < allExercises[j].Slug })
 	doneCount := 0
-	statuses := make([]bool, len(items))
-	for i, ex := range items {
+	statuses := make([]bool, len(allExercises))
+	for i, ex := range allExercises {
 		done, _ := progress.IsCompleted(ex.Slug)
 		statuses[i] = done
 		if done {
@@ -226,13 +254,24 @@ func runProgress() error {
 	fmt.Println(theme.Heading("GoLearn Progress Dashboard"))
 	fmt.Println(strings.Repeat("=", 26))
 	width := progressBarWidth()
-	fmt.Printf("\nCompleted: %d/%d\n", doneCount, len(items))
-	fmt.Println(renderProgressBar(doneCount, len(items), width))
+	fmt.Printf("\nCompleted: %d/%d\n", doneCount, len(allExercises))
+	fmt.Println(renderProgressBar(doneCount, len(allExercises), width))
 	fmt.Println()
-	fmt.Println(theme.Emph("Exercises:"))
-	for i, ex := range items {
+	fmt.Println(theme.Emph("Concepts:"))
+	for _, ex := range cat.Concepts {
 		box := "[ ]"
-		if statuses[i] {
+		done, _ := progress.IsCompleted(ex.Slug)
+		if done {
+			box = theme.Success("[x]")
+		}
+		fmt.Printf(" %s %s - %s\n", box, ex.Slug, ex.Title)
+	}
+	fmt.Println()
+	fmt.Println(theme.Emph("Projects:"))
+	for _, ex := range cat.Projects {
+		box := "[ ]"
+		done, _ := progress.IsCompleted(ex.Slug)
+		if done {
 			box = theme.Success("[x]")
 		}
 		fmt.Printf(" %s %s - %s\n", box, ex.Slug, ex.Title)

internal/exercises/catalog.yaml

@@ -1,3 +1,4 @@
+concepts:
 - slug: 01_hello
   title: Hello, Go!
   test_regex: ".*"
@@ -134,3 +135,45 @@
   hints:
     - Define a custom error type and return it from a function.
 
+projects:
+- slug: 28_text_analyzer
+  title: Text Analyzer (Easy)
+  test_regex: ".*"
+  hints:
+    - Implement functions to count characters, words, and unique words in a given text.
+- slug: 29_shape_calculator
+  title: Shape Area Calculator (Medium)
+  test_regex: ".*"
+  hints:
+    - Define structs for different shapes, implement methods to calculate their areas, and use an interface for common shape behavior.
+- slug: 30_task_scheduler
+  title: Task Scheduler (Hard)
+  test_regex: ".*"
+  hints:
+    - Create a task scheduler with features like adding/removing tasks, a custom iterator, closures for task execution, and custom error handling.
+- slug: 31_http_server
+  title: HTTP Server (Easy)
+  test_regex: ".*"
+  hints:
+    - Implement a basic HTTP server that responds to GET requests.
+- slug: 32_cli_todo_list
+  title: CLI Todo List (Medium)
+  test_regex: ".*"
+  hints:
+    - Build a command-line tool to manage a todo list, including adding, listing, and completing tasks.
+- slug: 33_simple_chat_app
+  title: Simple Chat Application (Medium)
+  test_regex: ".*"
+  hints:
+    - Create a basic client-server chat application.
+- slug: 34_image_processing_utility
+  title: Image Processing Utility (Hard)
+  test_regex: ".*"
+  hints:
+    - Develop a command-line utility for basic image transformations like resizing or converting to grayscale.
+- slug: 35_basic_key_value_store
+  title: Basic Key-Value Store (Hard)
+  test_regex: ".*"
+  hints:
+    - Implement an in-memory key-value store with basic CRUD operations and optional persistence.
+

internal/exercises/exercises.go

@@ -25,35 +25,44 @@ type Exercise struct {
 	Hints     []string `yaml:"hints"`
 }
 
+type Catalog struct {
+	Concepts []Exercise `yaml:"concepts"`
+	Projects []Exercise `yaml:"projects"`
+}
+
 var (
 	catalogOnce sync.Once
-	catalogData []Exercise
+	catalogData Catalog
 )
 
-func catalog() []Exercise {
+func catalog() Catalog {
 	catalogOnce.Do(func() {
 		b, err := catalogFS.ReadFile("catalog.yaml")
 		if err != nil {
 			// Fallback minimal catalog
-			catalogData = []Exercise{{
-				Slug:      "01_hello",
-				Title:     "Hello, Go!",
-				TestRegex: ".*",
-				Hints:     []string{"Implement Hello() to return 'Hello, Go!'"},
-			}}
+			catalogData = Catalog{
+				Concepts: []Exercise{{
+					Slug:      "01_hello",
+					Title:     "Hello, Go!",
+					TestRegex: ".*",
+					Hints:     []string{"Implement Hello() to return 'Hello, Go!'"},
+				}},
+			}
 			return
 		}
-		var items []Exercise
-		if err := yaml.Unmarshal(b, &items); err != nil || len(items) == 0 {
-			catalogData = []Exercise{{
-				Slug:      "01_hello",
-				Title:     "Hello, Go!",
-				TestRegex: ".*",
-				Hints:     []string{"Implement Hello() to return 'Hello, Go!'"},
-			}}
+		var cat Catalog
+		if err := yaml.Unmarshal(b, &cat); err != nil {
+			catalogData = Catalog{
+				Concepts: []Exercise{{
+					Slug:      "01_hello",
+					Title:     "Hello, Go!",
+					TestRegex: ".*",
+					Hints:     []string{"Implement Hello() to return 'Hello, Go!'"},
+				}},
+			}
 			return
 		}
-		catalogData = items
+		catalogData = cat
 	})
 	return catalogData
 }
@@ -81,23 +90,31 @@ func discoverLocal() ([]Exercise, error) {
 	return items, nil
 }
 
-func List() ([]Exercise, error) {
+func ListAll() (Catalog, error) {
 	locals, err := discoverLocal()
 	if err != nil {
-		return nil, err
+		return Catalog{}, err
 	}
+
 	if len(locals) > 0 {
-		return locals, nil
+		// For simplicity, if local exercises are present, we'll only return them for now.
+		// A more robust solution might merge local and catalog exercises.
+		return Catalog{Concepts: locals}, nil
 	}
 	return catalog(), nil
 }
 
 func Get(slug string) (Exercise, error) {
-	for _, ex := range catalog() {
+	for _, ex := range catalog().Concepts {
 		if ex.Slug == slug {
 			return ex, nil
 		}
 	}
+	for _, ex := range catalog().Projects {
+		if ex.Slug == slug {
+			return ex, nil	
+		}
+	}
 	locals, err := discoverLocal()
 	if err != nil {
 		return Exercise{}, err
@@ -125,7 +142,12 @@ func templateExists(slug string) bool {
 }
 
 func InitAll() error {
-	for _, ex := range catalog() {
+	for _, ex := range catalog().Concepts {
+		if err := copyExerciseTemplate(ex.Slug); err != nil {
+			return err
+		}
+	}
+	for _, ex := range catalog().Projects {
 		if err := copyExerciseTemplate(ex.Slug); err != nil {
 			return err
 		}

internal/exercises/templates/14_closures/closures.go

@@ -1,22 +1,14 @@
 package closures
 
-import "fmt"
+// TODO:
+// - Implement a closure function that captures state and returns a func() int
+//   which increments and returns an internal counter on each call.
+// - Each call to closure() must produce an independent counter.
+// - Do not change function names or signatures; tests call closure().
 
-func closure() func() int {
-	i := 0
-	return func() int {
-		i++
-		return i
-	}
-}
+// NOTE: Keep imports minimal in skeletons to avoid unused import errors.
 
-func main() {
-	next := closure()
-	fmt.Println(next())
-	fmt.Println(next())
-	fmt.Println(next())
-
-	anotherNext := closure()
-	fmt.Println(anotherNext())
-	fmt.Println(anotherNext())
+func closure() func() int {
+	// TODO: implement a counting closure
+	return func() int { return 0 }
 }

internal/exercises/templates/15_recursion/recursion.go

@@ -1,8 +1,11 @@
 package recursion
 
+// TODO:
+// - Implement factorial using recursion.
+// - Handle the base case: factorial(0) == 1.
+// - Keep the signature the same; tests call factorial(n).
+
 func factorial(n int) int {
-	if n == 0 {
-		return 1
-	}
-	return n * factorial(n-1)
+	// TODO: implement recursive factorial
+	return 0
 }

internal/exercises/templates/16_range_built_in/range_built_in.go

@@ -1,17 +1,16 @@
 package range_built_in
 
+// TODO:
+// - Use range to iterate over slices and maps.
+// - sumSlice: return the sum of all elements in the slice.
+// - countMap: return the number of key/value pairs in the map.
+
 func sumSlice(s []int) int {
-	sum := 0
-	for _, v := range s {
-		sum += v
-	}
-	return sum
+	// TODO: implement summation with range
+	return 0
 }
 
 func countMap(m map[string]int) int {
-	count := 0
-	for range m {
-		count++
-	}
-	return count
+	// TODO: count items in map using range
+	return 0
 }

internal/exercises/templates/17_pointers/pointers.go

@@ -1,6 +1,11 @@
 package pointers
 
+// TODO:
+// - Modify the value pointed to by the incoming *int.
+// - Return the same pointer after updating the underlying value.
+// - Avoid allocating any new memory; operate in place.
+
 func modifyValue(ptr *int) *int {
-	*ptr = 100
+	// TODO: implement mutation via pointer
 	return ptr
 }