aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitattributes1
-rw-r--r--README.md33
-rw-r--r--cmd/myshell/main.go18
-rw-r--r--codecrafters.yml11
-rw-r--r--go.mod11
-rw-r--r--go.sum0
-rwxr-xr-xyour_shell.sh15
7 files changed, 89 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..bcc52e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+[![progress-banner](https://backend.codecrafters.io/progress/shell/3b0a8105-4d68-45ce-a347-69a2af75c53f)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+
+This is a starting point for Go solutions to the
+["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
+
+_Add a description of your course here_
+
+**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 `shell` implementation is in `cmd/myshell/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
+```
+
+Time to move on to the next stage!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `go (1.19)` installed locally
+1. Run `./your_shell.sh` to run your program, which is implemented in
+ `cmd/myshell/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.
diff --git a/cmd/myshell/main.go b/cmd/myshell/main.go
new file mode 100644
index 0000000..6c65d9c
--- /dev/null
+++ b/cmd/myshell/main.go
@@ -0,0 +1,18 @@
+package main
+
+import (
+ "bufio"
+ "fmt"
+ "os"
+)
+
+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
+ // fmt.Fprint(os.Stdout, "$ ")
+
+ // Wait for user input
+ bufio.NewReader(os.Stdin).ReadString('\n')
+}
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
diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..4fabe2f
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,11 @@
+// DON'T EDIT THIS!
+//
+// Codecrafters relies on this file being intact to run tests successfully. Any changes
+// here will not reflect when CodeCrafters tests your code, and might even cause build
+// failures.
+//
+// DON'T EDIT THIS!
+
+module github.com/codecrafters-io/shell-starter-go
+
+go 1.22
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/go.sum
diff --git a/your_shell.sh b/your_shell.sh
new file mode 100755
index 0000000..983f6fe
--- /dev/null
+++ b/your_shell.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 -o "$tmpFile" ./cmd/myshell )
+
+exec "$tmpFile" "$@"