Replace shell scripts with a Go based CLI (spring1843#119)

Author: spring1843

.github/cmd/cmd/count_problems.go

@@ -0,0 +1,32 @@
+package cmd
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+)
+
+var countRehearsalsCommand = &cobra.Command{
+	Use:   "count-rehearsals",
+	Short: "Counts the number of rehearsals",
+	Long:  "Iteratively counts the number of rehearsals for each section.",
+	Run: func(cmd *cobra.Command, args []string) {
+		dir, err := os.Getwd()
+		if err != nil {
+			log.Fatalf("Error finding current directory: %s", err)
+		}
+
+		count := 0
+		for _, section := range sections {
+			matches, err := filepath.Glob(filepath.Join(dir, section, "*_test.go"))
+			if err != nil {
+				log.Fatalf("Error while globbing: %s", err)
+			}
+			count += len(matches)
+		}
+		fmt.Println(count)
+	},
+}

.github/cmd/cmd/export_md.go

@@ -0,0 +1,39 @@
+package cmd
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+)
+
+var exportMDCommand = &cobra.Command{
+	Use:   "export-md",
+	Short: "Joins the entire project into one output",
+	Long:  "Iteratively finds every README.md and outputs them",
+	Run: func(cmd *cobra.Command, args []string) {
+		dir, err := os.Getwd()
+		if err != nil {
+			log.Fatalf("Error finding current directory: %s", err)
+		}
+
+		allFiles := []string{
+			"README.md",
+			"preface.md",
+			"complexity.md",
+		}
+		for _, section := range sections {
+			allFiles = append(allFiles, filepath.Join(section, "README.md"))
+		}
+
+		for _, file := range allFiles {
+			content, err := os.ReadFile(filepath.Join(dir, file))
+			if err != nil {
+				log.Fatalf("Error reading file: %s", err)
+			}
+			fmt.Println(string(content))
+		}
+	},
+}

.github/cmd/cmd/root.go

@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var rootCmd = &cobra.Command{
+	Use:   "cmd",
+	Short: "Utility to work with go-dsa",
+	Long:  `This is a CLI tool that is made to work with go-dsa.`,
+}
+
+// Execute adds all child commands to the root command and sets flags appropriately.
+func Execute() {
+	rootCmd.AddCommand(countRehearsalsCommand)
+	rootCmd.AddCommand(exportMDCommand)
+
+	if err := rootCmd.Execute(); err != nil {
+		os.Exit(1)
+	}
+	rootCmd.AddCommand()
+}

.github/cmd/cmd/sections.go

@@ -0,0 +1,19 @@
+package cmd
+
+var sections = []string{
+	"array",
+	"strings",
+	"linkedlist",
+	"stack",
+	"queue",
+	"hashtable",
+	"tree",
+	"heap",
+	"recursion",
+	"dnc",
+	"bit",
+	"backtracking",
+	"graph",
+	"greedy",
+	"dp",
+}

.github/cmd/main.go

@@ -0,0 +1,7 @@
+package main
+
+import "github.com/spring1843/go-dsa/.github/cmd/cmd"
+
+func main() {
+	cmd.Execute()
+}

.github/linters/.golangci.yml

@@ -32,9 +32,13 @@ issues:
         - wsl
         - dupl
         - dupword
-
 linters:
   enable-all: true
   enable:
     - revive
     - misspell
+
+linters-settings:
+  forbidigo:
+    forbid:
+      - 'ioutil\.*'

.github/scripts/count-rehearsals.sh

@@ -12,7 +12,6 @@ Welcome to **Data Structures and Algorithms in Go**! 🎉 This project is design
 * Executable and comes with 100% test coverage, ensuring correctness and quality
 * Completely free, community-editable, and continuously evolving
 * Ability to study and practice in your favorite IDE, editor, or web browser
-* Pure Go, no third-party libraries, Guaranteed forward compatibility
 
 ## 📚 Table of Contents
 

.github/scripts/export-md.sh

@@ -1,3 +1,10 @@
 module github.com/spring1843/go-dsa
 
 go 1.20
+
+require github.com/spf13/cobra v1.7.0
+
+require (
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+)

.github/scripts/sections.sh

@@ -0,0 +1,10 @@
+github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I=
+github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=