Add initial documentation functionality

Author: chand1012

.gptignore

@@ -0,0 +1,2 @@
+.vscode/**
+LICENSE

Justfile

@@ -0,0 +1,11 @@
+default:
+  just --list --unsorted
+
+build:
+  go build -v -o otto
+
+clean:
+  rm -f otto
+
+run *commands:
+  go run main.go {{commands}}

cmd/ask.go renamed to cmd/chat.go

@@ -14,9 +14,9 @@ import (
 
 var question string
 
-// askCmd represents the ask command
-var askCmd = &cobra.Command{
-	Use:   "ask",
+// chatCmd represents the chat command
+var chatCmd = &cobra.Command{
+	Use:   "chat",
 	Short: "Ask ChatGPT a question from the command line.",
 	Long: `Ask ChatGPT a question from the command line.
 
@@ -37,11 +37,11 @@ If '-q' is not specified, the user will be prompted to enter a question.
 
 		// if the question is not provided, prompt the user for it
 		if question == "" {
-			fmt.Print("What would you like to ask ChatGPT?\n> ")
+			fmt.Print("What would you like to chat ChatGPT?\n> ")
 			fmt.Scanln(&question)
 		}
 
-		// ask ChatGPT the question
+		// chat ChatGPT the question
 		resp, err := openai.CreateChatSimple(question, 0) // 0 sets the max tokens to 1024
 		if err != nil {
 			fmt.Printf("Error: %s", err)
@@ -55,17 +55,7 @@ If '-q' is not specified, the user will be prompted to enter a question.
 }
 
 func init() {
-	rootCmd.AddCommand(askCmd)
+	rootCmd.AddCommand(chatCmd)
 
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// askCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// askCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
-
-	askCmd.Flags().StringVarP(&question, "question", "q", "", "Question to ask ChatGPT")
+	chatCmd.Flags().StringVarP(&question, "question", "q", "", "Question to chat ChatGPT")
 }

cmd/doc.go

@@ -0,0 +1,91 @@
+/*
+Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	"github.com/chand1012/ottodocs/config"
+	"github.com/chand1012/ottodocs/document"
+)
+
+// docCmd represents the doc command
+var docCmd = &cobra.Command{
+	Use:   "doc",
+	Short: "Document a file",
+	Long:  `Document a file using the OpenAI ChatGPT API.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		if filePath == "" {
+			fmt.Println("Please provide a path to a file to document.")
+			fmt.Println("Run `ottodocs doc -h` for more information.")
+			os.Exit(1)
+		}
+
+		if chatPrompt == "" {
+			chatPrompt = "Write documentation for the following code snippet:"
+		}
+
+		conf, err := config.Load()
+		if err != nil || conf.APIKey == "" {
+			// if the API key is not set, prompt the user to login
+			fmt.Println("Please login first.")
+			fmt.Println("Run `ottodocs login` to login.")
+			os.Exit(1)
+		}
+
+		var contents string
+
+		if inlineMode || !markdownMode {
+			contents, err = document.SingleFile(filePath, chatPrompt, conf.APIKey)
+		} else {
+			contents, err = document.Markdown(filePath, chatPrompt, conf.APIKey)
+		}
+
+		if err != nil {
+			fmt.Printf("Error: %s", err)
+			os.Exit(1)
+		}
+
+		if outputFile != "" {
+			// write the string to the output file
+			err = os.WriteFile(outputFile, []byte(contents), 0644)
+			if err != nil {
+				fmt.Printf("Error: %s", err)
+				os.Exit(1)
+			}
+		} else if overwriteOriginal {
+			// overwrite the original file
+			// clear the contents of the file
+			file, err := os.OpenFile(filePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+			if err != nil {
+				fmt.Printf("Error: %s", err)
+				os.Exit(1)
+			}
+
+			// write the new contents to the file
+			_, err = file.WriteString(contents)
+			if err != nil {
+				fmt.Printf("Error: %s", err)
+				os.Exit(1)
+			}
+		} else {
+			fmt.Println(contents)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(docCmd)
+
+	// see cmd/vars.go for the definition of these flags
+	docCmd.Flags().StringVarP(&filePath, "file", "f", "", "The file to document")
+	docCmd.Flags().StringVarP(&chatPrompt, "prompt", "p", "", "The prompt to use for the document")
+	docCmd.Flags().StringVarP(&outputFile, "output", "o", "", "The output file to write the documentation to. ")
+	docCmd.Flags().BoolVarP(&inlineMode, "inline", "i", false, "Inline mode. Adds the documentation to the code.")
+	docCmd.Flags().BoolVarP(&markdownMode, "markdown", "m", false, "Markdown mode. Outputs the documentation in markdown.")
+	docCmd.Flags().BoolVarP(&overwriteOriginal, "overwrite", "w", false, "Overwrite the original file.")
+}

cmd/docs.go

@@ -0,0 +1,148 @@
+/*
+Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/chand1012/git2gpt/prompt"
+	"github.com/chand1012/ottodocs/config"
+	"github.com/chand1012/ottodocs/document"
+	"github.com/spf13/cobra"
+)
+
+// docsCmd represents the docs command
+var docsCmd = &cobra.Command{
+	Use:   "docs",
+	Short: "Document a repository of files",
+	Long: `Document an entire repository of files. Specify the path to the repo as the first positional argument. This command will recursively
+search for files in the directory and document them.
+	`,
+	Args: cobra.PositionalArgs(func(cmd *cobra.Command, args []string) error {
+		if len(args) < 1 {
+			return fmt.Errorf("requires a path to a repository")
+		}
+		return nil
+	}),
+	Run: func(cmd *cobra.Command, args []string) {
+		repoPath = args[0]
+
+		if (!markdownMode || inlineMode) && outputFile != "" {
+			fmt.Println("Error: cannot specify an output file in inline mode")
+			os.Exit(1)
+		}
+
+		if markdownMode && overwriteOriginal {
+			fmt.Println("Error: cannot overwrite original file in markdown mode")
+			os.Exit(1)
+		}
+
+		if markdownMode && outputFile == "" {
+			fmt.Println("Error: must specify an output file in markdown mode")
+			os.Exit(1)
+		}
+
+		if outputFile != "" {
+			// if output file exists, throw error
+			if _, err := os.Stat(outputFile); err == nil {
+				fmt.Printf("Error: output file %s already exists!\n", outputFile)
+				os.Exit(1)
+			}
+		}
+
+		conf, err := config.Load()
+		if err != nil || conf.APIKey == "" {
+			// if the API key is not set, prompt the user to login
+			fmt.Println("Please login first.")
+			fmt.Println("Run `ottodocs login` to login.")
+			os.Exit(1)
+		}
+
+		ignoreList := prompt.GenerateIgnoreList(ignoreFilePath, ignoreFilePath, !ignoreGitignore)
+		ignoreList = append(ignoreList, filepath.Join(repoPath, ".gptignore"))
+		repo, err := prompt.ProcessGitRepo(repoPath, ignoreList)
+		if err != nil {
+			fmt.Printf("Error: %s", err)
+			os.Exit(1)
+		}
+
+		for _, file := range repo.Files {
+			var contents string
+
+			path := filepath.Join(repoPath, file.Path)
+
+			if outputFile != "" {
+				fmt.Println("Documenting file", file.Path)
+			}
+
+			if chatPrompt == "" {
+				chatPrompt = "Write documentation for the following code snippet. The file name is" + file.Path + ":"
+			}
+
+			if inlineMode || !markdownMode {
+				contents, err = document.SingleFile(path, chatPrompt, conf.APIKey)
+			} else {
+				contents, err = document.Markdown(path, chatPrompt, conf.APIKey)
+			}
+
+			if err != nil {
+				fmt.Printf("Error documenting file %s: %s\n", path, err)
+				continue
+			}
+
+			if outputFile != "" && markdownMode {
+				// write the string to the output file
+				// append if the file already exists
+				file, err := os.OpenFile(outputFile, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+				if err != nil {
+					fmt.Printf("Error: %s\n", err)
+					os.Exit(1)
+				}
+
+				_, err = file.WriteString(contents)
+				if err != nil {
+					fmt.Printf("Error: %s\n", err)
+					os.Exit(1)
+				}
+
+				file.Close()
+			} else if overwriteOriginal {
+				// overwrite the original file
+				// clear the contents of the file
+				file, err := os.OpenFile(filePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+				if err != nil {
+					fmt.Printf("Error: %s\n", err)
+					os.Exit(1)
+				}
+
+				// write the new contents to the file
+				_, err = file.WriteString(contents)
+				if err != nil {
+					fmt.Printf("Error: %s\n", err)
+					os.Exit(1)
+				}
+
+				file.Close()
+			} else {
+				fmt.Println(contents)
+			}
+		}
+
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(docsCmd)
+
+	// see cmd/vars for the definition of these flags
+	docsCmd.Flags().StringVarP(&chatPrompt, "prompt", "p", "", "Prompt to use for the ChatGPT API")
+	docsCmd.Flags().StringVarP(&outputFile, "output", "o", "", "Path to the output file. For use with --markdown")
+	docsCmd.Flags().StringVarP(&ignoreFilePath, "ignore", "n", "", "path to .gptignore file")
+	docsCmd.Flags().BoolVarP(&markdownMode, "markdown", "m", false, "Output in Markdown format")
+	docsCmd.Flags().BoolVarP(&inlineMode, "inline", "i", false, "Output in inline format")
+	docsCmd.Flags().BoolVarP(&overwriteOriginal, "overwrite", "w", false, "Overwrite the original file")
+	docsCmd.Flags().BoolVarP(&ignoreGitignore, "ignore-gitignore", "g", false, "ignore .gitignore file")
+}

cmd/prompt.go

@@ -11,19 +11,17 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var repoPath string
-var preambleFile string
-var outputFile string
-var estimateTokens bool
-var ignoreFilePath string
-var ignoreGitignore bool
-var outputJSON bool
-
 // promptCmd represents the prompt command
 var promptCmd = &cobra.Command{
 	Use:   "prompt",
 	Short: "Generates a ChatGPT prompt from a given Git repo",
-	Long:  `Generates a ChatGPT prompt from a given Git repo.`,
+	Long:  `Generates a ChatGPT prompt from a given Git repo. Specify the path to the repo as the first positional argument.`,
+	Args: cobra.PositionalArgs(func(cmd *cobra.Command, args []string) error {
+		if len(args) < 1 {
+			return fmt.Errorf("requires a path to a repository")
+		}
+		return nil
+	}),
 	Run: func(cmd *cobra.Command, args []string) {
 		repoPath = args[0]
 		ignoreList := prompt.GenerateIgnoreList(repoPath, ignoreFilePath, !ignoreGitignore)
@@ -82,6 +80,7 @@ var promptCmd = &cobra.Command{
 func init() {
 	rootCmd.AddCommand(promptCmd)
 
+	// see cmd/vars.go for the definition of these flags
 	promptCmd.Flags().StringVarP(&preambleFile, "preamble", "p", "", "path to preamble text file")
 	// output to file flag. Should be a string
 	promptCmd.Flags().StringVarP(&outputFile, "output", "o", "", "path to output file")

cmd/root.go

@@ -11,7 +11,7 @@ import (
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "ottodocs",
+	Use:   "otto",
 	Short: "Document your code with ease",
 	Long:  `Code documentation made easy using GPT.`,
 	// Uncomment the following line if your bare application

cmd/vars.go

@@ -0,0 +1,15 @@
+package cmd
+
+var repoPath string
+var preambleFile string
+var outputFile string
+var estimateTokens bool
+var ignoreFilePath string
+var ignoreGitignore bool
+var outputJSON bool
+
+var filePath string
+var chatPrompt string
+var inlineMode bool
+var markdownMode bool
+var overwriteOriginal bool

constants/commentOperators.go

@@ -0,0 +1,29 @@
+package constants
+
+var CommentOperators = map[string]string{
+	".py":    "#",    // Python
+	".go":    "//",   // Go
+	".c":     "//",   // C
+	".cpp":   "//",   // C++
+	".h":     "//",   // C/C++ Header
+	".cs":    "//",   // C#
+	".java":  "//",   // Java
+	".js":    "//",   // JavaScript
+	".ts":    "//",   // TypeScript
+	".php":   "//",   // PHP
+	".rb":    "#",    // Ruby
+	".rs":    "//",   // Rust
+	".swift": "//",   // Swift
+	".sh":    "#",    // Shell Script
+	".pl":    "#",    // Perl
+	".lua":   "--",   // Lua
+	".m":     "%",    // MATLAB
+	".r":     "#",    // R
+	".scala": "//",   // Scala
+	".kts":   "//",   // Kotlin
+	".vb":    "'",    // Visual Basic .NET
+	".f":     "!",    // Fortran
+	".asm":   ";",    // Assembly
+	".html":  "<!--", // HTML (Opening Comment)
+	".css":   "/*",   // CSS (Opening Comment)
+}

constants/openAI.go

@@ -0,0 +1,3 @@
+package constants
+
+const OPENAI_MAX_TOKENS int = 4000