Merge pull request #4 from codecrafters-io/CC-1274-js

glokta1 · web-flow · commit 1c259c387da7 · 2024-06-05T16:44:13.000+05:30
Add support for Javascript
diff --git a/compiled_starters/go/README.md b/compiled_starters/go/README.md
@@ -3,7 +3,10 @@
 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_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/compiled_starters/javascript/.gitattributes b/compiled_starters/javascript/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/compiled_starters/javascript/.gitignore b/compiled_starters/javascript/.gitignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/compiled_starters/javascript/README.md b/compiled_starters/javascript/README.md
@@ -0,0 +1,35 @@
+![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/shell.png)
+
+This is a starting point for JavaScript solutions to the
+["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
+
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, 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 `shell` implementation is in `app/main.js`. 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 `node (21)` installed locally
+1. Run `./your_shell.sh` to run your program, which is implemented in
+   `app/main.js`.
+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/compiled_starters/javascript/app/main.js b/compiled_starters/javascript/app/main.js
@@ -0,0 +1,15 @@
+// Uncomment this block to pass the first stage
+// const readline = require("readline");
+
+// 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 rl = readline.createInterface({
+//   input: process.stdin,
+//   output: process.stdout,
+// });
+//
+// rl.question("$ ", (answer) => {
+//   rl.close();
+// });
diff --git a/compiled_starters/javascript/codecrafters.yml b/compiled_starters/javascript/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 JavaScript version used to run your code
+# on Codecrafters.
+#
+# Available versions: nodejs-21
+language_pack: nodejs-21
diff --git a/compiled_starters/javascript/package-lock.json b/compiled_starters/javascript/package-lock.json
diff --git a/compiled_starters/javascript/package.json b/compiled_starters/javascript/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@codecrafters/build-your-own-shell",
+  "version": "1.0.0",
+  "description": "Build your own Shell challenge, from CodeCrafters",
+  "main": "main.js",
+  "scripts": {
+    "dev": "node app/main.js"
+  },
+  "keywords": [
+    "build-your-own-x"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {}
+}
diff --git a/compiled_starters/javascript/your_shell.sh b/compiled_starters/javascript/your_shell.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# DON'T EDIT THIS!
+#
+# CodeCrafters uses this file to test your code. Don't make any changes here!
+#
+# DON'T EDIT THIS!
+exec node app/main.js "$@"
diff --git a/compiled_starters/python/README.md b/compiled_starters/python/README.md
@@ -3,7 +3,10 @@
 This is a starting point for Python solutions to the
 ["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
 
-_Add a description of your course here_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/compiled_starters/rust/README.md b/compiled_starters/rust/README.md
@@ -3,7 +3,10 @@
 This is a starting point for Rust solutions to the
 ["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
 
-_Add a description of your course here_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/course-definition.yml b/course-definition.yml
@@ -19,6 +19,7 @@ languages:
   - slug: "go"
   - slug: "python"
   - slug: "rust"
+  - slug: "javascript"
 
 marketing:
   difficulty: medium
diff --git a/dockerfiles/nodejs-21.Dockerfile b/dockerfiles/nodejs-21.Dockerfile
@@ -0,0 +1,15 @@
+FROM node:21.7-alpine3.19
+
+ENV CODECRAFTERS_DEPENDENCY_FILE_PATHS="package.json,package-lock.json"
+
+WORKDIR /app
+
+COPY package.json ./
+COPY package-lock.json ./
+
+# If dependencies in the package lock do not match those in package.json, instead of updating the package lock, npm ci will exit with an error. 
+RUN npm ci
+
+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
diff --git a/solutions/go/01-oo8/code/README.md b/solutions/go/01-oo8/code/README.md
@@ -3,7 +3,10 @@
 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_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/solutions/javascript/01-oo8/code/.gitattributes b/solutions/javascript/01-oo8/code/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/solutions/javascript/01-oo8/code/.gitignore b/solutions/javascript/01-oo8/code/.gitignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/solutions/javascript/01-oo8/code/README.md b/solutions/javascript/01-oo8/code/README.md
@@ -0,0 +1,35 @@
+![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/shell.png)
+
+This is a starting point for JavaScript solutions to the
+["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
+
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, 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 `shell` implementation is in `app/main.js`. 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 `node (21)` installed locally
+1. Run `./your_shell.sh` to run your program, which is implemented in
+   `app/main.js`.
+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/solutions/javascript/01-oo8/code/app/main.js b/solutions/javascript/01-oo8/code/app/main.js
@@ -0,0 +1,10 @@
+const readline = require("readline");
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+rl.question("$ ", (answer) => {
+  rl.close();
+});
diff --git a/solutions/javascript/01-oo8/code/codecrafters.yml b/solutions/javascript/01-oo8/code/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 JavaScript version used to run your code
+# on Codecrafters.
+#
+# Available versions: nodejs-21
+language_pack: nodejs-21
diff --git a/solutions/javascript/01-oo8/code/package-lock.json b/solutions/javascript/01-oo8/code/package-lock.json
diff --git a/solutions/javascript/01-oo8/code/package.json b/solutions/javascript/01-oo8/code/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@codecrafters/build-your-own-shell",
+  "version": "1.0.0",
+  "description": "Build your own Shell challenge, from CodeCrafters",
+  "main": "main.js",
+  "scripts": {
+    "dev": "node app/main.js"
+  },
+  "keywords": [
+    "build-your-own-x"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {}
+}
diff --git a/solutions/javascript/01-oo8/code/your_shell.sh b/solutions/javascript/01-oo8/code/your_shell.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# DON'T EDIT THIS!
+#
+# CodeCrafters uses this file to test your code. Don't make any changes here!
+#
+# DON'T EDIT THIS!
+exec node app/main.js "$@"
diff --git a/solutions/javascript/01-oo8/diff/app/main.js.diff b/solutions/javascript/01-oo8/diff/app/main.js.diff
@@ -0,0 +1,24 @@
+@@ -1,15 +1,10 @@
+-// Uncomment this block to pass the first stage
+-// const readline = require("readline");
++const readline = require("readline");
+
+-// 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 rl = readline.createInterface({
++  input: process.stdin,
++  output: process.stdout,
++});
+
+-// Uncomment this block to pass the first stage
+-// const rl = readline.createInterface({
+-//   input: process.stdin,
+-//   output: process.stdout,
+-// });
+-//
+-// rl.question("$ ", (answer) => {
+-//   rl.close();
+-// });
++rl.question("$ ", (answer) => {
++  rl.close();
++});
diff --git a/solutions/javascript/01-oo8/explanation.md b/solutions/javascript/01-oo8/explanation.md
@@ -0,0 +1,28 @@
+The entry point for your Shell implementation is in `app/main.js`.
+
+Study and uncomment the relevant code: 
+
+```javascript
+// Uncomment this block to pass the first stage
+const readline = require("readline");
+```
+
+```javascript
+// Uncomment this block to pass the first stage
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+rl.question("$ ", (answer) => {
+  rl.close();
+});
+```
+
+Push your changes to pass the first stage:
+
+```
+git add .
+git commit -m "pass 1st stage" # any msg
+git push origin master
+```
diff --git a/solutions/python/01-oo8/code/README.md b/solutions/python/01-oo8/code/README.md
@@ -3,7 +3,10 @@
 This is a starting point for Python solutions to the
 ["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
 
-_Add a description of your course here_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/solutions/rust/01-oo8/code/README.md b/solutions/rust/01-oo8/code/README.md
@@ -3,7 +3,10 @@
 This is a starting point for Rust solutions to the
 ["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
 
-_Add a description of your course here_
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
 
 **Note**: If you're viewing this repo on GitHub, head over to
 [codecrafters.io](https://codecrafters.io) to try the challenge.
diff --git a/starter-repository-definitions.yml b/starter-repository-definitions.yml
@@ -61,3 +61,24 @@
   template_attributes:
     required_executable: "go (1.19)"
     user_editable_file: "cmd/myshell/main.go"
+- language: javascript
+  file_mappings:
+    - source: starter_templates/README.md
+      target: README.md
+    - source: starter_templates/codecrafters.yml
+      target: codecrafters.yml
+    - source: starter_templates/javascript/package.json
+      target: package.json
+    - source: starter_templates/javascript/package-lock.json
+      target: package-lock.json
+    - source: starter_templates/javascript/app/main.js
+      target: app/main.js
+    - source: starter_templates/javascript/your_shell.sh
+      target: your_shell.sh
+    - source: starter_templates/.gitattributes
+      target: .gitattributes
+    - source: starter_templates/javascript/.gitignore
+      target: .gitignore
+  template_attributes:
+    required_executable: "node (21)"
+    user_editable_file: "app/main.js"
diff --git a/starter_templates/README.md b/starter_templates/README.md
diff --git a/starter_templates/codecrafters.yml b/starter_templates/codecrafters.yml
diff --git a/starter_templates/javascript/.gitignore b/starter_templates/javascript/.gitignore
diff --git a/starter_templates/javascript/app/main.js b/starter_templates/javascript/app/main.js
diff --git a/starter_templates/javascript/package-lock.json b/starter_templates/javascript/package-lock.json
diff --git a/starter_templates/javascript/package.json b/starter_templates/javascript/package.json
diff --git a/starter_templates/javascript/your_shell.sh b/starter_templates/javascript/your_shell.sh
