Merge pull request #46 from weaponsforge/feat/weaponsforge-44

refactor: organize aoc-related functions

Author: weaponsforge

README.md

@@ -48,7 +48,7 @@ It follows the directory structure:
 > [!NOTE]
 > 📂 dist<br>
 > 📂 src<br>
-> └─ 📂 utils<br>
+> └─ 📂 aoc<br>
 > └─ 📂 sample<br>
 > └─ 📂 2024<br>
 > └─── 📂 2024-12-01<br>
@@ -77,7 +77,7 @@ Each Advent of Code (AOC) event quiz has its folder under **`"/src/<YEAR>/<YYYY-
 
 #### 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/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'
 

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

@@ -1,6 +1,6 @@
 import path from 'path'
-import { directory, readFile } from '@/utils/file.js'
-import { uniformArrayElements } from '@/utils/arrays.js'
+import { directory, readFile } from '@/aoc/file/utils.js'
+import { uniformArrayElements } from '@/aoc/array/utils.js'
 
 export type Rules = Record<number, number[]>
 

src/2024/2024-12-05/lib/fixOrderingUpdates.ts

@@ -1,5 +1,5 @@
 import { isOrderedReport } from './orderedUpdates.js'
-import { arrayMiddleIndex, uniformArrayElements } from '@/utils/arrays.js'
+import { arrayMiddleIndex, uniformArrayElements } from '@/aoc/array/utils.js'
 
 import type { Rules } from './fileReader.js'
 import type { QuizData } from './fileReader.js'