Merge pull request #42 from weaponsforge/dev

v1.2.1

Author: weaponsforge

.gitignore

@@ -5,3 +5,7 @@ dist/
 *.zip
 *.rar
 *.tgz
+src/**/*.js
+
+**/*.txt
+!src/**/*.txt

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+20.15.0

README.md

@@ -1,6 +1,8 @@
 ## ✨ adventofcode
 
-This repository contains solutions and a local development environment for the [Advent of Code](https://adventofcode.com/) event puzzles.
+This repository contains solutions and a local development environment for the [Advent of Code](https://adventofcode.com/) event puzzles using TypeScript/JavaScript.
+
+The codes are structured in a way that discusses and walks through the solution steps for the AoC quizzes rather than focusing on AoC's competitive programming.
 
 ### 🎄 Advent of Code Quiz Information
 
@@ -12,6 +14,11 @@ This repository contains solutions and a local development environment for the [
 - Day 3: Mull It Over [[link]](/src/2024/2024-12-03/README.md)
 - Day 4: Ceres Search [[link]](/src/2024/2024-12-04/README.md)
 - Day 5: Print Queue [[link]](/src/2024/2024-12-05/README.md)
+- Day 6: Guard Gallivant [[link]](/src/2024/2024-12-06/README.md)
+- Day 7: Bridge Repair [[link]](/src/2024/2024-12-07/README.md)
+- Day 8: Resonant Collinearity [[link]](/src/2024/2024-12-08/README.md)
+- Day 9: Disk Fragmenter [[link]](/src/2024/2024-12-09/README.md)
+- Day 10: Hoof It [[link]](/src/2024/2024-12-10/README.md)
 
 </details>
 
@@ -72,7 +79,7 @@ Each Advent of Code (AOC) event quiz has its folder under **`"/src/<YEAR>/<YYYY-
 
 ### 📋 Requirements
 
-- Node v20.15.0
+- Node v20.15.0 (at least)
    - node: 20.15.0
    - npm: 10.7.0
 
@@ -95,7 +102,7 @@ Each Advent of Code (AOC) event quiz has its folder under **`"/src/<YEAR>/<YYYY-
 Using Node
 
 1. (Optional) Replace the values of specific `input.txt` in the `"/src/<YEAR>/<YYYY-MM-DD>"` directories with actual AOC input.
-2. Run a non-test TypeScript file inside the **/src** directory. For example:
+2. Run a non-test TypeScript file inside the **/src** directory from the project's _**"root directory"**_. For example:
    ```
    npx vite-node src/sample/sample.ts
    ```
@@ -108,7 +115,7 @@ Using Node
    npm run transpile
    node dist/sample/sample.js
    ```
-4. See the [Available Scripts](#available-scripts) section for more information.
+4. See the [Available Scripts](#-available-scripts) section for more information.
 
 ## ⚡ Alternate Usage
 

package-lock.json

@@ -5,8 +5,8 @@
   "main": "dist/index.js",
   "type": "module",
   "engines": {
-    "node": "20.15.0",
-    "npm": "10.7.0"
+    "node": ">=20.15.0",
+    "npm": ">=10.7.0"
   },
   "scripts": {
     "dev": "vitest",

package.json

@@ -1,5 +1,5 @@
 import path from 'path'
-import { readFile, currentDirectory } from '@/utils/file.js'
+import { readFile, directory } from '@/utils/file.js'
 
 export type arrayLists = {
   list1: string[];
@@ -12,8 +12,8 @@ export type arrayLists = {
  */
 export const fileReader = (): arrayLists => {
   // Read quiz input file
-  const directory = currentDirectory(import.meta.url)
-  const file = readFile(path.join(directory, '..', 'input.txt'))
+  const dir = directory(import.meta.url)
+  const file = readFile(path.join(dir, '..', 'input.txt'))
   const pairs: string[] = file.split('\n')
 
   const list1: string[] = []

src/2024/2024-12-01/lib/fileReader.ts

@@ -1,14 +1,14 @@
 import path from 'path'
-import { readFile, currentDirectory } from '@/utils/file.js'
+import { readFile, directory } from '@/utils/file.js'
 
 /**
  * Reads the quiz's input file into two (2) string arrays
  * @returns {arrayLists} An object containing two (2) string arrays: `{ list1, list2 }`
  */
 export const fileReader = (): number[][] => {
   // Read quiz input file
-  const directory = currentDirectory(import.meta.url)
-  const file = readFile(path.join(directory, '..', 'input.txt'))
+  const dir = directory(import.meta.url)
+  const file = readFile(path.join(dir, '..', 'input.txt'))
 
   return file
     .split('\n')

src/2024/2024-12-02/lib/fileReader.ts

@@ -1,9 +1,9 @@
 import path from 'path'
-import { currentDirectory, readFile } from '@/utils/file.js'
+import { directory, readFile } from '@/utils/file.js'
 import { extractMultiply, extractMultiplyCondition } from './lib/extractMultiply.js'
 
-const directory = currentDirectory(import.meta.url)
-const input = readFile(path.join(directory, 'input.txt'))
+const dir = directory(import.meta.url)
+const input = readFile(path.join(dir, 'input.txt'))
 
 /**
  * Part 1/2 of the 2024-12-03 quiz

src/2024/2024-12-03/main.ts

@@ -1,11 +1,11 @@
 import path from 'path'
-import { currentDirectory, readFile } from '@/utils/file.js'
+import { directory, readFile } from '@/utils/file.js'
 import { wordCount } from './lib/wordCount.js'
 import { countMASword } from './lib/xmasCount.js'
 
-const directory = currentDirectory(import.meta.url)
+const dir = directory(import.meta.url)
 
-const data: string[][] = readFile(path.join(directory, 'input.txt'))
+const data: string[][] = readFile(path.join(dir, 'input.txt'))
   .split('\n')
   .map(row => row.split(''))