diff options
| -rw-r--r-- | .gitattributes | 1 | ||||
| -rw-r--r-- | README.md | 60 | ||||
| -rw-r--r-- | cmd/mygit/main.go | 40 | ||||
| -rw-r--r-- | codecrafters.yml | 11 | ||||
| -rw-r--r-- | go.mod | 9 | ||||
| -rw-r--r-- | go.sum | 0 | ||||
| -rwxr-xr-x | your_git.sh | 15 |
7 files changed, 136 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/README.md b/README.md new file mode 100644 index 0000000..740b5ea --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +[](https://app.codecrafters.io/users/codecrafters-bot?r=2qF) + +This is a starting point for Go solutions to the +["Build Your Own Git" Challenge](https://codecrafters.io/challenges/git). + +In this challenge, you'll build a small Git implementation that's capable of +initializing a repository, creating commits and cloning a public repository. +Along the way we'll learn about the `.git` directory, Git objects (blobs, +commits, trees etc.), Git's transfer protocols and more. + +**Note**: If you're viewing this repo on GitHub, head over to +[codecrafters.io](https://codecrafters.io) to try the challenge. + +# Passing the first stage + +The entry point for your Git implementation is in `cmd/mygit/main.go`. Study and +uncomment the relevant code, and push your changes to pass the first stage: + +```sh +git add . +git commit -m "pass 1st stage" # any msg +git push origin master +``` + +That's all! + +# Stage 2 & beyond + +Note: This section is for stages 2 and beyond. + +1. Ensure you have `go` installed locally +1. Run `./your_git.sh` to run your Git implementation, which is implemented in + `cmd/mygit/main.go`. +1. Commit your changes and run `git push origin master` to submit your solution + to CodeCrafters. Test output will be streamed to your terminal. + +# Testing locally + +The `your_git.sh` script is expected to operate on the `.git` folder inside the +current working directory. If you're running this inside the root of this +repository, you might end up accidentally damaging your repository's `.git` +folder. + +We suggest executing `your_git.sh` in a different folder when testing locally. +For example: + +```sh +mkdir -p /tmp/testing && cd /tmp/testing +/path/to/your/repo/your_git.sh init +``` + +To make this easier to type out, you could add a +[shell alias](https://shapeshed.com/unix-alias/): + +```sh +alias mygit=/path/to/your/repo/your_git.sh + +mkdir -p /tmp/testing && cd /tmp/testing +mygit init +``` diff --git a/cmd/mygit/main.go b/cmd/mygit/main.go new file mode 100644 index 0000000..a8d2b65 --- /dev/null +++ b/cmd/mygit/main.go @@ -0,0 +1,40 @@ +package main + +import ( + "fmt" + // Uncomment this block to pass the first stage! + // "os" +) + +// Usage: your_git.sh <command> <arg1> <arg2> ... +func main() { + // You can use print statements as follows for debugging, they'll be visible when running tests. + fmt.Println("Logs from your program will appear here!") + + // Uncomment this block to pass the first stage! + // + // if len(os.Args) < 2 { + // fmt.Fprintf(os.Stderr, "usage: mygit <command> [<args>...]\n") + // os.Exit(1) + // } + // + // switch command := os.Args[1]; command { + // case "init": + // for _, dir := range []string{".git", ".git/objects", ".git/refs"} { + // if err := os.MkdirAll(dir, 0755); err != nil { + // fmt.Fprintf(os.Stderr, "Error creating directory: %s\n", err) + // } + // } + // + // headFileContents := []byte("ref: refs/heads/main\n") + // if err := os.WriteFile(".git/HEAD", headFileContents, 0644); err != nil { + // fmt.Fprintf(os.Stderr, "Error writing file: %s\n", err) + // } + // + // fmt.Println("Initialized git directory") + // + // default: + // fmt.Fprintf(os.Stderr, "Unknown command %s\n", command) + // os.Exit(1) + // } +} diff --git a/codecrafters.yml b/codecrafters.yml new file mode 100644 index 0000000..77886cf --- /dev/null +++ b/codecrafters.yml @@ -0,0 +1,11 @@ +# Set this to true if you want debug logs. +# +# These can be VERY verbose, so we suggest turning them off +# unless you really need them. +debug: false + +# Use this to change the Go version used to run your code +# on Codecrafters. +# +# Available versions: go-1.22 +language_pack: go-1.22 @@ -0,0 +1,9 @@ +// CodeCrafters Note: +// +// You can make changes to this file if you'd like to use dependencies. +// +// When updating this file, make sure to run `go mod tidy` to ensure that `go.sum` is updated too. + +module github.com/codecrafters-io/git-starter-go + +go 1.22 diff --git a/your_git.sh b/your_git.sh new file mode 100755 index 0000000..4c2c367 --- /dev/null +++ b/your_git.sh @@ -0,0 +1,15 @@ +#!/bin/sh +# +# DON'T EDIT THIS! +# +# CodeCrafters uses this file to test your code. Don't make any changes here! +# +# DON'T EDIT THIS! +set -e + +tmpFile=$(mktemp) + +( cd $(dirname "$0") && + go build -buildvcs="false" -o "$tmpFile" ./cmd/mygit ) + +exec "$tmpFile" "$@" |