Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TypeScript support #5

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions compiled_starters/typescript/.codecrafters/compile.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to compile your program on CodeCrafters
#
# This runs before .codecrafters/run.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

# (This file is empty since TypeScript programs don't use a compile step)
11 changes: 11 additions & 0 deletions compiled_starters/typescript/.codecrafters/run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to run your program on CodeCrafters
#
# This runs after .codecrafters/compile.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

exec bun run app/main.ts "$@"
1 change: 1 addition & 0 deletions compiled_starters/typescript/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
2 changes: 2 additions & 0 deletions compiled_starters/typescript/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Dependency directories
node_modules/
34 changes: 34 additions & 0 deletions compiled_starters/typescript/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/kafka.png)

This is a starting point for TypeScript solutions to the
["Build Your Own Kafka" Challenge](https://codecrafters.io/challenges/kafka).

In this challenge, you'll build a toy Kafka clone that's capable of accepting
and responding to APIVersions & Fetch API requests. You'll also learn about
encoding and decoding messages using the Kafka wire protocol. You'll also learn
about handling the network protocol, event loops, TCP sockets 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 Kafka implementation is in `app/main.ts`. Study and
uncomment the relevant code, and push your changes to pass the first stage:

```sh
git commit -am "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 `bun (1.1)` installed locally
1. Run `./your_program.sh` to run your Kafka broker, which is implemented in
`app/main.ts`.
1. Commit your changes and run `git push origin master` to submit your solution
to CodeCrafters. Test output will be streamed to your terminal.
11 changes: 11 additions & 0 deletions compiled_starters/typescript/app/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import net from "net";

// You can use print statements as follows for debugging, they'll be visible when running tests.
console.log("Logs from your program will appear here!");

// Uncomment this block to pass the first stage
// const server = net.createServer((connection) => {
// // Handle connection
// });
//
// server.listen(9092, "127.0.0.1");
11 changes: 11 additions & 0 deletions compiled_starters/typescript/codecrafters.yml
Original file line number Diff line number Diff line change
@@ -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 TypeScript version used to run your code
# on Codecrafters.
#
# Available versions: bun-1.1
language_pack: bun-1.1
6 changes: 6 additions & 0 deletions compiled_starters/typescript/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "@codecrafters/kafka",
"version": "1.0.0",
"type": "module",
"dependencies": {}
}
15 changes: 15 additions & 0 deletions compiled_starters/typescript/your_program.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/sh
#
# Use this script to run your program LOCALLY.
#
# Note: Changing this script WILL NOT affect how CodeCrafters runs your program.
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit early if any commands fail

# Copied from .codecrafters/run.sh
#
# - Edit this to change how your program runs locally
# - Edit .codecrafters/run.sh to change how your program runs remotely
exec bun run app/main.ts "$@"
1 change: 1 addition & 0 deletions course-definition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ languages:
- slug: "javascript"
- slug: "python"
- slug: "rust"
- slug: "typescript"

marketing:
difficulty: medium
Expand Down
18 changes: 18 additions & 0 deletions dockerfiles/bun-1.1.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# syntax=docker/dockerfile:1.7-labs
FROM oven/bun:1.1.27-alpine

ENV CODECRAFTERS_DEPENDENCY_FILE_PATHS="package.json,bun.lockb"

WORKDIR /app

# .git & README.md are unique per-repository. We ignore them on first copy to prevent cache misses
COPY --exclude=.git --exclude=README.md . /app

# For reproducible builds.
# This will install the exact versions of each package specified in the lockfile.
# If package.json disagrees with bun.lockb, Bun will exit with an error. The lockfile will not be updated.
RUN bun install --frozen-lockfile

RUN mkdir -p /app-cached
# If the node_modules directory exists, move it to /app-cached
RUN if [ -d "/app/node_modules" ]; then mv /app/node_modules /app-cached; fi
11 changes: 11 additions & 0 deletions solutions/typescript/01-vi6/code/.codecrafters/compile.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to compile your program on CodeCrafters
#
# This runs before .codecrafters/run.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

# (This file is empty since TypeScript programs don't use a compile step)
11 changes: 11 additions & 0 deletions solutions/typescript/01-vi6/code/.codecrafters/run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to run your program on CodeCrafters
#
# This runs after .codecrafters/compile.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

exec bun run app/main.ts "$@"
1 change: 1 addition & 0 deletions solutions/typescript/01-vi6/code/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
2 changes: 2 additions & 0 deletions solutions/typescript/01-vi6/code/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Dependency directories
node_modules/
34 changes: 34 additions & 0 deletions solutions/typescript/01-vi6/code/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/kafka.png)

This is a starting point for TypeScript solutions to the
["Build Your Own Kafka" Challenge](https://codecrafters.io/challenges/kafka).

In this challenge, you'll build a toy Kafka clone that's capable of accepting
and responding to APIVersions & Fetch API requests. You'll also learn about
encoding and decoding messages using the Kafka wire protocol. You'll also learn
about handling the network protocol, event loops, TCP sockets 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 Kafka implementation is in `app/main.ts`. Study and
uncomment the relevant code, and push your changes to pass the first stage:

```sh
git commit -am "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 `bun (1.1)` installed locally
1. Run `./your_program.sh` to run your Kafka broker, which is implemented in
`app/main.ts`.
1. Commit your changes and run `git push origin master` to submit your solution
to CodeCrafters. Test output will be streamed to your terminal.
7 changes: 7 additions & 0 deletions solutions/typescript/01-vi6/code/app/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import net from "net";

const server = net.createServer((connection) => {
// Handle connection
});

server.listen(9092, "127.0.0.1");
11 changes: 11 additions & 0 deletions solutions/typescript/01-vi6/code/codecrafters.yml
Original file line number Diff line number Diff line change
@@ -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 TypeScript version used to run your code
# on Codecrafters.
#
# Available versions: bun-1.1
language_pack: bun-1.1
6 changes: 6 additions & 0 deletions solutions/typescript/01-vi6/code/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "@codecrafters/kafka",
"version": "1.0.0",
"type": "module",
"dependencies": {}
}
15 changes: 15 additions & 0 deletions solutions/typescript/01-vi6/code/your_program.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/sh
#
# Use this script to run your program LOCALLY.
#
# Note: Changing this script WILL NOT affect how CodeCrafters runs your program.
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit early if any commands fail

