Merge branch 'master' into project-euler-5

Author: omkarnathparida

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -33,9 +33,9 @@ body:
       label: Steps to reproduce (if applicable)
       description: List steps to reproduce the behavior.
       placeholder: |
-        1. 
-        2. 
-        3. 
+        1.
+        2.
+        3.
         4.
     validations:
       required: false

.github/dependabot.yml

@@ -0,0 +1,8 @@
+# Keep GitHub Actions up to date with Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/stale.yml

@@ -16,5 +16,5 @@ markComment: >
   for your contributions.
 # Comment to post when closing a stale issue. Set to `false` to disable
 closeComment: >
-  Please reopen this issue once you commit the changes requested or 
+  Please reopen this issue once you commit the changes requested or
   make improvements on the code. Thank you for your contributions.

.github/workflows/Ci.yml

@@ -11,11 +11,11 @@ jobs:
     name: Code style and tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           cache: npm
 
       - name: 📦 Install dependencies
@@ -25,13 +25,13 @@ jobs:
         run: npm run test
 
       - name: 💄 Code style
-        run: npm run style
+        run: npm run check-style
 
   codespell:
     name: Check for spelling errors
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: codespell-project/actions-codespell@master
         with:
           # file types to ignore

.github/workflows/UpdateDirectory.yml

@@ -10,11 +10,11 @@ jobs:
   updateDirectory:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           cache: npm
 
       - name: 📦 Install dependencies
@@ -25,8 +25,8 @@ jobs:
 
       - name: Configure Github Action
         run: |
-          git config --global user.name github-actions
-          git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com'
+          git config --global user.name "$GITHUB_ACTOR"
+          git config --global user.email "$[email protected]"
 
       - name: 🤓 Commit & push new Directory (if needed)
         run: |

.github/workflows/UploadCoverageReport.yml

@@ -0,0 +1,45 @@
+---
+name: UploadCoverageReport
+
+'on':
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+
+env:
+  REPORT_PATH: "coverage/coverage-final.json"
+
+jobs:
+  UploadCoverageReport:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate coverage report
+        run: npm test -- --coverage
+
+      - name: Upload coverage to codecov (tokenless)
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository
+        uses: codecov/codecov-action@v4
+        with:
+          files: "${{ env.REPORT_PATH }}"
+          fail_ci_if_error: true
+
+      - name: Upload coverage to codecov (with token)
+        if: "! github.event.pull_request.head.repo.fork "
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: "${{ env.REPORT_PATH }}"
+          fail_ci_if_error: true
+...

.gitignore

@@ -14,3 +14,5 @@ yarn-error.log*
 
 # intelliJ workspace folder
 .idea
+
+/coverage

.husky/pre-commit

@@ -1,5 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run style
+npm run check-style
 npm run test

Backtracking/AllCombinationsOfSizeK.js

@@ -1,46 +1,28 @@
-/*
-  Problem: Given two numbers, n and k, make all unique combinations of k numbers from 1 to n and in sorted order
-
-  What is combinations?
-  - Combinations is selecting items from a collections without considering the order of selection
-
-  Example:
-  - We have an apple, a banana, and a jackfruit
-  - We have three objects, and need to choose two items, then combinations will be
-
-  1. Apple & Banana
-  2. Apple & Jackfruit
-  3. Banana & Jackfruit
-
-  To read more about combinations, you can visit the following link:
-  - https://betterexplained.com/articles/easy-permutations-and-combinations/
-
-  Solution:
-  - We will be using backtracking to solve this questions
-  - Take one element, and make all them combinations for k-1 elements
-  - Once we get all combinations of that element, pop it and do same for next element
-*/
-
-class Combinations {
-  constructor(n, k) {
-    this.n = n
-    this.k = k
-    this.current = [] // will be used for storing current combination
-    this.combinations = []
-  }
-
-  findCombinations(high = this.n, total = this.k, low = 1) {
-    if (total === 0) {
-      this.combinations.push([...this.current])
-      return this.combinations
+function generateCombinations(n, k) {
+  let currentCombination = []
+  let allCombinations = [] // will be used for storing all combinations
+  let currentValue = 1
+
+  function findCombinations() {
+    if (currentCombination.length === k) {
+      // Add the array of size k to the allCombinations array
+      allCombinations.push([...currentCombination])
+      return
     }
-    for (let i = low; i <= high; i++) {
-      this.current.push(i)
-      this.findCombinations(high, total - 1, i + 1)
-      this.current.pop()
+    if (currentValue > n) {
+      // Check for exceeding the range
+      return
     }
-    return this.combinations
+    currentCombination.push(currentValue++)
+    findCombinations()
+    currentCombination.pop()
+    findCombinations()
+    currentValue--
   }
+
+  findCombinations()
+
+  return allCombinations
 }
 
-export { Combinations }
+export { generateCombinations }

Backtracking/KnightTour.js

@@ -2,12 +2,13 @@
 
 class OpenKnightTour {
   constructor(size) {
+    // Constructor to initialize the chessboard and size
     this.board = new Array(size).fill(0).map(() => new Array(size).fill(0))
     this.size = size
   }
 
   getMoves([i, j]) {
-    // helper function to get the valid moves of the knight from the current position
+    // Helper function to get the valid moves of the knight from the current position
     const moves = [
       [i + 2, j - 1],
       [i + 2, j + 1],
@@ -19,18 +20,19 @@ class OpenKnightTour {
       [i - 1, j + 2]
     ]
 
+    // Filter out moves that are within the board boundaries
     return moves.filter(
       ([y, x]) => y >= 0 && y < this.size && x >= 0 && x < this.size
     )
   }
 
   isComplete() {
-    // helper function to check if the board is complete
+    // Helper function to check if the board is complete
     return !this.board.map((row) => row.includes(0)).includes(true)
   }
 
   solve() {
-    // function to find the solution for the given board
+    // Function to find the solution for the given board
     for (let i = 0; i < this.size; i++) {
       for (let j = 0; j < this.size; j++) {
         if (this.solveHelper([i, j], 0)) return true
@@ -40,22 +42,23 @@ class OpenKnightTour {
   }
 
   solveHelper([i, j], curr) {
-    // helper function for the main computation
+    // Helper function for the main computation
     if (this.isComplete()) return true
 
+    // Iterate through possible moves and attempt to fill the board
     for (const [y, x] of this.getMoves([i, j])) {
       if (this.board[y][x] === 0) {
         this.board[y][x] = curr + 1
         if (this.solveHelper([y, x], curr + 1)) return true
-        // backtracking
+        // Backtracking: If the solution is not found, reset the cell to 0
         this.board[y][x] = 0
       }
     }
     return false
   }
 
   printBoard(output = (value) => console.log(value)) {
-    // utility function to display the board
+    // Utility function to display the board
     for (const row of this.board) {
       let string = ''
       for (const elem of row) {