Merge pull request #52 from weaponsforge/dev

v1.2.2

Author: weaponsforge

.github/workflows/test.yaml

@@ -26,8 +26,7 @@ jobs:
         run: npm run lint
 
       - name: Transpile
-        run: npm run transpile
+        run: npm run transpile:noemit
 
       - name: Test
         run: npm test
-

README.md

@@ -1,8 +1,10 @@
 ## ✨ adventofcode
 
-This repository contains solutions and a local development environment for the [Advent of Code](https://adventofcode.com/) event puzzles using TypeScript/JavaScript.
+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.
+- The code repository structure follows a way that discusses and walks through the solution steps for the AoC quizzes rather than focusing on AoC's competitive programming.
+- The quizzes were solved for fun (unlocking the 2024 AoC Chrismas symbol 🎄) and brain exercise purposes. Therefore, no GPT or AI completion was used for solving, as advised on the AoC website.
+- These codes may get occasional optimization updates or solutions using other languages from time to time.
 
 ### 🎄 Advent of Code Quiz Information
 
@@ -19,6 +21,11 @@ The codes are structured in a way that discusses and walks through the solution
 - 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)
+- Day 11: Plutonian Pebbles [[link]](/src/2024/2024-12-11/README.md)
+- Day 12: Garden Groups [[link]](/src/2024/2024-12-12/README.md)
+- Day 13: Claw Contraption [[link]](/src/2024/2024-12-13/README.md)
+- Day 14: Restroom Redoubt [[link]](/src/2024/2024-12-14/README.md)
+- Day 15: Warehouse Woes [[link]](/src/2024/2024-12-15/README.md)
 
 </details>
 
@@ -44,7 +51,7 @@ It follows the directory structure:
 > [!NOTE]
 > 📂 dist<br>
 > 📂 src<br>
-> └─ 📂 utils<br>
+> └─ 📂 aoc<br>
 > └─ 📂 sample<br>
 > └─ 📂 2024<br>
 > └─── 📂 2024-12-01<br>
@@ -63,19 +70,20 @@ It follows the directory structure:
 
 #### Quiz Folders
 
-Each Advent of Code (AOC) event quiz has its folder under **`"/src/<YEAR>/<YYYY-MM-DD>"`** containing:
+Each Advent of Code (AoC) event quiz has its folder under **`"/src/<YEAR>/<YYYY-MM-DD>"`** containing:
 - **/lib**: Folder containing main quiz solution logic
 - **input.txt**: Random quiz input
+   > _**INFO:** The sample quiz inputs were slightly altered from the original AoC input text and quiz samples as advised on their website_
 - **main.ts**: Main program entry point containing quiz answer(s) using random input
 - **sample.test.ts**: Minimal sample input with expected correct answers
-- **README.md**: Reference and other notes about the AOC quiz question
+- **README.md**: Reference and other notes about the AoC quiz question
 
 #### Other Items
 
-- **/src/utils**: Folder containing generic utility helper functions
+- **/src/aoc**: 🗃️ Folder containing generic utility and common AoC helper functions
 - **/src/dist**: Folder containing the JavaScript files compiled from TypeScript (not committed to the repository)
 - **/src/sample**: Miscellaneous random examples
-- **/src/index.ts**: Exports all solutions to AOC quiz answer functions
+- **/src/index.ts**: Exports all solutions to AoC quiz answer functions
 
 ### 📋 Requirements
 