# Copied from .codecrafters/run.sh
#
# - Edit this to change how your program runs locally
# - Edit .codecrafters/run.sh to change how your program runs remotely
exec bun run app/main.ts "$@"
16 changes: 16 additions & 0 deletions solutions/typescript/01-vi6/diff/app/main.ts.diff
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
@@ -1,11 +1,7 @@
import net from "net";

-// You can use print statements as follows for debugging, they'll be visible when running tests.
-console.log("Logs from your program will appear here!");
+const server = net.createServer((connection) => {
+ // Handle connection
+});

-// Uncomment this block to pass the first stage
-// const server = net.createServer((connection) => {
-// // Handle connection
-// });
-//
-// server.listen(9092, "127.0.0.1");
+server.listen(9092, "127.0.0.1");
20 changes: 20 additions & 0 deletions solutions/typescript/01-vi6/explanation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The entry point for your Kafka implementation is in `app/main.ts`.

Study and uncomment the relevant code:

```typescript
// Uncomment this block to pass the first stage
const server = net.createServer((connection) => {
// Handle connection
});

server.listen(9092, "127.0.0.1");
```

Push your changes to pass the first stage:

```
git add .
git commit -m "pass 1st stage" # any msg
git push origin master
```
11 changes: 11 additions & 0 deletions starter_templates/typescript/code/.codecrafters/compile.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to compile your program on CodeCrafters
#
# This runs before .codecrafters/run.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

# (This file is empty since TypeScript programs don't use a compile step)
11 changes: 11 additions & 0 deletions starter_templates/typescript/code/.codecrafters/run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
#
# This script is used to run your program on CodeCrafters
#
# This runs after .codecrafters/compile.sh
#
# Learn more: https://codecrafters.io/program-interface

set -e # Exit on failure

exec bun run app/main.ts "$@"
2 changes: 2 additions & 0 deletions starter_templates/typescript/code/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Dependency directories
node_modules/
11 changes: 11 additions & 0 deletions starter_templates/typescript/code/app/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import net from "net";

// You can use print statements as follows for debugging, they'll be visible when running tests.
console.log("Logs from your program will appear here!");

// Uncomment this block to pass the first stage
// const server = net.createServer((connection) => {
// // Handle connection
// });
//
// server.listen(9092, "127.0.0.1");
6 changes: 6 additions & 0 deletions starter_templates/typescript/code/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "@codecrafters/kafka",
"version": "1.0.0",
"type": "module",
"dependencies": {}
}
3 changes: 3 additions & 0 deletions starter_templates/typescript/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
attributes:
required_executable: bun (1.1)
user_editable_file: app/main.ts