@@ -101,7 +109,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.
+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 from the project's _**"root directory"**_. For example:
    ```
    npx vite-node src/sample/sample.ts
@@ -166,6 +174,10 @@ Runs the sample TS script.
 
 Builds the JavaScript files from the TypeScript files.
 
+### `npm run transpile:noemit`
+
+Runs type-checking without generating the JavaScript or declatation files from the TypeScript files.
+
 ### `npm run lint`
 
 Lints TypeScript source codes.

package.json

@@ -12,6 +12,7 @@
     "dev": "vitest",
     "dev:debug": "vite-node src/sample/sample.ts",
     "transpile": "tsc -p tsconfig.json && tsc-alias",
+    "transpile:noemit": "tsc -p tsconfig.json --noEmit",
     "watch": "tsc -p tsconfig.json --watch",
     "watch:docker:win": "tsc -p tsconfig.json --watch --watchFile dynamicPriorityPolling --watchDirectory dynamicPriorityPolling",
     "lint": "eslint \"src/**/*.ts\" *.mjs *.ts",

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

@@ -1,5 +1,5 @@
 import path from 'path'
-import { readFile, directory } from '@/utils/file.js'
+import { readFile, directory } from '@/aoc/file/utils.js'
 
 export type arrayLists = {
   list1: string[];

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

@@ -1,4 +1,4 @@
-import { arrangeArray, ARRAY_ORDERING } from '@/utils/arrays.js'
+import { arrangeArray, ARRAY_ORDERING } from '@/aoc/array/utils.js'
 
 /**
  * Calculates the total distance between the smallest value-pairs from list `a` and list `b`

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

@@ -1,5 +1,5 @@
 import path from 'path'
-import { readFile, directory } from '@/utils/file.js'
+import { readFile, directory } from '@/aoc/file/utils.js'
 
 /**
  * Reads the quiz's input file into two (2) string arrays

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

@@ -1,5 +1,5 @@
 import path from 'path'
-import { directory, readFile } from '@/utils/file.js'
+import { directory, readFile } from '@/aoc/file/utils.js'
 import { extractMultiply, extractMultiplyCondition } from './lib/extractMultiply.js'
 
 const dir = directory(import.meta.url)

src/2024/2024-12-04/lib/wordCheckerUtils.ts

@@ -1,19 +1,8 @@
-export type CharacterArray = string[][]
-
-interface CoordinateBase {
-  x: number;
-  y: number;
-}
-
-interface Coordinate extends CoordinateBase {
-  direction: 1 | -1;
-}
-
-interface CoordinateData {
-  xDirection: 1 | -1;
-  yDirection: 1 | -1;
-  data: CharacterArray
-}
+import type {
+  Coordinate,
+  Point,
+  CoordinateData
+} from '@/aoc/point/types.js'
 
 /**
  * Finds the `WORD` input parameter in the vertical directions (up/down) from an (x,y) coordinate
@@ -23,11 +12,11 @@ interface CoordinateData {
  * @param coord.direction {number} Up or down letter-checking direction
  *   - `-1` for "up" going to (0,0)
  *   - `1` for "down" going to (N,N) from the `coord`
- * @param fullData {CharacterArray} 2D array of strings consisting of letters per item
+ * @param fullData {string[][]} 2D array of strings consisting of letters per item
  * @param WORD {string} Word to find
  * @returns {boolean} Flag indicating the existence of the `WORD`
  */
-export const checkVertical = (coord: Coordinate, fullData: CharacterArray, WORD: string): boolean => {
+export const checkVertical = (coord: Coordinate, fullData: string[][], WORD: string): boolean => {
   let yIndex = coord.y
   let subWord = ''
 
@@ -79,11 +68,11 @@ export const checkHorizontal = (coord: Coordinate, rowData: string[], WORD: stri
  * @typedef param {CoordinateData} Direction and data object
  * @param param.xDirection {number} `-1` for "left" going to (0,0) or `1` for "right" going to (N,N) from the `coord`
  * @param param.yDirection {number} `-1` for "up" going to (0,0) or `1` for "down" going to (N,N) from the `coord`
- * @param param.data {CharacterArray} 2D string array containing the input text
+ * @param param.data {string[][]} 2D string array containing the input text
  * @returns {boolean} Flag indicating the existence of the `WORD`
  * @param WORD {string} Word to find
  */
-export const checkDiagonal = (coord: CoordinateBase, param: CoordinateData, WORD: string): boolean => {
+export const checkDiagonal = (coord: Point, param: CoordinateData, WORD: string): boolean => {
   let xIndex = coord.x
   let yIndex = coord.y
   let subWord = ''

src/2024/2024-12-04/lib/wordCount.ts

@@ -2,7 +2,7 @@ import { checkVertical, checkHorizontal, checkDiagonal } from './wordCheckerUtil
 
 /**
  * Counts the number of occurence of the `WORD` from a set of input
- * @param data {CharacterArray} 2D string array containing the input text
+ * @param data {string[][]} 2D string array containing the input text
  * @param WORD_TO_FIND {string} Word to find
  * @returns {number} Number of `WORD`s
  */

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

@@ -1,5 +1,5 @@
 import path from 'path'
-import { directory, readFile } from '@/utils/file.js'
+import { directory, readFile } from '@/aoc/file/utils.js'
 import { wordCount } from './lib/wordCount.js'
 import { countMASword } from './lib/xmasCount.js'